Changes

Jump to: navigation, search

Workflows Overview

48 bytes removed, 19:50, 29 May 2019
no edit summary
=Configuring Configuration – Essentials=
==Create Workflow==
First create and configure the workflow.
For Workflows select the desired work flow (all workflows of the Type File will be displayed) and click save.
=Configuring Configuration – Advanced=
==Suppress Workflow Window==
When a workflow step is executed the user is generally presented with a Workflow window where they can select a value that will be used to determine the next task to be performed.
::* '''Activity Amount''': Level 2 field used to store the calculated amount for each record. If 'N/A' is selected, the Level 2s will be created without an amount.
::* '''Activity Index''': Level 2 field used to store the index number of each record. If 'N/A' is selected, the Level 2s will be created without an index number."
 
: If '''Schedule by Number of Activities''' option is selected then following settings are exposed.
::* '''Number of Activities''': Level 1 field used to set the number of activities to be created
::* '''Activity Index''': Level 2 field used to store the index number of each record. If 'N/A' is selected, the Level 2s will be created without an index number."
:* '''Days Delay''' - Number in days of delay before creation of new activity. If left blank, the new activity will be created immediately.::* '''Create for Users in UTA Role''' - select the UTA Role of the users that the Peer Activity should be created against.::* '''Activity Type''' - This is where you specify which Level 2 Type you wish to create. If you select the Custom Field option then a Custom Field ID field is exposed.::* '''Custom Field ID''' - The Create New Activity workflow can be driven by a Custom Field. For example, you could have check boxes at Level 1 corresponding to various Level 2 Types. Selecting each check box would create and attach the relevant Level 2 activity type. You must first create a Custom Field on the Level 1 record which stores the typeid(s) of the Level 2 Types to be created. To create multiple Level 2 records use one of the Select many field types (e.g. Select Many – Check Boxes, Select Many – Scrolling Check Box, Select Many – List Box) and to create a single Level 2 record use the Select One – Combo Box.::* '''Activity Status''' - Allows you to define the Status for the newly created Level 2 record(s). Note: If that Level 2 Status has a workflow attached to it the workflow will be triggered at the point of creation of the Level 2 record.::* '''Reminder Type''' - You can select whether a Quick Message or reminder email will be sent out to the Owner or contacts attached to the record, or any combination of the above.::* '''Reminder Days''' - Sets delay for reminder message being sent.
:
===Task Type: Generate PDF File===
Auto generation of a PDF that can be:
:::::* E-mailed to the person(s) designated in the workflow step.:::::* Stored within a Multiple Files Custom Field.
The PDF generated must be based upon a Web Page View Custom Field. You must specify the Custom Field ID of the Web Page View to be converted in the Web Page Field ID field on the Workflow Task settings.
:
Multiple PDFs can be created and stored in a single Link - Multiple Files custom field using this workflow task type, by entering the Custom Field IDs of the Web Page View fields, separated by commas.
Generate PDF File Tasks have the following settings:
::* '''Name''' - Narrative name for the task.::* '''Task Type''' - manually set to Create Consumer/Provider Link::* '''Task Number''' - A system generated number that determines the presentation order of the task in the workflow. This number can be changed to display the step in a different location.::* '''Description''' - Detailed description of the task (optional).::* '''Expire After''' - Intended duration of the workflow.::* '''Web Page Field ID''' - Must contain the Custom Field ID of the Web Page View to be converted into PDF format. To create multiple PDFs, enter the Custom Field IDs of the Web Page View fields in the Web Page Field ID# setting of the Workflow Task, separated by commas.::* '''Store to Field ID''' - If PDF file should also be stored to the record, must contain the Custom Field ID of the relevant Link - Multiple Files custom field.::* '''PDF Render Language''' - If a language is specified, the language option will be applied to the PDF generated::*::* '''Message Template: Message Type''' - Type of message – e-mail, instant message, both, or none required with this task. E-mail and instant messages can be created using variables that will create custom messages specific to instances of the workflow. Options are No Message Required (default), Quick Message, Email Only and Quick Message and Email.
{{Template:WorkflowMessageTemplate}}
::* '''Routing: Use Variable for Recipients''' - Allows recipients of the message to be selected using variables. See this article for configuration details.
::* '''Routing: Use UTA Role''' - When using roles to select recipients, the UTA Role can be used to determine recipients.
::* '''Routing: Role''' - Used to select recipients by role.
::* '''Routing: Selected Users''' - If required, specific users can be selected to complete this task. This technique restricts the number of users that the initiator can select.
::* '''Routing: Routing Options''' - Specifies the types of options available to process this workflow step. In many instances, the default options can be used, such as Approved, Rejected or Revise. But additional and alternate sets of options can be created to reflect more complex business processes.
:* '''Routing: Use Variable for Recipients''' - Allows recipients of the message to be selected using variables. See this article for configuration details.:* '''Routing: Use UTA Role''' - When using roles to select recipients, the UTA Role can be used to determine recipients.:* '''Routing: Role''' - Used to select recipients by role.:* '''Routing: Selected Users''' - If required, specific users can be selected to complete this task. This technique restricts the number of users that the initiator can select.:* '''Routing: Routing Options''' - Specifies the types of options available to process this workflow step. In many instances, the default options can be used, such as Approved, Rejected or Revise. But additional and alternate sets of options can be created to reflect more complex business processes. 
===Task Type: PDF Merge===
Will convert [[Custom Field Type: Special – MS Word Merge|Word Merge]] document to a PDF which can then be:
:::::* E-mailed to the person(s) designated in the workflow step.:::::* Stored within a Multiple Files Custom Field
:
The PDF generated must be based upon a [[Custom Field Type: Special – MS Word Merge|Word Merge]] Custom Field. You must specify the Custom Field ID of the MS Word Merge document to be converted in the MSWord Merge Field ID field on the Workflow Task settings.
Generate PDF File Tasks have the following settings:
::* '''Name''' - Narrative name for the task.::* '''Task Type''' - manually set to Create Consumer/Provider Link::* '''Task Number''' - A system generated number that determines the presentation order of the task in the workflow. This number can be changed to display the step in a different location.::* '''Description''' - Detailed description of the task (optional).::* '''Expire After''' - Intended duration of the workflow.::* '''MSWord Merge Field ID''' - Must contain the Custom Field ID of the Web Page View to be converted into PDF format. To create multiple PDFs, enter the Custom Field IDs of the Web Page View fields in the Web Page Field ID# setting of the Workflow Task, separated by commas.::* '''Store to Field ID''' - If PDF file should also be stored to the record, must contain the Custom Field ID of the relevant Link - Multiple Files custom field.::* '''PDF Render Language''' - If a language is specified, the language option will be applied to the PDF generated::*::* '''Message Template: Message Type''' - Type of message – e-mail, instant message, both, or none required with this task. E-mail and instant messages can be created using variables that will create custom messages specific to instances of the workflow. Options are No Message Required (default), Quick Message, Email Only and Quick Message and Email.
{{Template:WorkflowMessageTemplate}}
::* '''Routing: Use Variable for Recipients''' - Allows recipients of the message to be selected using variables. See this article for configuration details.
::* '''Routing: Use UTA Role''' - When using roles to select recipients, the UTA Role can be used to determine recipients.
::* '''Routing: Role''' - Used to select recipients by role.
::* '''Routing: Selected Users''' - If required, specific users can be selected to complete this task. This technique restricts the number of users that the initiator can select.
::* '''Routing: Routing Options''' - Specifies the types of options available to process this workflow step. In many instances, the default options can be used, such as Approved, Rejected or Revise. But additional and alternate sets of options can be created to reflect more complex business processes.
:* '''Routing: Use Variable for Recipients''' - Allows recipients of the message to be selected using variables. See this article for configuration details.:* '''Routing: Use UTA Role''' - When using roles to select recipients, the UTA Role can be used to determine recipients.:* '''Routing: Role''' - Used to select recipients by role.:* '''Routing: Selected Users''' - If required, specific users can be selected to complete this task. This technique restricts the number of users that the initiator can select.:* '''Routing: Routing Options''' - Specifies the types of options available to process this workflow step. In many instances, the default options can be used, such as Approved, Rejected or Revise. But additional and alternate sets of options can be created to reflect more complex business processes. 
===Task Type: People Association===
You can use the People Association Workflow Task Type to automatically add one or more contacts to a Level 1 record. They will be assigned to the record with the UTA role defined in the "Roles will be assigned" setting.
People Association have the following settings:
::* '''Name''' - Narrative name for the task.::* '''Task Type''' - manually set to People Association::* '''Task Number''' - A system generated number that determines the presentation order of the task in the workflow. This number can be changed to display the step in a different location.::* '''Description''' - Detailed description of the task (optional).::* '''Expire After''' - Intended duration of the workflow.::* '''Action''': Add, update or delete the people association::* '''Routing: Use Variable for Recipients''' - Allows recipients of the message to be selected using variables. This is discussed in greater detail in the Configuration – Advanced section.::* '''Routing: Use UTA Role''' - When using roles to select recipients, the UTA Role can be used to determine recipients.::* '''Routing: Role''' - Used to control role of user that will be associated.::* '''Routing: Selected Users''' - If required, specific users can be selected to be associated::* '''Roles will be Assigned''' - select the role(s) that you want the contact(s) to be associated with. To assign different contacts with different roles, you will have to create more than one People Association task.
In the Routing section select a Role currently possessed by the contact(s) you wish to add, whether this is a system role or a UTA role. You can then either select specific contacts or groups that will always be added to the Level 1 when the workflow is triggered, or you can choose Let current user select target user from this role to allow the person that triggers the workflow to select a contact to be added.
Note:
::** If you are allowing the current user to select target user Suppress Workflow Window must be off (not enabled) otherwise the workflow will not fire.::** If you are allowing the current user to select target user, the Workflow must be triggered by a status, and not by a script.::** Include a description, as the description will be presented to the user when they are asked to select the contact to be assigned.
In order to notify the contact(s) that they have been assigned you can create a subsequent Acknowledgement Workflow Task to e-mail all contacts with the UTA role you selected.
** Sensitivity={personal,private,company,confidential}
*: e.g. Priority=urgent;Importance=high
*
** '''Message Template: Endpoint''' - The URL or IP address of the destination server
** '''Message Template: Envelope Template''' - The content of the Web Service message to be sent to the external service. This can contain variables related to the object the workflow is triggered against.
:: <span style="font-size: small;">&lt;![CDATA[ '''''CONTENTS''''' ]]></span>
 
