Adding and managing custom functions

Adding and managing custom functions

Adding Custom Functions

A custom function can be added for one of the below listed categories, each corresponding to a specific feature in the application. Once created, the custom function becomes available for the feature in the selected model/module.

Select a category below to view instructions for creating a custom function.

Managing Custom Functions

After a Custom Function is added to the application, you can perform the following operations:

Accessing Custom Functions

You can access custom functions from both the developer application and the end application.

Accessing in the developer application

  1. Access the Developer Application.



  2. Click the Automate tab in the top.



  3. In the left pane, Select Actions.



  4. Select the Custom Functions tab.



You will now see the list of custom functions available in the application.

Accessing in the end application

  1. Access the End Application.



  2. Click on the Settings icon in the top right corner.



  3. Click Actions under the AUTOMATION section.



  4. Select the Custom Functions tab.


You will now see the list of custom functions available in the application.

Editing details of a custom function

After a custom function is added, its name and description can be edited.
  1. Access the custom function list view in the developer application or the end application.
  2. Hover over the name of the custom function you want to edit and click the ellipsis (...) icon that appears.



  3. Select Edit from the context menu. This will open the Edit Function form.



  4. Make the necessary changes to the name and description.



  5. Click Save.



  6. Click Update in the Update Warning pop up.


The changes made to the name and description of the custom function will now be updated.

Editing the custom function code

After a custom function is added, it's code can be edited.
  1. Access the custom function list view in the developer application or the end application.
  2. Hover over the name of the custom function you want to edit and click the ellipsis (...) icon that appears.



  3. Select Open Editor from the context menu. This will open the deluge code builder.



  4. Make the necessary changes to the code.



  5. Click Save and Close to save the updated code to the custom function and exit.


 
The changes made to the code of the custom function will now be updated.

Deleting a custom function

A custom function can be deleted in both the end application and the developer application.
Alert
Custom Function Dependencies:
  1. A custom function becomes a dependency when it is selected as the action for an alarm rule, schedule, notifications profile or workflow. To delete the custom function, you must first disassociate it from these dependencies.

  2. For example, the Create Service Order custom function is added as the action for an alarm rule called Temperature Status. Before you can delete the said custom function, you must edit the temperature status alarm rule and remove create_service_order as the action.
To delete a custom function in the end application,
  1. Access the custom function list view in the developer application or the end application.
  2. Hover over the name of the custom function you want to edit and click the ellipsis (...) icon that appears.



  3. Select Delete from the context menu.



  4. Click Check Dependencies in the Delete Validation pop up.



  5. Click Delete Function in the Delete Confirmation pop-up.


The custom function will now be deleted from the application.

See Also

      Connections
      Commands
      Alarm Rules