EvaluateSubset Parameters and Valid Execution Modes

The valid execution mode for EvaluateSubset is SYNCHR.

The parameters of EvaluateSubset are as follows:

EvaluateSubset Parameters
Name Semantics Type Valid Values Multi–

plicity

Direction: In
InDocument
(Mandatory) See Common Parameters.      
RelationshipName#
(Optional) See Common Parameters.      
Subset
(Optional) Subset Rule name. string Name of the Subset Rule to be applied. Should be specified for only non sync events (i.e events which are not for Catalog Synchronization). If specified, the Subset Rule name takes priority over catalog definition. 0..1
NamedVersionPrefix

(Optional)

Prefix used while creating named version. This parameter is used in case of incremental export. string Any string 0..1
IgnoreMetadata
Change Ignores the change in repository metadata.

In case of incremental export, if IgnoreMetadataChange is set to false and repository metadata changes, all data is exported even though the same data is exported earlier.

boolean True (Default)

False

0..1
MasterCatalog
(Optional) See Common Parameters.      
InRecordList
(Optional) Record list. recordlist Record list. If specified, the Subset Rule is applied on the record list. If no record collection is specified, Subset Rule is applied for all records in the repository.

Also note that if no Subset Rule is applicable (that is, no Subset Rule name is specified or the event is for catalog synchronization and no Subset Rule is selected in catalog definition), all records in the repository are selected.

0..1
PerspectiveName (Optional) See CreateWorkItem Parameters and Valid Execution Modes.
VersionOption(Optional) Record version selection option. string
CONFIRMED (Default)
LATEST

Specifies the record version to be selected. If there are any draft records in the workflow, they will be included automatically. This parameter is applicable only if the inrecord collection is null.

For use with Catalog, it is recommended that you do not override the versionOption specified in the catalog definition.

0..1
FEDOption
(Optional) See Common Parameters.      
FEDDate
(Optional) Refers to the date used to process the records between current date and future date (FED date). FED date is always greater than current date. string The valid value is date in format yyyy-MM-dd

If no date is specified then default (dummy) date is "3999-12-31".

0..1
Direction: Out
Evaluation
Timestamp Refers to the timestamp at which subset is evaluated. The timestamp format is yyyy-MM-dd hh:mm:ss. This timestamp is passed to the CreateNamedVersion activity in the Incremental Export workflow.

The timestamp is generated only if the NamedVersionPrefix is specified.

string The valid value is date and time.

The default value is current date and time.

0..1
Evaluation
Name Refers to the name of NamedVersion, which is used to verify last export date or time. This EvaluationName is passed to the CreateNamedVersion activity in the Incremental Export workflow.

The EvaluationName is generated only if the NamedVersionPrefix is specified.

string Any valid name of named version. 0..1
OutRecordList
(Optional) See Common Parameters.      
Records
Processed
(Optional) Number of records in outRecordList. long   1