Defining rules to execute an external action

You can define rules to run an executable program or script and perform other actions external to FootPrints—actions that you can also reach from a command prompt. The action simply runs the specified program or script; it does not automatically interact with the operating system’s command interpreter or shell.

If the action that you want performed requires a command interpreter (for example, to run an operating system command or redirect standard input/output), the action must explicitly call the appropriate command interpreter for your operating system (for example, cmd or command for Windows or sh for Linux).


An example of an external action that requires a command  interpreter: cmd /c “ipconfig > ipconfig.txt”. . (Full paths were omitted here for brevity.)

An example of an external action that does not require a command interpreter is: myprogram.exe.

Be aware of security considerations when setting up rules of this type.

To define a rule that executes an external action

  1. Open the item where you want to define the rule:
    1. Click the Administration tab.
    2. In the appropriate section, click the name of the container or click Manage to open the container Administration page. Then double-click the container.
      The container details page appears. 
    3. In the left pane, click the item link (such as Record Definitions in workspaces).
      The Items page appears. 
    4. Double-click the item that you want to modify.
      The Item details page appears.
  2. In the left pane, click Business Rules.
  3. Click New Business Rule and select the appropriate rule type.
    The Rule Builder page appears. For detailed information about configuring different types of rules, see Types of business rules.
  4. In the Business Rule Name field, enter a descriptive name for this rule.
  5. (Optional) In the Description field, type a useful description for this field.
  6. In the Business Rule Schedule field, accept the default of Run Any Time, or select from custom schedules defined for this container.
  7. In the Triggers section, define the action or event that should trigger this rule. For more information, see Selecting triggers for business rules.
  8. In the Criteria section, define any condition that will trigger this rule. For more information, see Defining criteria for business rules.
  9. In the Actions section:
    1. Click Add new action.
    2. In the Action field, select Execute external action.
    3. In the next field, enter the command for executing the action in the format you would normally use to execute the action.
      The argument that you enter in this field is dependent on the installed operating system; the command syntax will vary from one operating system to another. For example, to run the Windows command interpreter, you would enter either or cmd.exe, depending on the installed Windows operating system.
    4. (Optional) To insert a field name into the command field, click Insert, and select a field.
    5. Click Create.
  10. Click Save.
  11. Publish the container to implement your changes:
    1. In the breadcrumb trail, click the container link.

    2. Click Save and Publish.
      A confirmation message appears.

    3. Click Yes.
      The Publication Succeeded message appears, showing the number of errors and warnings.

Related topics

Configuring business rules

Managing business rules

Deleting business rules

Was this page helpful? Yes No Submitting... Thank you