login | sign up

Your session has timed out due to inactivity.

You can go back to the overview without login or use the login form to login again before redirect

Knowledge Base / Administrators – Preparing your one2edit™ Workspace / Workflow Templates

Workflow Actions > Trigger Webservice

Created on 15th November 2018 at 16:05 by Jamie O'Connell



'Workflow Actions' window

Actions can be added to a workflow from the 'Workflow Actions' window (accessed via 'File > Actions' in the workflow view).

This lesson details the 'Trigger Webservice' action.

The 'Trigger Webservice' action is used to trigger an API call in either one2edit™ or a third-party system.

Trigger Webservice

After dragging the 'Trigger Webservice' action into the action field, double-click on it to open the 'Action Editor' window. Here you can set up the web-service call.

The screenshot above shows an example 'before and after' scenario.

(1) 'URL'
The URL field contains the target URL for the
web-service to be called. The URL "http://www.one2edit.com/" is in there by default. However, it should be changed to the URL of the system to which the web-service belongs.

(2) Parameter Table
Chosen parameters will be listed in this table.

  • Name: By default, the 'Name' of each parameter is identical to the 'Value' of that parameter. This name may need to be changed to match the target parameter name. Simply click the name to edit it.
  • Type: The type of HTTP method for each parameter should be chosen here. The options are GET and POST. These values will depend on what is expected by the target web-service.
  • Value: The one2edit-side value of the parameter. It is shown as a variable name which will be replaced by an actual value when the call is made.

(3) 'Add Parameter'
A variety of one2edit™ parameters are available to choose from. When a parameter is selected, it will be added to the table, where it can be updated as required.

The parameters available are:

  • Value: A user-defined value that does not need to come from the one2edit™ system.
  • System Name: The name given to the one2edit™ system. This can only be tailored if you have a dedicated system (i.e. not one2edit™ Express).
  • System URL: The URL needed to access the one2edit™ system.
  • Company Name: The name of the current client workspace.
  • Company ID: The one2edit™ ID for the current client workspace.
  • Document ID: The ID of the document.
  • Document Name: The 'name' text of the document.
  • Document Version: The 'version' text of the document.
  • Document Description: The 'description' text of the document.
  • Document Pages: The page names and numbers of the document.
  • Document Lastedit Date: The date and time of the last edit made to the document.
  • Document Owner Name: The full name of the user who created the document.
  • Document Owner Contact: The username (i.e. email address) of the user who created the document.
  • Document Owner Domain: The user domain to which the document-creator belongs.
  • Document Lastuser Name: The full name of the user who last edited the document.
  • Document Lastuser Contact: The username (i.e. email address) of the user who last edited the document.
  • Document Lastuser Domain: The user domain to which the last editor of this document belongs.
  • Document Word Count: The word count for the entire document.
  • Document Character Count: The character count for the entire document.

Example:
We are using project management (PM) software to keep track of things. The URL at
(1) is linked to the API of the PM software.

We have chosen several parameters (3) that will help us to identify the document and owner of the job. We have updated the 'Name' field for each parameter in the table (2) to match the input requirements of the PM software's API. While this example API requires that the parameters be sent using the GET method, it would also be possible to send them using POST.

Result: Within our workflow, we have assigned this 'Trigger Webservice' action to the 'Running' position of each workflow step. Therefore, our PM software will receive an update when a user begins their workflow step.




© 2009-2021 1io BRANDGUARDIAN GmbH · All rights Reserved · Legal / Privacy Policy


top