Integrate the Application with an External Third-Party Software

Required Permissions

This section requires the Application Designer permission from your Domain's administrator.

Check What are the Design Tasks? to learn more about permissions to work with Design Mode and other tools.

Learn how to create a Custom Action enabling the application to interact with a third-party software through the API.

Question

A software API it's intermediary system that enables the communication between two software to exchange data or require an operation execution.

Note

This document explains only how to configure an Invoke API Remote-type Custom Action in eLegere. Each software has its own API that differ to one each other. Verify the documentation of the third-party software to learn how its API works.

If you aren't a developer, check with your administrator the parameters' values to insert in the Custom Action.

  1. In Design Mode, click on the icon in the upper-right corner of any panel.

    The action leads to the Custom Actions panel.

  2. Click on the Enable Module toggle switch to activate the Custom Actions in your application.

  3. Click on the New Action drop-down menu button.

  4. Choose Invoke API Remote from the list of Custom Actions types. This action creates a Custom Action.

    This action creates the Invoke API Remote Custom Action to be configured.

  5. Insert in the Info section the required information.

    • (1) Name Insert a name for the eLegere Script Custom Action.
    • (2) Description optional Insert a description for the eLegere Script Custom Action.
    • (3) Manual If enabled, the Users launch this Custom Action manually. If disabled, choose at (4) Event a triggering condition to launch the Custom Action. (By default, the toggle switch is enabled.)
    • (4) Event If (3) Manual is disabled, choose a trigger condition from the drop-down list.
    Event - Triggering Options

    For the Event option, when the Manual toggle-switch is disabled, choose a moment when the Custom Action runs.

    PRE ROW INSERT Before inserting a row.

    POST ROW INSERT After a row's insertion.

    PRE ROW UPDATE Before any changes apply to a row.

    POST ROW UPDATE After having edited a row.

    PRE ROW DELETE Before deleting a row.

    POST ROW DELETE After having deleted the row.

    PRE ATTACHMENT INSERT Before uploading an attachment to a row.

    POST ATTACHMENT INSERT After having uploaded an attachment to a row.

    POST MASTER INSERT After having inserted a row on the Master table.

    POST MASTER UPDATE After having saved an edited row on the Master table.

    POST MASTER DELETE After having deleted a row on the Master table.

    • (5) Async Enable to run the Custom Action in the background instead of waiting for its completition to use the application. (By default, the Async toggle-switch is enabled when (3) Manual is enabled. Otherwise, the toggle-switch is disabled.)
    • (6) Execution optional Click to open the Formula Editor. Insert a Formula to define the conditions for executing the Custom Action.
    • (7) Visibility optional Click to open the Formula Editor. Insert a Formula to define the conditions to display the Custom Action in the application.
    • (8) Refresh optional If enabled, the application refreshes the data on the table when the Custom Action has finished to run.
    • (9) Icon optional Choose an icon for the Custom Action.
    • (10) Context Decide if the User launches the Custom Action from the Custom Actions drop-down menu in the application or from the Row's Options (). Disabled if (3) Manual is disabled.
    • (11) Table Choose the table where the Custom Action runs.

  6. In the Parameters, insert the requested values.

    Note

    The parameters' values depends on the specific third-party software's API. Check its documentation or contact your administrator to retrieve the values you need.

    • (1) The URL for the HTTP request triggering the action from the API.
    • (2) The request method: GET or POST.
    • (3) If the Use Context toggle switch is enabled, the Custom Action will pass the row's context with its values with the request.
    • (4) Provide the Authentication: all the keys and values that the API requires for the access. (Click on New to define a value and a key. Click on the Reset button to clear all the values and keys from the section.)
    • (5) Provide the Headers: all the keys and values with the metadata required to perform the action. (Click on New to define a value and a key. Click on the Reset button to clear all the values and keys from the section.)
    • (6) Provide the Body: all the keys and values required to perform the desired action. (Click on New to define a value and a key. Click on the Reset button to clear all the values and keys from the section.)

  7. This step is optional. Follow this step if you want to block the use of one application while the Invoke API Remote Custom Action is running.

    In the Application Lock, click on the Enabled toggle switch to enable the application's locking. (By default, Enabled is turned OFF.)

    Choose one or more applications from the drop-down list to lock while the Custom Action is running.

  8. When you have completed the configuration, click on the Save button () in the top-left corner to save the Invoke API Remote Custom Action.

Success

You have configured an Custom Action calling a third-party software's API in your application.

Tip

If you want to disable the Invoke API Remote Custom Action without deleting it from the Application, click on the toggle switch next to the Custom Action's name to hide it from the users.

Tip

If you want to delete a Invoke API Remote Custom Action, click on the Remove in the Info section.

A window will ask for confirmation. Click Yes to confirm the deletion. (Click No to abort the deletion.)

Click on the Save button () in the top-left corner to save the deletion.