Invoke Method

Invoke Method invokes a designated method.

Currently, methods are supported for CIMPLICITY Trends, SPC Charts, Recipes, and Alarm Viewer controls.

Note: See the documentation for these controls for more information.

Configure the action as follows.

1

Action type

2

Object name

3

Method

4

Confirmed

5

Advanced

 

1

Action type

Select Invoke method.

2

Object name

Available control objects are listed.

If the object is named on the Properties dialog box General tab, the name is listed.

Default

<Event trigger object>

 

3

Method

Methods available for the control object being configured are listed.

4

Confirmed

When checked, Confirmed requires confirmation at runtime.

A message box will display before the action occurs requesting confirmation to proceed.

Default

Clear

Confirmation is not required.

 

5

Advanced

Advanced is enabled for methods that require further specifications.

The Edit Method dialog box for that method opens. The information and format that you enter in the Edit Method dialog depends on the method you select.

General configuration includes.

 

Field

Description

A

Method name

Method selected on the Actions tab.

Another method can be selected from the list of available methods.

B

Method result

(Optional) Enter a Setpoint in the Method result field if the function returns a value. You can use a device or global Point ID with the correct Point Type for the status value

C

Name

Parameters to be configured for the method.

D

Type

Format required for the corresponding entry in the Value field.

 

 

Integer

Choose one:

An expression using the Edit Expression dialog box or the Popup menu. The results of the expression evaluation at runtime are passed to the method.

A Point ID: The contents of the Point ID are passed to the method

 

 

String

Choose one or a combination of the following:

Point ID that refers to a text point

Constant string enclosed in double quotes

If/Then/Else condition where:

If is A (from either 1 or 2 on the list)

Then is B (a text expression)

Else is C (a text expression)

A short hand If/Then/Else is A?B:C

E

Optional

Specifies if a Value entry is optional.

 

 

No

Not optional; a value must be entered.

 

 

Yes

Optional; the value can be blank.

F

Do setpoint

Options are:

 

 

Disabled

Setpoints are not allowed.

 

 

Enabled

Configuration can specify is setpoints are allowed.

 

 

 

Check

Setpoints are allowed.

 

 

 

Clear

Setpoints are not allowed.

 

 

If the argument can be used as an output argument, the Do Setpoint checkbox will be enabled. To assign the output value of the argument to a CIMPLICITY Point when the function exits, enter the Point ID in the Expression field.

G

Value

Expression that will pass as the argument for each argument in the Name column.

 

 

 

 

 

 

 

More information

Available actions.