ImportCatalogRecords Parameters and Valid Execution Modes

The valid execution mode for ImportCatalogRecords is SYNCHR.

The parameters of ImportCatalogRecords are as follows:

ImportCatalogRecords Parameters
Name Semantics Type Valid Values Multi-plicity
Direction: In
AsynProcessIndicator
(Optional) See Common Parameters.      
CatalogInputMap
(Optional) There can be multiple input maps associated with a catalog. So, when importing a catalog, the input map name should be specified. An MLXML document always contains an input map name, so even if this parameter is not present, the activity can use the one specified in MLXML. string Input Map Name. 0..1
ErrorThreshold
(Optional) If the error count reaches this threshold, the import is terminated.

The value can set using the Configurator (Repository > Catalog Import Error Threshold).

The order of the configuration is: Value specified in workflow file > Value specified in Configurator > Default value.

long Default is 1000. 0..1
Incremental
(Optional) This parameter is provided to indicate if the given set of records is the ‘complete’ set for a given repository (Incremental=no) or is an addition to existing records in the repository. (Incremental=yes). string Yes (default)

No

0..1
InDocument
(Mandatory) See Common Parameters.      
InRecordList
(Optional) Collection of records to process. recordlist Not applicable. 0..1
MasterCatalog
(Mandatory) See Common Parameters.      
MergeData
(Optional) This parameter is used to determine what the default value for an attribute in a record should be when nothing is specified in the input data source. When set to ‘yes’, the existing attribute value in the repository record is retained. When set to ‘no’, it is possible to over-write an attribute value as ‘null’. 

The ‘null if blank’ option in the input map definition in the UI determines the overall behavior. string Yes (default)

No

1
ProcessOption
(Optional) Specifies the process option for import:
  • MUTATION (M) — Indicates whether the record ID should be tested for mutations. Records are considered to have key mutation when PRODUCTID or EXT changes over the lifetime of the record. If the flag is not specified, the mutation test is not performed. (True in configurator means M in import option). False is default for Configurator (Optimization > Import Mutation Test Performed).
  • DUPLICATE (D) — Indicates that a test for duplicate rows in the import should be performed. If this flag is specified and the same record appears more than once, only the first occurrence is processed and other occurrences are rejected. True in Configurator means D in Import options. True is default in Configurator (Optimization > Duplicate Row Check).
string M

D

C

Default is D.

0..1
 
  • CYCLIC (C) — Performs a cyclic check on the new relationship being imported. A cyclic check is very time consuming and should be requested only when data is expected to have cyclic relationships. (True in Configurator means C in import option). False is default in Configurator (Optimization > Cyclic Import Check).

    The Workflow file value will take precedence over the Config file value.

     
RecordPerAsyncCall
(Optional) See Common Parameters.      
Rulebase
(Optional) See Common Parameters.

You can use ImportCatalog and EvaluateRuleBase in a single step, in which case, no additional record versions will be created and import will be faster.

To configure this:
Pass the rulebase through the ImportCatalog activity. For example:

<Parameter direction="in" name="Rulebase" eval="constant" type="string">D:\common\ac\rulebase/catalogvalidation.xml</Parameter>
string Existing Rulebase file. 1
ParameterNames
(Optional) This parameter is applicable only if using a Rulebase.

The values to input variables defined in the rulebase can be passed though activity parameters. The names of the parameters must match the declarations in the rulebase.

<declare usage=”input”>

string Have to be declared as input variables in the rulebase. 0..n
SplitImportBatch 
(Optional) This value is stored as a Process Detail. It has no effect on the behavior of the import activity. string
Split/Approval Required
Split/No Approval
Direct Load
1
RecordState Indicates the state of the saved record. You can specify the following states:
  • CONFIRMED : If you specify the CONFIRMED value, the imported records are confirmed immediately. When this state is specified, workflow does not require a separate UpdateRecordState activity. You should change the out-of-the-box workflow to skip updateRecordState activity.
  • UNCONFIRMED : If you specify the UNCONFIRMED or DRAFT value, workflow may require the UpdateRecordState activity.
  • DRAFT : If you do not specify any value, Draft is defaulted.
string DRAFT (Default)
CONFIRMED UNCONFIRMED  
VersionPolicy (Optional) Indicates how the record versions are managed. The allowed VersionPolicy values are NEW, CORRECT, OPTIMIZE.
  • NEW: using this option, you can create a new version of a record. This is the default value.
  • CORRECT: using this option, you can update the existing record versions. New version is not created, only if the old record version state and new record version state match.
  • OPTIMIZE: using this option, you can optimize the best choice between the CORRECT and NEW options. TIBCO MDM automatically decides if a new version should be created.
The following rules are used when VersionPolicy=OPTIMIZE:
  • A new record version is created, if the old and new record state do not match.
  • A new record version is created, if the old record state is REJECTED.
  • A new record version is created, if the old record version is DELETED.
  • The existing record versions are corrected, if both the old and new record state match.
  • For everything else, the existing record versions are corrected.
string
  • NEW (Default): creates a new version
  • CORRECT: updates an existing record version, no new version. If policy rule allows correction.
  • OPTIMIZE: this is a combination of both NEW and CORRECT. TIBCO MDM automatically decides whether or not a record can be corrected; otherwise a new version is created.
0..1
Note: Record version correction is allowed in the ImportCatalogRecord activity only when the activity is running in the ConfirmImmediately mode. That is, VersionPolicy=Correct is applicable to ImportCatalogRecord Activity only if the activity is set to RecordState=CONFIRMED. For best results, use Optimize.
Direction: Out
CatalogsWithErrors
(Optional) Total number of input catalogs with errors. If this parameter is not specified and RejectedRecords is not zero, the workflow aborts. long    
DeletedRecords
(Optional) Total number of records deleted. long Applicable only if Incremental=no. 1
DuplicateRecords
(Optional) Total number of records rejected as duplicates. long Any positive number. 1
EditedRecords
(Optional) Total number of modified records. long Any positive number. 1
NewRecords
(Optional) Total number of new records imported. long   1
OutDocument
(Deprecated) See Common Parameters.

For backward compatibility, outDocument will be the same as InDocument.

    1
RecordsAttempted
(Optional) Total number of records processed. long Any positive number. 1
RecordsProcessed
(Optional) Number of Records processed by the activity. long Any number. 1
RecordsSuccess
(Optional) Total number of records added, updated, or deleted. long Any positive number. 1
RejectedRecords
(Optional) Total number of records rejected due to validation errors. long Any positive number. 1