Settings screen

Configures the settings for your custom page in Page Builder.

Background and Setup

Examples

(Example) Anonymous Page in Page Builder
(External) AgilePoint NX Page Builder Pages Now Available To External Users
Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

An access token for Anonymous End User.
For more information, refer to Access Token for Anonymous End User.
These access rights:
- View Global Application Resources
- Enable Anonymous End User Access
For more information, refer to:
- Roles
- (Example) Add a Role
The user associated with the Anonymous End User access token must be a member of the Page Viewers permission group for the page.
The anonymous pages require AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.
To use an eForm on an anonymous page, the form must be configured with anonymous authentication.
AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

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

How to Start

Open the Custom Page Design screen.
For information about how to open this screen, refer to Custom Page Design screen.
Click Settings.

Settings screen

Configures the settings for your custom page in Page Builder.

Fields

Field Name	Definition
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	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.

Examples

(Example) Anonymous Page in Page Builder
(External) AgilePoint NX Page Builder Pages Now Available To External Users
Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

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

Good to Know

A page designer who configures a custom page to use anonymous authentication must have a role with the Allow Enabling Anonymous Access access right.
The Allow Enabling Anonymous Access access right lets the page designer create an anonymous page in Page Builder at design time. It does not control the security for the anonymous page or the anonymous page user at runtime. The user credentials used for the anonymous authentication access token do not require this access right.

At minimum, the user account associated with the Anonymous End User access token must be a member of the Page Viewers permission groups for the custom page.
As a security best practice, in your access token for anonymous pages, AgilePoint recommends user credentials with minimum access rights. This is a user with the Page Viwers permission group with the default access rights.
It is not recommended to use an Administrator, Application Designer, or Developer account of any kind for anonymous access.
To make sure only APIs specific to run through custom pages are allowed to avoid security risks, such as code injection attacks, AgilePoint recommends you add only the required APIs.
To add an API, click Add Whitlisted API on the Anonymous Access Settings tab on the Settings screen.
For more information, refer to Best Practices For Anonymous Access

Fields

Field Name	Definition
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
Add Whitelisted API	Description: Adds the Endpoint and Payload fields to add an API to the whitelist. Example: Refer to: (External) AgilePoint NX Page Builder Pages Now Available To External Users
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: 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: 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: 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: In the Access Token field, select an Access Token. 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: In the Access Token field, select an Access Token.
Delete	Description: Deletes the URL for the anonymous page. To Open this Field: In the Access Token field, select an Access Token. 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: In the Access Token field, select an Access Token. Click Generate. Allowed Values: Read only.
Copy Anonymous Link	Description: Copies the URL for the anonymous page. To Open this Field: In the Access Token field, select an Access Token. Click Generate. Allowed Values: Read only.

Settings > Dependent Files tab

Shows the dependent files associated with the custom page.

Dependent Files screen — Figure: Settings > Dependent Files tab

Prerequisites

AgilePoint NX OnDemand (public cloud), AgilePoint NX PrivateCloud, or AgilePoint NX OnPremises v9.0 Software Update 1 or higher.

Fields

Field Name	Definition
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.