Managing - Action, Action Filters & Error Filters

Tags:

Updated:

7 minute read

Actions are certain tasks like getting data from an application or sending data to an application based on specific API filter conditions known as Action Filters. Every Schema is an entity that requires to multiple actions to perform multiple operations as per the transaction happening. For Eg: GET, POST, PUT, DELETE etc.

This section of the document will enable the user to create actions, action filter and error filters under a created schema, when working with processflow.

Prerequisites

  • The User should have a valid APPSeCONNECT account.
  • APPSeCONNECT should be up and running
  • An application node is needed for defining the Actions.
  • The app node needs to be dragged in the designer section to define the actions under manage schema
  • The Schemas should be created under which the Actions are to be defined.
  • For defining Action & Error Filters, you need to have the ACTIONS created for the chosen application on your organisations. Click Here to know more about creating actions.
  • You need to have an action filter/retry filter created, to create it as a template.

Adding a New Action

1) Navigate to the processflow and the drag the application node for which the Actions are to be made. The Node configuration window of the app node opens.

2) Enter all the mandatory fields and click on the save button.

3) If you donot get to find the needed action in the actions menu, click on the Manage Action button for defining Actions.

pf_actions1

4) The Manage Action window opens. You will be able to view the schema, selected in the node configuration window.

pf_actions2

5) Click on the Ellipsis icon (three horizontal dots) beside the schema to view the Add Action option in the contextual menu.

pf_actions3

6) You will provided with two mandatory fields for creating the ACTION under the schema. Below are the mentioned fields.

  • Action Name: This is the name of the action that would signify the operation it would be doing. For Example: POST Customers, getting Customer from WooCommerce etc.
  • Action Description: The description of the actions briefs the operation, the action would be performing. For Example: Adding customes to Shopify, Fetching Orders from Magento etc.

Click on the SAVE button.

pf_action4

Following the above steps , you can successfully create a new Action to a schema.

Note:

  • The newly created action will be created in the organisation level.
  • The field Action Name will allow a maximum 100 characters
  • You can create multiple ACTIONS under a schema.

Edit, Delete & Rename an existing action

1) Navigate to the Manage Actions in the node configuration window of the selected application. Select the required action from the Actions contextual menu in the Node Configuration Window, that needs to be EDITED. The Manage Action window opens.

edit_actions1

2) Expand the Schema node > Actions Node to view the selected action. Click on the Contextual menu to view the following option.

  • Edit Action:
    • You can view the two fields Action Name & Action Description in the edit window.
    • Modify the changes required and click on the SAVE button.

edit_action2

  • Delete Action
    • Clicking on the delete action button, you get a confirmation message for deletion process.
    • Clicking on the YES button will delete the action from your organisation for the selected application.
  • Rename Action
    • Clicking on the RENAME button, You get the edit action window.
    • You can successfully rename both the mandatory fields: Action Name & Action Description.
    • Click on the SAVE button to apply the changes on your organisation.

edit_action3

Following the above process, you can successfully Edit, Delete & Rename an existing action.

Note:

  • You cannot delete an action that is already in use and deployed.
  • You can also perform the DELETE and the EDIT operation of the schema for the APP > Select your App > Schema.

Adding Action Filters

1) Select the Action from the contextual menu of the node configuration window of the dragged application.

2) Click on the Configure Filter button after selecting the action from the contextual menu.

actionfilter1

3) The Configure filter window opens. You can view the selected shema listed on the window.

actionfilter2

4) Expand the nodes customer > Action > Select Action to view the Action Filter and the Error Filter

actionfilter3

5) Click on the ellipses beside the Action Filter to view the CREATE Button. Clicking on the create button, the action filter creation window opens.

actionfilter4

6) You get the option to provide your filter for TWO sections. Either on HEADER and BODY. As per you application API, you can provide the following details to configure the action filter.

  • Key: This is the filter key that will define the key to filter.
  • Operator: You need to select the type of operator needed for the execution of the action filter.
  • Value: You need to provide the value to the filter that will be executed to GET or POST data.

Click on the SAVE icon beside the filter to save the current sibling.

actionfilter5

7) You can also append multiple filters by clicking on the APPEND button add conjuction on the same level as of the elder sibling filter.. To add a conjuction on a level below, click on the (+) button beside the elder sibling.

8) You can also save the filter as a template by clicking on SAVE AS TEMPLATE for reusing it on a different processflow for the same application within the same organisation. For more details on TEMPLATE, Click Here.

Note: You need to save the elder sibling before applying conjuction on same level or below level.

Adding Retry Filters

1) Select the Action from the contextual menu of the node configuration window of the dragged application.

2) Click on the Configure Filter button after selecting the action from the contextual menu.

errorfilter1

3) The Configure filter window opens. You can view the selected shema listed on the window.

errorfilter2

4) Expand the nodes customer > Action > Select Action to view the Action Filter and the Error Filter

errorfilter3

5) Click on the ellipses beside the Error Filter to view the CREATE Button. Clicking on the create button, the error filter creation window opens.

errorfilter4

6) You get the option to provide your retry filter for TWO sections. Either on HEADER and BODY. As per you application API, you can provide the following details to configure the retry filter. Provide the following details to configure the retry filter.

  • Key: This is the filter key that will define the key to filter.
  • Operator: You need to select the type of operator needed for the execution of the action filter.
  • Value: You need to provide the value to the filter that will be executed to GET or POST data.

Click on the SAVE icon beside the filter to save the current sibling. To add a conjuction on a level below, click on the (+) button beside the elder sibling. You can also click on the ADD CRITERIA button to add conjuction on the same level as of the elder sibling filter.

Following the above process, you can successfully implement Retry filter for an action.

Saving and creating from a Template Filter

1) Drag the application node for whose Action filter/Retry filter you need to create as a template.

2) You need to navigate to the Node Configuration window > Select Action > configure filter.

3) The Configure Filter opens. Expand the nodes until Action filter & Retry Filter appears.

4) Click on the CREATE button as per the options selected, either ACTION FILTER or RETRY FILTER. The create window opens as per the selected choice (The window remains same for both Action Filter and Retry Filter). Here we have chosen ACTION FILTER.

4) Provide the details in the fields and click on the SAVE icon beside the filter column. After saving the column, you get the option of SAVE AS TEMPLATE.

savetemplate1

5) Click on the Save as Template button to save the provided Action Filter as a template. You can reuse this saved template on any other nodes of any processflow in your organisation, provided the application node , Schema & the Action remains the same.

6) You can view the saved for the schema and action by navigating to Manage Schema > your selected Schema Entity > The Action in which you have created the Template > Click on the Action filter. You will be able to view the saved template for that schema and the action. The template will not be editable in the Manage schema window.

7) To create filter from a saved template, navigate to Node Config window -> Select Schema -> Select Action -> Configure filter. Expand the Schema node until Action Filter, Retry Filter appears.

8) Click on the Ellipses beside your chosen option (Action Filter, Retry Filter) and select the option Create from template from the context menu.

createtemplate1

9) On clicking Create from template you get a confirmation message. Click on the YES button.

createtemplate2

10) The saved template opens. You can anytime edit the action filter placed in the template as per your requirement. The updates made will not change in the template that is saved.

createtemplate3

Following the above process you can successfully SAVE and create filter from template.

Note:

-The steps to remains when working with Retry filer.

- Each action of a schema can have only one created template.

- You cannot modify the template when viewed from the Manage Schema section.

- You can also view , edit and delete the saved template from the APPS section.

Comments