Previous Topic: Input ParametersNext Topic: Get Operator


Operation-Specific Parameters

Enter the following data about the selected operation.

Note: Do not enter data for them if you have already entered data in the Parameter Expression and Parameter Namespace Expression fields.

AbortStartRequest
Instance

Specifies the instance of the start request to abort.

Cancel
MdrProduct

Specifies the unique identifier of the connecting product that you want to cancel the request with.

Example: CA:00074 (CA Process Automation)

MdrProdInstance

Specifies the unique identifier of the instance of the connecting product (as registered in the Catalyst Broker) that you want to cancel the request with.

Example: CA:00074:01

MdrElementID

Specifies the unique ID of the product element instances.

Example: Process instance ID to cancel.

DelegateTask
TaskID

Specifies the ID of the task that you want to cancel.

Export

Specifies information about the exported content.

ExportRequest
  • Folder Name: Specifies the name of the folder that holds the exported content.
  • IsAbsolute
  • SealModifiableReleaseVersions
ExportFileName

Specifies

  • ExportLocation
  • OverwriteFile
Filter

ObjectTypes: Lets you filter a specific object type.

Hold
MdrProduct

Specifies the unique identifier of the connecting product.

CA:00074 (CA Process Automation)

MdrProdInstance

Specifies the unique identifier of the instance of the connecting product (as registered in the Catalyst Broker).

Example: CA:00074:01

MdrElementID

Specifies the unique ID of the product element instances.

Example: Process instance ID to be put on hold.

Import
ImportLocation

Specifies the CA Process Automation library location to import the .xml.

Example: /Testimport/

SourceLocation

Specifies the location from where to import the .xml.

Example: C:\test_import\import_test.xml

OverwriteAction
Import

Increase the version of the imported object if the same object exists in the specified import folder. Overrides the release version if the same release version exists.

DoNotImport

Do not import objects with the same name as an existing object.

ImportAndReplace

Import and replace the existing object. Deletes the previous versions of the object.

SetCurrent

Boolean: true (sets the imported version to current) or false (set the imported version as not current).

MakeAvailable

Boolean: true (sets the imported version as available) or false (sets the imported version as not available).

QueryDatasetNames
PathName

Specifies the path that contains the name of the dataset that you want to run a query on.

QueryDatasetParameters
PathName

Specifies the path that contains the name of the dataset that you want to run a query on.

QueryModuleConfigProperties
ModuleName

Specifies the name of the CA Process Automation module properties that you want to configure.

QueryModuleConfigs
(Optional) ModuleName

Specifies the name of the CA Process Automation module.

(Optional) The <ModuleType>

Specifies whether the standard module configuration or custom module group configuration is returned. By default, the QueryModuleConfigs method returns all the available modules. The <ModuleType> attribute takes the following values:

All

Returns the standard modules and the custom modules configuration.

Standard

Returns only standard modules configuration.

Custom

Returns only custom modules configuration.

QueryStartRequestForms
LookUpPath

Specifies the path or the CA Process Automation library folder to query the start request forms.

Example: /SRF_test

IsRecursive

Values:

  • True: Specify true to search recursively over the child folders under the specified folder.
  • False: Specify false to not to search over the child folders under the specified folder.
Keywords

Provide the start request forms Tags property as keywords to filter the list of start request forms.

QueryStartRequests
Instance

Specifies the start request instance to query.

IsArchived

Specifies whether the start request instance is archived.

Values:

  • True: CA Process Automation checks if the provided start request instance is available in the archived table database. If the start request instance is not in the archived table database, the provided instance name returns all of the available archived instances from the database.
  • False: CA Process Automation checks if the provided start request instance is available in the current table database. If the start request instance is not in the current table database, the provided instance name returns all of the available unarchived instances from the database.
QueryTasks
TaskID

Specifies the ID of the task that you want to query.

RootUUID

Specifies the ROOTUUID of the process instance.

ProcessID

Specifies the process instance ID.

State

Specifics the state of the task, such as pending, taken, completed, failed, and timeout.

Release
MdrProduct

Specifies the unique identifier of the connecting product.

Example: CA:00074 (CA Process Automation)

MdrProdInstance

Specifies the unique identifier of the instance of the connecting product (as registered in the Catalyst Broker).

Example: CA:00074:01

MdrElementID

Specifies the unique ID of the product element instances.

Example: Process instance ID to be released.

ReplyTask
TaskID

Specifies the ID of the task that you want to reply to.

IsApproved

Specifies the ID of the task that you want to approve.

Values:

  • True: Specifies approved.
  • False: Specifies rejected.
Arguments

Specifies the arguments/parameters and their value for the forms that is attached to the task.

ReturnTask
TaskID

Specifies the ID of the task that you want to return.

Start
MdrProduct

Specifies the unique identifier of the connecting product.

Example: CA:00074 (CA Process Automation)

MdrProdInstance

Specifies the unique identifier of the instance of the connecting product (as registered in the Catalyst Broker).

Example: CA:00074:01

MdrElementID

Specifies the unique ID of the product element instances.

Example: Path to the process to start from the library.

Argument

Specifies the parameters and its values to be initialized when the process starts.

SubmitStartRequestForm
Name

Specifies the name of the start request form to submit.

Path

Specifies the path of the start request form to submit.

Arguments

Specifies the parameters and their values to assign during when you submit the start request forms.

StartDate

Specifies the start date of the start request form to submit.

StartTime

Specifies the time that the start request form you want to submit began.

Priority

Specifies the priority of the start request form that you want to submit.

TakeTask
TaskID

Specifies the ID of the task that you want to take.

TransferTask
TaskID

Specifies the ID of the task that you want to transfer.

Users

Specifies the user to transfer the task to.

Example: pamadmin or pamusers

Groups

Specifies the groups to transfer the task to.

Example: pamadmin groups, pamuser groups, pamdesigner groups

UpdateDatasetParameters
PathName

Specifies the name of the path for the dataset that contains the parameters that you want to update.

Parameters

Specify a new parameter value for the dataset that you want to update.