Flow-fx Dialog

Description
Flow-fx Dialog The Flow-fx dialog is used to create a new Flow-fx workflow and the associated builder space.
Name field Specifies the name for the Flow-fx function.
Comments field Specifies the optional field for comments or a brief description.
Create button Save the configuration of the Flow-fx function and provision it.
Cancel button Abort and close the dialog.

Flow-fx Actions Menu

Description
Flow-fx Actions Menu On the right-hand side of the Flow-fx list view, you will find the "Actions" menu that displays shortcut icons and the dropdown menu icon. Below, we have listed the actions for the Flow-fx module.
Copy ID item Stores the Flow-fx ID in the clipboard.
Open Flow Designer item Displays the Flow-fx designer dialog, which is used to design execution flows.
Run Flow item Opens a confirmation dialog and executes the flow if confirmed.
PIN - Run Flow item Pins the Run Flow command to the {NEXUS} Start area for convenient access.
Clear Run Logs item Opens a confirmation dialog and clears all run logs of the flow if confirmed.
Delete Flow item Opens a confirmation dialog that, if confirmed, deletes the Flow-fx function.

Flow-fx Designer Dialog

Description
Flow-fx Designer Dialog The Flow-fx Designer dialog enables you to drag and drop components to visually design a process. Below, we provide a description of its functionalities.
FLOW tab Displays a list of Flow process components that can be dragged onto the designer area.
Name item Specifies the name for the Flow-fx function.
Comments item Provides comments or a brief description for the Flow-fx function.
Flow Runs chart Displays a small chart with counters for Total Runs, Success, Failed, and Running.
Clear Logs button Opens a confirmation dialog and clears all run logs of the flow if confirmed.
ABITD tab Displays a list of ABITD (Automate/Build/Integrate/Test/Deploy) components that can be dragged onto the designer area.
API tab Displays a list of {SITENAME} API components that can be dragged onto the designer area.
Designer tab The designer area where components are dropped and connected to represent the sequence of the process flow.
Log View tab Displays a list of run logs along with their contents.
Run button Executes the Flow-fx function.
Export button Exports the Flow-fx function in YAML format.
Import button Imports the Flow-fx function from YAML code.
Save button Saves the Flow-fx function.
Close button Closes the Flow-fx Designer dialog.
Property pane The property pane is used to configure the settings of a Step (flow object).
Flow objects
  • Left Connector Circle:
    Represents the data input of the component.
  • Right Connector Circle:
    Represents the data output of the component.
  • Left mouse-click:
    Selects the flow component.
  • Right mouse-click:
    Selects the flow component and displays the property pane along with the delete button.
  • Left mouse-down-and-drag:
    Selects a flow component and drags it to the desired position.
  • Left mouse-down-and-drag from output to input:
    Creates a flow connection from a component's output to another component's input.
  • Left mouse-click on connector line:
    Selects a connection.
  • Right mouse-click on connector line:
    Selects a connection and displays the delete button.
  • Delete Key:
    Deletes the selected component or connection.


The flowfx Policy


The following is a list of policy grants that define and regulate access permissions for both users and the API. To manage these policies, please use the Roles dialog.

Grants

Description

API Command
full Grants full access ALL
clearlogs Permits the clearing of the logs. clearlogs
counter Permits the retrieval of run counters. counter
delete Permits the deletion of the item. delete
edit Permits access to the "Designer" dialog.  
exec Permits the execution of the Flow-fx.  
exec-id Permits the execution of the Flow-fx. run
export Permits the export to YAML code operation. export
import Permits the import of YAML code operation. import
list Permits listing in the List View area or as JSON objects. list
logs Permits the retrieval of the runs logs. logs
new Permits access to the new "Provisioning" dialog.  
runs Permits access to the list of Flow-fx runs. runs
save Permits execution of the provisioning process. create