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 parameters of the demo program /PCH/GCP_CFM_XFACE_TEST are generally optional. Depending on the settings in ProConfiguration, more or less data must be entered for the various functions. Accordingly, no validations are carried out within the demo program. However, when the functions are executed via the interfaces, any messages are then issued.
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 FREE method to release all resources.
There are always corresponding RFC function modules for the following functions. For these, the material and document keys as well as any information for checking the change number must be entered with each call. There are no SET_* RFC function modules.
Many of the parameters of the methods below are optional. Which data is necessary for which use case depends on the settings of the corresponding processing scenarios of ProConfiguration as well as the standard SAP settings.
In case of errors, it is recommended to 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 | Tipp |
|---|---|---|
Create material | PREPARE_MATERIAL_CREATE | Also to be used for a creation of a plant or sales view.The actual creation must be done via a call of SAP standard modules for the creation (e.g. MATERI-AL_MAINTAIN_DARK). The corresponding material status must be set correctly. This method PRE-PARE_MATERIAL_CREATE must be done before the actual creation. |
Start material change | PREPARE_MATERIAL_CHANGE und START_MATERIAL_CHANGE | The method START_MATERIAL_CHANGE executes the necessary status change on the material master directly. If other data is to be changed in addition to the status, the change can be prepared with PRE-PARE_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 of current configuration for set material object | GET_CONFIGURATION | |
Query information about 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 | |
Start data package change | START_DATAPACKAGE_CHANGE | |
Determine the use of a document in configurations of ProConfiguration | GET_DOCUMENT_CFM_USAGE | Returns the change number of the current change for the set material object. |
Check validity / change number and assignment mode Set change number | SET_ECM_MODE | Check can be: none, >= valid today or same change number as 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 to the document. |
Add a document info record or a new version of a document to the configuration | ADD_DOCUMENT | The set document is added to the configuration of the currently set material object. The data package is determined automatically. |
Remove a document info record | REMOVE_DOCUMENT | The set document is removed from the configuration of the currently set material object. The data package is determined automatically. |
Registration in the management of documents used more than once | REGISTER_DOCUMENT_IN_MLD | Registers the set document for adding or exchanging the version in the ProConfiguration mvD administration. The mvD setting for the corresponding document must be set up correctly. |