Configuring Integrations

Updated in 8.7

Integrations run external PowerShell commands directly from Alloy Navigator Express. In the Web App and Desktop App, Integrations are available in the Action Bar and the Actions menu among other workflow actions, in the Integrations group.

NOTE: In order to allow for seamless integration, Alloy Navigator Express uses Alloy Integration Launcher. Web users get this small program installed when they run such a workflow action for the first time. Desktop users get the launcher installed automatically.

TIP: Creating Integrations requires a working knowledge of PowerShell. See Microsoft PowerShell documentation at https://docs.microsoft.com/powershell/.

Depending on the task you want your command to perform, it can run it on a client computer, i.e. on the computer from which the workflow action is initiated, or on the server computer, i.e. the computer hosting the Automation Server. Client commands can be launched only from the Web App, Desktop App, and the Self Service Portal. Server commands can be launched from anywhere.

INFO: For more detailed description of External Command operations, see Administration Guide: Configuring Integrations.

To configure an Integration:

  1. Go to Customization > [Module] > [Object Class] > Workflow > Integrations section and click New. The Integration window opens.

    TIP: To base a new Integration on an existing one, select the source Integration and click Copy Item.

  2. In the Name field, type in the Integration name. This name will be displayed to the user in the Action Bar and the Actions menu. Optionally, add a description.

  3. Keep the Enabled check box selected. Otherwise, the Integration will not be available.

  4. Under Run command on, choose where to run the command: on the client or on the server.

  5. Under Run, enter the commands or scripts for the PowerShell to run. This can be a PowerShell cmdlet, a combination of cmdlets, a script, or any external program.

    To enter a dynamic parameter, click Insert Placeholder and use the Select Placeholder window to insert a placeholder. At runtime, all placeholders will be replaced by the actual data.

    IMPORTANT: Add double quotation marks (") around placeholders, so all placeholders in your command are enclosed in quotes. For example: "%[DBF Field1]%" or "%[DBF Field1]%%[DBF Field2]%%[DBF Field3]%".

    INFO: For additional information, see Microsoft PowerShell documentation at https://docs.microsoft.com/powershell/.

  6. For client commands: If you want the user to review the output information in the PowerShell window, select the Display PowerShell window check box.

  7. For server commands: Specify the timeout period (in minutes) after which the Automation Server will finish inactive background jobs.

    TIP: If you want the job to run with no timeout, enter 0 (zero).

  8. Click OK.

NOTE: To run an External Command operation, the PowerShell executable file (powershell.exe) must exist in the folder specified in the PATH environment variable on the computer where the operation runs, i.e. on the client or on the server.