...

Step 1	Enter the Job Name , for example ONELIST_JOBS_SCHEDULER
Step 2	Enter the Job Class - B or C (Medium / Low priority)
Step 3	Press the Step button
Step 4	Enter the ABAP Program Name: IQX Component version <= 3.2.2 : /IQX/ONELIST_JOBS IQX Component version >= 3.2.3: /IQX/ONELIST_SCHEDULER with variant WITH_OPS_JOB
Step 5	Enter the User - e.g. OL_ADMIN  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.  We recommend that this user should be classified as a 'System' user in SU01 (not 'Dialog'): 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 roles in the table below, see Roles and Authorizations for Background Processing. Press the Save button
Step 6	Press the Start conditions button Press the Date/Time button and enter the scheduled start date and time Press the Period Values button and choose Other period from the options Enter 1 in the Minute(s) field Image RemovedImage Added Press the Save button to complete the setup Once the OneList Scheduler background job has been created, it will automatically schedule the OneList Adapter jobs defined in the 'OneList Job configuration' entries, discussed below (or the /IQX/OL_JOB_DEF maintenance table further down, for older versions).

...

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:
Image Removed

...

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. 

...

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 Removed or

...

or, for example, Image Removed

...

In FAB 3.3 release, the framework was improved should be resilient to terminate the long-running job after a period of time, i.e. 10hrs ~ 36000 seconds. This will make stuck background jobs to be restarted so next scheduler can continue on another round of background jobs. Configuring time-out period per OPS type would look like this:

...

OneList Integration configuration
Note that you will (only once) have to configure a User integration entry. You . (If no value is specified, the default value is 86400 seconds/1day).

...

OneList Operation jobs configuration

Since IQX Component version 3.2.3, OneList framework introduces new operation job configuration in which the framework will check whether it is required to create the subsequent scenario based adapter jobs based on the available data of each TaskType/Adapter.

...

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): 

...

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

User Sync

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 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.

...

SYNC_ACTIONS

...

SYNC_ATTACHMENTS

...

SYNC_CHANGED_TASK_LIST

...

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.

...

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.

OneList Delegation Profiles

Delegation Profiles that should be synchronized to OneList can be configured in transaction /IQX/OL_CONFIG.

...

Key

...

Value

...

Workflow Type

...

WF - Workflow

...

Substitution Profile

...

Defines the Substitution Profile maintained in SPRO that will be used by OneList.

...

Active

...

Flag that sets the Delegation Profile as active when ticked or inactive when unticked.

OneList Global Settings

OneList Global Settings can be configured in transaction /IQX/OL_CONFIG.

...

Key

...

Value

...

EMAIL_APPR_ENABLED

...

Flag that sets the email approval enabled if the value “X” or disabled if left blank.

...

EMAIL_MAX_AGE_DAYS

...

Defines the maximum age of the email.

...

EMAIL_MAX_FILESIZE

...

Defines the maximum size of the email.

...

EMAIL_SOURCE

...

Possible values:

• UM - Email is retrieved from User Master

• HR - Email is retrieved from HR

• UM-HR - Default option if no setting is defined. Email is initially retrieved from the User Master. If the User Master is empty, the email is retrieved from HR.

• HR-UM - Email is initially retrieved from the HR. If the HR is empty, the email is retrieved from User Master.

FAB Workflow integration with OneList (Optional)

SAP Development tasks

1. Create a FAB Form with a Workflow (in this example, we will refer to a FAB app called IQX_FAB_APP).

OneList FAB Adapter framework configuration

Maintain the OneList configuration tables via transaction /IQX/OL_CONFIG.
Note 1: Parts of this section may have been done already if you also use standard SAP Workflow with OneList.
Note 2: If the above-mentioned transaction does not exist, then follow the instructions for the previous version below.
Note 3: 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.. 

...

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. 

...

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 Removed or, for example, Image Removed

...

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).

...

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 (Since IQX Component version 3.3 the following methods are supported by class /IQX/CL_OL_SYNC_USERS:

The end result should look something like this:

...

Integration for SAP WF Process

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_SRVC_ENTRY_SHEET_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 Added

    
    

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.

OneList Delegation Profiles

Delegation Profiles that should be synchronized to OneList can be configured in transaction /IQX/OL_CONFIG.

...

OneList Global Settings

OneList Global Settings can be configured in transaction /IQX/OL_CONFIG.

...

FAB Workflow integration with OneList (Optional)

SAP Development tasks

1. Create a FAB Form with a Workflow (in this example, we will refer to a FAB app called IQX_FAB_APP).

OneList FAB Adapter framework configuration

Maintain the OneList configuration tables via transaction /IQX/OL_CONFIG.
Note 1: Parts of this section may have been done already if you also use standard SAP Workflow with OneList.
Note 2: If the above-mentioned transaction does not exist, then follow the instructions for the previous version below.
Note 3: 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 (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:

...

 or, for example, 

...

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_IM_APR in this example).

...

OneList Job Configuration (part of this may be complete already, especially pertaining to the USER_SYNC entry)
User Sync

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_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.

Since IQX Component version 3.3 the following methods are supported by class /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.

...

:

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_V2) 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

• SYNC_BUSINESS_OBJECTS
  
  For each entry, specify:

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

  • 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 RemovedImage Added

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.

...