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

1. Go to Workflows > All workflows.

2. Open the Workflow designer:

   1. New workflow: Click Create workflow.

   1. Existing workflow: Select the workflow you want from the Workflows page.

3. If the Start event configuration panel does not open automatically, click Start event on the designer canvas.

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.

1. Open the Start event configuration panel. For more information, see Open the Start event configuration panel.

2. 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 and agentflow actions and start events. or a Nintex start event that will trigger the start of the workflow.

   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.

3. If you chose your workflow to Start from a connector, select an Event.

The Configuration section is displayed to configure the start event.

4. Create and add variables that can be passed as parameters in the HTTP call to start the workflow. To view existing variables, see View start event variables. To create new variables in component and orchestration start events, see Create start event variables.

5. If you are configuring a connector start event, select a Connection. If you do not have a connection, see Add a connection.

6. If you are configuring a path-based connector start event, enter the Path to the connector. 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.

   Caution: If a file/folder that's used in a workflow is moved, renamed, or deleted, any workflows that use that file/folder will not start or will fail. Make sure you keep the paths in your workflow configurations up to date.

7. (Optional) In Conditions, click Add condition to set conditions for the start event. Set conditions that start your workflow only when defined conditions are true. The Condition builder supports nested conditions, enabling you to create conditions within another condition. For fields and settings, see Condition builder.

   For each condition: 

   1. In When, select a start event variable. For example, select Name for a new file start event.
   2. In Operator, select an operator for comparing the variable to the value. For example, select Contains.

   3. If needed, in Value, type or select the value to use for the comparison. For example, type marketing.

   4. (Optional) Enter a Condition summary.

   5. Click Add condition.
   6. Select all or any to control how multiple conditions are evaluated.

8. Complete other fields as required.

Your start event is configured when all required configuration fields are completed.

View start event variables

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. are automatically added to the workflow. They are passed as parameters in the HTTP call to start the workflow.

At the top of the Start event configuration panel, click Show variables. The list of start event variables is populated.

Alternatively, click Hide variables to hide them.

To create variables to use in component and orchestration start events, see Create start event variables.

The start event variables in connector start events are contained in an object called Start variable. The start event variables in Form start events are contained in an object called Workflow initiator.

Create start event variables

You can create 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. to use in component and orchestration start events.

Start event variables are automatically added to the workflow. They are passed as parameters in the HTTP call to start the workflow.

1. Open the Start event configuration panel. For more information, see Open the Start event configuration panel.

2. Click Create variable.

3. If you have previously created a variable, click Create.

Tip: Click Reorder to reorder the list of variables. The order of start event variables determines the order of the associated fields in a generated form.

4. Enter a user-friendly Name for the new variable.

5. Select the variable Type.

   Data types of variables

   Variable 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.

6. Click Create.

7. Close the Variables panel after creating variables.

Start event configuration panel fields and settings

Section	Field	Description
Start event	Show variables	(Not available in scheduled start events.) Displays variables that are available to use throughout the start event. Variables are classified based on how they are created or generated. Show variables fields and selections Selection Description Name Internal name to identify your variable within the workflow or start event. Type The data type of your variable. You can assign only the variable type that a workflow or start event expects. For example, if you want to capture a Date entry in a form, then you must create a variable of the DateTime type. Used in Indicates the number of workflow actions using the variable. Delete Cancels adding the variable to the workflow. You cannot cancel the selection of start event variables that are used in any actions in the workflow.
	Hide variables	(Not available in scheduled start events.) Closes the Variables pane.
(unlabeled)	Start from	The connector or Nintex event that starts the workflow.
	Event	(Only available in Tables and connector start events.) The event that must occur in the selected connector to trigger the workflow.
(unlabeled)	Create variable	(Only available in component and orchestration start events.) Creates variables that can be passed as parameters in the HTTP call to start the workflow.
Configuration	Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.	(Only available in connector start events.) The connection to use for the start event. To add a connection, select Add connection. To refresh the available connections, click .
	Path	(Only available for path-based connector start events.) Path to connector. 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. Caution: If a file/folder that's used in a workflow is moved, renamed, or deleted, any workflows that use that file/folder will not start or will fail. Make sure you keep the paths in your workflow configurations up to date.
	Entity or object selection field	(Only available for some connector start events.) Example selections include the Campaign entity for Microsoft Dynamics CRM or the Account object for Salesforce.
	Allow concurrent workflows on a single item	(Only available for some connector start events.) When enabled, allows multiple instances of this workflow to run on the start event item. For example, an instance is allowed to run on an updated Account object (Salesforce) or Campaign entity (Microsoft Dynamics CRM) even if another instance is already running on the same item. Default setting: Disabled
	Give form access to	(Only available in Form start events.) Specify who can access the form. Choose from one of the options below: Authenticated users in this tenant - Users who can access the tenant with a Participant user role. Anyone with the form URL - Users who have access to the URL to the published form.
	This form is available as	(Only available in Form start events.) Specify how the form is accessed. Choose one or more of the options below: URL - The form is available only when a user clicks the form URL. Nintex Mobile and My Nintex - The user must sign in to Nintex Mobile or My Nintex to view the form.
Conditions	Add condition/Edit condition/Delete condition	(Only available in connector start events.) Displays the condition builder to define new conditions or edit or delete existing conditions. Add condition - Displayed when there are no existing conditions specified. Edit condition - Icon displayed when there are existing conditions set. You can edit the condition. Delete condition - Icon displayed when there are existing conditions set. You can delete the condition. The Condition builder supports nested conditions, enabling you to create conditions within another condition. For fields and settings, see Condition builder.