Data Dictionary Files (*MetaData.xml)

Purpose

The data dictionary files provide the format for the data that can be synchronized by Primavera Gateway.

Schema file

MetaData.xsd

A MetaData or an ExtraMetaData element that contains zero to many App elements each of the type AppType. For more details see the AppType table below:

AppType Table

Each AppType element contains the following child elements:

Element	Type	Parent	Description
Description	string restricted to maxLength(255)	App	The optional element that describes the data dictionary. This description is displayed in the Summary area of the Data Dictionary tab in the Primavera Gateway user interface.
Name	string restricted to maxLength(60)	App	The optional element that provides the name of the data dictionary. The content of this element is listed in the Summary area of the Data Dictionary tab in the Primavera Gateway user interface.
Type	string restricted to 'Host' 'Guest' 'PDI'	App	The optional element that determines the type of data dictionary. The content of this element is listed in the Summary area of the Data Dictionary tab in the Primavera Gateway user interface. This field is deprecated to currently support backward compatibility, and will be removed in a future release.
Version	string restricted to maxLength(60)	App	The optional element that provides the version of the data dictionary. The content of this element is listed in the Summary area of the Data Dictionary tab in the Primavera Gateway user interface.
ObjectCategory	ObjectCategoryType See the ObjectCategoryType table below.	App	The element that determines the type of object.
FieldCategory	FieldCategoryType See the FieldCategoryType table below.	App	Zero to many elements containing child elements that define the structure of the fields. For example, a Project business object might contain a field that is named ID that has a data type of String.
AppConfigs	AppConfigsType See the AppConfigType table below.	App	Zero to many elements containing child elements that describe the structure of the deployments.
AppInstance	AppInstanceType See the AppInstanceType table below.	App	Zero to many elements containing child elements that describe the instantiation of a deployment.
BusinessObject	BusinessObjectType See the BusinessObjectType table below.	App	Zero to many elements containing child elements that define the business objects. Examples of business objects include Projects, Resources, and Activities. Business object elements can contain zero or more Field elements. Elements in this node are included in the Data Dictionary tab of the Primavera Gateway user interface.

FieldCategoryType Table

Element	Type	Parent	Description
Name	string restricted to maxLength(60)	FieldCategory	The element that provides the name of the field category.
Description	string restricted to maxLength(255)	FieldCategory	The element that describes the purpose of the field category.

ObjectCategoryType Table

Element	Type	Parent	Description
Name	string restricted to maxLength(60)	ObjectCategory	The element that provides the name of the object category.
Description	string restricted to maxLength(255)	ObjectCategory	The element that describes the purpose of the object category.

AppConfigType Table

Each AppConfigType element contains the following child elements:

Element	Type	Parent	Description
Name	string restricted to maxLength(60)	AppConfigs	The element that defines the name that is used to look up the deployment in deployment code.
Title	string restricted to maxLength(60)	AppConfigs	The element that provides the title text that is used in the Primavera Gateway user interface.
SequenceNo	int	AppConfigs	The element that controls the ordering of the item in the Primavera Gateway user interface.
Type	string restricted to maxLength(10)	AppConfigs	The element that defines the data type of the configuration item.
Description	string restricted to maxLength(255)	AppConfigs	The element that describes the configuration item.
DefaultValue	string restricted to maxLength(255)	AppConfigs	The value that appears in the Primavera Gateway user interface and is used as the default value configuration item if no other input is provided.
Required	boolean	AppConfigs	The element that determines whether the metadata is a required field.
EnumerationOptions	EnumerationOptionsType	AppConfigs	The container for the element that describes the enumeration options of the configuration item.

EnumerationOptionsType Table

Element	Type	Parent	Description
Enumeration	EnumerationType	EnumerationOptions	The container for the element that describes each enumeration available for the configuration item.
FileExtension	FileExtensionType (See the FileExtensionType Table below)	EnumerationOptions	The container for the element that describes the type of file extension for the file.

