Anonymous Access screen (Form-Based App)

Lets you use a form-based app with no authentication credentials.

Background and Setup

Examples

Prerequisites

Good to Know

How to Start

  1. Click App Builder.

    Build Apps screen
  2. On the Application Explorer screen, click [App Name] > App Model & Resources > Forms > New Form > Select a form.

    Select New Form
  3. Click Anonymous.

    Anonymous screen

App Settings > Anonymous Access tab

Specifies an access token for anonymous authentication.

Figure: App Settings > Anonymous Access tab

Anonymous Access tab

Fields

Field NameDefinition

Anonymous Access Name
Function:
Specifies the name of the anonymous authentication.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Access Token
Function:
Specifies the access token that connects to AgilePoint NX.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Generate
Function:
Gives the URL for your anonymous form.

You can use this URL to access and complete an eForm with anonymous authentication.

Example:
Refer to:

Delete
Function:
Deletes the selected connections in the Schema Mapper for this activity.

View
Function:
Shows the URL for your anonymous form.
Example:
Refer to:

Finish
Function:
Saves the configuration and closes the screen.

App Settings > URL tab

Specifies your proxy or external URL to show your eForm to anonymous form users. You can also add your own query string parameters to show form controls completed with the values for the query string parameter.

Figure: App Settings > URL tab

URL tab

Fields

Field NameDefinition

Base URL
Function:
Specifies your AgilePoint NX Portal instance URL. You can also specify your proxy or external URL to expose your form externally.
Accepted Values:
A valid portal instance URL.
Default Value:
Your portal instance URL.

The default portal instance URL is the same as the portal instance URL on the Tenant Settings.

Example:
Refer to:

Parameter
Function:
Shows the query string parameter. You can not change the default parameter, but you can change its value. You can specify your own query string parameters and values. This shows the specified values on your eForm.
Accepted Values:
A query string parameter.
Default Value:
FormApplication
Accepts Process Data Variables:
No

Value
Function:
Specifies the form from the list for the query string parameter. You can specify your own query string parameters and values.
Accepted Values:
A value for parameter.
Default Value:
[The name of your form-based app]_New Account.
Accepts Process Data Variables:
No
Example:
Refer to:
Limitations:

Add Add icon
Function:
Creates a row to specify your own query string parameter and its value.

You can send this query string parameter to your form.

Delete Delete icon
Function:
Deletes the row.

Generate
Function:
Gives the URL for your anonymous form.

You can use this URL to access and complete an eForm with anonymous authentication.

Example:
Refer to:

Update
Function:
Saves the values in the configuration fields in the URL and Firewall tab.

Delete
Function:
Deletes the selected connections in the Schema Mapper for this activity.

View
Function:
Shows the URL for your anonymous form.
Example:
Refer to:

Finish
Function:
Saves the configuration and closes the screen.

App Settings > Firewall tab

Specifies an IP address range to limit the access of an anonymous form.

Figure: App Settings > Firewall tab

Firewall tab

Fields

Field NameDefinition

IP From
Function:
Specifies the lowest IP address that can open your eForm.

If this field is blank, it allows all IP addresses to access an eForm.

Accepted Values:
A valid IP address.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
192.168.88.1

IP To
Function:
Specifies the highest IP address that can open your eForm.

If this field is blank, it allows all IP addresses to access an eForm.

Accepted Values:
A valid IP address.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
192.168.88.98

Generate
Function:
Gives the URL for your anonymous form.

You can use this URL to access and complete an eForm with anonymous authentication.

Example:
Refer to:

Update
Function:
Saves the values in the configuration fields in the URL and Firewall tab.

Delete
Function:
Deletes the selected connections in the Schema Mapper for this activity.

View
Function:
Shows the URL for your anonymous form.
Example:
Refer to:

Finish
Function:
Saves the configuration and closes the screen.

App Settings > Security > Restrict APIs tab

Prevents unauthorized access by allowing only APIs on your whitelist to make API calls to or from your anonymous form. If an API is not on the whitelist, and it tries to make calls against the anonymous form, an error message shows.

Figure: >App Settings > Security > Restrict APIs tab

Restrict APIs tab

Prerequisites

Fields

Field NameDefinition

Enable API Whitelisting
Function:
Specifies whether to enable the API's whitelist to make changes with the the API.
Accepted Values:
  • Selected - Enable the API's whitelist to make changes with the APIs.
  • Deselected - The APIs are not whitelist, and changes are not permitted.
Default Value:
Deselected

Show All APIs
Function:
Specifies whether to show the required APIs in the API's whitelist.

AgilePoint NX creates the APIs by default that are required for the anonymous form. You cannot delete these APIs.

Accepted Values:
  • Selected - Shows the required APIs in the API's whitelist.
  • Deselected - Shows the APIs that are retrieved from the anonymous form or that you added in the API's whitelist.
Default Value:
Deselected

Start Capturing APIs
Function:
Opens the anonymous form in the preview window where you can run the rules to add the APIs in the APIs whitelist to give the access to users.

Stop Capturing APIs
Function:
Captures the APIs from the anonymous form and added in the APIs whitelist to give the access to the user for those APIs on the anonymous form.

Generate
Function:
Gives the URL for your anonymous form.

You can use this URL to access and complete an eForm with anonymous authentication.

Example:
Refer to:

Delete
Function:
Deletes the selected connections in the Schema Mapper for this activity.

View
Function:
Shows the URL for your anonymous form.
Example:
Refer to:

Finish
Function:
Saves the configuration and closes the screen.

App Settings > Security > Restrict System Tokens tab

Prevents the system data variables for anonymous form.

Figure: App Settings > Security > Restrict System Tokens tab

Restrict System Tokens tab

Prerequisites

Fields

Field NameDefinition

Exclude Selected System Tokens
Function:
Specifies whether to show the system data variables that are used in anonymous forms at runtime.

This option can prevent sensitive information from showing on an eForm.

Accepted Values:
  • Selected - Shows the list of system data variables. You can select the system data variables from the list that you do not want to resolve in anonymous forms at runtime.
  • Deselected - The anonymous form field shows the resolved values for all system data variables at runtime.
Default Value:
Deselected

EXCLUDED SYSTEM TOKENS
Function:
Specifies whether to select all system data variables at one time.
To Open this Field:
  1. On the Security tab, in the Restrict System Tokens tab, select Exclude Selected System Tokens.
Accepted Values:
  • Selected - Selects all system data variables at a time.
  • Deselected - Select system data variables one by one.
Default Value:
Deselected

Search By Token Name
Function:
Finds the system data variable.
To Open this Field:
  1. On the Security tab, in the Restrict System Tokens tab, select Exclude Selected System Tokens.