Flow
doohickey flow allows you to interact with flow instances in your OIH environment. These flows pass data between systems.
Arguments
doohickey flow accepts one argument - an alias for the flow instance
Deploy
doohickey flow deploy will instantiate an instance of a flow from a selected template. Before you can run this command, your integration project must already contain at least one template. The deploy command is used for both creating a flow instance and subsequent updates to that flow instance.
| flags | type | description |
|---|---|---|
--environment (-e) | string | Target OIH environment |
--tenant (-t) | string | Target tenant to deploy the flow instance |
--url (-U) | string | Base URL for OIH flow repository |
--start (-s) | boolean | Indicate if flow should be started after deployment |
--forceCreate (-c) | boolean | Force creation of a new flow instance even if it already exists in current environment and tenant. A new ID will be associated with alias. |
--template | string | Name of template associated with flow instance |
--configFile (-C) | string | File path to a JSON configuration object for insertion into flow instance |
Delete
doohickey flow delete will remove a component from both your local integration environment and OIH.
| flags | type | description |
|---|---|---|
--environment (-e) | string | Target OIH environment |
--tenant (-t) | string | Target tenant to deploy the flow instance |
--url (-U) | string | Base URL for OIH flow repository |
Start
doohickey flow start will activate a flow instance and allow data to start moving through it. If the flow contains any global components that are not currently active, the CLI will return the name and ID of these components to you so they too can be activated.
| flags | type | description |
|---|---|---|
--environment (-e) | string | Target OIH environment |
--tenant (-t) | string | Target tenant to deploy the flow instance |
--url (-U) | string | Base URL for OIH flow repository |
--template | string | Name of template associated with flow instance |
Status
doohickey flow status will return the deployment status of a flow.
When deployed through Doohickey Cloud, a flow is a combination of a template and an integration configuration. Thus to view the status of a deployed flow you must specify both the template and the integration configuration, which can be specified by either the alias or the id.
Note that this command is not relevant for flows deployed directly to Open Integration Hub.
| flags | type | description |
|---|---|---|
--template | string | The alias of the template |
--templateId | string | The id of the template |
--integration | string | The alias of the integration |
--integrationId | string | The id of the integration |
For example, to retrieve the status of the flow created by a template with the alias of my_template and an integration configuration with the alias my_integration, run the command doohickey flow status --template my_template --integration my_integration.
The result will be something like this:
{
"id": "61f69022e379c6062a0c6e2b",
"status": "success",
"templateId": "2UMP5C4CYY4K8SEDTVBYDX1D77",
"integrationId": "FIZ4NRB614T8DQRTAJNP568N4B",
"message": "flow 61f69022e379c6062a0c6e2b processed"
}
Stop
doohickey flow stop will deactivate a flow instance and prevent further data from moving through it. This will not affect any global components associated with the flow instance.
| flags | type | description |
|---|---|---|
--environment (-e) | string | Target OIH environment |
--tenant (-t) | string | Target tenant to deploy the flow instance |
--url (-U) | string | Base URL for OIH flow repository |
--template | string | Name of template associated with flow instance |
View
doohickey flow view will allow you to view:
- All flows currently in the OIH environment
- A single flow in the OIH environment
- A template output without having to deploy to OIH
| flags | type | description |
|---|---|---|
--environment (-e) | string | Target OIH environment |
--id (-i) | string | ID associated with a flow instance |
--tenant (-t) | string | Target tenant to deploy the flow instance |
--verbose (-v) | boolean | Flag to display additional information about flow - (Only available on view all flows) |
--template | string | Name of template associated with flow instance |
--configFile (-C) | string | File path to a JSON configuration object for insertion into flow instance |
View All Flows
To view all flow instances in an OIH environment, run the command doohickey flow view and OIH will return a limited amount of information about all the flows. There is a --verbose flag that can be used to display more information.
View a Single Flow
To view a single flow instance in an OIH environment, run the command doohickey flow view myFlowAlias, replacing myFlowAlias with the alias of the flow you would like to view. OIH will retrieve that flows current state and return it to you.
View a Generated Template
To preview what a flow would look like before officially deploying it, run the command doohickey flow view --template myTemplateAlias replacing myTemplateAlias with the name of the template you want to see. A flow JSON will be generated and returned to you.