Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Following are the general steps to configure a new scenario in OneList,

Configure the source system

The key information required to register a source system to OneList are: 

  • The unqiue OneList API key for the source system. The OneList adapters of the source system must use this API key to interact with OneList APIs. OneList authenticates the requests by validating the API key and uses it to identify the source system and its adapters to handle the requests.
  • The mapping between the source system user and OneList user. The user mapping can be created automatically or by user. Automatic user mapping is achieved if OneList and the source system have the same user id, or if the source system adapter creates the mapping via the OneList user sync APIs. When user mapping cannot be resolved, OneList creastes the mapping using the standard OIDC and ADFS protocols to request the user id from the source system. This requires user logging on to the source system once to give consent for OneList to retrieve the user's profile information. Once the user mapping is established, the user's tasks are available on OneList.

Configure the task category

Task category is designed to assist users to navigate their tasks easily and inturitively. Task categories are purly OneList categorization of tasks and do not have to bind to any task attribute or source system. In fact, tasks of the simuliar nature from different source systems should be assigned to the same task category.

Configure the adapter

OneList adapter plays two role in the integration between OneList and the source system: data sychronization and task layout tranformation. The data synchronization functionality is documented in the Integration Guide. The focus of this document is the registration of adapters and the task layout configuration.

There are two types of adapters:

  • Task adapter is responsible for the task synchronization and the task layout transformation; 
  • Delegation adapter is responsible for the synchronization of task delegation settings; Delegation adapter is optional;

Detail steps of the above configuration are in the following sections

  • No labels