[RFE] ManageIQ Workflows - UI

[Fryguy]

Tracking issue for the UI implementation of the design: ManageIQ/manageiq#22302

• Modify existing integration points, starting off with (but not limited to)
  • Service Dialog authoring of dynamic components Introducing embedded_workflow to dynamic select box in service dialogs #8844
  • Service Catalog item Entry Points Adding embedded workflows to service catalog item #8815
• New Menu & UI for Workflows Automate -> Embedded Workflows (can probably be copied from Embedded Ansible) - [WIP] Embedded Workflow integration #8718
  • Workflows - Adding menu items and pages for Workflows and WorkflowRepositories #8774
    • Summary (create/update/delete/import/export can come later if we only allow repositories at first) -
    • Text version
      • JSON representation of ASL color coded with CodeMirror
    • Visual version
      • Phase 1 show a simple svg since we don't need create; Phase 2 would be drag and drop canvas
    • Associate Credential with Workflow - Credential Mapping Form #8905
  • Repositories - Similar (copy/paste?) to Embedded Ansible -> Repositories - Adding menu items and pages for Workflows and WorkflowRepositories #8774
    • List View
    • Summary View
    • Create/Update/Delete
  • Credentials - Similar (copy/paste?) to Embedded Ansible -> Credentials - Added Embedded Workflows / Credentials Page #8834
    • List View
    • Summary View
    • Create/Update/Delete
• New UI for workflow instances (not sure where this should live yet) Introducing workflow status list in request's show page #8782
  • Text version
    • Table showing each step's start/end time, inputs/outputs errors, logs, etc - Introducing workflow status list in request's show page #8782
    • JSON representation of ASL color coded with CodeMirror (reuse component from workflow view above) - Moving to future Epic
  • Visual UI (reuse the visual UI for runtime presentation) - Moving to a future Epic
    • Phase 1 style the simple svg; Phase 2 would be to style the drag and drop canvas

[noopurAg]

Here is the mockup design for the navigational flow of the screens for Automated workflows .
@Fryguy please review.

[noopurAg]

1 additional point , for view graph , we can directly integratee with the toolkit or plugin to render the state machine from the json .

[Fryguy]

@noopurAg This looks good to me overall, but I have some comments:

• I don't like the name "Automated Workflows" - we will have to discuss that - I think I had started a conversation with @jeffibm and @agrare about that somewhere, but we should come up with the name sooner than later so as not to churn too much later.
• "The workflows will be created manually or via script in database."
  • This is not accurate, but the sentiment here is that we will not support authoring at this time, so perhaps we just say that. Instead we expect workflows to be created manually outside of ManageIQ, and imported via a git repository.
• "The graph svg will also be stored in the database"
  • This is not accurate, but the sentiment is that it will come from the API, so let's change this to "The graph svg will be provided by the server via the API". It will be generated on the fly by the server. I'm thinking it should be a separate API call/paramater to /api/workflows and/or a call to the /api/pictures endpoint - not sure offhand. I want to avoid making it a permanent part of the API, because eventually we will do the drag/drop canvas version and the svg will no longer be needed.

[noopurAg]

@Fryguy thanks for the feedback.
yeah make sense .. for 3 point , you mean to say -we can generate svg on the fly by rendering the state machine (by the server)

[noopurAg]

Adding the mockup UI for Entrypoints for the Service Dialogs -

@Fryguy please review and suggest .

[Fryguy]

@noopurAg Looks good to me - couple thoughts:

• for the wording, instead of "Choose Option", perhaps, "Automation Type" and the values would be "Embedded Automate" and "Embedded Workflows" - Open to suggestions for something besides automation type.
• for the "fig" part, I think fig 1 is good for Embedded Automate. For fig 2 for Embedded Workflows, I was thinking a simpler dropdown, however now that you presented a tree, I wonder if we should have a loose namespacing based on the name? Maybe support / in the name for hierarchy? @agrare What do you think?

[Fryguy]

@agrare This actually now raises more questions - we pull the name from the workflow asl file itself, but do have a more "permanent" uid somehow? What happens if someone changes the name? My mind is going to export/import (without git repos, for example).

[agrare]

@Fryguy yeah we can add a guid to workflows that gets generated on initial creation and stays with it over the lifecycle of the workflow. I'm thinking we'll want to add a filename also, since we'll likely need to know how to reference a single workflow file in a git repo.

[noopurAg]

@Fryguy the suggested naming conventions seem good .. 'll make the corrections accordingly... I think it'll be too many workflows to display in a single dropdown, might be a list of 100-200 items .. is there a way we can subdivide it? or maybe display as a simple list ( not needed to be in the tree format ) would be better?

[Fryguy]

@agrare filename or perhaps path if it's eventually nested under folders.

Only downside to GUID is if the same repository is pulled into a separate region or instance of MIQ, then it will be all different guids

[agrare]

If we're thinking these will primarily be coming from git repos, then the repo_name + branch + file_path would make sense as the "unique" attribute across export/import. If there is no git repo then just file_path would have to be enough.

[agrare]

ManageIQ/manageiq-schema#687

[noopurAg]

@Fryguy -please review

saved-worflows.mov

ManageIQ/ui-components#469 for
Modify existing integration points, starting off with (but not limited to)-Service Dialog authoring of dynamic components

[noopurAg]

Integration with API to show the list of workflows :
And some css changes to reflect the selected type.

[noopurAg]

@Fryguy I have come up with the following design for the instances activity page for Service (having workflow entry point) with a catalog item (includes workflow). Here are the screens :
Screen 1 - With all service requests.
Screen 2 - With a particular request(clicking on the table ) .
Screen 3 - Screen 2 with the workflow in execution details as per activities status.
Scrren 1 :

Screen 2:

Screen 3:

Instead of workflow_name, we will have activity names for the workflow in execution later on when we click on particular workflow .... OR
we can show the activity _name and status of the entrypoint workflows list by list here itself on the same page.

@Fryguy please review and suggest. Thanks!

[noopurAg]

I have a couple of suggestions though

in 1 service we can have different entry points and each entry point ll have a workflow
so in the Service request details page, we can show all the workflows in a table, and clicking on 1 workflow request will show the status of the activities of that workflow
The headings for the table would be like Workflow Name and Status
And clicking on that workflow will give the Textual representation with color-coded status

Activity_Name Status
worklfow1 Success
workflow2. In Progress

[agrare]

@noopurAg @jeffibm you can now set a configuration_script_id on a resource_action

[Fryguy]

Marking this as completed. Other functionality will be moved to future PRs