...

Background job - setup (Mandatory)

...

1. Enter the Job Name , for example ONELIST_JOBS_SCHEDULER
   

2. Enter the Job Class - B or C (Medium / Low priority)

3. Press the Step button

4. Enter the ABAP Program Name - /IQX/ONELIST_JOBS
   

5. Enter the User - e.g. OL_ADMIN info

   title	User information

   1. A service user account must be created to run these background jobs, similar to WF-BATCH. This user can be allocated any name (like OL_ADMIN above) to fit in with your organisation's policies / standards. 

   2. We recommend that this user should be classified as a 'System' user in SU01 (not 'Dialog'):

   
   Image Removed

   2. We recommend that, like WF-BATCH, the service account must have broad authorisations (to be able to start background jobs, call programs, execute the methods in the Adapter framework, etc.). We therefore recommend SAP_ALL be allocated to this user. If that is not possible, then the user must be given at least the following:

      Authorisation Object: S_BTCH_NAM (BTCUNAME - Background User Name for Authorization Check)
      Values: * (All users)
      

6. Press the Save button

7. Press the Start conditions button

8. Press the Date/Time button and enter the scheduled start date and time

9. Press the Period Values button and choose Other period from the options

10. Enter 1 in the Minute(s) field
    

    Image RemovedImage Added

Press the Save button to complete the setup

...

Standard SAP Workflow integration with OneList (Optional)

...

This section will detail the steps you need to follow for setting up such a custom SAP Workflow adapter that can connect to OneList V6. 

...

Maintain the OneList configuration tables via transaction /IQX/OL_CONFIG.
Note 1: If the above-mentioned transaction does not exist, then follow the instructions for the previous version below.
Note 2: Use the configuration / development development client, and transport this configuration to subsequent systems like QA and the Productive system. If you have a development Unit Test client, use SCC1 to copy the config from the configuration client.. 
Note that there is a sequence to be followed, as per the tree structure, shown below:

...

OneList Endpoint configuration
Add entries for each of the systems in your SAP landscape. When you save this information, SAP will prompt you for a transport request. This will enable you to transport the entries to your Quality Assurance and Productive systems, as well as importing into your Development Unit Testing Client. 

...

Notes:

IQX will provide the values that need to be entered for the OneList URL and API Key.

All entries should be marked as 'active' under normal circumstances. The OneList Adapter will dynamically determine the correct URL and API key based on the system that it is running in. Only in unusual situations will the endpoint be marked as inactive, but then the Adapter will not be able to call the OneList instance in the relevant system.

There is a transaction (/IQX/OL_ENDPOINT) that can be run in the 'active' clients (Unit Test, QA and PRD) to maintain these values directly in the active/target system. This should only be used when emergency maintenance needs to be performed (DOS attack, etc.). The changed values should be copied back into the configuration client and added to a new transport.

In the transaction /IQX/OL_ENDPOINT there is a 'Connection Test' option to check for the correctness of the URL and API key. This can be executed in each system:
Image Modified or, for example, Image Modified

OneList Integration configuration
Note that you will (only once) have to configure a User integration entry. You may end up with multiple processes integrating with OneList, each of which will require their own entry here (and follow-on entries - see below). It does not matter how many processes you integrate with OneList, you will only need to do this step once - the processes all share the user integration. Add an entry to synchronise the SAP users with OneList, as follows (and note that the Task ID and the Fab Layout form entries remain empty): 

...

There is no need to specify a Workflow task or FAB form for the user synchronisation.

...

• Next, add an entry for the SAP Workflow process you want to integrate between SAP and OneList.  If you are integrating OneList with an SAP Workflow, you will need to know the Standard Task ID (use the Workflow Builder (SWDD) or transaction PFTSto get this information) that contains the processing steps - in the example below, it is called "SAP WF Process", linking to Workflow task TSxxxxxxxx.

When you add an entry, you will have to specify the following:

...

...

Paging Size" refers to the number of tasks that will be sent to OneList at one time - if this number is too large, then your integration activities may suffer from performance degradation.

...

OneList Job Configuration
Highlight the User integration entry (configured above, and remember this is only done once):

...


Then double-click the 'OneList Job configuration' entry in the tree structure. Configuring this step allows the Adapter framework to communicate with the OneList instance, specifically for user integration. IQX has provided a standard user integration Adapter class (/IQX/CL_OL_SYNC_USERS), but in rare circumstances your organisation may need to alter the behaviour of this class. In that case, you will have to create a subclass of this class (see step 1 above, under SAP Development tasks) and override the relevant methods to suit your needs. In that case, instead of /IQX/CL_OL_SYNC_USERS, use the name of your subclass in the below configuration steps. 

You will need to define entries for the SYNC_USER_REQUEST and SYNC_USER_REQUEST_DELTA OneList User Integration APIs/Actions. For each entry, specify:

• Adapter Class name: /IQX/CL_OL_SYNC_USERS, or your user integration subclass

• Frequency in minutes: how often the background job calling this OneList API should run. We recommend between 5 and 30 minutes.

• Active - A flag to set whether this job should run. During specific scenarios (shutdown, data take-on, etc.) you may want to disable individual API calls. Normal value will be ticked.


The end result should look something like this:

...


Now highlight the process integration point for which you want to configure the background jobs ("SAP WF Process" in this example). Remember that there can be multiple processes integrated with OneList - these steps need to be repeated for every process:

...


Then double-click the 'OneList Job configuration' entry in the tree structure. Configuring this step provides a link between your SAP Adapter class (for example ZCL_OL_PO_ADAPTER, created above) and the IQX OneList SAP Adapter framework.  For each entry defined here, the Adapter framework will create a background job at the specified frequency, thereby pushing / pulling data to and from OneList. You will need to define entries for the following 4 OneList Integration APIs/Actions:

