Managing Policies, Workflows, Reports - myantandco/RA-BitnobiPilotJuly2020 GitHub Wiki

The Bitnobi UI displays lists of Workflows, Policies, Reports and Esports that you have created and provides a common UI for managing and searching these items.

Common List Behaviours

  • Settings Dropdown - a user can hide/unhide list item properties (e.g. Name, Description, User ) by clicking on the "gear" icon and then checking/unchecking the corresponding items in the dropdown list.
  • Search Field - In the upper right hand corner of the pane is the filter field. Any text that you enter here will match against the name/description/user columns and only those rows that have matching text will be displayed.
  • Column Sort - clicking on a column header will sort the list order based on ascending/descending/unsorted order for that column.
  • Common Properties - lists for Workflows, Policies and Reports will display properties for:
    • Name - name assigned to the item.
    • Description - description assigned to the item.
    • User - the Bitnobi user that created this item.
    • Created - the date and time when the item was created.
  • Paging - if there are a large number of list items, you can page through the list by using the arrows in the lower right hand corner. You can also change the number of items per page.
  • Remember List Settings - The UI will remember your settings for filtering, sorting, paging but only for your current session. Once you signout and signin again these will revert to the default settings.
  • Create - button in the upper left corner to create a new item (Workflow, Policy, Report or Export respectively)

Workflows List

In addition to the common properties, Workflow List displays properties for:

  • Expiry Date - when the result set for this workflow will expire.
  • Last Modified Date - (hidden by default) when the workflow was last modified.
  • Last Execution Date - (hidden by default) when the workflow was last run.
  • Elapsed Time - How long the workflow took run in HH:MM:SS format. For workflows in progress, the elased time is updated every 10 seconds.
  • Status - status of workflow: Ready, Completed, Error while executing, Expired, Local workflow in progress, Queued for execution, Stopped. When a workflow expires, its result set is deleted and its status will remain Expired until you run it again to re-create the result set. When the user requests a workflow to be run, it is placed in a first-in-first-out queue waiting for the next available Worker process to execute it. It remains in Queued for execution status until it starts running. Clicking on the workflow status field for an “In Progress” workflow opens the Workflow Progress dialog displaying a vertical list showing the sequence of workflow steps, which ones are complete and which one is currently running. If there is a workflow execution error, an error status is shown for the step that failed. Error details are then displayed at the bottom of the dialog.
  • Options - These include:
    • Open - opens the Workflow Canvas Editor
    • Edit - allows the workflow name, description, tags and expiry date to be changed
    • Access Control - allows policies to be attached to a workflow
    • Data Transfer Control - controls the data transfer capabilities for the other users that use this workflow as a datasource ( Upload to PowerBI, Upload to Jupyter, Download as CSV ).
    • Info - more details about the workflow
    • Delete - Deletes the workflow and result set.

The Workflows List allows segregating workflows into named groups. There are buttons at the top of the page to help manage this:

  • Create Group - allows creating a new group and moving existing workflows into it

  • Collapse - hides the workflow entries showing only the group names. Clicking on a group entry will toggle between expanding/collapsing the workflows in the group.

  • All / Group - when All is pressed, the group names are hidden and a list of all the workflows is displayed and the Create Group and Collapse buttons are hidden. When Group is pressed then Workflow groups are displayed.

Policy Control List

In addition to the common properties, Policy List displays properties for:

  • Options - These include:
    • Edit - opens the Policy Editor
    • Info -
    • Delete - Deletes the Policy

Report List

In addition to the common properties, Report List displays properties for:

  • Options - These include:
    • Edit - opens the Report Canvas Editor
    • Rename - allows the Report name and description to be changed
    • Info -
    • Delete - Delete the Report

Data Transfer List

In addition to the common properties, the Data Transfer List displays properties for:

  • Transfer Type - csv, jupyter or powerBI
  • Status - displays current status for the upload/download operation.
  • Options - These include:
    • Edit- allows the data transfer name, description and datasource to be changed
    • Download - start the Data Transfer operation
    • Info - more details about the Data Transfer definition
    • Delete - Deletes the Data Transfer definition.
⚠️ **GitHub.com Fallback** ⚠️