Schema Node Property and Description

The Schema Node property and description displays the property information for the selected Node in the Schema Node tree. The number of entries in the Schema Node property section varies depending on the type of Node selected. This dictates what the user is allowed to enter in order to build a valid DELMIA Apriso XML schema.

For an in-depth understanding of these Schema Node properties, refer to the Node Attributes Summary section.

Root Node Properties

Property Name Description
Name The name of the XML Schema. This name uniquely identifies the XML Schema and its structure.
Version By default, the  version is 1.0. The version should be manually incremented when an existing schema is altered and the changes are distinguished by using this property.

Table Node Properties

Property Name Description
Annotation The user comments for the current element.
Columns* A list of all of the table columns and its properties.
DALAssemblyName* The name and signature of a DAL Component Assembly Name.
DALFactoryName* The DAL Component Factory Name.
FetchFieldName An optional property. It is used in combination with NodeVariable. This is a valid table column name.
MaxOccurs The maximum occurrence of this Table Node. Enter “1” for unbounded.
MinOccurs The minimum occurrence of this Table Node. Enter an integer between 0 and n.
Name* The name of the Table Node.
NodeAction* Thee action to be performed against the current Table Node. Select from a list of all valid NodeActions.
NodeVariable An optional property. It is used in combination with FetchFieldName.
SelectUniqueMethodName* A valid SelectBy method for the selected DAL.
SelectUniqueMethodParameters* A list of parameters that are not listed in the Columns property for the SelectBy method in the SelectUniqueMethodName property.

To view the column definition for a Table Node, click the button on the far right for the columns item. The following table describes the columns definition properties.

