The following XML files need to be created for a provider:
- MetaData:. To describe the business objects supported by the provider and the fields that these business objects contain. Also indicate whether the fields are Read-only. Choices include True, or False (default).
- Mapping Template: To describe how your provider's business objects map to the Gateway and provider metadata files.
- DVM: To list the enumeration mappings for fields which have enumerated values.
- Provider: To define the following information for your provider:
- Flows
- Filters
- Parameters
- Class path to Java code that implements the provider
For example, see the SampleProvider.xml file in the <Gateway_Home>\GenericInstaller\GatewayUtility\sampleprovider\data folder. For additional information on content and format of the provider description XML file to create for your application, see <Gateway_Home>\GenericInstaller\GatewayUtility\gateway\schema\provider.xsd.
- XRefDefinition: To describe the two-way cross-reference keys that are used to establish the links between the provider business object and the Gateway business object.
Note: To convert your provider application to use the new XRefDefinition schema, see Modifying Providers to use the Two-Way XRefDefinition Keys.
- ExtraMetaData: To describe any UDF and Code fields that your application requires to be included in a Primavera provider, along with their corresponding fields in the Gateway format. A provider can contain more than one ExtraMetaData file.
Note: Use the ExtraMetaData file to extend the Gateway data dictionary or the Primavera provider's data dictionary.
- Flow: This file contains custom flows and the flow steps in each flow that is supported by the provider.
The XML files use corresponding XSD files. For a detailed list of schema files and elements, see Appendix C: Primavera Gateway Schema Files. You can also use the examples of data definition XML files created for the Sample provider as a starting point to develop your provider. The Sample provider data definition XML files are located in the <Gateway_HOME>\sample\sampleprovider\data folder.