Salesforce

W4 - Methods (Magic xpi 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

W4 – Methods

The following methods are used to configure the W4 component:

The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Name

Parameters

Description

Cancel Case cancels a currently executing workcase.

Case ID

Enter the ID number for the workcase to be cancelled.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Create Case creates a new workcase.

Procedure Name

Enter the name of the procedure that the workcase is part of. A procedure is the process model being used.

Initiator Name

Enter the name of the workcase initiator. The initiator is a person who has rights to create a new instance or procedure.

Prefix Case Name

Enter the prefix case name for W4.

Responsible

Enter the name of the person who is responsible for the W4 workcase.

Priority Override

This is the priority of the case. If the value is "0", the default priority from the procedure definition is inherited.

Makes Unique Name?

This specifies a value that indicates whether or not to generate a unique name from the given prefix.

Alarm Override

This sets the case alarm date. For example, 'DD/MM/YYYY'DATE.

Overdue Override

This sets the case overdue override date. For example, 'DD/MM/YYYY'DATE.

Case ID

This parameter is returned, containing the ID number corresponding to the workcase that was created.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Create Task creates a new task. A task is an instance of a step in W4.

Case Name

You should enter the W4 case name here.

Node Name

You should enter the W4 node name here.

Actor Name

You should enter the W4 actor name here.

Priority

You should enter the priority of the task here.

Alarm Date

You should enter the task alarm date here, in DD/MM/YYYY format.

Overdue Date

You should enter the case overdue date here, in DD/MM/YYYY format.

Task ID

This is the task ID that is created by W4.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

End Task ends a current task. A task is an instance of a step in W4.

Task ID

Enter the ID number for the current task. A task is an instance of a step and is created when a step becomes active.

Variable List

This is the list of variables that will be passed to the task. It is a string that consists of the variable names, each one separated by a comma. For example, '<?Variable1?>,<?Variable2?>'.

Out Value

This is the value that will be passed to the next W4 task.

Next Task ID List

This parameter is returned, containing the next task’s ID.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Set Case Variable updates a W4 case variable.

Case ID

This parameter is returned, containing the ID number corresponding to the workcase that was created.

Variable Name

This is the name of the variable that will be updated. For example, '<?Variable1?>'.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Set Case Variables updates W4 case variables.

Case ID

This parameter is returned, containing the ID number corresponding to the workcase that was created.

Variable List

This is the list of variables that will be passed to the workcase that is to be updated. It is a string that consists of the variable names, each one separated by a comma. For example, '<?Variable1?>,<?Variable2?>'.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Start Case starts the execution of a workcase.

Case ID

Enter the ID number for the workcase to be started.

Variable List

This is the list of variables that will be passed to the workcase that was started. It is a string that consists of the variable names, each one separated by a comma. For example, '<?Variable1?>,<?Variable2?>'.

Task ID List

This parameter is returned, containing the first task’s ID.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Related Topics

How to Use Direct Access Methods

Reference
Attachment 
Attachment