Object Types

The Object Types defined in the flow configuration are used in the interaction rules. The user can create new Object Types or modify the provided Object Types.

Provided Object Types are listed below:

Event

The Event properties are common to:

  • FileEvent
  • TimeEvent
Property Type Size Description
type String 30 Type of the event
creationDate DateTime  

Creation date of the event

componentId String 30 Id of the component that generates this event
listenerId String 30 Id of the listener that generates this event
externalId String 30 Functional Id. Used in getEvent(Id)
flow String 30 Flow name
interaction String 30 Interaction name
interactionId Number   Interaction Id

FileEvent

Includes the Event properties plus the following:

Property Type Size Description
dataFile String 100 Data file path
propertyFile String 100

Property file path

errorFile String 100 Error file path
collectionTypeName String 30 Name of the collection type that describes the data file
collectionTypeVersion Number   Version of the collection type
applicationName String 30 Name of the application that is used to find the engine configuration
configurationId String 30 Id of the engine configuration
session String 30

Rule engine session.

It is mapped to SESSION in the script.fig file.

If the value is not provided, the default value is the interaction name

operationDate Date  

Operation date.

It is mapped to DATE_OPERATION in the script.fig file.

If the value is not provided, the Rule Engine session uses the system date.

The expected date format is DD/MM/YYYY; if the date is not provided in this format, the file processing is aborted.

stamper String 30

Stamping prefix.

It is mapped to STAMPER in the script.fig file.

If the value is not provided, the default value is STAMP. The first five characters of this parameter are used in Stamp ID if the Audit is enabled.

insert String 30

Used to embed a custom script and setup rarely-used properties.

To use it, fill the {INSERT} placeholder in the script.fic file.

environmentTransformation String 30

Defines the domain to activate.

The default value is Batch.

TimeEvent

Includes the Event properties.

Result

The Result properties are common to:

  • ProcessResult
  • FileResult
  • ImportResult
  • ExportResult
  • ExportFile
  • PurgeResult
  • MoveFilesResult
  • DeleteFileResult
  • SendEventResult
  • ImportAIConfigurationResult
Property Type Size Description
type String 30 Type of the result
success Boolean 1

True if the operation has succeeded

errorCode String 50 Code of the error that make the operation fail
function String 30 Name of the ExecuteOperation function that has returned this result
flow String 30 Flow name. Copied from original event
interaction String 30 Interaction name. Copied from original event

ProcessResult

Includes the Result properties plus the following:

Property Type Size Description
inputAudit Boolean   Data file path for reject
outputAudit Boolean  

Property file path for reject

rejects Boolean   Error file path for reject
reportsNumber Integer   Data file path for audit
reportsGenerated Boolean   Property file path for audit
collectionTypeName String 30 Data file path for output
collectionTypeVersion Integer   Property file path for output

FileResult

Includes the Result properties plus the following:

Property Type Size Description
type String 30 Type of the result
success Boolean 1 Boolean. True if the operation has succeeded
errorCode String 50 Code of the error that make the operation fail
function String 30 Name of the ExecuteOperation function that returned this result
flow String 30 Flow name. Copied from the original event.
interaction String 30 Interaction name. Copied from the orignal event
collectionTypeName String 30 Collection type name
collectionTypeVersion Integer 30 Collection type version
filename String 30

Possible values:

  • Rejects
  • InputAudit
  • OutputAudit
  • Name of the Processing Context Out for output events
outputType String 30

Type of the output file.

Possible values:

  • OUTPUT_EVENT
  • REJECT
  • INPUT_AUDIT
  • OUTPUT_AUDIT
dataFile String 30 Data file path
propertyFIle String 30 Property file path
applicationName String 30 Name of the application that is used to find the engine configuration
configurationId String 30 Identifier of the Rule Engine configuration stored in Repository

ImportResult

Includes the Result properties plus the following:

  • Property – errorMessage
  • Type – String
  • Size – 50
  • Description – Error code if the operation failed

ExportResult

Includes the Result properties plus the following:

  • Property – numberOfCollections
  • Type – Integer
  • Description – The number of exported collections

ExportFile

Includes the Result properties plus the following:

Property Type Size Description
dataFile String 50 Path to the collection data file that has been exported
propertyFile String 50 Path to the collection property file that has been exported

PurgeResult

Includes all the Result properties.

MoveFilesResult

Includes the Result properties plus the following:

Property Type Size Description
dataFile String 100 Path to the collection data file that has been moved
propertyFile String 100 Path to the collection property file that has been moved
errorFile String 100 Path to the collection error file that has been moved

DeleteFilesResult

Includes all the Result properties.

SendEventResult

Includes all the Result properties.

ImportAIConfigurationResult

Includes all the Result properties.

Related Links