DOCUMENTATION (CURRENT)

v8.x Documentation v6.x-v7.x Documentation

Activity Documentation screen

Configures and shows the activity documentation.

Background and Setup

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 Software Update 2 or higher.

Good to Know

App designers can manage and view activity documentation in Process Builder.
Runtime app users can view activity documentation if it is configured to show in Work Center and Manage Center at runtime.
Attached files are stored as application resources in the AgilePoint NX workflow database.

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
On the Process Builder screen, on any activity, click Activity Settings > Activity Documentation.

Activity Documentation > Links tab

Shows a list of links added for the activity documentation.

Activity Documentation Links tab — Figure: Activity Documentation > Links tab

Fields

Field Name	Definition
Show At Runtime	Description: Specifies whether to show the link at runtime. Allowed Values: Selected - Shows the link in Process Builder at design time, and shows the link in Work Center and Manage Center at runtime. Deselected - Shows the link in Process Builder at design time, and does not show the link in Work Center and Manage Center at runtime. Default Value: Deselected
Display Name	Description: Shows the display names for the links for the activity documentation. Allowed Values: Read only.
Link	Description: Shows a list of URLs added for the activity documentation.
Add Link	Opens this Screen: Add Link screen Description: Adds a link to use in activity documentation.
Copy Link	Description: Copies the URL.
Edit	Description: Changes the URL. URLs can only be changed in Process Builder.
Delete	Description: Deletes the link from the list. Links can only be deleted in Process Builder.

Activity Documentation > Attachments tab

Shows a list of attached files added for the activity documentation.

Activity Documentation Attachments tab — Figure: Activity Documentation > Attachments tab

Fields

Field Name	Definition
Show At Runtime	Description: Specifies whether to show the attached file at runtime. Allowed Values: Selected - Shows the attached file in Process Builder at design time, and shows the file in Work Center and Manage Center at runtime. Deselected - Shows the attached file in Process Builder at design time, and does not show the file in Work Center and Manage Center at runtime. Default Value: Deselected
Display Name	Description: Shows the display names for the attached files for the activity documentation. Allowed Values: Read only.
File Name	Description: Shows the list of attached files for the activity documentation. Allowed Values: Read only.
Add Attachment	Opens this Screen: Add Attachment screen Description: Adds a file attachment to use in activity documentation.
Download	Description: Downloads the attached file to your local machine.
Edit	Description: Changes the attached file. Attached files can only be changed in Process Builder.
Delete	Description: Deletes the attached file from the list. Attached files can only be deleted in Process Builder.