About Flow and Step Configuration Structures
Comparison of flow and step definition files in the QuickStart format and in the Hub Central format.
Overview
DHS project artifacts can be in the QuickStart format or in the Hub Central format. Each format is essentially a different JSON schema.
QuickStart and Hub Central can only read the project artifacts in the format intended for that tool; however, most Gradle tasks can read both formats.
A Comparison of Two Formats
| Hub Central Format | QuickStart Format |
|---|---|
| Step configurations are in their own separate files in the your-project-root/steps/step-type directory, and the flow configuration structure includes references to them. | Step configurations are embedded in the flow configuration structure. |
The mapping configuration is embedded in the mapping step configuration file under $.properties. |
The mapping configuration is in a separate file in the your-project-root/mappings/flow-name-step-name directories. |
The hierarchy in the step definition is flatter without the $.options and $.fileLocations objects. |
Some properties are embedded inside the $.options and $.fileLocations objects. |
Different property names:
|
Different property names:
|
Additional properties:
|
|
To create a flow, run the Gradle task hubCreateFlow without -PwithInlineSteps. It creates multiple files: one for the flow configuration and one for each of the example step configurations.
Learn more: Create Flow Using Gradle |
To create a flow, run the Gradle task hubCreateFlow with -PwithInlineSteps=true. It creates a single file containing the flow configuration with embedded example steps.
Learn more: Create Flow Using Gradle |
| To create a step and add it to a flow, run the Gradle task hubCreateStep and hubAddStepToFlow.
Learn more: Create Steps Using Gradle - HC Format |
To create a step and add it to a flow, run the Gradle task hubCreateStepDefinition and manually copy the step configuration structure from the new step definition file to the appropriate location in the flow configuration structure.
Learn more: Create Steps Using Gradle - QS Format |
| Details | Details |
In either format, you must customize the example steps before running the flow. You can delete the steps you don't need, and you can duplicate the steps if you need multiple steps of the same type. However, you must assign a unique sequence number for each step.