Interface

This ProIntegrationLib - ProConfiguration interface is implemented by the class /PCH/CL_GCP_CFM_XFACE with appropriate methods. RFC modules of the function group /PCH/GCP_CFM_XFACE are available for calling via RFC.
The demo program /PCH/GCP_CFM_XFACE_TEST implements all methods of interface class /PCH/CL_GCP_CFM_XFACE as examples. Each option provided in this program is implemented using the method call or the RFC function. The program can also be used directly to test the interface.

The description of the individual methods and their parameters can be found in class /PCH/CL_GCP_CFM_XFACE. The basic procedure is described below:

• Create an instance of the class. However, an instance can be used for several actions with different objects.
• Set the material, plant or sales object (SET_MATERIAL_CLIENT, SET_MATERIAL_PLANT, SET_MATERIAL_SALES_ORG)
• If a document is to be handled in the configuration:
  • Set the document key with SET_DOCUMENT_OBJECT
  • Set the settings for engineering change management with SET_ECM_MODE
• Executing the function

• At the end of processing, always release all resources by calling the method FREE.

  At the end of processing, that is, when the instance of the /PCH/CL_GCP_CFM_XFACE class is no longer needed, call the method FREE to release all resources.

  There are always corresponding RFC function modules for the following functions. With these function modules, the material and document keys and any information about the change number check must be included with each call. There are no SET_* RFC function modules.

  Many of the parameters of the methods listed below are optional. Which data is required for which application case depends on the settings of the corresponding processing scenarios in ProConfiguration and the standard SAP settings.

  If errors occur, we recommend that you always run the functions directly in the application first and then set the entries to be made in the programs accordingly.

  Below is an overview of the corresponding functions. For some of the individual functions, there are also corresponding methods for querying whether this function is possible. These are listed in the "Test Method" column.

  Function	Method (test method)	Hint
  create material	PREPARE_MATERIAL_CREATE	Can also be used for creating a plant or sales view. The actual creation must take place by calling SAP standard modules for the creation (for example, MATERIAL_MAINTAIN_DARK). The corresponding material status must be set correctly. This method PREPARE_MATERIAL_CREATE must take place before the actual creation.
  Start material change	PREPARE_MATERIAL_CHANGE and START_MATERIAL_CHANGE	Can also be used to change a plant or sales view. The method START_MATERIAL_CHANGE executes the necessary status change directly in the material master. If other data is to be changed in addition to the status, the change can be prepared with PREPARE_MATERIAL_CHANGE and the actual status change with other data can be carried out with an SAP standard function module such as MATERIAL_MAINTAIN_DARK.
  Query the current configuration for set material object	GET_CONFIGURATION
  Query information on data packages for set material object	GET_DATAPACKAGES	Provides information about existing and all defined data packages and whether they can be changed or created.
  Create data package	CREATE_DATAPACKAGE (GET_DATAPACKAGES)
  Start data package change	START_DATAPACKAGE_CHANGE (GET_DATAPACKAGES)
  Determining the use of a document in ProConfiguration configurations	GET_DOCUMENT_CFM_USAGE
  Determine ProConfiguration change number to be used	GET_CHANGE_NUMBER	Returns the change number of the current change for the set material object.
  Check effectivity/change number and assignment mode Set change number	SET_ECM_MODE	Check can be: none, >= valid today or the same change number as the material change. Set: if activated and the document info record has no change number assigned, the change number of the current material change is set for the document.
  Add a document info record or a new version of a document to the configuration	ADD_DOCUMENT (CAN_DOCUMENT_BE_ADDED)	The set document is added to the configuration of the material object currently set. The data package is determined automatically.
  Remove a document info record	REMOVE_DOCUMENT (CAN_DOCUMENT_BE_REMOVED)	The document that is set is removed from the configuration of the material object that is currently set. The data package is determined automatically.
  Registration in the administration of multiple used documents	REGISTER_DOCUMENT_IN_MLD (CAN_DOCUMENT_BE_REGISTERED_MLD)	Registers the set document for adding or exchanging the version in the ProConfiguration mvD Administration. The mvD settings for the corresponding document must be set up correctly.