RelayState Builder
You can use the RelayState builder for the management of the RelayState parameters. The RelayState builder provides a simple overview of the RelayState parameters for the particular SAML configurations. It also allows you to add, edit, and delete RelayState parameters.
When you go to Administration > Configuration > External Systems > SAML Configuration, the Relay States section is provided at the bottom of the SAML Configuration page.
Add RelayState
To add a new RelayState parameter:
Click the Add button.
An empty row will appear at the bottom of the Relay State table.
Enter your values for the Relay State Name and the Relay State URL.
When you use the Add button to enter a new parameter you are not provided with any context for the available valid URL parameters. You are provided only with simple input fields. It is recommended to use the Add button in case you have already the complete URL prepared.
Add RelayState (Builder)
You can also add a new RelayState parameter by using the Add Builder.
Click the Add (Builder) button.
You will be redirected to the Add Relay State screen.
Enter the Relay State Name.
Click the Add button.
In the URL Parameters, click the input field for the Name.
Select the parameter from the drop-down list.
Enter the Value for the URL parameter.
Enter all required URL parameters.
In the Additional Settings, enter the Environment URL.
Click the Save button.
Usage of the URL Parameter Names is restricted to the following list of values:(applicationEnvironment
, confName
, partition
, targetPage
, targetPageState
, targetPageTab
, targetPageAction
). The default value of the Environment URL is /app/
.
Edit RelayState
To edit a RelayState parameter:
Select the particular parameter.
Click the Edit button.
You will be redirected to the Edit Relay State screen.
On the Edit Relay State screen, you are provided with the parsed Relay State URL. You can edit, add, or delete the particular URL Parameters.
Show Values for CRM
The Show Values for CRM feature generates values that are needed for integration with your CRM platform (Salesforce, Microsoft Dynamic, SAP C4C, etc.)
Select the particular parameter from the Relay States table.
Click the Show Values for CRM button.
You will be redirected to the CRM Integration Helper screen.
The desired CRM will be automatically preselected based on the selected SAML configuration.
Found an issue in documentation? Write to us.