File

Inputs (required)

Display Name

Display name of the flow

Flow ID

Unique ID of the flow, recommend using Resource id or workflowid

Owner

Flow owner/maker

Environment

Environment name

Definition

Flow definition/clientData

Inputs Optional

AutoReview allows configuration of the review metrics, if left blank the review will follow the default values.

Complexity

New complexity items can be added with the 'Add new item' button. Though we recommend using the text mode (small pen in top right corner).

The complexity json object can then be edited in a source code editor (like Visual Studio Code or Notepad++) and then pasted in its entirety into the aComplexityTemplate input. With the reference inputted to the Reference Complexity.

Naming Convention

The naming convention json has to be placed in 3 inputs.

  • Naming Reference - sReference

  • Naming Char - char

  • data - data array

Ratings

Each rating key needs to be entered into the relevant inputs.

Scoring

The scoring json follows same pattern as complexity, with the reference input separately from the aScoringTemplate array.

Outputs

The File api returns the following

  • File

  • Data

File

The file key returns a HTML pile that can be used to create a file. There are 4 different file types:

*coming soon **coming not so soon

Data

Data is a stringified json and once parsed returns different values depending on the file selected.

Review and Report

*Review only

Diagram

Returns the nomnoml file. This file is similar to mermaid and creates a text file that is rendered as a diagram. The text can be pasted into nomnoml site or a site using the library.

#fillArrows: true
#lineWidth: 2
#fill:#569AE5
#background: white
#acyclicer: greedy
#ranker: tight-tree
#.data: visual=database fill=#EBDAF9
#.trigger: visual=roundrect fill=#569AE5
#.if: visual=rhomb fill=#2596be
#.switch: visual=ellipse fill=#2596be
#.scope: visual=frame fill=#808080
#.foreach: visual=transceiver fill=#00C1A0
#.until: visual=sender fill=#00C1A0
#.var: visual=input fill=#9925be
#.terminate: visual=receiver fill=#cc4747
#.var: visual=input fill=#EBDAF9

[<trigger> *Recurrence]->[HTTP]
[<foreach>Apply_to_each]--:>[<terminate>Terminate]
[HTTP]->[<data>Parse_JSON]
[<data>Parse_JSON]->[<foreach>Apply_to_each]


Next Steps - Files

Last updated