Creating a UI Workflow - Platform - BlueCat Gateway - 19.8.1

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
19.8.1
  1. Log in to BlueCat Gateway.
  2. Select Administration > Create Workflow.


    Note: BlueCat Gateway generates sub-directories and files for your new workflow including _page.py file, _form.py (this contains validators for fields in the page of your workflow), _init_.py file, as well as sub-folders for the HTML page, in <bluecat_gateway>/workflows/. For example, <bluecat_gateway>/workflows/Examples/example_workflow.
  3. In the New Workflow Name field, type the Python module name of your new workflow. As you type the Python Implementation Name (this the Flask name for the workflow that is used for permissioning), and Endpoint Name (the full endpoint is a composite of the Python Implementation name and Endpoint name (<implementation_name>/<endpoint_name>) fields will auto-complete. You can modify the content of those fields as necessary.
    Note: The workflow name must start with a letter or underscore and consist of only letters, numbers, and underscores. Also, the workflow name must not be duplicated in different categories.
  4. Optional—In the Workflow Category field, type the nested category and sub-categories for your new workflow. For example, Examples/example_workflow. Leave this field blank if you want to place the new workflow at the root level.
  5. In the Available Actions Display Name field, enter a name for your new workflow as it will appear under the Available Action menu.
  6. In the Workflow Description field, enter a basic summary of what the workflow does.
  7. Under Workflow Type, select which type of template to create, either Workflow with UI to make your workflow available through the BlueCat Gateway user interface, or Workflow using only REST API.
  8. Click SUBMIT.