Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Production Management

File integration properties

  • Last UpdatedSep 06, 2023
  • 4 minute read

Refer to the following tables for the key configurable properties of File integration.

Field Mappings properties

Note: The sequence of fields is very important, and must follow the sequence found in the file.

Property

Description

Valid values

FieldMappings

The field mappings for each pair of source/destination fields.

Add the field mappings using the Mapping Collection Editor. Click Browse (...) to open.

For each pair, configure these properties:

  • Source: Select one of the source fields that you defined previously in the Source Fields.

  • Target: Select one of the destination fields that you defined previously in the DestinationFields.

    Important: The Data Type for a source field and destination field must match to create a successful mapping between them.

SourceCulture

The culture associated with the source data in the database. Use this setting when the data in the File is from a different culture to the one used by the server.

Any supported regional setting

SourceFields

The set of fields that are provided by the integration source. These fields are the incoming source fields.

Each incoming source field must be configured using the Field Collection Editor.

Click Browse (...) to open the editor.

For each field, configure these parameters:

  • Name: The exact name of the column returned in the Select Command.

  • Allow Nulls: Determines whether to use the Default Value if a null is found in the source. A null is classified as an empty string, or more specifically, the value between the Separation Character trimmed of spaces being empty.

  • Data Type:The data type of the field. If this parameter is set to DateTime, the only format accepted is “yyyy-MM-ddTHH:mm:ssZ” which is the ISO 8061 standard for date times. The value must be in UTC.

  • Default Value: This parameter is applicable only when the Allow Nulls is False. It specifies the value to use when a null is encountered.

  • Max Length: This is parameter is applicable only when the Data Type is String. It specifies the maximum length of the string.

  • Schema Usage: Not applicable in this integration.

DestinationFields

The set of fields to which AVEVA™ Production Management writes the data.

Add field items for each receiving field and configure the parameters in the same way that you configured the source fields. Use the Field Collection Editor to do this.

A field of the same name must exist on that reporting point location. However, not every field in the reporting point must be configured to receive data. Destination fields are configured with ColumnName rather than field name.

Collection of fields

File Parameters properties

Property

Description

Valid values

ArchiveDirectory

The directory to move the files to after they are read.

Create an expression to determine the destination directory to move files into using the Expression Editor. Click Browse (...) to open.

This is an expression that enables you to specify the directory where this connector places the files after it has processed them.

Example

“C:\\File2Ampla Examples\Archive”

Note: If the connector does not process the file correctly, it is still placed in the Archive directory with its file extension changed to “.failed”

FileMask

The file extension for the file. This is the search string to match against the names of files in path. Wildcards are supported.

Example: *.csv means files in the source directory that end in .csv.

  • * - Zero or more characters

  • ? - Exactly zero or one character

For more information, see http://msdn.microsoft.com/en-us/library/wz42302f(v=VS.100).aspx

HeaderRow

Indicates whether the file contains a header row that is ignored.

Select True to ignore the first row of data in the source file.

True, False

SeparationCharacter

The character that separates field values.

For example, comma-separated values are separated by a comma.

SourceDirectory

The directory to look for the source files.

Create an expression that enables you to specify the directory where this connector looks to process the files using the Expression Editor.

Example

“C:\\File2Ampla Examples”

Parameters properties

Property

Description

Valid values

AllowModifyExistingRecord

Enables or disables the ability to update records with new arriving information.

True, False

FilterFields

The fields to identify the unique record row to update. This property appears only when AllowModifyExistingRecords is set to True.

Collection of fields

Location

The location in Studio where the external data enters the AVEVA Production Management system.

Click Browse (...) to open the Select Location dialog box and choose the location in Studio that is the entry point for the external data.

Reporting point, or Material movement

Triggers properties

Property

Description

Valid values

TriggerExpression

Specifies the expression that determines when the variable information is collected.

Execution occurs when the result of the expression changes from False to True. It is common practice to point to a timer, 15 minutes or 1 hour.

An expression

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in