Tenant screen

Tenant Name

Description:

Specifies the name of the tenant in AgilePoint NX.

Tenant Administrator

Description:

Specifies the Tenant Administrator.

Allowed Values:

A user name from the list.

Only the Tenant Administrator or the AgilePoint Service Account can see this list because only those users can change the Tenant Administrator. There can be only one Tenant Administrator at a time.

• The AgilePoint Service Account can change the Tenant Administrator any number of times so they can always see this list.
• Because there can be only one Tenant Administrator, if, for example, the current Tenant Administrator A assigns the role to a new Tenant Administrator B, after the change, only Tenant Administrator B can see the list.

Default Value:

The current administrator for the tenant.

Example:

Refer to:

• How Do I Change the Tenant Administrator?

Limitations:

Only the current Tenant Administrator can change this vaule.

Tenant Administrator Email

Description:

Shows the email address for the Tenant Administrator.

Allowed Values:

Read only.

Server Instance URL (REST)

Description:

Shows the REST URL for your AgilePoint Server instance.

Note: If your AgilePoint Server instance uses HTTPS, to use on-premises SharePoint, the web application for your SharePoint site must be configured to use HTTPS.

Allowed Values:

Read only.

Server Instance URL (wsHttp)

Description:

Shows the web service URL for your AgilePoint Server.

Allowed Values:

Read only.

OpenAPI Documentation URL (Swagger)

Description:

Shows the URL for the AgilePoint REST API documentation in Swagger.

Allowed Values:

Read only.

Portal Instance URL

Description:

Shows the URL for the AgilePoint NX Portal.

Note: If your AgilePoint Server instance uses HTTPS, to use on-premises SharePoint, the web application for your SharePoint site must be configured to use HTTPS.

Allowed Values:

Read only.

IdP Issuer URL

Description:

Shows the URL AgilePoint NX uses as an identity provider (IdP) issuer for third-party authentication.

Allowed Values:

Read only.

System Timezone

Description:

Shows the time zone for the AgilePoint Server machine.

By default, this field shows the date and time in UTC format.

Allowed Values:

Read only.

Limitations:

This field is available in these releases:

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

Access Key

Description:

Specifies the access key for your Amazon S3 account. This key is a unique, alphanumeric string that identifies the user who owns the account.

Secret Key

Description:

Specifies the secret key for your Amazon S3 account.

Region

Description:

Shows the geographic region where Amazon S3 is hosted.

Allowed Values:

Read only.

Root Folder Path

Description:

Shows the base URI of the Amazon S3 folder.

Allowed Values:

Read only.

Function:

Does a search for categories based on the display name.

Opens this Screen:

Add Category screen

Function of this Screen:

Creates a category in AgilePoint NX.

Export

Function:

Downloads the categories as a JSON file to the local machine.

Limitations:

This field is available in these releases:

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

Import

Function:

Specifies a JSON file that stores the categories to import.

Allowed Values:

A JSON file that contains a list of exported categories.

Select a file from your local machine.

Default Value:

None

Limitations:

This field is available in these releases:

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

Description:

Restores the default settings for the standard (out of the box) categories.

This has no effect on custom categories.

Display Name

Description:

The name that shows for the category in AgilePoint NX.

Allowed Values:

Read only.

Internal Name

Description:

Shows the unique, technical name for the category.

Allowed Values:

Read only.

Description

Description:

Shows an optional text description for the category.

Allowed Values:

Read only.

Description:

Changes the display name and description for a category.

Description:

Deletes a category.

Limitations:

A category that is associated with an app can not be deleted.

Display Name

Description:

Specifies the name that shows for the category in AgilePoint NX.

To Open this Field:

1. Click Add New Category .

Allowed Values:

One line of text (a string).

Accepted:

• Letters
• Numbers
• Spaces

Default Value:

None

Internal Name

Description:

Specifies a unique, technical name for the category.

When a user clicks this field, the field shows the value specified in the Display Name field with no spaces. You can also specify a custom internal name. After the Internal Name is created, it can not be changed.

To Open this Field:

1. Click Add New Category .

Allowed Values:

One line of text (a string).

Not Accepted:

• Spaces

Default Value:

None

Description

Description:

Specifies an optional text description for the category.

To Open this Field:

1. Click Add New Category .

Allowed Values:

More than one line of text.

Default Value:

None

Enable Application-Level Permissions

Description:

Lets you set access rights specific to an app as an alternative to applying access controls to all apps in your AgilePoint NX environment.

When you enable this feature, it only applies to new apps, not the apps that already exist. To apply application level permissions to your existing apps, you can change the settings for those apps as necessary.

Allowed Values:

• On - Lets you enable access controls specific to your apps.
• Off - Applies access controls to all apps in your AgilePoint NX environment.

Default Value:

On

Enable Right To Left Language Support

Description:

Specifies whether to use right-to-left (RTL) languages in AgilePoint NX Portal.

Allowed Values:

• On - Uses right-to-left languages in AgilePoint NX Portal.
• Off - Languages do not show right-to-left in AgilePoint NX Portal.

Default Value:

On

Limitations:

This field is available in these releases:

• AgilePoint NX OnDemand (public cloud)
• AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher

Filter By

Function:

Specifies the status of the announcement to show on the Announcements tab.

Allowed Values:

• All - Shows draft, published, and archived announcements.
• Draft - The announcement is created successfully, but it is in draft status.
• Published - The announcement is published and the user can see the announcement notification.
• Archived - The announcement is created successfully, but it is not ready to publish.

Default Value:

All

Create New

Opens this Screen:

Create New Announcement screen

Function of this Screen:

Creates an announcement for AgilePoint NX Portal.

Title

Function:

Shows the title of announcements.

Allowed Values:

Read only

Subtitle

Function:

Shows the subtitles for announcements.

Allowed Values:

Read only

Status

Function:

Shows the status of the announcements.

Allowed Values:

Read only

Submitted by

Description:

Shows the name of the user who created the announcements.

Allowed Values:

Read only.

Edit

Description:

Changes the information for an announcement.

Delete

Function:

Deletes the announcement.

Title

Description:

Specifies the title of the announcement.

Allowed Values:

One line of text (a string).

Accepted:

• Letters
• Numbers
• Spaces
• Special characters

Default Value:

None

Subtitle

Description:

Specifies the summary of the content that shows next to the title of an announcement on the Announcements screen.

Allowed Values:

One line of text (a string).

Accepted:

• Letters
• Numbers
• Spaces
• Special characters

Default Value:

None

Status

Description:

Specifies the status of the announcement.

Allowed Values:

• Draft - The announcement is created successfully, but it is in draft status.
• Published - The announcement is published and the user can see the announcement notification.
• Archived - The announcement is created successfully, but it is not ready to publish.

Default Value:

Draft

Submitted by

Description:

Specifies the name of the user who created the announcement.

Allowed Values:

A user name.

Default Value:

None

Content

Description:

Specifies the content of the announcement.

Allowed Values:

More than one line of text.

Format:

• Rich text

Default Value:

None

Preview

Description:

Shows a preview of the announcement.

Create

Description:

Saves the announcement.

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

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:

0

Length

Description:

Specifies the duration for the maintenance in hours.

Allowed Values:

An integer.

Range:

• 1-720

Default Value:

0

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.

Default Value:

None

Clear

Function:

Deletes the content from the Custom Popup Content field.

Insert Default Content

Function:

Deletes your changes and shows the default text in the Custom Popup Content field.

Reset

Description:

Changes the settings for the maintenance notification configuration to the default values.

Preview

Description:

Shows a preview of the maintenance notification.

Save

Function:

Saves the changes to the maintenance notification configuration.