FileExtensionType Table

Element	Type	Parent	Description
Extension	string	FileExtension	The container for the element that contains the name of the file extension.
ErrorHint	string	FileExtension	The container for the element that contains a description of the error hint for the file extension.

EnumerationType Table

Element	Type	Parent	Description
Name	String	Enumeration	The container for the element that contains the name of the enumeration.
AssociateFieldName	String	Enumeration	The container for the element that contains the field name associated with the enumeration name.

AppInstanceType Table

Element	Type	Parent	Description
Description	string restricted to maxLength(255)	AppInstance	The element that describes the instantiated deployment.
Name	string restricted to maxLength(60)	AppInstance	The name of the instantiated deployment.
Configs	ConfigsType	AppInstance	Zero to many elements containing child elements that describe the structure of instantiated deployments.

ConfigsType Table

Element	Type	Parent	Description
Name	string	MetaData	The element that provides the name of the configuration item.

ConfigType Table

Element	Type	Parent	Description
Name	string	Configs	The element that provides the name of the configuration item.
Value	string	Configs	The element that provides the value of the configuration item.

BusinessObjectType Table

Element	Type	Parent	Description
Description	string restricted to maxLength(255)	BusinessObject	The optional element that describes the business object. This description is presented in the Data Dictionary tab in the Primavera Gateway user interface.
Name	string restricted to maxLength(256)	BusinessObject	The optional element that determines the name of the Business object. This name is presented in the Data Dictionary tab in the Primavera Gateway user interface.
Field	FieldType See the FieldType table below.	BusinessObject	The zero to many elements that contain the fields that are related to the business object.

FieldType Attribute Table

Attribute	Type	Element	Description
category	string	Field	The optional attribute that relates the field to a particular FieldCategory element.
topic	string	Field	The optional attribute used to specify an alternate name for the field. An example use is for specifying field name that contains spaces to be used as an alternate for the same field name without spaces.
required	boolean	Field	The optional attribute that determines whether the field must be synchronized.

FieldType Table

Element	Type	Parent	Description
Description	string restricted to maxLength(255)	Field	The optional element that describes the field. This description is presented in the Fields table on the Data Dictionary tab in the Primavera Gateway user interface.
OldName	string restricted to maxLength(256)	Field	The optional element that determines the old name of the field.
Name	string restricted to maxLength(256)	Field	The optional element that determines the name of the field. This name is presented in the Fields table of the Data Dictionary tab in the Primavera Gateway user interface.
JoinTo	string restricted to maxLength(60)	Field	The element that contains the object that this field is joining to. This field is used when the field type is ForeignKey. For example, in P6 Data Dictionary, the WBSObjectId field in Activity joins to WBS object.
ReadOnly	boolean	Field	The element that determines whether the field is read-only.
Type	string restricted to maxLength(32) Boolean DateTime Double Int String ForeignKey Password Enum StandardWorkWeek HolidayOrExceptions	Field	The optional element that defines the data type of the value of the field's data when it is synchronized.
MaxLength	positiveInteger	Field	The optional element that defines the maximum length of the value of the field's data when it is synchronized. This element can be used with the Type element whose content is String to limit the field's data values.
MaxValue	double	Field	The optional element that defines the maximum value of the field's data when it is synchronized. This element can be used with the Type element whose content is Int to limit the field's data values.
MinValue	double	Field	The optional element that defines the minimum value of the field's data when it is synchronized. This element can be used with the Type element whose content is Int to limit the field's data values.
FieldValue	FieldValueType For more details, see the FieldValueType table below.	Field	An optional element that defines the value of an enum field type. Field elements can contain zero or more FieldValue elements if the Field element contains a Type element whose content is Enum.

FieldValueType Table

Element	Type	Parent	Description
Description	string restricted to maxLength(255)	FieldValue	An optional element that describes the fieldValue.
Value	string restricted to maxLength(60)	FieldValue	An optional element that defines an enumerated value.