Frames Identification Conditions

A Frame is a special technique to identify a page in your application so that users can see relevant content on relevant pages. You can add conditions to verify if a Frame is connected to the right page while creating or editing the Frame. 

For Apty to connect your application pages to a Frame, enabling you to create content like ValidationsLaunchersTooltips, and Announcements on your application, you can construct Frames using any one of the conditions mentioned below.

Anchors

Anchors are like bookmarks for application pages. For Apty to identify your application page, you can create unique page Frames by anchoring your page elements to the Frame. Each element on the application page can be used as an Anchor Point to accurately identify your page.

 

Example: If you want to show a Tooltip to a user only when they navigate to the Leads page in Salesforce, you can select upto 5 elements on the Leads page to add as Anchor Points in the condition as shown in the following GIF.

To create an Anchor Point:

1.  On the Create New Frame page in the Apty Studio, enter your Frame Name.

2.  Click the anchor icon to add a new Anchor Point.

3.  Hover your cursor over the page elements and then click the element(such as the text field, button, page title, etc.) you want to add as the Anchor Point.

 

Note:

  • A green color check mark indicates that an anchor point has been added.
  • Multiple Anchor Points may be added to the Frame for a more reliable page identification. In such cases, your webpage will connect to the Frame only if all of the Anchor Points meet the requirements. Otherwise, you'll need to edit the Frame to reflect the page updates.
  • Anchor Points is a default condition while creating a new Frame. However, you can select a different condition from the list of available options that appears when you click the ellipsis. 

4.  Click Save.

You can now use the Frame to create Apty Content like ValidationsLaunchersTooltips, and Announcements on your application.

 

Custom Script

In complex scenarios for highly dynamic applications like Salesforce, using Anchor Points to create Frames may not be enough. To ensure that users are on the correct page and can seamlessly create content like ValidationsLaunchersTooltips, and Announcements on your application, you can use custom JavaScript to create and connect unique Frames to their relevant pages. For instance, using a JavaScript with Boolean expression, which when executed, connects your webpage to a Frame only if the Boolean value is true and disconnects when it is false.

Example: If you want to show a Tooltip to a user only when they navigate to the Leads page in Salesforce, you can add a condition as shown in the following screenshot.

To add Custom Script to your Frame,

1.  On the Create New Frame page in the Apty Studio, enter your Frame Name.

2.  Click the ellipsis and then select Custom Script from the list of options.

3.  Enter your JavaScript function in the input field.

4.  Click Save.

 

URI Hash

If you want to identify a page using the hash value of your URL, you can use this condition. Hashes are usually present in Single page applications developed using AngularJS or ReactJS.

Example: If you want to show a Tooltip to a user only when they navigate to the Leads page in Salesforce, you can add a "/" followed by the value that comes after "#" in the condition as shown in the following screenshot.

To add a URI Hash to your Frame,

1.  On the Create New Frame page in the Apty Studio, enter your Frame Name.

2.  Click the ellipsis and then select URI Hash from the list of options.

3.  Enter your application page's URI Hash value in the input field.

4. Click Save.

 

Label Comparison

When you choose a label on your application page, Apty's Label Comparison condition will check whether the value it contains is true or false using a variety of relational operators.

Example: If you want to show a Tooltip to a user only when they navigate to the Leads page in Salesforce, you can add a condition as shown in the following GIF.

To use the Label Comparison condition in your Frame,

1.  On the Create New Frame page in the Apty Studio, enter your Frame Name.

2.  Click the ellipsis and then select Label Comparison from the list of options.

3.  Click + Add Condition.

4.  Click the Select Label button and then select a label on the application page.

Note:

You can add multiple conditions to the Frame for a more reliable page identification. In such cases, your webpage will connect to the Frame only if all of the conditions are met. Otherwise, you'll need to edit the Frame to reflect the page updates or remove the conditions that no more serve a purpose.

5.  Select a relational operator from the dropdown.

The operators will define the relationship between the label and the value, depending on which the Frame will be connected to the relevant page for content creation and display.

Operator Description
Equal The selected label exactly matches the value set in the given condition.

Not Equal

The selected label does not match the value set in the given condition.
Regex  
Contains

The selected label consisting of a string value holds the value set in the given condition.

Empty Value The selected label does not hold any value. E.g., an empty input field.
Non Empty Value The selected label holds some value which is not specified in the condition.

6.  Enter a value in the input field to match the selected value of the label.

7.  Click Save.