Purpose
The Event Provider file provide the format for designing an event provider for a provider application to generate event-based synchronizations in Primavera Gateway.
Schema file
EventProvider.xsd
Contents
An EventProvider element that contains that contains the following elements:
Element | Type | Parents | Description |
|---|---|---|---|
Description | string | EventProvider | A description of the event provider. |
Name | string | EventProvider | The name of the event provider. |
ApplicationName | string | EventProvider | The name of the application associated with the event provider. |
Version | string | EventProvider | The version number of the event provider. |
Type | string | EventProvider | The type of event provider. Choices include: Polling, Receiving. |
ClassPath | string | EventProvider | The class path for classes and other resource files used the Java interfaces for the event provider. |
EventProviderConfigs | EventProviderConfigsType | EventProvider | The element that contains one or more event provider configurations for the event provider. |
EventListeners | EventListenersType | EventProvider | The element that contains one or more event listeners associated with the event provider. |
EventProviderInstance | EventProviderInstanceType | EventProvider | The element that contains one or more event provider instances associated with the event provider. |
EventProviderConfigsType Table
Element | Type | Parents | Description |
|---|---|---|---|
Config | EventConfigType | EventProviderConfigs | The element that contains one or more event provider configurations of the event provider. |
EventConfigType Table
Element | Type | Parents | Description |
|---|---|---|---|
CriteriaOptions | CriteriaOptionsType | Config | The element that contains the criteria options of the event provider configuration. |
DefaultValue | string | Config | The default value of the event provider configuration. |
Description | string | Config | A description of the event provider configuration. |
Name | string | Config | The name of the event provider configuration. |
Sequence | Integer | Config | The sequence number of the configuration. The sequence number determines the order in which the configuration parameters are displayed. |
Title | string | Config | The title of the event provider configuration. |
Type | string | Config | The type of configuration parameter. |
CriteriaOptionsType Table
Element | Type | Parents | Description |
|---|---|---|---|
ObjectOptions | ObjectOptionsType | CriteriaOptions | The element that contains one or more event listeners associated with the event provider. |
ObjectOptionsType Table
Element | Type | Parents | Description |
|---|---|---|---|
Object | ObjectType | ObjectOptions | The element that contains one or more event listeners associated with the event provider. |
ObjectType Table
Element | Type | Parents | Description |
|---|---|---|---|
Name | string | Object | The element that contains the name of the object associated with the event provider. |
DefaultValue | string | Object | The element that contains the default value of the object associated with the event provider. |
EventListenersType Table
Element | Type | Parents | Description |
|---|---|---|---|
EventListener | EventListenerType | EventProvider | The element that contains one or more event listeners associated with the event provider. |
EventListenerType Table
Element | Type | Parents | Description |
|---|---|---|---|
Description | string | EventListener | A description of the event provider. |
Name | string | EventListener | The name of the event provider. |
EventListenerConfigs | EventListenerConfigsType | EventListener | The element that contains one or more event listener configurations associated with the event provider. |
EventListenerConfigsType Table
Element | Type | Parents | Description |
|---|---|---|---|
Config | EventConfigType | EventListenerConfigs | The element that contains one or more configuration parameters for each event listener configuration. |
EventProviderInstanceType Table
Element | Type | Parents | Description |
|---|---|---|---|
AppInstance | string | EventProviderInstance | The application instance associated with the event provider. |
Description | string | EventProviderInstance | A description of the event provider instance. |
ProviderConfigs | ProviderConfigsType | EventProviderInstance | The element that contains one or more event provider configurations associated with an event provider instance. |
EventListenerInstances | EventListenerInstancesType | EventProviderInstance | The element that contains one or more event listener instances associated with an event provider instance. |
ProviderConfigsType Table
Element | Type | Parents | Description |
|---|---|---|---|
Config | EventInstanceConfigType | ProviderConfigs | The element that contains one or more configuration parameters associated with a provider configuration. |
EventInstanceConfigType Table
Element | Type | Parents | Description |
|---|---|---|---|
Name | string | Config | The name of the configuration parameter. |
Value | string | Config | The value of the configuration parameter. |
EventListenerInstancesType Table
Element | Type | Parents | Description |
|---|---|---|---|
EventListenerInstance | EventListenerInstanceType | EventListenerInstances | The event listener instance associated with an event provider. |
EventListenerInstanceType Table
Element | Type | Parents | Description |
|---|---|---|---|
DelayInMinutes | integer | EventListenerInstance | The time duration between when an event is received by event provider and a synchronization job is triggered in the Gateway user interface. |
ListenerName | string | EventListenerInstance | The name of the event listener instance. |
ListenerConfigs | ListenerConfigsType | EventListenerInstance | The element that contains one or more event listener configuration parameters associated with an event listener instance. |
FlowName | string | EventListenerInstance | The flow name associated with the event listener instance. |
SynchronizationName | string | EventListenerInstance | The synchronization name associated with the event listener instance. |
ListenerConfigsType Table
Element | Type | Parents | Description |
|---|---|---|---|
Config | EventInstanceConfigType | ListenerConfigs | The element that contains one or more event listener configuration parameters associated with an event listener configuration. |