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.

To delete the operation:

Select one or several operations.
Execute one of the operations:

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

Click the Delete button.
Select the Delete item in the operation's context menu.

After executing the operations the deletion confirmation dialog box opens. If the answer is positive, the selected operations are deleted.

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

Operation Handlers

Operations are handled using the custom class implemented in one of the repository units. Operation handler methods must have the following signature:

In the web application one can select a unit and a class in the Handler Without Visual Components and Class drop-down lists. In the desktop application one can select a unit and a class on the Operation Handlers tab. There are differences presented below that depend on where the work is executed.

Web application Desktop application

The list of system operations available in the web application:

CREATEOBJECT
OPEN
EDIT
DELETE
PASTE

Web forms can be used to handle operations. A web form can be selected in the Web Form drop-down list of the required operation. The OPEN and EDIT events are always handle in a web form. The DELETE and PASTE events are always handled in a custom class. The CREATEOBJECT event and any other custom events can be handled both in a web form and in a custom class. If a web form is not selected, an event is handled in a custom class. For details about setting up web forms see the Using Web Forms for Handling Custom Class Operations subsection.

The list of system operations available in the desktop application:

OPEN
OPENWITHPARAMS
EDIT
DELETE
PASTE

The EDIT operation is handled on creating and editing a custom class object.

The Operation Handlers tab is used to specify a custom class:

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.

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.

Specifying the script that handles web application operations is no loner supported and is kept for compatibility with previous platform versions.

Web application Desktop application

Class WebOperations: Object
    Sub Createobject(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle the Create operation
    End Sub Createobject;

    Sub Open(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle the Open operation
    End Sub Open;

    Sub Edit(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle the Edit operation
    End Sub Edit;

    Sub Paste(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle the Paste operation
    End Sub Paste;

    Sub Delete(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle the Delete operation
    End Sub Delete;

    Sub Custom1(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle custom operation
    End Sub Custom1;

    Sub Custom2(ObjDesc: IMetabaseObjectDescriptor);
    Begin
        // Handle custom operation
    End Sub Custom2;
End Class WebOperations;

Class Operations: Object
    Sub Open(Obj: IMetabaseObjectDescriptor);
    Begin
        // Handle the Open operation
    End Sub Open;

    Sub Edit(Obj: IMetabaseObjectDescriptor);
    Begin
        // Handle creating the custom class object or operation Edit
    End Sub Edit;

    Sub Delete(Obj: IMetabaseObjectDescriptor);
    Begin
        // Handle the Delete operation
    End Sub Delete;

    Sub Paste(Obj: IMetabaseObjectDescriptor);
    Begin
        // Handle the Paste operation
    End Sub Paste;

    Sub CLS1OP1(Obj: IMetabaseObjectDescriptor);
    Begin
        // Handle the first custom operation
    End Sub CLS1OP1;

    Sub CLS1OP2(Obj: IMetabaseObjectDescriptor);
    Begin
        // Handle the second custom operation
    End Sub CLS1OP2;
End Class Operations;