Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: PFUN-25229

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.

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

...

To add a new RelayState parameter click :

  1. Click the Add button.

  2. An empty row will appear at the bottom of the Relay State table.

  3. Enter your values for the Relay State Name and the Relay State URL.

    RelayState Builder SectionImage Added
Info

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 clicking using the Add Builder.

  1. Click the Add (Builder) button.

  2. You will be redirected to the Add Relay State screen.

  3. Enter the Relay State Name.

  4. Click the Add button.

  5. In the URL Parameters,

...

  1. click the input field for the Name.

  2. Select the parameter from the

...

  1. drop-down list.

  2. Enter the Value for the URL parameter.

    RelayState Builder Add Builder ProgressImage Added
  3. Enter all required URL parameters.

  4. In the Additional Settings, enter the Environment URL.

    RelayState Builder Add BuilderImage Added
  5. Click the Save button.

Info

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

RelayState Builder Add Relay StateImage Removed

Edit RelayState

To edit a RelayState parameter select :

  1. Select the particular parameter

...

  1. .

  2. Click the Edit button.

  3. 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. So you You can edit, add, or delete the particular URL Parameters. You can also add a new parameter by clicking the Add button.

RelayState Builder Edit Relay StateImage Removed

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

  1. Select the particular parameter

...

  1. from the Relay States table.

  2. Click the Show Values for CRM button.

  3. You will be redirected to the CRM Integration Helper screen.

The desired CRM will be automatically preselected .

...

based on the selected SAML configuration.

Info

See also: