Purpose
The provider files defines how the data will be exchanged between a source application and a destination application by defining the following information for each application:
- Flows
- Parameters
- Class path to Java code that implements the provider
Schema file
Provider.xsd
Contents
A Provider and ExtraProvider element containing the following child elements:
Element | Type | Parent | Description |
|---|---|---|---|
Provider | ProviderType | Root | The name of the provider application. |
ExtraProvider | ProviderType | Root | The name of a second provider application. |
ProviderType Table
Element | Type | Parent | Description |
|---|---|---|---|
Name | string | Provider | The name of the provider application. |
ApplicationName | string | Provider | The name of the application that is associated with this file. |
Type | String | Provider | The type of provider application. |
Version | string | Provider | The application version. |
ClassPath | string | Provider | The path to the Java class that implements the flow provider interfaces. |
FlowDefinition | FlowDefinitionType | Provider | The container for the elements that describe the business objects that can be synchronized, the flows that the provider supports and the parameters that are associated with the flow. The information in the FlowDefinition element provides the ability to filter and limit what data is exchanged by the Primavera Gateway and corresponds to the flows in the Gateway user interface. |
Settings | SettingsType | Provider | The container for the elements that define global settings that will show up in the Settings dialog box. When a flow runs, these settings will show up just as parameter of a flow type would. |
SettingsType Table
Element | Type | Parent | Description |
|---|---|---|---|
Parameter | ParameterType | SettingsType | The name of the parameter. |
FlowDefinitionType Table
Element | Type | Parent | Description |
|---|---|---|---|
Name | string | FlowDefinition | The name of the business flow. |
AppType | string | FlowDefinition | The container for the element that determines whether a provider will show up in the Source side or Destination side. To maintain compatibility with version 1.0, defaults to Guest for the 1.0 provider files. |
DisableCompare | boolean | FlowDefinition | The container for the element that determines whether the Compare step is to be applied or skipped. |
FlowBusinessObject | FlowBusinessObjectType | FlowDefinition | The container for the element that defines the name of one of the business objects that can be included in the flow. |
FlowStep | FlowStepType | FlowDefinition | The container for the element that defines the name of one of the individual steps in the flow which this provider supports or for which it provides an implementation. |
Parameter | ParameterType | FlowDefinition | The container for the elements that defines the parameters that are associated with the business objects and flows. |
FlowBusinessObjectType Table
Element | Type | Parent | Description |
|---|---|---|---|
Name | string | FlowBusinessObject | The name of the business flow. |
FlowStepType Table
Element | Type | Parent | Description |
|---|---|---|---|
Description | string | FlowStep | A description of the flow step in the business flow. |
Name | string | FlowStep | The name of the flow step in the business flow. |
AlternativeName | string | FlowStep | An alternative name of the flow step. |
Sequence | integer | FlowStep | The numerical positioning of the flow step within a business flow. For example, the 2nd step in the flow step sequence executed by the business flow. |
Type | string | FlowStep | The type of flow step that defines it's purpose and function within a business flow. |
Script | string | FlowStep | The script associated with the business flow. |
OwnerAppType | string | FlowStep | The type of application associated with the flow step. |
ParameterType Table
Element | Type | Parent | Description |
|---|---|---|---|
DefaultValue | string | Parameter | The default value for this custom parameter that is used when the parameter is included in the flow and the value is not changed. |
Description | string | Parameter | The element that provides a description of the parameter. |
EnumerationOptions | EnumerationOptionsType | Parameter | The element that contains the enumeration options for the parameter. |
FilterOptions | FilterOptionsType | Parameter | The element that contains the filter options for the parameter. |
Name | string | Parameter | The element that provides the name of the parameter. The name is used to lookup the parameter in the provider Java code. |
Sequence | int | Parameter | The element that provides the mechanism for ordering the parameters. |
Title | string | Parameter | The element that provides the display title of the parameter. |
Type | string | Parameter | The element that defines the data type of the value of the field's data when it is synchronized. |
EnumerationOptionsType Table
Element | Type | Parent | Description |
|---|---|---|---|
Enumeration | EnumerationType | EnumerationOptions | The element that specifies the name of the enumeration. |
FileExtension | FileExtensionType | EnumerationOptions | The element that specifies the FileExtension for the enumeration. |
IntegerOption | IntegerOptionType | EnumerationOptions | The element that specifies the IntegerOptionType for the enumeration. |
EnumerationType Table
Element | Type | Parent | Description |
|---|---|---|---|
Name | string | Enumeration | The element that specifies the name of the enumeration. |
FileExtensionType Table
Element | Type | Parent | Description |
|---|---|---|---|
Name | string | FileExtension | The element that specifies the name of the FileExtension. |
ErrorHint | string | FileExtension | The element that contains the error hint description for the file extension. |
IntegerOptionType Table
Element | Type | Parent | Description |
|---|---|---|---|
Spinner | boolean | IntegerOption | The element that determines how the parameter type displays in the user interface. |
MinMax | MinMaxType (see the MinMaxType table below.) | IntegerOption | The element that is a container for the minimum and maximum values for the parameter type. |
MinMaxType Table
Element | Type | Parent | Description |
|---|---|---|---|
Minimum | string | MinMax | The element that contains the minimum value of the parameter. |
Maximum | string | MinMax | The element that contains the maximum value of the parameter. |
FilterOptionsType Table
Element | Type | Parent | Description |
|---|---|---|---|
ObjectOptions | ObjectOptionsType | FilterOptions | The element that contains the object options. |
ObjectOptionsType Table
Element | Type | Parent | Description |
|---|---|---|---|
ObjectName | string | ObjectOptions | The element that specifies the name of the object. |
Field | FilterFieldType | ObjectOptions | The element that specifies the database field corresponding to the object. |
FilterFieldType Table
Element | Type | Parent | Description |
|---|---|---|---|
Name | string | Field | The element that specifies the name of the filter. |
DefaultValue | string | Field | The element that specifies the default value of the filter. |