1. Knowledge Articles
  2. Guide Conditioning
  3. How to use FQIDs in EPM Application

How to use FQIDs in EPM Application

This topic helps you to use the FQIDs in the EPM Application.

  1. What is FQID?

    FQID (Fully Qualified ID) is a unique identifier used to segment or restrict a guide to a particular page within an application.

  2. Why we use FQID?
    • It's important to understand that within the EPM application, the FQID serves as a precise identifier for a page or component, making it ideal for scenarios where a guide needs to be triggered only under very specific conditions.
    • In the EPM application, FQIDs are used to manage complex interactions where different pages or elements may have similar characteristics but require distinct handling.
    • Utilizing FQID in the EPM application ensures that guides appear exactly where intended, maintaining accuracy and preventing users from encountering guides on irrelevant pages.
  3. How to use FQID?
    • Go to the application you want to work with.

      FQID

    • Inspect the page by right-clicking and selecting "Inspect" or pressing F12 to open the Developer Tools.

      Inspect

    • Navigate to the Console tab in the Developer Tools.

      Console

    • In the console section, type the following command and press Enter: iridize.diagnose()

      Command

    • A new pop up will open.

      Pop up

    • In the popup, select the second option: Guides Break and Stop Running.

      Option

      Note:

      For more information regarding the Diagnostics Tool, just click Diagnostic Tool
    • Copy the page ID value.
      • After selecting the option, several points will be displayed. Look for the point Page ID.
      • Once you locate the Page ID, copy the value as shown in the below attachment. You will need this information to set up the guide's activation condition.

        Diagnostic tool

Set Up the Guides Activation Conditions
Perform the following actions to set up the Guides Activation Condition:
  1. Go to the guide you've created (e.g., a process guide or message guide).

    Guide created

  2. Open the "Activation Settings" tab.

    Activation Settings

  3. Select "Advanced Condition" to configure the activation criteria.

    Advanced condition

  4. In the condition settings, choose "When page has session variable.

    Session Variable

  5. Set the key as "g_efsOglFqId", In “Enter Session Variable” field which will be consistent across all EPM applications.

    key

  6. Select "Equals" for the condition type.

    Equals

  7. In the “Enter Session Variable value” field, paste the FQID value that you copied earlier.

    Sessio Var

  8. Click on Done and then Save & Exit the configuration.

    Done

    Full Image of the condition is displayed below in the screenshot.

    Full condition

    To decide between "Display in Help Panel" and "Display in Autoload" based on the guide type, follow these criteria:

    Autoload

    • Display in Autoload: Choose this option if the guide is a standalone guide with only one tip. This will automatically show the guide without requiring the user to open it manually.
    • Display in Help Panel: Choose this option if the guide is a sticky guide with more than one step. This will place the guide in the help panel, allowing users to access it as needed.
    • So, your choice depends on the number of steps in the guide.
      • One step: Display in Autoload
      • Multiple steps: Display in Help Panel

Test the Guide
  1. Refresh the application.

    Refresh

  2. Check the Help Panel to see if the guide is available on the targeted page.

    Widget

  3. To confirm that the guide is restricted to the specific page, navigate to a different page within the application.

    Diff page

  4. Verify that the guide is not available on the other pages.
  5. By following these steps, you ensure that the guide is only accessible on the intended page.