Box - New folder
Use the Box - New folder start event The connector and event for triggering the workflow to run, including required configuration. An example is Box - New file, which triggers the workflow to run when a new file is uploaded to the specified folder. to start your workflow whenever a new folder is created at a path you specify in your Box account. For more information about the Box start events, go to Box start events.
Box has other actions as well. For more information, see Connectors.
Before you begin:
-
Understand the Start event configuration panel
-
Understand Variables
-
Learn about Handling files in your workflow
Jump to:
Select the Box - New folder start event
- At the top of the designer canvas on the Designer page, click Start event to open the Start event configuration panel.
- In the Start from drop-down list, select Box.
-
For Event, select Box - New folder.
Additional fields appear. To configure, see Configure the start event.
Configure the start event
During configuration of the Box - New folder start event, you can select the folder path for monitoring, add provided 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 store information about the new folder for use later in the workflow, and set conditions, such as requirements for the folder name or creation date. We recommend configuring the start event to start the workflow only when a particular condition exists.
In the Start event configuration panel:
- Find the Source section.
- Select a Connection. If you do not have a connection, see Add a connection.
-
For Path, type the path to the folder that contains the new folders to monitor. Example: /Draft. This value is case-insensitive. Do not add a trailing slash (as in "/Draft/").
For more information on the fields and buttons, see Box - New folder start event fields by section.
-
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 .
- Name: The folder name. Text variable.
- Folder ID: The Box GUID for the folder. Text variable. Example: 48357280114.
- Path: The full path of the new folder. Text variable. Example: /Draft/MyNewFolder.
- Created date: The date when the new folder was added to the folder path in the Box account for the selected connection.
- Created by (email): The email address of the person who created the new folder. Text variable.
- Created by (display name): The friendly identifier of the person who created the new folder. Text variable.
For more information on the fields and buttons, see Box - New folder start event fields by section.
We recommend configuring the start event to start the workflow only when a particular condition exists.
- 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.
For more information on the fields and buttons, see Box - New folder start event fields by section.
Maintain path integrity
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.
Section |
Field |
Description |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Show variables |
Displays variables that are available to use throughout the workflow. Variables are classified based on how they are created or generated. Show variables fields and selections
|
|||||||||||||
Source | Connection |
The Box connection to use for the start event. |
||||||||||||
Path |
The folder path to monitor for new folders. Type the folder path. Example: /Draft. This value is case-insensitive. Do not add a trailing slash (as in "/Draft/"). |
|||||||||||||
Add variables |
Displays selections for browsing, selecting, and adding variables to use throughout the workflow. For example, if you want to send an email later in the workflow to the person who added the folder, then select the variable Created by (email). Add variables selection
The following informational elements related to the new folder that start the workflow are available:
|
|||||||||||||
Conditions |
Add condition |
Displays fields for defining a new condition. |
||||||||||||
|
When |
The start variable the operator compares with the value. The File variable can't be used in conditions. |
||||||||||||
|
Operator |
How the When variable and Value are compared. Select from the drop-down. The operators available in the drop-down depend on the When variable type. Example: in the condition 'created date is after 2018-05-02, 12:49 PM. ', the operator is 'is after'. |
||||||||||||
|
Value |
The text or variable that the operator compares with the When variable. Type to enter text. The variable type must match the When variable type. Example: in the condition 'created date is after 2018-05-02, 12:49 PM. ', the value is 2018-05-02, 12:49 PM. |
||||||||||||
|
Add |
Saves the condition to the start event. |
||||||||||||
|
Cancel |
Discards the condition you are editing. |
||||||||||||
|
all/any |
If you select:
|
||||||||||||
|
(Edit condition) |
Redisplays condition fields for editing. |
||||||||||||
|
(Delete condition) |
Deletes the indicated condition. |