• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Ontology buildingFoundry RulesDeployDeploy workflow

    Deploy workflow

    You can deploy a new Foundry Rules workflow from within the Rules application. From the application, generate the required objects and Actions for your workflow.

    1. Deploy a new Rules workflow: Find and select the Foundry Rules application in the sidebar, then select Rule-based data pipeline.

      Button in the Rules application to deploy Foundry Rules

    2. Provide configuration: The application will create a new project for you that includes the relevant backing datasets, Foundry Rules workflow, and Workshop application resource.

      Rules Workflow configuration page

      • Choose the relevant space.
      • Choose the relevant Ontology. If you have multiple Ontologies, select the Ontology that contains all the object types on which you would like to define your rules.
      • The Rule editor group is used for the submission criteria of the actions. Users in this group are able to create proposals to add, edit, delete rules, and also, to decide on proposals. This configuration is meant as a starting point as you can configure the submission criteria on the rule actions later. To change the submission criteria on the action types, review the FAQ.

    3. Deploy: Once the fields have been completed, select Deploy. The deploy process takes about two to three minutes in the background during which you can safely navigate away. Pending and completed installations can be found on the main page under Pending installations or Existing Rule Workflows. All workflows have the default name "Foundry Rules Workflow" and a timestamp in the list of existing workflows. You may rename the workflow by renaming the corresponding resource in your project folder.

      Rules Workflow configuration page

    After completing the above steps, learn how to configure the workflow.

    FAQ

    How do I change the submission criteria on the action types?

    To update your submission criteria on the action types, navigate to the Workshop application, select Edit. Then, review the Rule Editor configuration panel on the right as shown below.

    Workshop application Rule editor configuration panel screen

    Then, hover your cursor over the "i" icon inline with the Create add proposal action's "Create a proposal to add a rule" dropdown option.

    From the new pop up, select View Action Configuration.

    Create a proposal to add a rule pop-up

    From here, you will be able to change the submission criteria.