ja-sync-entities
The schema defines the following additional types:
Properties of the JASyncEntitiesInBackgroundConfig object:
Property | Type | Required | Description |
type | action.sync-entities | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | When the property is set to 'false', the action will not execute. Default is 'true'. |
options | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC_FILE | DATA_PROVIDER_SALESFORCE | Generic Options | true | Options related to Jig Actions on bottom panel |
When the property is set to 'false', the action will not execute. Default is 'true'.
options (DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC_FILE | DATA_PROVIDER_SALESFORCE | Generic Options, required)
Options related to Jig Actions on bottom panel
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entities | OneDriveProviderSyncEntity[] | true | |
force | boolean | string | false | |
The object is an array with all elements of the type OneDriveProviderSyncEntity.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entities | Array<data-provider-definition | Dynamic Entity> | true | |
force | boolean | string | false | |
The elements of the array must match at least one of the following properties:
Properties of the Dynamic Entity object:
Property | Type | Required | Description |
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC_FILE | true | |
entities | DynamicFileProviderSyncEntity[] | true | |
force | boolean | string | false | |
The object is an array with all elements of the type DynamicFileProviderSyncEntity.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_SALESFORCE | true | |
entities | Array<data-provider-definition | Salesforce Entity> | true | |
force | boolean | string | false | |
The elements of the array must match at least one of the following properties:
Properties of the Salesforce Entity object:
Property | Type | Required | Description |
entity | data-provider-definition | true | |
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | data-provider-definition | string | true | |
entities | Array<data-provider-definition | GenericProviderSyncEntity> | true | |
force | boolean | string | false | |
The object must be any of the following types:
The elements of the array must match at least one of the following properties:
The object must be any of the following types:
Properties of the OneDriveProviderSyncEntity object:
Property | Type | Required | Description |
entity | data-provider-definition | string | true | |
data | Parameters | string | true | |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
tokenType | string | string | true | Token type |
Token type
The object must be any of the following types:
Properties of the DynamicFileProviderSyncEntity object:
Property | Type | Required | Description |
entity | data-provider-definition | string | true | |
The object must be any of the following types:
Properties of the GenericProviderSyncEntity object:
Property | Type | Required | Description |
entity | data-provider-definition | string | true | |
function | string | string | false | |
functionParameters | Expression | Primitive | false | |
The object must be any of the following types:
The object must be any of the following types:
Properties of the JASyncEntitiesOnButtonConfig object:
Property | Type | Required | Description |
type | action.sync-entities | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | When the property is set to 'false', the action will not execute. Default is 'true'. |
options | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC_FILE | DATA_PROVIDER_SALESFORCE | Generic Options | true | Options related to Jig Actions on bottom panel |
When the property is set to 'false', the action will not execute. Default is 'true'.
options (DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC_FILE | DATA_PROVIDER_SALESFORCE | Generic Options, required)
Options related to Jig Actions on bottom panel
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entities | OneDriveProviderSyncEntity[] | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
force | boolean | string | false | |
The object is an array with all elements of the type OneDriveProviderSyncEntity.
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entities | Array<data-provider-definition | Dynamic Entity> | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
force | boolean | string | false | |
The elements of the array must match at least one of the following properties:
Properties of the Dynamic Entity object:
Property | Type | Required | Description |
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC_FILE | true | |
entities | DynamicFileProviderSyncEntity[] | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
force | boolean | string | false | |
The object is an array with all elements of the type DynamicFileProviderSyncEntity.
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_SALESFORCE | true | |
entities | Array<data-provider-definition | Salesforce Entity> | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
force | boolean | string | false | |
The elements of the array must match at least one of the following properties:
Properties of the Salesforce Entity object:
Property | Type | Required | Description |
entity | data-provider-definition | true | |
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | data-provider-definition | string | true | |
entities | Array<data-provider-definition | GenericProviderSyncEntity> | true | |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
force | boolean | string | false | |
The object must be any of the following types:
The elements of the array must match at least one of the following properties:
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
![Doc contributor](https://s3.amazonaws.com/archbee-animals/rabbit.png)