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 Description
type String Type of the event
creationDate DateTime Creation date of the event
componentId String Id of the component that generates this event
listenerId String Id of the listener that generates this event
externalId String Functional Id. Used in getEvent(Id)
flow String Flow name
interaction String Interaction name
interactionId Number Interaction Id

FileEvent

Includes the Event properties plus the following:

Property Type Description
dataFile String Data file path
propertyFile String Property file path
errorFile String Error file path
collectionTypeName String Name of the collection type that describes the data file
collectionTypeVersion Number Version of the collection type
applicationName String Name of the application that is used to find the engine configuration
configurationId String Id of the engine configuration
session String

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

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

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

Defines the domain to activate.

The default value is Batch.

TimeEvent

Includes the Event properties.

Result

The Result properties are common to:

  • ProcessResult
  • GenerateSamplesResult
  • FileResult
  • ImportResult
  • ExportResult
  • ExportFile
  • PurgeResult
  • MoveFilesResult
  • DeleteFileResult
  • SendEventResult
  • TransformAIConfigurationResult
  • TransformFileResult
  • ImportAIConfigurationResult
  • PurgeEventsResult
  • PurgeReportsResult
  • ReconciliationResult
  • ChangeCollectionsStatusResult
Property Type Description
type String Type of the result
success Boolean True if the operation has succeeded
errorCode String Code of the error that makes the operation fail
function String Name of the ExecuteOperation function that has returned this result
flow String Flow name. Copied from original event
interaction String Interaction name. Copied from original event

ProcessResult

Includes the Result properties plus the following:

Property Type Description
inputAudit Boolean True if an input audit file was generated
inputAuditPath String Path to the input audit file
outputAudit Boolean True if an output audit file was generated
outputAuditPath String Path to the output audit file
rejects Boolean True if at least one reject was generated
reportsNumber Integer Number of reports generated
reportsGenerated Boolean True if reports were generated without error
collectionTypeName String Name of the collection type that describes the data file
collectionTypeVersion Integer Version of the collection type

GenerateSamplesResult

Includes the Result properties plus the following:

Property Type Description
applicationName String Name of the application that is used to find the engine configuration
auditPath String Path of the input audit file used by the sampler
conditionPath String Path of the output audit file used by the sampler
generateCondition Boolean True if the rule requested generation of conditions
outputPath String Path of the output file generated by the sampler

FileResult

Includes the Result properties plus the following:

Property Type Description
collectionTypeName String Collection type name
collectionTypeVersion Integer Collection type version
filename String

Possible values:

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

Type of the output file.

Possible values:

  • OUTPUT_EVENT
  • REJECT
  • INPUT_AUDIT
  • OUTPUT_AUDIT
  • SAMPLE_AUDIT
dataFile String Data file path
propertyFile String Property file path

ImportResult

Includes the Result properties plus the following:

Property Type Description
collectionId Integer The identifier of the imported collection
collectionTypeName String The type name of the imported collection
collectionTypeVersion Integer The type version of the imported collection
totalObjects Integer The number of the imported objects
totalElements Integer The number of the imported elements
totalErrors Integer The number of the imported errors

ExportResult

Includes the Result properties plus the following:

Property Type Description
numberOfCollections Integer The number of exported collections

ExportFile

Includes the Result properties plus the following:

Property Type Description
dataFile String Path to the collection data file that has been exported
propertyFile String 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 Description
dataFile String Path to the collection data file that has been moved
propertyFile String Path to the collection property file that has been moved
errorFile String Path to the collection error file that has been moved

DeleteFilesResult

Includes all the Result properties.

SendEventResult

Includes all the Result properties.

TransformAIConfigurationResult

Includes the Result properties plus the following:

Property Type Description
numberOfCollectionTypes Integer Number of transformed Collection Types
numberOfObjectTypes Integer Number of transformed Object Types

TransformFileResult

Property Type Description
dataFile String Data file path
propertyFile String Property file path
outputType String

Type of the output file.

Possible values:

  • FORMATS
  • DICTIONARIES
  • DESCRIPTION

ImportAIConfigurationResult

Includes all the Result properties.

PurgeEventsResult

Includes all the Result properties.

PurgeReportsResult

Includes the Result properties plus the following:

Property Type Description
numberOfReports Integer Number of deleted reports

ReconciliationResult

The result of the execute reconciliation operation. Includes the Result properties plus the following:

Property Type Description
collectionId String The collection identifier
historyId Long The history identifier for the query attached to the reconciliation

ChangeCollectionsStatusResult

Includes the Result properties plus the following:

Property Type Size Description
changed String 150 A comma separated list of the identifiers of the collections whose status was changed.
noTransition String 100 A comma separated list of the identifiers of the collections which had no transitions defined for the current state.
notAuthorized String 100 A comma separated list of the identifiers of the collections which were not authorized for changing the status.
conditionFailed String 100 A comma separated list of the identifiers of the collections whose status could not be changed because the condition failed.
otherError String 100 A comma separated list of the identifiers of the collections whose status could not be changed because of some errors.

Related Links