Do the following in the Workflow Variables pane to create the variable:
- For Name, type the variable name you want to use.
- Select a Type.
- If you want to display the variable on the start form, select the Show on start form check box.
- Click Create.
- On the toolbar of the Designer page, click Variables . The Variables dialog box appears.
- Click New and fill in the following:
- For Name , type the variable name you want to use.
- For Type , select a variable type corresponding to the type of data you want to store.
- If you want to specify the variable as a start variable, select the Initiation check box.
- Click to specify the Initiation options Initiation options control the display and behavior of the variable on the start form that is displayed when a workflow is started manually. .
- Click Save.
The following table describes the variable types available in the Variables dialog box as well as their initiation options, which are available when you select Yes for Initiation. Initiation options control the display and behavior of the variable on the start form that is displayed when a workflow is started manually.
Variable type | Description |
Underlying .NET data type: System.String.
- Multiple Lines: When selected, allows multiple text lines in the default value.
- Description: Text to display under the text box on the start form. Example: "Enter new name".
- Default value: Default value for variable.
Yes or No value.
Underlying .NET data type: System.Boolean.
- Description: Text to display under the check box on the start form. Example: "Enable?"
- Default value: Default value for variable: Yes (true) or No (false).
Date and time value.
Underlying .NET data type: System.DateTime.
- Description: Text to display under the text box on the start form. Example: "Select the date needed by".
- Default value: Default value for variable: None or Today's date.
- Allow blank values?: When selected, allows the start form to be submitted without specifying a value for the variable.
- Display format: Display format for variable: Date and time or Date only.
Globally unique identifier, often used to reference a list item in SharePoint .
Underlying .NET data type: System.Guid.
Numeric with a Decimal value.
Underlying .NET data type: System.Double.
- Description: Text to display under the text box on the start form. Example: "Specify quantity".
- Default value: Default value for variable. Can be selected or entered.
Numeric without a decimal.
Underlying .NET data type: System.Int32.
A value that requests a selection from a list of allowed values. The value selected by the workflow initiator is stored in the variable.
Underlying .NET data type: System.String.
- Description: Text to display under the drop-down list on the start form. Example: "Select the product"
- Choices: Choices available in the variable. Enter each choice on a separate line.
- Default value: Default value for variable. Enter one of the specified choices.
A value that requests a selection from a user lookup. The item selected by the workflow initiator is stored in the variable.
Underlying .NET data type: System.String.
- Description: Text to display under the text box on the start form. Example: "Select your manager"
- Allow selection of: Scope of allowed selection: People Only or People and Groups.
- Choose from: Source of selection: All Users or SharePoint Group. Use the drop-down list to select a SharePoint group.
- Allow blank values?: When selected, allows the start form to be submitted without specifying a value for the variable.
- Allow multiple values?: When selected, allows entry of multiple values.
A value that requests a hyperlink URL and description.
Two text boxes are provided:
- Type the Web address
- Type the description
The values entered by the workflow initiator are stored in the variable.
Underlying .NET data type: System.String.
- Description: Text to display under the "Type the description" text box on the start form. Example: "Enter a display value for the URL"
- Allow blank value?: When selected, allows the start form to be submitted without specifying a value for the variable.
A container that holds a single logical unit of variables. For more information, see Dictionary variables.
Underlying .NET data type: Microsoft.Activities.DynamicValue.
An index-based array of values, also known as an ordered list of values. For more information, see Collection variables.
Each field that accepts variables accepts one or more methods for inserting variables. The method available differs depending on the field.
Available methods are given below:
- Click on the field and select an existing variable from the drop-down list for the field.
- Click on the field, click Create New Variable, and fill the following fields in the Workflow Variable pane that appears:
- For Name, type the variable name you want to use.
- Select the Show on start form check box if you want to display the variable on the start form.
- Click Create.
- Click on the field, select Workflow Variables or Workflow Context, and select a variable from the corresponding drop-down list.
Metadata columns for the item the workflow is associated with. Available only for list workflows.
Context variables that represent data related to the current workflow instance, such as current item or site URL and workflow name.
- Current item URL: The URL of the item the workflow is associated item. Available only for list workflow actions.
- Current site URL: The URL of the site the workflow is associated site.
- Initiator login name: The login name of the person who started the workflow instance.
- Initiator display name: The display name of the person who started the workflow instance.
- Initiator email address: The email address of the person who started the workflow instance.
- Instance ID: The unique identifier of the workflow instance.
- List ID: The unique identifier of the list the workflow is associated with. Available only for list workflow actions.
- List Name: The name of the list the workflow is associated with. Available only for list workflow actions.
- Manager login name: The login name of the manager of the initiator (the person who started the workflow instance).
- Manager display name: The display name of the manager of the initiator (the person who started the workflow instance).
- Manager email address: The email address of the manager of the initiator (the person who started the workflow instance).
- Publish user: The person who published the workflow.
- Workflow name: The name of the executing workflow.
You can configure variables to collect data when a workflow is manually started. These variables will be shown on a start form used to initiate the workflow and allows users to specify a value for the workflow variable before the workflow starts, basically passing values into the workflow before it starts.
Variables displayed on a start form are also known as the "start data" of the workflow and represent data that must be collected when the workflow is started.
Note: If the workflow starts automatically, then default values are used for start data.
To learn how to manually start a workflow, see Start a workflow manually.
Configure a variable to show on a workflow start form:
- Open the required workflow. The workflow designer opens.
- On the toolbar, click Variables. The Variables window opens.
- To edit an existing variable, click the required variable. The row becomes editable. or
To create a variable, click New on the Variables window toolbar, enter a Name, and select the Type for the variable.
- If you want to configure initiation options, click to open the Initiation options dialog box, make the changes and click OK. For more information about the fields, see User-defined variable types and Initiation options.
- Click Save to commit changes.
- ip4: 149.72.205.150
- ip4: 149.72.211.139
Add and configure the Send an email action
- Click the User Interaction action group in the action toolbox. or Type the action name or function in the Search field at the top of the action toolbox.
- Drag the Send an email action to the point in the workflow where you want to send an email.
- Open the Action Configuration window. For steps on how to open the Action configuration window, see Action configuration window
- In the To field, type the Recipient email addresses.
- Type the Subject of the email.
- Type the Message Body of the email.
- Click Save.
For more information on the fields and buttons, see Send an email fields, buttons, and settings.
Email addresses of recipients to send the email message to. To enter do one of the following in this field:
Email addresses for the CC line on the email message that the action sends. These recipients will receive a read only copy of the email and are not able to respond to the tasks.
To enter do one of the following in this field:
Email addresses for the Bcc line on the email message that the action sends. BCC recipients are not able to respond to the tasks. Other recipients of the email will not be able to see any addresses in the BCC field.
To enter do one of the following in this field:
Subject of the email message sent by the action.
Email Service
Options to select the email service.
- Internal email: To send emails to accounts inside your tenancy using the email service native to Office 365 .
- Email service: Microsoft Office 365.
- Reply-to address: no-reply@sharepointonline.com (cannot be changed).
- Attachments: Not supported.
- Email service: External email service configured by Nintex .
- Reply-to address: The reply to address differs depending on the location of the tenant data center:
- West United States: noreply@workflownotification.com
- Northern Europe: noreply@neu.workflownotification.com
- Japan: noreply@jae.workflownotification.com
- Australia: noreply@aus.workflownotification.com
- When the Send an email action uses external configuration in the Email service field, the action may execute on servers running outside your data center Centralized locations used to house servers used by Nintex for remote storage, processing, or distribution of data. Nintex has a number of regional data centers available for Nintex for Office 365. For information about Nintex data centers and where your data center is located, contact your Nintex account or territory manager. region. Before implementing, consider performance and regional concerns where digital boundaries are an issue. For more information, see In-tenant and external actions.
- Nintex for Office 365 leverages the following services when sending emails and notifications depending on the selection made in the Email service field of the action configuration:
- SharePoint email services: to send internal emails and notifications to accounts within the same tenant.
- SendGrid: to send external emails and workflow notifications. The IP addresses used by SendGrid are:
- ip4: 149.72.205.150
- ip4: 149.72.211.139
(This becomes configurable only when External email and attachment option is selected).
The email address the recipient can respond to. To enter do one of the following in this field:
Sender display name
The From name displayed in the email sent by the action.
The sender display name is followed by the default sender. For example, if your Sender display name is "Marketing Team" and the default sender is nintex@workflowcloud.com, the From field in the email displays: Marketing Team .
If you do not enter a sender display name then the email only shows the default sender in the From field.
Email Attachments
(Available only when the External email and attachment option is selected in the Email service field).
Allows file attachments to be added to the email from a list or document library on the current site.
The option available depends on from where the workflow is opened as given below;
For list workflows opened from a list: Select the Include current item attachments check box to include all attachments for the current item in the email. This check box is only available for workflows opened from a list.
You can also add a site relative URL to an attachment in the current site.
- For list workflows opened from a document library: Select the Attach file from workflow check box to upload the file to a document library / folder. This check box is only available for workflows opened from a document library.
- For site workflows opened from site contents: Add the site relative URL to an attachment in the current site.
- Navigate to the document library containing the file, for example, a spreadsheet (.xls).
- Click for the item you want to attach. An options menu appears.
- Select Copy Link.
The site portion of the link must be removed. See the example below:
Link copied: https://abc.sharepoint.com/sites/test2/Shared%20Documents/TestLink.docx
Portion to remove from copied link: https://abc.sharepoint.com/sites/test2/
URL example to paste in Email attachments field: Shared%20Documents/TestLink.docx
Body of email message sent by the action. Click in the body area to enter or edit the content.
Use the Rich Text editor to display formatted text, pictures, hyperlinks and HTML in a workflow action. Click in the email body area to enter or edit content.
- Due to some security enhancements done to the rich text editor some HTML tags are no longer supported. For more information, see HTML tags not supported .
- If no font is specified, then font is inherited from the platform used. For example, if an email is sent using Outlook, then its default font is used (typically Times New Roman).
- On the toolbar of the email body frame, click . A section appears below the email body frame.
- Specify the URL and hyperlink text. To reference the task URL, select URL from the Task Properties section of the Insert Reference pane.
To reference the current item ID (for a list workflow), select Item ID from the Task Properties section of the Insert Reference pane. For example, the following image shows the URL field set to the current site URL reference and the Hyperlink Text field set to the phrase "Item ID" plus the ID reference.
For more information about how to use Lookups in configuration fields, see Lookups in action configuration fields.