Tenant Settings 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 Settings.

    Tanent Settings

Tenant Settings > Tenant Information tab

Configures the tenant information for your NX tenant.

Figure: Tenant Settings > Tenant Information tab

Tenant Information tab

Fields

Field NameDefinition

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

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.

Tenant Settings > Categories tab

Configures the category settings in AgilePoint NX.

Figure: Tenant Settings > 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 your category based on the display name.
Add New Category Add New Category icon
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:

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:

Reset To Default Reset To Default icon
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 your category.
Accepted Values:
More than one line of text.
Default Value:
None
Edit Edit icon
Function:
Lets you change the display name and description for a category.
To Open this Field:
  1. Select a category.
Delete Delete icon
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.

Add Category screen

Creates a category in AgilePoint NX.

Figure: Add Category screen

Add Category screen

Prerequisites

Fields

Field NameDefinition

Display Name

Function:
Specifies the name that shows for the category in AgilePoint NX.
To Open this Field:
  1. Click Add New Category Add New Category icon.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Description

Function:
Specifies an optional text description for your category.
To Open this Field:
  1. Click Add New Category Add New Category icon.
Accepted Values:
More than one line of text.
Default Value:
None

Tenant Settings > Settings tab

Specifies the settings for your apps and mobile eForms for your tenant.

Figure: Tenant Settings > Settings tab

Settings tab

Fields

Field NameDefinition

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