Start event configuration panel
In the Start event configuration panel, you can configure when or how your workflow starts. You can specify connections, select variables to add to your workflow, and set conditions. The panel appears when you click on the Start event on your designer canvas.
Open the Start event configuration panel
-
Open the Designer canvas.
-
If the Start event configuration panel does not open automatically, click Start event on the canvas.
If invalid variables are detected, a message is displayed at the top of the Start event configuration panel. It can be due to changes that have been made to the start event, such as:
-
The start event configuration may have been changed.
-
The start event may have been changed completely. For example, the start event connector changed to a new connector or changed from a connector to a Nintex event.
-
The source configured in the start event configuration may have been changed or deleted. For example, after a workflow is configured to start when a new item is added to a SharePoint list, a column in the SharePoint list is deleted or the list is deleted.
If you see this message it is recommended that you update the variables. You can update the variables or delete them as required in the Variables panel.
If there are invalid references they will be deleted when the workflow is published. Deletion of variables may result in unconfigured actions and you will have to update the configuration of the impacted actions.
Configure the start event
Configure your workflow to start when an event occurs in Nintex or in one of your connections. For example, a workflow can be triggered to start when a new file is uploaded to your Box account.
Caution: After you have selected and configured your start event and you begin designing the workflow and using start event variables in any of your actions, you can no longer change Start from and Event.
In the Start event configuration panel:
- In Start from, select a connector A software component that allows seamless integration with third-party services, business applications, and content stores. Examples include Salesforce, Box, and Microsoft SharePoint. Connectors are used to create connections required for workflow actions and start events. or a Nintex start event that will trigger the start of the workflow.
- If you chose your workflow to Start from a connector, select an Event.
-
Complete the new fields that appear.
-
For Connection, select an existing connection from the drop-down list or click Add connection to create a new connection.
Example: To create a Microsoft OneDrive for Business connection-
In the drop-down list for Connection, select Add connection.
-
Type a Connection name.
- Type your OneDrive Tenant URL.
- Click Connect.
-
Enter credentials, if prompted.
Upon successful log in, you are prompted to grant or deny access to Nintex Automation Cloud.
- Click the option to grant access.
- Click Save permissions.
The entered name is validated for uniqueness. If credentials are not stored in the browser for the selected connector service, then you are prompted for credentials. For more guidance on connections, see Connectors.
A window appears where you can assign owner and user permissions to the connection. Add Owners and Users, if required.
Your newly added connection now appears in the Connection field.
-
-
If needed, complete the Path field (displayed for path-based connectors). If the folder browse icon () is displayed to the right of the field, then click it to navigate to the folder that you want. If no folder browse icon is displayed for the selected connector, then type the path, beginning with the root folder.
-
-
If needed, add or update start event variables A variable associated with the start event. Often referenced by actions in the workflow. For example, a start event variable might capture input in a form field. for your workflow design. Steps to add variables depend on the selected start event.
-
Third-party connector steps to add a start event variable
For most third-party start events, variables are automatically generated, but need to be added if you plan to use them later in the workflow design.
-
On the Designer canvas, click Start event.
-
Select a connector from the Start from drop-down list.
-
Select an event from the Event drop-down list.
- Click Add variables.
- Select the predefined variables that you want to add to your workflow. If you know the variable and you want to find it faster, type the variable name in the Filter options field. To select all variables, click Select All.
- Click Add.
Note: If you want to edit the selection of variables, hover over the variable, click , and then click Show Details. Edit the variable name in the Name field or click .
-
-
Nintex - Component workflow steps to add a start event variable (workflow input)
For Nintex - Component workflow, you can create your own variables to define workflow inputs Variable to store a value or file when the workflow starts. Set up as a start event variable..
-
On the Designer canvas, click Start event.
-
From the Start from drop-down list, select Component workflow.
- Click Create variable.
- If you have previously created a variable, click Create.
- Type a user-friendly Name for the new variable.
-
Select the variable Type you want.
Data types of variablesVariable type
Usage
Text String value, such as John. Decimal Decimal value, such as 1.2. Integer
Integer value, such as 1.
Boolean
Boolean value (Yes or No).
DateTime
Date or date and time value.
Collection
Set of files or array of values.
File
File.
-
Click Create.
Every start event variable is rendered as a workflow input and is available later in the workflow.
-
-
Nintex - Form steps to add a start event variable (form control A form part corresponding to a user-input field (such as a text field) or display-only item (such as a heading). accepting user input)
For Nintex - Form, start event variables are automatically generated for every user-input form field you add to the form.
-
On the Designer canvas, click Start event.
-
From the Start from drop-down list, select Form.
- Click Design form to open the forms designer.
-
Drag the control that you want onto the canvas. The control must accept user input for a start event variable to be generated.
- To change the internal reference name for the control:
- Click the control to open its configuration panel.
- In the configuration panel, update the value for the following fields:
Title
Name. Prior to updating the Name, toggle on Customize.
-
Close the configuration panel and forms designer.
A start event variable is listed corresponding to the added control. Its name (Name) reflects the internal reference name set up in the control configuration.
-
-
- If you want to cancel a start event variable from being added to the workflow, complete the following steps:
- In the Start event configuration panel, click Show variables.
- In the Start event tab, click the name of the variable indicated with (warning flag).
- Click and then click Resolve.
- In the dialog box that appears:
- To remove all workflow references to the deleted control, click Remove all.
- To update workflow references to point to another control, click Replace all and then select the variable associated with the control you want to use instead.
- Click Show variables.
- In the Start event tab, click the name of the variable.
- Click Delete.
-
Define or update one or more conditions for starting the workflow if applicable to your workflow design (available for third-party applications.)
- Find the Conditions section.
-
For each condition:
- Click Add condition.
- For When, select a start event variable. For example, select Created date for a new file.
- For Operator, select an operator for comparing the variable to the value. For example, select is before or on.
-
For Value, type or select the value to use for the comparison. For example, select 2017-12-31, 11:59 PM.
-
Type a Condition summary, if desired.
-
Click Add condition.
The condition is added to the start event.
- Select all or any to control how multiple conditions are evaluated.
Additional fields appear that you can use to configure your start event.
Note: To view start event variables that are available for use throughout the workflow, click Show variables in the start event configuration panel. This list of start event variables is populated once you have selected which variables to add to the workflow. For more information, see Show variables.
For a variable corresponding to a form field, open the forms designer to remove the related form control from the form.
When you go back to the Start event configuration panel, variables for deleted controls with workflow references are highlighted.
Variables available for replacement are limited to those of the same type.
Variables are available for you to select whether or not to pass to the workflow. If you want to cancel selection of a variable, complete the following steps:
Note: You cannot cancel selection of start event variables that are used in any actions in the workflow.
The variable is removed from the Start event tab. If you want to reselect the variable, click Add variables in the Start event configuration panel.
Your start event is configured when all required configuration fields are completed.
Section | Field (or column) | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Show variables |
Displays variables that are available to use throughout the workflow. Variables are classified based on how they are created or generated. Use the Start event tab to view the start event variables added to the workflow. Show variables fields and selections
|
|||||||||||||
|
Start from |
Lists the Nintex connector and third-party connectors, such as Salesforce and Dropbox Business. A warning message appears when one or more start event variables are referenced by actions within the workflow. The connector and event cannot be changed until the variables are no longer referenced within the workflow. |
||||||||||||
|
Event |
Lists events for the selected connector. |
||||||||||||
(varies) |
This section is displayed for additional configurations required for the selected start event. Fields displayed depend on the selected connector and event.
|
|||||||||||||
|
Add variables |
Displays the variables you can add to the workflow.
Add variables selection
|
||||||||||||
|
(Move) |
(Displayed for the Nintex Component workflow start event only.) Reposition the indicated start event variable. The order of start event variables determines the order of the associated fields in the generated form. |
||||||||||||
Conditions (available for third-party events) |
Add condition |
Displays fields for defining a condition under which to start the workflow. |
||||||||||||
|
When |
(Displayed after clicking Add condition.) The first value for the workflow start condition. Must be an available start event variable for the selected event. |
||||||||||||
|
Operator |
(Displayed after clicking Add condition.) The operator for the condition. Select an operator from the drop-down list. |
||||||||||||
|
Value |
(Displayed after clicking Add condition.) The second value for the workflow start condition. Must be an entered value. |
||||||||||||
|
Add condition |
Saves the condition with the defined condition fields. |
||||||||||||
|
all/any |
all: Starts the workflow when all conditions are true. When selected, conditions are separated by "AND." any: Starts the workflow when any single condition is true. When selected, conditions are separated by "OR." |
||||||||||||
|
(Edit condition) |
Redisplays condition fields for editing. |
||||||||||||
|
(Delete condition) |
Deletes the indicated condition. |
||||||||||||
Configuration | Give form access to |
Specify who can access the form. Choose from one of the options below:
|
||||||||||||
This form is available as |
Specify how the form is accessed. Choose one or more of the options below:
|