Property Name Description
Annotation The user's comments for the selected column.
DateException The possible values are None and NoUTCConversion. The default is None. This is only valid for columns with the datetime data type. If the user selects NoUTCConversion for this column, Business Integrator will not perform any UTC Conversion to the value in this column.
DefaultOrFixedOption The possible values are None, SetDefaultValue, and SetFixedValue. The default is None. If SetDefaultValue or SetFixedValue is selected, the user must enter the default or fixed in the DefaultOrFixedValue property.
DefaultOrFixedValue The user must enter the default or fixed if SetDefaultValue or SetFixedValue is selected in the DefaultOrFixedOption property.
MaxLength If the data type of the column is string, the maxlength contains the maximum length for the column. Automatically filled, if applicable.
Name The name of the column. Automatically filled.
Nullable The possible values are True or False: True if the column can be nullable, otherwise False. Automatically filled.
SampleValue Enter the sample value to be used when generating a new XML instance.
Type The data type of the column. Automatically filled.
Used The possible values are True or False. If True, the column will be generated; otherwise, the column will not be generated. All of the columns (such as CreatedOn and ID are defaulted to false, which means these columns will not be generated in the XML Schema.
SetToNullOnUpdate (New 9.4 SP1) The possible values are True or False. If True, the column will be reset with the NULL value on the update Operation.

Properties of Field Node with NodeAction GetParentValue

Property Name Description
Name* The name of the Field Node. This name is a valid column name of the parent Table Node. Automatically filled.
NodeAction* Hardcoded to “GetParentValue”.
NodeVariable* Get the value with this NodeVariable name at one of the parent Nodes for the current column. The name of the NodeVariable must be defined at a parent Node.
Optional The occurrence of the Node. It can be optional (set to True) or required (set to False). When the occurrence of the Node is optional, the minOccurs is set to 0; otherwise, it is set to 1.

Properties of Field Node with NodeAction GetNewValue

Property Name Description
Name* The name of the Field Node. This name can be a valid column name of the parent Table Node. If not, use the ActualNodeName property to specify the column name. Automatically filled.
NodeAction* Hardcoded to “GetNewValue”.
NodeVariable An optional property. The name of the NodeVariable will store the value to this variable at runtime.
ActualNodeName An optional property. If the value for the Name property is not the column name, enter the actual column name here.
FetchFieldName An optional property. Use in combination with NodeVariable. This is a valid column name and the value of this column is fetched from the recordset returned by the SelectBy method.
Optional The possible values are True and False. The default is True. When set to True, the minOccurs is set to 0; otherwise, it is set to 1.

For a Child Table Node

Property Name Description
Annotation The user comments for the current element.
Columns* A list of all of the table columns and its properties.
DALAssemblyName* The Assembly Name and signature of the DAL Component. Automatically filled.
DALFactoryName* The Factory Name of the DAL Component. Automatically filled.
FetchFieldName An optional property. It is used in combination with NodeVariable. This is a valid column name and the value of this column is fetched from the recordset returned by the SelectBy method.
MaxOccurs The maximum occurrence of this Table Node. Enter “1” for unbounded.
MinOccurs The minimum occurrence of this Table Node. Enter an integer between 0 and n.
Name* The name of the Table Node. Automatically filled.
NodeAction* The possible values are InsertOnly, UpdateOnly, DeleteOnly, InsertUpdate, and UpdateAll. This is the database action to be performed against the current Table Node.
NodeVariable An optional property. The name of the NodeVariable will store the value to this variable at runtime.
SelectUniqueMethodName* The SelectBy method for the selected DAL.
SelectUniqueMethodParameters* A list of parameters that are not listed in the Columns property for the SelectBy method in the SelectUniqueMethodName property.

Properties of Field Node with NodeAction GetRequiredValue

Property Name Description
DALAssemblyName*   The Assembly Name and signature of the DAL Component. Automatically filled.
DALFactoryName*   The Factory Name of the DAL Component. Automatically filled.
FetchFieldName   An optional property. It is used in combination with NodeVariable. This is a valid column name and the value of this column is fetched from the recordset returned by the SelectBy method.
Name* The name of the Field Node. This name is a valid column name of the parent Table Node. Automatically filled.
NodeAction* Hardcoded to “GetRequiredValue”.
NodeVariable An optional property. The name of the NodeVariable will store the value to this variable at runtime.
SelectUniqueMethodName* The SelectBy method for the selected DAL.
SelectUniqueMethodParameters* A list of parameters that are not listed in the Columns property for the SelectBy method in the SelectUniqueMethodName property.
Optional The possible values are True and False. The default is True. When set to True, the minOccurs is set to 0; otherwise, it is set to 1.

Properties of Field Node with NodeAction GetValue

Property Name Description
DALAssemblyName* The Assembly Name and signature of the DAL Component. Automatically filled.
DALFactoryName* The Factory Name of the DAL Component. Automatically filled.
FetchFieldName An optional property. It is used in combination with NodeVariable. This is a valid column name and the value of this column is fetched from the recordset returned by the SelectBy method.
Name* The name of the Field Node. This name is a valid column name of the parent Table Node. Automatically filled.
NodeAction* Hardcoded to “GetValue”.
NodeVariable An optional property. The name of the NodeVariable will store the value to this variable at runtime.
SelectUniqueMethodName* The SelectBy method for the selected DAL.
SelectUniqueMethodParameters* A list of parameters that are not listed in the Columns property for the SelectBy method in the SelectUniqueMethodName property.
Optional The possible value are True and False. The default is True. When set to True, the minOccurs is set to 0; otherwise, it is set to 1.

Properties of FIInvocation Asynchronous Event (FIInvocationBGTask) Node

Property Name Description
Annotation The user comments for the current element.
MaxOccurs The maximum occurrence of this Node. Enter “-1” for unbounded.
MinOccurs The minimum occurrence of this Node. Enter an integer between 0 and n.
Name Hardcoded to reference the FIInvocationAsynchronousEvent Node.

Properties of FIInvocation Synchronous Event (FIInvocation) Node

Property Name Description
Annotation The user comments for the current element (e.g., what is the Node intended for).
MaxOccurs The maximum occurrence of this Node. Enter “-1” for unbounded.
MinOccurs The minimum occurrence of this Node. Enter an integer between 0 and n.
Name Hardcoded to reference the FIInvocationSynchronousEvent Node.

Properties of Job Creation Event (JobCreationEvent) Node

Property Name Description
Annotation The user comments for the current element (e.g., what is the Node intended for).
MaxOccurs The maximum occurrence of this Node. Enter “-1” for unbounded.
MinOccurs The minimum occurrence of this Node. Enter an integer between 0 and n.
Name Hardcoded to reference the JobCreationEvent Node.

Properties of JE Job Creation Event (JEJobCreationEvent) Node

Property Name Description
Annotation The user comments for the current element (e.g., what is the Node intended for).
MaxOccurs The maximum occurrence of this Node. Enter “-1” for unbounded.
MinOccurs The minimum occurrence of this Node. Enter an integer between 0 and n.
Name Hardcoded to reference the JEJobCreationEvent Node.

Properties of Field Node with NodeAction GetValue

Property Name Description
Name The name of the Field Node. This name is a valid column name of the parent Table Node.
NodeAction Hardcoded to reference GetNewGUID Node.

* Pre-populated when selecting the DAL Component from the DAL Component Picker