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 – Essential Workshops / Steps – Setting up an Editing Project

Section 12: Assign 'Workflow Actions' to workflow steps

Created on 09th October 2017 at 12:52 by Jamie O'Connell



This section shows you how to assign 'Workflow Actions' to workflow steps.

The following content is an excerpt of our workshop. To see this lesson in context, please refer to "Workshop 2: How to create an Edit Job Workflow (Steps 10ff.)".

NOTE:
A detailed description of any window used here can be found in the 'User Interface Description' sections.

Let's get started!

Assign 'Workflow Actions'

To assign actions to each workflow step you need to open the 'Workflow Actions' window:

  1. Double-click 'Action' area: Double-clicking in an empty 'Action' area will open the 'Workflow Actions' window.
  2. Click 'Workflow > Actions': The 'Workflow Actions' window can also be opened via the menus ('Workflow > Actions').
  3. Drag & Drop actions: Drag and drop the desired actions into the workflow steps.
  4. Open 'Action Editor' windows: After assigning an action to an action field, double-click on that action to open the respective 'Action Editor' window. Using this window, you can adapt each action to your requirements.

NOTE:
More detailed information about the 'Workflow' window can be found in the 'User Interface Description' (for example, the difference between the 'Start', 'Running', and 'Finished' 'Action' areas).

Workflow Action - Export Document

After dragging the 'Export Document' action into the action field, double-click on it to open the 'Action Editor' window. This action is used to automatically export a file at a specific position in the workflow. The file can be exported via a download link in an email ('Target > Email') or to a specified folder on an asset server ('Target > Asset Server').

(1) Type:
This drop-down menu allows you to choose the type of file to export.

The options are:

  • Package: This exports an Adobe® InDesign® package as a .zip file. The package will contain the INDD file, as well as all links and document fonts.
  • INX: This is a file of the (deprecated) "InDesign Interchange" format. It is a way to export an InDesign document as XML from older versions of InDesign. Has been replaced by the IDML format.
  • PDF: The PDF (Portable Document Format) is a file type typically used for print. Options such as the PDF preset can also be chosen here.
  • INDD: An InDesign Document (INDD) file is the file type used by Adobe InDesign. The underlying INDD file will be exported in its current workflow state.
  • IDML: An IDML (InDesign Markup Language) file is an XML representation of the INDD file. It can be used to open a newer INDD file in an older version of InDesign (e.g. opening a CS6 file with CS5).
  • TMX: The TMX (Translation Memory eXchange) file format is used to synchronise an external translation memory with the current translations in the workflow. It should typically only be exported from the 'Steps Complete' workflow area.
  • History: This exports the full document change history as an XML file. This XML can be opened and viewed in a web browser.

(2) Target:
The options for 'Target' are to:

  • send a download link for the exported file via email
  • export a file to an asset server

(3) Email 'Subject' and 'Text':
If choosing to export to email, you will need to fill in the details of the email and the recipients.

  • Subject: for the email subject line.
  • Text: will contain the body text for the email. The body text must contain a variable for the download link that will be generated once the file has been exported. The 'Download Link' variable can be found in the 'Insert Variables...' drop-down menu, as can the 'Download Expire Date' variable. Variables are inserted at the cursor's location in the 'Text' field. More information about the variables is available in the appropriate section of the knowledge base. In all cases, 'document' refers to the document with the workflow applied to it.

(4) Recipient(s):

There are four options to choose for the email recipients:

  • Specific: You will need to manually input any main or cc'd recipients in the appropriate fields.
  • Step users: An email will be sent to all users of the current workflow step. This option should not be used in the 'Steps Completion' area, as there are no users assigned to it.
  • Document owner: The owner of the document (i.e. the user that created the document in one2edit™) will receive the email.
  • Workflow starter: The user who started the workflow (i.e. who pressed the 'play' button in the workflow view, or who pressed the 'Start' button on a Template) will receive the email.

No matter what option you choose, it is always possible to add supplementary email addresses to the "CC" field.

(5) Asset Server details:

If 'Asset Server' is chosen as the target, you will need to click the 'Browse' button and choose the folder to which the file will be exported.

Doing so will fill in the following details:

  • Project: The ID of the target asset project.
  • Path: The folder path chosen as a target for the exported file.
  • Name: The filename (containing variables to be filled in at a later stage) that will be given to the exported file.

Workflow Action - Email Notification

After dragging the 'Email Notification' action into the action field, double-click on it to open the 'Action Editor' window. This action is used to automatically send an email at a specific position in the workflow. The email can be sent to users in the workflow (even if they are 'variable users') and there is always a 'CC' field available.

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

(1) Subject
This will be the subject line of the email notification.

(2) Text (with Variables)
Here you can write the body text of the email. You can use variables to ensure that the text will be correct, even if the same workflow is re-used in multiple projects or jobs. Variables are inserted at the cursor's location in the 'Text' field.
More information about the variables is available in the appropriate section of the knowledge base. In all cases, 'document' refers to the document with the workflow applied to it.

(3) Recipient(s)
There are four options to choose for the email recipients:

  • specific: You will need to provide at least one specific email address in the 'To' field.
  • Step users: The email will be sent to all users assigned to the current workflow step. This option should not be used in the 'Steps Completion' area, as there are no users assigned to it.
  • Document owner: The owner of the document (i.e. the user that created the document in one2edit™) will receive the email.
  • Workflow starter: The email will be sent to the user who started the workflow. If a one2edit™ Template was used to start the workflow, the 'workflow starter' is the user who clicked 'Start' for that Template.

No matter what option you choose, it is always possible to add supplementary email addresses to the "CC" field.

Workflow Action - Trigger Webservice

After dragging the 'Trigger Webservice' action into the action field, double-click on it to open the 'Action Editor' window. This action is used to trigger an API call in either one2edit™ or a third-party system.

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

(1) 'URL'
The URL field contains the target URL for the webservice 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 webservice 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 webservice.
  • 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.
More information about the parameters is available in the appropriate section of the knowledge base.

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. This API also requires that the parameters be sent using the GET method (as opposed to 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.

Deleting a Workflow Action

Any action that has been added to a workflow can, of course, also be deleted. In order to delete a 'Workflow Action', click the '-' button which is set next to each action. Whenever a 'Workflow Action' is deleted from a 'Workflow Step', a 'Question' message occurs, requiring another approval before deleting the action.

NOTE:
A 'Workflow Step' does not need to contain ANY 'Workflow Action'. Each 'Workflow Step' functions as long as there is a user assigned to it.

Example: 1io Recipe Inc.

Here you can see an example of our 1io Recipe Inc. workflow tracks, adjusted to our needs:

(1) 'Actions'
Several actions were assigned within each 'Workflow' track:

  • 'Email Notification': For our 1io Recipe Inc. workflow, we placed 'Email Notification' actions in the 'Start' position of each workflow step. This will mean that each user in this workflow will receive an email as soon as there is a job ready for him/her. For Jane and Paul, the job will be available as soon as the workflow starter clicks the 'Play' button. For the reviewers, the job becomes available as soon as content from the previous step is sent onwards.
  • 'Trigger Webservice': In the example above, we inserted 'Trigger Webservice' actions in the 'Running' position of each workflow step. This action can be used to trigger a web service call so that, for example, workflow progress can be linked to an external project management system. In our case, information will be sent to an external system when a step user opens their job for the first time (because that is when the 'Running' action is triggered).

(2) 'Steps Completion'
When both workflow tracks have been 100% completed, the entire workflow will be complete. That's when any action assigned to the 'Steps Completion' area will be executed. In this case, a high-resolution PDF will be exported, and an associated download link sent by email.




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


top