Tenant screen

Configures your AgilePoint NX tenant.

Background and Setup

Video: App Permissions

Video: Change the Look and Feel of the eForm in Mobile Device

Prerequisites

Good to Know

How to Start

  1. Click Settings.

    Settings
  2. Click Tenant.

    Click Tenant

Tenant Information tab

Configures the tenant information for the AgilePoint NX tenant.

Figure: Tenant Information tab

Tenant Information tab

Fields

Field NameDefinition

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:
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:

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.

Categories tab

Configures the settings for categories in AgilePoint NX.

Figure: Categories tab

Categories tab

Prerequisites

Good to Know

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

Fields

Field NameDefinition
Search Categories By Display Name
Function:
Does a search for categories based on the display name.
Add New Category
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:

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:

Reset To Default
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.
Edit Edit icon
Description:
Changes the display name and description for a category.
Delete Delete icon
Description:
Deletes a category.
Limitations:
A category that is associated with an app can not be deleted.

Add Category screen

Creates a category in AgilePoint NX.

Figure: Add Category screen

Add Category screen

Prerequisites

Fields

Field NameDefinition

Display Name
Description:
Specifies the name that shows for the category in AgilePoint NX.
To Open this Field:
  1. Click Add New Category Add New Category icon.
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 Add New Category icon.
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 Add New Category icon.
Allowed Values:
More than one line of text.
Default Value:
None

Settings tab

Configures the settings for app level permissions and right-to-left (RTL) language support.

Figure: Settings tab

Settings tab

Fields

Field NameDefinition

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:

Tenant Settings > Maintenance Notification tab

Configures the maintenance notification for your tenant.

Figure: Tenant Settings > Maintenance Notification tab

Maintenance Notification tab

Prerequisites

Good to Know

  • Users can create, change, and delete maintenance notifications if they have access rights for the Settings module, and they are named in the NX Portal web.config file in the key EnableServiceMaintenanceForUsers.

Fields

Field NameDefinition

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 from 1 to 30.
Default Value:
0

Length
Description:
Specifies the duration for the maintenance in hours.
Allowed Values:
An integer from 1 to 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:
  • Deselected - Shows only the text message specified in the Custom Popup Content field.
  • Selected - Shows the date and time for the maintenance with the specified text message.
Default Value:
Selected

Custom Popup Content
Description:
Specifies the text to show 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.