1.3.2. Invoke a CimEdit Script (Advanced Entries)

If you select a function to invoke a script and the function returns a value that contains arguments, you will have to do some easy, but advanced, configuration.

In these instances, the Advanced button on the Edit tab of the Properties dialog box will be enabled.

  1. Click an enabled Advanced… button in the Actions tab of the Properties dialog box.

The Edit Method dialog box opens. The arguments correspond to arguments in the script function.

  1. Enter values for the function's arguments.

 

Field/Type

Description

Example

A

Method name

(Default) Method selected on the Action tab.

SwitchViewToTank

 

 

Note: You can select another method from the drop-down list. The listed arguments change or disappear to correspond with the newly selected method.

B

Method result

(Optional) A setpoint in the Method result field if the function returns a value can be a:

 

 

Device or global point ID with the correct Point Type for the status value.

Variable ID that evaluates to a point ID. If you use a variable ID that does not evaluate to a point ID, nothing happens.

C

ByRefString

Enter one:

Name

TankID

 

 

An expression enclosed in double quotes. The results of the expression evaluation at runtime are passed to the method.

The point ID of a text point. The contents of the point ID are passed to the method.

A point ID for a non-text point enclosed in double quotes. The contents of the point ID are passed to the method.

Value

"Tank223"

D

ByRefInteger

Enter one:

Name

BatchNumber

 

 

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.

Value

BATCHNUMBER point

E

Do Setpoint

Enabled if the argument can be used as an output argument.

Value

BATCHNUMBER point is valid for a checked setpoint box.

 

 

Note: The expression must consist of a single point ID for the setpoint to be performed.

 

 

  1. Click OK to save your changes and return to the Actions tab.

  2. Click OK to save the procedure information and return to the Events tab.

  3. Click OK to save the event.

Result: You are now ready to test your script.

More information

1.3. Invoke the CimEdit script.