For example, an address could contain ampersands, so it should be wrapped as follows:
<pre><primarycontact> <firstname>@firstname@</firstname> <lastname>@lastname@</lastnamepre> <address><![CDATA[@address@]]> </address></primarycontact></pre>
If the response to your Web Service call contains values that you wish to store within a Custom Field on the object against which the Workflow was triggered, you can connect a Update Custom Field Value Workflow Task to be the task following the Web Service - SOAP Message and use the variable syntax to pull the value from the XML Custom Field you selected to store the response to the Web Service call.
FROM: Authorization=Basic c3NcUyVzZXI6SzhAtHVuY2g<span style="color: #ff0000;">'''='''</span><br/>
TO: Authorization=Basic c3NcUyVzZXI6SzhAtHVuY2g<span style="color: #ff0000;">'''%3D'''</span>
 
====Parsing JSON response====
<!--67458 - Add GET/POST REST services workflow tasks that are compatible with JSON-->
Example:
 
_triggerwf('@opportunityid@',98765);
Example:
 
_triggerwf('@eventid@',98765,26);
2. Click the '''Task type''', '''File''' link. The Workflow step is displayed with the following fields in the request:
 
* '''Task Name''' – The name of the [[Workflow|workflow]] task.
* '''Created Date''' – The date the task was triggered.
2,299
edits

Navigation menu