Tenant Settings screen

Tenant Name

Function:

Specifies the name of the tenant in AgilePoint NX.

Tenant Administrator

Function:

Specifies the administrator for your tenant. You can specify only one administrator for the tenant.

Accepted Values:

A list of users in the tenant.

This list shows only to the current administrator for the tenant.

Default Value:

The current administrator for your tenant.

Example:

Refer to:

• How Do I Change the Tenant Administrator?

Limitations:

Only the current Tenant Administrator can change this vaule.

Server Instance URL (REST)

Function:

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.

Accepted Values:

Read only.

Server Instance URL (WsHttp)

Function:

Shows the web service URL for your AgilePoint Server.

Accepted Values:

Read only.

OpenAPI Documentation URL (Swagger)

Function:

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

Accepted Values:

Read only.

Portal Instance URL

Function:

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.

Accepted Values:

Read only.

System Time Zone

Function:

Shows the time zone for the AgilePoint Server machine.

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

Accepted Values:

Read only.

Limitations:

This field is available in these releases:

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

Access Key

Function:

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

Function:

Specifies the secret key for your Amazon S3 account.

Function:

Does a search for your category 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 your local machine.

Limitations:

This field is available in these releases:

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

Import

Function:

Specifies a JSON file that stores the categories to import.

Accepted 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 Private Cloud or AgilePoint NX OnPremises v8.0 Software Update 2 or higher

Function:

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

This has no effect on custom categories.

Display Name

Function:

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

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Internal Name

Function:

Shows the unique, technical name for the category.

Accepted Values:

Read only.

Description

Function:

Specifies an optional text description for the category.

Accepted Values:

More than one line of text.

Default Value:

None

Function:

Lets you change the display name and description for a category.

To Open this Field:

1. Select a category.

Function:

Lets you delete a category.

To Open this Field:

1. Select a category.

Limitations:

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

Display Name

Function:

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

To Open this Field:

1. Click Add New Category .

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Description

Function:

Specifies an optional text description for the category.

To Open this Field:

1. Click Add New Category .

Accepted Values:

More than one line of text.

Default Value:

None

Enable Mobile eForms

Function:

Lets you enable eForms. If this options is enabled, it creates a shared variable with the connection URL for mobile devices.

Accepted Values:

• Yes - Creates an eForms base URL in shared variables for mobile devices.
• No - Disables eForms access for mobile devices.

Default Value:

No

Example:

Refer to:

• Enable eForms on Mobile Devices
• (Example) Offline Mobile eForms in a Process-Based App
• (Example) Offline Mobile eForms in a Form-Based App

Enable Application-Level Permissions

Function:

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.

Accepted Values:

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

Default Value:

No

Next Maintenance Date

Function:

Specifies the date and time for the maintenance.

Accepted Values:

A date and time from the date picker.

Default Value:

None

Alert Window

Function:

Specifies the number of days before the scheduled date to show the maintenance notification on the tenant.

Accepted Values:

An integer from 1 to 30.

Default Value:

0

Length

Function:

Specifies the duration for the maintenance in hours.

Accepted Values:

An integer from 1 to 720.

Default Value:

0

Use Default Message

Function:

Specifies whether to use the default text for the maintenance notification.

Accepted 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

Function:

Specifies whether the maintenance notification shows the date and time for the maintenance.

To Open this Field:

1. Deselect Use Default Message.

Accepted 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

Function:

Specifies the text to show the maintenance notification.

To Open this Field:

1. Deselect Use Default Message.

Accepted 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

Function:

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

Preview

Function:

Shows a preview of the maintenance notification.

Save

Function:

Saves the changes to the maintenance notification configuration.