• SYNC_ACTIONS

• SYNC_ATTACHMENTS

• SYNC_CHANGED_TASK_LIST

• SYNC_DELTA_TASK_LIST

For each entry, specify:

  • Adapter Class name: your class created above, for example ZCL_OL_PO_ADAPTER

  • Frequency in minutes: how often the background job calling this OneList API should run. We recommend between 1 and 5 minutes at most.

  • Active - A flag to set whether this job should run. During specific scenarios (shutdown, data take-on, etc.) you may want to disable individual API calls. Normal value will be ticked.

The end result should look something like this:
Image Modified


With the above in place, the background job defined in the first step will create a background job per integration task type, at the specified frequency. The 'SYNC*' methods (described above) will call the methods you have redefined in your custom Adapter class, thereby enabling the extraction of data from the SAP Workflow / SAP objects (which will be sent to OneList) and the return flow of the OneList Actions to the SAP Workflow / SAP Objects.

FAB Workflow integration with OneList (Optional)

...


Note that there is a sequence to be followed, as per the tree structure, shown below:


...

OneList Endpoint configuration (this may be complete already)
Add entries for each of the systems in your SAP landscape. When you save this information, SAP will prompt you for a transport request. This will enable you to transport the entries to your Quality Assurance and Productive systems, as well as importing into your Development Unit Testing Client. 


...


Notes:

IQX will provide the values that need to be entered for the OneList URL and API Key.

All entries should be marked as 'active' under normal circumstances. The OneList Adapter will dynamically determine the correct URL and API key based on the system that it is running in. Only in unusual situations will the endpoint be marked as inactive, but then the Adapter will not be able to call the OneList instance in the relevant system.

There is a transaction (/IQX/OL_ENDPOINT) that can be run in the 'active' clients (Unit Test, QA and PRD) to maintain these values directly in the active/target system. This should only be used when emergency maintenance needs to be performed (DOS attack, etc.). The changed values should be copied back into the configuration client and added to a new transport.

In the transaction /IQX/OL_ENDPOINT there is a 'Connection Test' option to check for the correctness of the URL and API key. This can be executed in each system:
Image Modified or, for example, Image Modified

OneList Integration configuration

Note that you will (only once) have to configure a User integration entry. You may end up with multiple processes integrating with OneList, each of which will require their own entry here (and follow-on entries - see below). It does not matter how many processes you integrate with OneList, you will only need to do this step once - the processes all share the user integration. Add an entry to synchronise the SAP users with OneList, as follows (and note that the Task ID and the Fab Layout form entries remain empty): 

...


There is no need to specify a Workflow task or FAB form for the user synchronisation.

Next, add an entry for the FAB process you want to integrate between SAP and OneList.  You will need to specify the App name (IQX_FAB_APP in this example).


...



OneList Job Configuration (part of this may be complete already, especially pertaining to the USER_SYNC entry)
Highlight the User integration entry (configured above, and remember this is only done once):

...


Then double-click the 'OneList Job configuration' entry in the tree structure. Configuring this step allows the Adapter framework to communicate with the OneList instance, specifically for user integration. IQX has provided a standard user integration Adapter class (/IQX/CL_OL_SYNC_USERS), but in rare circumstances your organisation may need to alter the behaviour of this class. In that case, you will have to create a subclass of this class (see step 1 above, under SAP Development tasks) and override the relevant methods to suit your needs. In that case, instead of /IQX/CL_OL_SYNC_USERS, use the name of your subclass in the below configuration steps. 

You will need to define entries for the SYNC_USER_REQUEST and SYNC_USER_REQUEST_DELTA OneList User Integration APIs/Actions. For each entry, specify:

• Adapter Class name: /IQX/CL_OL_SYNC_USERS, or your user integration subclass

• Frequency in minutes: how often the background job calling this OneList API should run. We recommend between 5 and 30 minutes.

• Active - A flag to set whether this job should run. During specific scenarios (shutdown, data take-on, etc.) you may want to disable individual API calls. Normal value will be ticked.


The end result should look something like this:


...


Now highlight the process integration point for which you want to configure the background jobs ("FAB_APP" in this example). Remember that there can be multiple processes integrated with OneList - these steps need to be repeated for every process:

...


Then double-click the 'OneList Job configuration' entry in the tree structure. Configuring this step provides a link between the your form, the IQX FAB Adapter class (/IQX/CL_FAB_ADPT) and the IQX OneList SAP Adapter framework.  For each entry defined here, the Adapter framework will create a background job at the specified frequency, thereby pushing / pulling data to and from OneList. You will need to define entries for the following 4 OneList Integration APIs/Actions:

• SYNC_ACTIONS

• SYNC_ATTACHMENTS

• SYNC_CHANGED_TASK_LIST

• SYNC_DELTA_TASK_LIST

For each entry, specify:

  • Adapter Class name: the IQX FAB Adapter class /IQX/CL_FAB_ADPT

  • Frequency in minutes: how often the background job calling this OneList API should run. We recommend between 1 and 5 minutes at most.

  • Active - A flag to set whether this job should run. During specific scenarios (shutdown, data take-on, etc.) you may want to disable individual API calls. Normal value will be ticked.

The end result should look something like this:


    Image Modified

With the above in place, the background job defined in the first step will create a background job per integration task type, at the specified frequency. The 'SYNC*' methods (described above) will call the methods in the IQX FAB Adapter class, thereby enabling the extraction of data from the FAB Form (which will be sent to OneList) and the return flow of the OneList Actions to the FAB Form.

...