Set System Maintenance activity

An activity that sets a maintenance notification for your AgilePoint NX tenant.


Set System Maintenance 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 Set System Maintenance activity onto your process.

    Drag Set System Maintenance activity

General Configuration

Specifies the basic settings for the Set System Maintenance 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

Set System Maintenance Configuration

Configures the maintenance notification for your tenant.

Figure: Set System Maintenance screen

Set System Maintenance 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.

Next Maintenance Date

Description:
Specifies the date and time for the maintenance.
Allowed Values:
A date and time from the date picker.
Default Value:
None
Accepts Variables:
Yes

Alert Window

Description:
Specifies the number of days before the scheduled date to show the maintenance notification on the tenant.
Allowed Values:
An integer.

Range:

  • 1-30
Default Value:
1

Length

Description:
Specifies the duration for the maintenance in hours.
Allowed Values:
An integer.

Range:

  • 1-720
Default Value:
1

Use Default Message

Description:
Specifies whether to use the default text for the maintenance notification.
Allowed Values:
  • Deselected - Uses custom text on the maintenance notification.
  • Selected - Uses the default text for the maintenance notification.

    This is the default message:

    This system will be down for scheduled maintenance for 2 hours Wednesday, November 30, starting at 12:00 AM Eastern Time. Thank you for your patience while we work to improve your experience.

Default Value:
Selected

Show Maintenance Date And Duration

Description:
Specifies whether the maintenance notification shows the date and time for the maintenance.
To Open this Field:
  1. Deselect Use Default Message.
Allowed Values:
  • Selected - Shows the date and time for the maintenance with the specified text message.
  • Deselected - Shows only the text message specified in the Custom Popup Content field.
Default Value:
Selected

Custom Popup Content

Description:
Specifies the text to show on the maintenance notification.
To Open this Field:
  1. Deselect Use Default Message.
Allowed Values:
More than one line of text.

Format:

  • Rich text
Default Value:
None