Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If desired, you can edit the category for your new workflow. Click on the current category ("uncategorized", for a new Workflow) to open the Select Category screen.

Image Modified

Click on the expand icons (plus) to browse the category lists, or filter from the search box. Click on the desired category to select it, then click "update" to apply the category to your Workflow. 

...

You may also add a description to your Workflow.

Image Modified

Double-Click inside the description field to edit the description, when complete click "Close" or click anywhere outside of the description field to exit out. 

...

Click the “Connectors” button to the left of the “Save” button in the upper-right corner to bring up the Edit Connectors screen.  

Image Modified

From the select box, pick “sixconnect.”

...

Use the ‘Test’ button to make sure the information is correct. If successful, a "Connector test success." message appears to confirm a valid connection.

Image Modified

After confirming the test succeeds, save the connector by clicking ‘Apply’, then ‘Close' to exit out of the connector screen and return to the Workflow page.


Step

...

5: Add Workflow Steps

Now it is time to add the first step of the Worfklow. 

From the “Workflow Steps” area on the Workflow page, select the connector we have just made:  “sixconnect - ProVision 1”. 

Image Modified

The middle box of the form will pull in all the API Endpoint Families for this product.  Pick ‘resources.’

Image Modified

The final box will pull in all of the specific endpoints belonging to that family.  Pick “Get resources” and click the ‘Add’ button to the right of the form.

Image Modified

The new step is added to the main ACP work area.  An ‘Output’ step is automatically created below it.

Image Removed

At this point - being that a valid step has been added - you can save your new workflow by clicking "Save" near the top right of the Workflow page.

Image Modified

After the first successful save of a new Workflow, the "Delete" and "Execute" buttons will be available. 

Image Modified

Step 6: Review Step Inputs & Options

  Click the blue ‘Get Resources’ step we just created to view detailed information for the step

Image Added

ACP has read in the API specification for this endpoint and will display forms for required and optional parameters, as well as additional step options. 

Available tabs for this step include General Options, Optional Inputs, Iteration Options, Sub Steps, Conditions & Routes, and OutputThe ‘Get resource’ API call does not have any required parameters, so the "Required Inputs" tab is disabled.


Click on the "Optional Inputs" Tab.  none are shown here. All optional parameters are initially set to ‘omitted,’ meaning they will not be included with the API call on this step.

Image Addedw

To make this step do something a bit more useful, find the ‘Name’ parameter in the list of optional fields.  Change its drop-down from ‘omitted’ to ‘default value.’ This means this parameter will be a constant, defined in the text box which appears to the right.  Place the text ‘TLR’ in the 'default value' box.

Image Added

This configures the API call to pull all the information about the resource named ‘TLR,’ which is the root of the ProVision resource hierarchy.

Step 7: Configure Output

While the previous step has fetched the data we need, we need to configure the Output step to return it to us.  Click the blue ‘GET RESOURCES’ header to collapse the first step.

Then click the black ‘OUTPUT’ header to expand the output section.  Currently, nothing is configured, and when the workflow is run it will return nothing.

Image Added

Click ‘Add Parameter’ to add a new field to the output of this Workflow. Output parameter options will appear.

Image Added

  Change the name from ‘output-param-1’ to ‘id’, and then select ‘Workflow Link’ from the adjacent drop-down.  The form expands.

Image Added

In ‘Workflow Link’ mode the third box contains all the steps of the workflow.  You can select parameters from any call to return in the output, either in whole or in part.  Select ‘Get Resources → (object).’ Clicking on the fourth and last box will bring up a listing of all the parameters returned by the Get Resources call.

Choose ‘id.’  This will return a single field, which is the id of the resource named ‘TLR.’

Image Added

Step 8: Save Changes

  Hit the ‘Save’ button in the upper-right to save the changes made to any steps or the output. 

Image Added

Step 9: Execute Workflow

Step 9:  Hit the ‘Execute’ button next to ‘Save.’ 

Image Added

After the processing timer finishes, a Results section appears with the response object:  { "id": "1" }. We have queried the API for a resource named ‘TLR’ and have found that its resource id# is 1.

...