Publish an agentflow
Important: Agents is currently in private beta and is not yet available to all customers.
Publishing a agentflow makes it available to run when the configured start event An event that triggers a workflow to run when it occurs. An example is Box - New file, which triggers the workflow to run when a new file is uploaded to the specified folder. occurs. When you publish, you decide if the agentflow is counted against your agent subscription license as production or development. The Status column on the agentflows page indicates the status of the agentflow. The status of published agentflows is shown as Published in the agentflows page.
Jump to:
Request to publish a production agentflow
Publishing production agentflows may be restricted to certain roles or groups, using the agentflow publishing setting in agentflow settings. Global Administrators and Automation administrators can configure the agentflow publishing settings to select users who can publish production agentflows.
If you don't have permission to publish a production agentflow, the Request publish option will be displayed when you select Production as the Assigned use. You must submit a request to it.
-
Global administrators and Automation administrators can always publish production agentflows.
-
This only applies to production agentflows. Development agentflows can be published by all designers and developers.
When a publish request is sent for a agentflow:
-
The Status of the agentflow is displayed as Publish requested in the agentflows page and you can identify the agentflows waiting to be published via the status. If you have permission to publish agentflows, you can open the agentflow and publish it. When a agent is published, the status of the agentflow changes to Published.
-
An email notification is sent to the members of the groups if the relevant option is selected in the agentflow publishing page.
Publish an agentflow
-
Go to Agents > All agents.
-
Click the agent in the agentflow list to open it.
- On the toolbar at the top of the Agent Designer, click Publish.
-
Enter the Agentflow name.
Note: The name must be unique and no more than 50 characters. Also, special characters (
/ ^ $ . | ? * + ( ) < > ! \ @ # % & , [ ] : ; =) are not allowed in agentflow names. A warning is displayed if there's another agentflow with the same name in the tenant. - (Optional) Complete the other fields as required. For more information, see Agentflow Publish dialog box fields.
Note: If you select Production as the Assigned use and you don’t have permission to publish production agentflows, the Publish button changes to Request publish and you must request for the agentflow to be published.
- Click Publish.
Publish a agentflow with a Publish requested status
You can easily identify the agentflows waiting to be published through the Status column on the agentflows page. agentflows marked with Publish requested status are pending review. If you have publishing permissions, you can open these agentflows and publish them directly.
Additionally, if the Send an email to everyone in these groups when a request to publish is submitted setting is selected in the Publish an agentflow settings of the tenant, an email is sent to users with publishing permission. This email includes a link to open the agentflows page in the Nintex Workflow tenant, where you can find the agentflow with the Publish requested status, review it, and proceed with publishing.
-
Go to Agents > All agents.
-
Find the agentflow you want to publish:
-
If you received an email about the publish request, click the link in the email. The agentflows page opens filtered to display the agentflows with the Publish requested Status.
-
Open the agentflows page and filter the agentflows by Status to find the agentflows with a Publish requested Status.
-
-
Open the agentflow.
Note: Ensure that you open the agentflow that has the Publish requested status and not the Published version.
-
On the toolbar, click Publish.
Cancel a request to publish
You can cancel a request to publish a agentflow before the agentflow is published.
-
Go to Agents > All agents.
-
Find the agentflow you want, then click
, and select Cancel request to publish. A confirmation message is displayed. -
Click Yes to confirm the cancellation.
The status of the agentflow changes to Draft and is displayed in the Status column on the Agentflows page.
Rename a published agentflow
-
Go to Agents > All agents.
-
Click the agentflow in the agentflows list to open it.
-
On the toolbar at the top of the Agent Designer, click Publish.
-
Enter the new Agentflow name.
Note: The name must be unique and no more than 50 characters. Also, special characters (
/ ^ $ . | ? * + ( ) < > ! \ @ # % & , [ ] : ; =) are not allowed in agentflow names. A warning is displayed if there's another agentflow with the same name in the tenant. -
Select Rename the current agentflow or Publish a new agentflow.
- Rename the current agentflow: Renames the current agentflow. The agentflow version history will automatically include a comment: " agentflow name changed from 'Current agentflow name' to 'New agentflow name'."
-
Publish a new agentflow: Creates a duplicate agentflow with a new name.
-
Click Publish.
| Field | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Agentflow name |
Name to identify the agentflow. This name is displayed in the Agents > All agents page. Maximum number of characters: 50. Special characters are not allowed. If an existing agentflow has the same name you type in this field, a message appears asking you whether or not to overwrite the existing agentflow. Select your response as desired. |
|||||||||||||||
| Agentflow description |
Description of agent. This description is displayed in the Agents > All agents page. Maximum number of characters: 500.
|
|||||||||||||||
|
Assigned use |
Used to specify whether a agentflow is in the Development or Production phase. Development is selected by default.
|
|||||||||||||||
| Agentflow owners |
Owners for the agentflow. Agentflow owners can assign permissions, and access agentflows and associated agentflow tasks and instances. Assigning agentflow permissions allow you to define which users can access agentflows and provide agentflow permissions to other users. Note:
|
|||||||||||||||
| Version comments | Information about the agentflow you are currently publishing. Use this field to provide comments that will identify this specific version of your agentflow. |