interface ModProcessctlProperties {
    clientReference?: string;
    clientReferenceKey?: string;
    mandatorId?: string;
    processToken?: string;
    processctlServer?: string;
    processctlSolutionsServer?: string;
}

Hierarchy (view full)

Properties

clientReference?: string

clientReference will be considered only when you authenticate with mandatorId.

The clientReference setting can be used to customize the widget's process. Not all widgets use this setting, so please refer to the widget's documentation for more details.

clientReferenceKey?: string

clientReferenceKey will be considered only when you authenticate with mandatorId.

The clientReferenceKey allows you to label the widget instance with a keyword, so you can monitor the success of the widgets with the given reference key.

For instance, if you are running various campaigns to advertise a new product, you could provide campaign identifiers in the reference key. Then, the user usage data can be retrieved from the Process Controller API.

mandatorId?: string

Widget's authentication can be done by providing either a processToken or a mandatorId. If both are provided, the processToken will take precedence.

After registering, you will be provided with a UUID known as the 'mandatorId'. Once you provide the 'mandatorId', the widget will automatically generate a 'processToken' for the predefined Client associated with your Mandator.

processToken?: string

Widget's authentication can be done by providing either a processToken or a mandatorId. If both are provided, the processToken will take precedence.

The processToken is a UUID and must be obtained from the API before authentication by providing Client credentials.

processctlServer?: string

Server URL of the Process Controller API.

Default

https://di-processctl-finapi-general-live.finapi.io
processctlSolutionsServer?: string

Server URL of the Process Controller Solutions API.

Default

https://di-processctl-finapi-general-live.finapi.io

Generated using TypeDoc