Settings screen

Configures the settings for your custom page in Page Builder.

Background and Setup

Prerequisites

Good to Know

  • An anonymous page does not support the Work Center or Report Part widgets.

How to Start

  1. Open the Custom Page Design screen.

    For information about how to open this screen, refer to Custom Page Design screen.


    Open Custom Page
  2. Click Settings.

    Click Settings

Settings screen

Configures the settings for your custom page in Page Builder.

Figure: Settings screen

Settings screen

Fields

Field NameDefinition

Direct Link

Description:
Shows the URL of the custom page that opens the page in a new browser window or a new tab.

URL Format:

https://[Your domain name]/pages/[internal name of the custom page]

URL Example:

https://myclouds.com/pages/new-page

Copy Direct Link Clone icon

Description:
Copies the URL of the custom page or sample page.

You can use the URL to open the custom page in a new browser window or a new tab.

Title

Description:
Specifies the name of a custom page.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
The title of a specified page.

Relative URL

Description:
Shows the unique page name in the relative URL for a custom page.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Hyphens (-)

Not Accepted:

  • Spaces
  • Other special characters
Default Value:
The relative URL of a specified page.
Example:
my-custom-home-page

Settings > Anonymous Access Settings tab

Configures the custom page to use with no authentication credentials.

Figure: Settings > Anonymous Access Settings tab

Anonymous Access Settings tab

Prerequisites

Fields

Field NameDefinition

Access Token

Description:
Specifies the access token that connects to AgilePoint NX.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Endpoint

Description:
Specifies the APIs to add to the whitelist to make API calls to or from the anonymous page.

Page Builder APIs are whitelisted by default.

To Open this Field:
  1. Click Add Whitlisted API.
Allowed Values:
An AgilePoint API.
Default Value:
None

Payload

Description:
Specifies a payload to use to connect to AgilePoint Server.
To Open this Field:
  1. Click Add Whitlisted API.
Allowed Values:
A payload in XML or JSON format.
Default Value:
None

Remove

Description:
Deletes the specified API from the whitelist.
To Open this Field:
  1. Click Add Whitlisted API.

Anonymous Access Token

Description:
Shows the unique access key for the anonymous page. The key is used to access the page in anonymous mode. It is appended to the URL of the anonymous page.
To Open this Field:
  1. In the Access Token field, select an Access Token.
  2. Click Generate.
Allowed Values:
Read only.

Generate

Description:
Creates the URL for the anonymous page.

You can use this URL to access a custom page with anonymous authentication.

To Open this Field:
  1. In the Access Token field, select an Access Token.

Delete

Description:
Deletes the URL for the anonymous page.
To Open this Field:
  1. In the Access Token field, select an Access Token.
  2. Click Generate.

Anonymous Link

Description:
Shows the URL for the anonymous page.

You can use this URL to access a custom page with anonymous authentication.

To Open this Field:
  1. In the Access Token field, select an Access Token.
  2. Click Generate.
Allowed Values:
Read only.

Copy Anonymous Link Copy Anonymous Link icon

Description:
Copies the URL for the anonymous page.
To Open this Field:
  1. In the Access Token field, select an Access Token.
  2. Click Generate.
Allowed Values:
Read only.

Settings > Dependent Files tab

Shows the dependent files associated with the custom page.

Figure: Settings > Dependent Files tab

Dependent Files screen

Prerequisites

Fields

Field NameDefinition

CSS

Description:
Shows the name of the CSS files used on the custom page.

This option opens the Custom CSS screen for the CSS file.

Allowed Values:
Read only.

JavaScript Files

Description:
Shows the name of the JavaScript files used in the custom page.

This option opens the Custom JavaScript screen for the JavaScript file.

Allowed Values:
Read only.

Menu

Description:
Shows the name of the menus used on the custom page.

This option opens the Custom Menu screen for the menu file.

Allowed Values:
Read only.