Create Announcement activity

An activity that creates an announcement in AgilePoint NX.


Create Announcement activity

Configure the Create Announcement activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the AgilePoint NX tab.

    AgilePoint NX tab
  3. On the AgilePoint NX tab, drag the Create Announcement activity onto your process.

    Drag Create Announcement activity

General Configuration

Specifies the basic settings for the Create Announcement activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Create Announcement Configuration

Specifies the information to create an announcement in AgilePoint NX.

Figure: Create Announcement Configuration screen

Create Announcement Configuration screen

Fields

Field NameDefinition

AgilePoint NX

Description:
Specifies the access token that connects to your AgilePoint NX environment.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon

Opens this Screen:
Access Token for AgilePoint NX
Function of this Screen:
Configure an access token to connect to AgilePoint NX.

Title

Description:
Specifies the title for the announcement to show on the Announcements screen on the AgilePoint NX Portal home page.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes

Subtitle

Description:
Specifies the subtitle for the announcement that shows next to the title on the Announcements screen on the AgilePoint NX Portal home page.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes

Status

Description:
Specifies the status of the announcement.
Allowed Values:
  • Draft - The announcement is in draft status, and it is not ready to publish.
  • Published - The announcement is published and all the users in your Agilepoint NX tenant can see the announcement notification.
  • Archived - The announcement is complete, but not published.
Default Value:
None
Accepts Variables:
Yes

Submitted By

Description:
Specifies the name of the AgilePoint NX user who creates or changes the announcement.

Only the Tenant Administrator, the AgilePoint Service Account, or the user specified in the key announcement:allowedusers in NX Portal web.yaml file has permission to create, change, and publish an announcement.

Allowed Values:
An AgilePoint NX user name.

There are security restrictions for the users who can create announcements. For more information, refer to [commonLink].

Default Value:
None
Accepts Variables:
Yes

Content

Description:
Specifies the text to show in the announcement.
Allowed Values:
More than one line of text.

Format:

  • Rich text
Default Value:
None

Store Response in this Variable

Description:
Specifies a variable to store the ID of the announcement.

The Announcement ID comes from AgilePoint NX.

Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers

Not Accepted:

  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes