Posting Framework

Posting Framework is the mechanism allowing automatic processing of inbound checklist in a step-based manner. It allows to define scenarios consisting of one or multiple steps (methods). Such scenario is then linked with checklist (template id and version) and processed automatically once the corresponding checklist is submitted in the FSM.

It is important to note that the framework will not start without the proper configuration defined in one of the following transactions: the cluster view /PACG/ECM_FRMDEF or the scenario builder /PACG/ECM_FRMW_BUILD.

Despite the selected method of customization (cluster view/scenario builder) one needs to complete similar set up process: create scenario, create/assign structure, define class and class steps for a scenario and follow the configuration of the company assignment, trigger assignment and checklists mapping.

See also https://proaxia-prod-doc.atlassian.net/wiki/spaces/PFCC/pages/2091745291

The common example of using framework is the meter exchange process. After the exchange meter checklist is filled with the relevant data: the goods issue will be posted, the equipment will be replaced and the measurement readings will be saved. The configuration for meter exchange process is following:

SCENARIOS ID (checklist scenario ID) between 000 and 999 are reserved for internal use only. Customers scenarios identified by ID from this range might get overwritten.

Cluster view /PACG/ECM_FRMDEF

Scenario builder /PACG/ECM_FRMW_BUILD

Cluster view /PACG/ECM_FRMDEF

Scenario builder /PACG/ECM_FRMW_BUILD

In the first level of the cluster the scenario and its description can be created:

In the next level the class can be assigned. The class is a space where different steps (methods) or actions should be defined :

Please note that the class above is a Z-class - no standard implementation logic is delivered with FSM Cloud Connector for posting scenarios.

In the lower level, the steps (methods from a class specified before) and their sequence can be defined. Additionally, the optional fields FrmwErrSta and FrmwUsrSta are available. If they are filled with some value, then after completing the step, the service order user status will be updated with the relevant value.

In the next node: company assignment, the scenario can be linked with the applicable company.

In the trigger assignment the template ID and its version are linked with the framework structure along with the set of conditions for processing. The conditions should be based on checklist’s content. If conditions are met, then the actions should be taken.

Framework structure can be created in Scenario builder or in ABAP Dictionary. It should include the fields that are chosen to be mapped to the checklist fields. Please note that /PACG/ECM_FRMWD table serves as a template for structure creation.

The condition definition below means that for a given checklist template id, version and structure the checklist field EQOLD can not be empty. One can also define more sophisticated conditions by providing specific values or ranges of values for a chosen checklist field by using standard options: Sign (Include/Exclude), Options pushbutton (Single value, Greater than, Less than, Range etc), Lower limit and Upper limit.

In the next level: checklist mapping the checklist positions are mapped to the the fields from the defined structure. Similarly to /PACG/ECM_VCLCNZ - New Checklist Mapping Customizing instead of position numbers, specific position names of a checklist are used.

Scenario builder consists of the same steps as the cluster but it also allows to create a new structure in nan easy way.

After the scenario is created on can assign a structure to it in the Structure assignment step.

One can create its own structure with the automatically defined name or pick existing one (for example created before in ABAP Dictionary). The name of the new structure is defaulted according to the following naming convention where prefix ZPACG_FRMW is concatenated with a time stamp. The time stamp part of the name can be changed.

The structure can be created by accepting/amending the name and using arrows to move fields between the columns. One can choose from variety of standard available fields from /PACG/ECM_FRMWD table which are listed in the column on the left.

Additionally one can also define and add own fields in the customer enhancement. It is important to note that the additional table fields cannot be appended but need to be entered manually.

In the next steps one can continue with the same set up steps as in the cluster: define the processing class and processing step, assign the company, trigger and define the checklist mapping:

After the checklist is filled with data and submitted and the required conditions are met, the framework is started and defined steps are processed.

Below is the sample data entered in the exchange meter checklist. Note the dismantled and installed meter information as well as their measurement readings.

After submitting the checklist, the results can be viewed in the new transaction Posting Framework - Logs Viewer /PACG/ECM_FRMW_LOGS which displays the logs for each processed step for the specific checklist document number, order number and so on. On the resulting ALV there is also an option to manipulate the data by manually setting a step as done.

For the example exchange meter order one can see the general confirmation that processing was successful along with more detailed information about each step.

One can view the material document mentioned in the log and check that it was posted in MB51 (Display Material Document transaction):

One can also check the equipment details from the log and note that the old equipment was dismantled and replaced with the new equipment in IE03 (Display Equipment transaction):

Dismantled equipment:

 

Installed equipment:

 

One can also check the measurement documents for both equipments in IK17 (Display Measurement Documents transaction):

Additionally the framework includes the set of transactions that allow for examination and correction of the failed processing. The details regarding the errors can be viewed in the log in previously mentioned transaction /PACG/ECM_FRMW_LOGS. The log show the list of steps that were processed and their status together with the action/error message.

In the below example one can see that there is a problem with the step related to replacing the equipment., This is due to the fact that technician entered the same equipment as dismantled and installed in the checklist:

The transaction Modify scenarios source data /PACG/ECM_FRMW_SRC allows to view and manually correct /modify the data that were saved to the data table. It can be used to change the data that stopped the framework from further processing:

In the presented example the installed equipment information has been manually corrected and saved:

After applying the corrections the transaction (Re)start scenario processing /PACG/ECM_FRMW_PROC can be used to (re-)/start the processing of the framework for the specific object:

One can see that after applying the change, the framework processing was successful.

 

If you'd like to help us improve the documentation, please provide your feedback using the communication channels listed /wiki/spaces/PFCC/pages/1561427969. Learn about support possibilities here.