DeleteRecord Parameters and Valid Execution Modes

The valid execution mode for DeleteRecord is SYNCHR or ASYNCHR.

The parameters of DeleteRecord are as follows:

DeleteRecord Parameters
Name Semantics Type Valid Values Multi-plicity
Direction: In
IncludeDraft
Records
(Optional) See Common Parameters.      
InDocument
(Optional) See Common Parameters.

One of the following parameters must be specified:

ProductIds, RecordKey, InRecordList or InDocument.

     
InRecordList
(Optional) See Common Parameters.

One of the following parameters must be specified:

ProductIds, RecordKey, InRecordList or InDocument.

     
MasterCatalog
(Optional) Specify this parameter, if InDocument is specified and InRecordList, ProductIDs, RecordKeys are not specified.

The activity tries to get the repository name in the following order:

From InParameter.

From InDocument.

An exception is thrown and the workflow exits in the following conditions:

  • repository name is not found in both InParameter and InDocument.
  • repository name does not resolve to a valid repository.
string Any string. 0..1
PerspectiveName (Optional) See CreateWorkItem Parameters and Valid Execution Modes.
ProductExtns
(Optional) Indicates:
  • Product extensions of the records to be processed (Arraylist). For example: 
    <Parameter direction="in" name="ProductExtns" type="arraylist" eval="variable"
>ProductIDKeyArray1</Parameter>
  • Individual product extension (string). For example: 
    <Parameter direction="in" name="ProductExtns" type="string" eval="constant">w33</Parameter>

    This input is used only if ProductIds is specified. If an arraylist is specified, the number of entries in the array must be the same as the number of entries in productIds.

arraylist 
or 
string A valid value for extension as an array or string.

An array is processed only if the input for productId is Array.

0..n
ProductIds
(Optional) This is a required parameter only when you want to process the record from the input.

You must specify either this parameter or the RecordKey parameter. If both are specified, recordKey is processed. If none of them are specified, the activity fails.

One of the following parameters must be specified:

ProductIds, RecordKey, InRecordList or InDocument.

This parameter indicates:

  • Product IDs of the records to be processed (arraylist). For example: 
    <Parameter direction="in" name="ProductIds" type="arraylist" eval="variable"
>ProductIDKeyArray1</Parameter>
  • Individual product ID (string). For example: 
    <Parameter direction="in" name="ProductIds" type="string" eval="constant">w33</Parameter>
 arraylist 
or 
string Valid ProductIDs for the records that exist in the system. 0..1
RecordKey
(Optional) You must specify either this parameter or the ProductIds parameter. If both are specified, recordKey is processed. If none of them are specified, the activity fails.

One of the following parameters must be specified:

ProductIds, RecordKey, InRecordList or InDocument.

arraylist List of record keys for the records to be deleted. 0..1
RelationshipName
(Optional) See Common Parameters.

If relationship names are specified, the activity tries to build the bundle and process it. That is, the bundle of the specified relationship is built and each record in the bundle is marked for deletion.

This parameter accepts ALL as a valid input. If ALL is specified, all the relationships applied to the catalog (including forward and reverse) are considered for deletion.

string ALL or a valid relationship name applicable for the repository. 0..n
VersionOption
(Optional) See Common Parameters.     0..1
ImportDataDeleteRecord This parameter applies when the DeleteRecord activity is invoked by ImportCatalogRecords activity as part of the import process.

This parameter is used to delete records during import.

boolean True

False

0..1
Direction: Out
RecordsDeleted
(Optional) This parameter contains the total number of records deleted by this activity. long   1
RecordsProcessed
(Optional) This parameter contains the total number of records processed by this activity. long   1