Flow Files (*Flow.XML)

The flow file defines the flows applicable to a provider application. Each flow can contain one or more business flows and synchronizations.

Schema File

Flow.xsd

Contents

Contains one or more BusinessFlow and Synchronization elements.

Element

Type

Parents

Description

BusinessFlow

BusinessFlowType
(See BusinessFlowType table below)

Flows

Zero to many elements containing child elements that describe the structure of a BusinessFlow.

Synchronization

SynchronizationType
(See SynchronizationType table below)

Flows

Zero to many elements containing child elements that describe the structure of a Synchronization.

BusinessFlowType Table

Element

Type

Parents

Description

Name

string
restricted to Maxlength (100)

BusinessFlow

Element that contains the name of the business flow.

Description

string
restricted to Maxlength (255)

BusinessFlow

Element that contains a description of the business flow

DisableCompare

boolean

BusinessFlow

Element that determines whether the Compare step is to be enabled in the business flow.

ConfigSteps

boolean

BusinessFlow

An indicator to determine is steps have been configured for the business flow.

FlowDefinitionName

string
restricted to MaxLength(60)

BusinessFlow

Element that contains the name of the Flow Definition.

SourceAppName

string
restricted to MaxLength (60)

BusinessFlow

Element that contains the name of the source application.

DestinationAppName

string
restricted to MaxLength (60)

BusinessFlow

Element that contains the name of the destination application.

FlowSteps

FlowStepsType
See the FlowStepsType Table.

Business Flow

Element that contains the flow steps associated with the business flow.

PDIBusinessObjects

PDIBusinessObjectType
(See the PDIBusinessObjectType table below)

BusinessFlow

Container label for one or more PDI business objects.

FieldMapTemplates

FieldMapTemplatesType
(See the FieldMapTemplatesType table below)

BusinessFlow

Container label for one or more field mapping templates.

Parameters

FlowParametersType
(See the FlowParametersType table below)

BusinessFlow

Container label for one or more parameters associated with a business flow.

FlowStepsType Table

Element

Type

Parents

Description

FlowStep

FlowStepType
See the FlowStepType table below

FlowSteps

Container label for the name of the flow step within a flow.

FlowStepType Table

Element

Type

Parents

Description

Name

string
restricted to MaxLength(60)

FlowStep

Container label for the name of the flow step within a flow.

Included

boolean

FlowStep

Indicator that determines if a flow step is included within a flow.

PDIBusinessObjectsType Table

Element

Type

Parents

Description

Object

ObjectType
(See ObjectType table)

PDIBusinessObjects

Container label for the names of the business object.

ObjectType Table

Element

Type

Parents

Description

Object

string
restricted to maxLength(60)

Objects

Name of the business object.

FieldMapTemplatesType Table

Element

Type

Parents

Description

FieldMapTemplate

FieldMapTemplateType
max unbounded.
(See the FieldMapTemplateType table below)

FieldMapTemplates

Container label for one or more names of FieldMapTemplate.

FieldMapTemplateType Table

Element

Type

Parents

Description

Name

String
restricted to maxLength(100)

FieldMapTemplate

Name of the FieldMapTemplate.

SourceObjectName

String
restricted to maxLength(60)

FieldMapTemplate

Name of the source object.

DestinationObjectName

String
restricted to maxLength(60)

FieldMapTemplate

Name of the destination object.

Type

String
Create
Update
Both

FieldMapTemplate

A container for the element the identifies the type of FieldMapTemplate.

FlowParametersType Table

Element

Type

Parents

Description

Parameter

FlowParameterType
(See the FlowParameterType table below)

Parameters

Container label for one or more parameters.

FlowParameterType Table

Element

Type

Parents

Description

Parameter

FlowParameterType
(See the FlowParameterType table below)
max unbounded

Parameters

Container label for one or more parameters.

FlowParameterType Table

Element

Type

Parents

Description

Name

string
restricted to maxLength(60)
max unbounded

Parameter

The name of the parameter.

Attribute

string
enumeration values include:
Optional
Hidden
Read only
Required

Parameter

Attributes of each parameter.

DefaultValue

string
restricted to maxLength(4000)

Parameter

The default value of the parameter.

SynchronizationType Table

Element

Type

Parents

Description

Name

string
restricted to maxLength(60)
max unbounded

Synchronization

The name of the synchronization.

Description

string
restricted to maxLength(255)

Synchronization

The description of the synchronization.

BusinessFlowName

string
restricted to maxLength(60)

Synchronization

The name of the Business Flow associated with the synchronization.

SourceAppInstance

string
restricted to maxLength(60)

Synchronization

The instance of the source application.

DestinationAppInstance

string
restricted to maxLength(60)

Synchronization

The instance of the destination application.

Parameters

SynchronizationParametersType
(See the SynchronizationParametersType table below)

Synchronization

Container label for one or more synchronization parameters.

SynchronizationParametersType Table

Element

Type

Parents

Description

Parameter

SynchronizationParameterType
(See the SynchronizationParameterType table below)
max unbounded

Parameters

Container label for one or more more parameters associated with a specific synchronization.

SynchronizationParameterType Table

Element

Type

Parents

Description

Name

string
restricted to maxLength(60)

Parameter

The name of the parameter associated with a specific synchronization.

Value

string
restricted to maxLength(4000)

Parameter

The value of each parameter.

Related Topics

Appendix C: Primavera Gateway Schema Files

Data Value Mapping Files (*DVM.xml)

Event Provider Files (*EventProvider.xml)

FieldMapTemplate Files (*FieldMapTemplate.XML)

FileConverter Files (*FileConverter.XML)

FlowDefinition Files (*FlowDefinition.XML)

Data Dictionary Files (*MetaData.xml)

Provider Files (*Provider.xml)

XRefDefinition File (*xrefDefinition.xml)

DataConfiguration File (*dataConfiguration.XML)



Legal Notices | Your Privacy Rights
Copyright © 2013, 2021

Last Published Thursday, December 16, 2021