Setting Up Custom Class Operations: Custom Metadata

To set up the operations that will be available for custom class objects, use the Operations tab in the The <class name> Class dialog box.

To open the dialog box

Web application Desktop application

The table displays standard operations by default that cannot be edited or deleted.

To add an operation:

Execute one of the operations:

In the web application click the Add button.
In the desktop application:

Click the Add button.
Select the Add item in the context menu of the list of operations.

Set the parameters:

Name. Enter operation name. The default name is Operation <number>.
Identifier. Enter a sequence of Latin letters, numbers, and underscore characters, starting with a letter. Operation identifier should match with the name of the procedure that will be created in the operation handler. The default identifier is set in the format: CLS<class number>OP<operation number>. Each operation must have a unique identifier.

After executing the operations the operation is added for the custom class. Operations are available in the context menu of the custom class object in the navigator if handlers are set up for these operations.

To edit operation, execute one of the following:

In the web application click the operation name or identifier and change them.
In the desktop application:

Execute one of the operations:

Select the operation name or identifier and click the Rename button.
Select the Rename item in the context menu of the operation name or identifier.
Double-click the operation name or identifier.

Change the operation name or identifier.

After executing the operation correct procedure name in the operation handler if the identifier was changed.

Access permissions can be granted both to custom operations and standard operations. For details see the Additional Security Parameters section.

Operation Handlers

Web application Desktop application

To set an operation handler in the web application, specify script URL in the Script box (JS file or HTML page containing the script) that implements operations, for example, https://TestServer/CustomObjects/Index.html or https://TestServer/CustomObjects/Operations.js.

Below is the example of JavaScript code of operation handler on the custom class object:

var url = location.search;//URL of the current page. On selecting operation from the context menu of the user object it will look as follows: S/Index.html?op=Open&k=600

//where S is a path to the script, Index.html is a page with the script, Open is operation name, 600 is a key of the user object

var tmp = new Array();

tmp = url.split("&");//array of symbols in the address bar, divided by &

if (tmp.length > 1) {

var strPar = tmp[0];//take new element of tmp array

var param_op = new Array();

var param_op = strPar.split("=");//array of symbols in the address bar, divided by =

if (param_op.length > 1) {

switch (param_op[1]) {

case "Open"://if op=Open

location.replace("https://TestServer/CustomObjects/open.htm");//Go to the specified site

break;

case "Edit"://if op=Edit

location.replace("https://TestServer/CustomObjects/edit.htm");

break;

case "Delete"://if op=Delete

alert("The Delete operation");

break;

}

If the Open and Edit items are selected, the system goes to the specified site pages. If the Delete item is selected, a message is displayed.

In the Unit drop-down list select a unit/form/assembly, and in the Class drop-down list select a class containing operation handler implementations. Operation handler methods must have the following signature:

Sub <OperationIdentifier>(<Parameter>: IMetabaseObjectDescriptor);

If parametric objects are supposed to be created, methods with the WithParams postfix and the following signature should also be determined:

Sub <OperationIdentifier>WithParams(<Parameter1>: IMetabaseObjectDescriptor; <Parameter2>: IMetabaseObjectParamValues);

In the object navigator operations for objects are available if the following conditions are met:

The user has permissions to execute the operation
The class includes a procedure to handle the operation.

The example of operation handler class is given in the Creating Custom Class Objects subsection.