Layout Variation Alerting

If the system doesn't match pages to a layout, you can create new layout variations based on existing layouts that would be matched to those pages. With layout variation alerting, the system analyzes each page marked as No Layout Variation Found, compares it to layout variations not included in live releases, and determines if there's a layout variation that closely matches it. Then, you can use that layout variation as a starting point for creating a layout variation that matches the page. If the page exactly matches a layout variation not included in a live release, you create a release that includes it.

Not available in SaaS deployments
Layout variation alerting is not available in SaaS deployments of Hyperscience.

 

Performance considerations

Before enabling layout variation alerting, you should make sure that it will not negatively affect the performance of your instance.

Timing and length of analysis

When layout variation alerting is enabled, the system's analysis takes place daily in the early AM hours. Currently, you cannot specify the time at which the analysis takes place.

To prevent performance issues, the analysis times out after 1 hour, regardless of whether it is finished.

Layout variation alerting in high-volume instances

This feature runs in the application and not the trainer. To prevent processing delays, we do not recommend enabling this feature in instances processing high volumes of submissions (i.e., over one million submissions per day).

Using layout variation alerting

The steps below outline how to use layout variation alerting to create layout variations for pages marked as No Layout Variation Found.

1.  Enable layout variation alerting.

To enable layout variation alerting:

  1. Go to Administration  > System Settings.

  2. Scroll down to the Beta Features section, and click Edit.

  3. Select the Layout variation alerting checkbox, and click Save

2.  View the results of layout variation alerting.

  1. To view the results of layout variation alerting, go to <instance_url>/admin/form_extraction/layoutvariationalert/

If the system found potential matches for pages marked as No Layout Variation Found, the results will be displayed in a table.

LayoutVariationAlertingList.png

The table contains the following information about each page:

  • ID — The ID of the page’s alert record in the system
  • DT Created — The date the alert record was created
  • Variation Reason — The technical details of why this variation was identified as a potential match for the page
  • Submission Page — The page's page number in its submission
  • Predicted Template — The layout containing the layout variation that potentially matches the page
  • Associated Layout Variation Name — The name of the layout variation that potentially matches the page
  1. Click the number in the Submission Page column to see more details about the page, including the ID of the submission it came from.

LayoutVariationAlertingSubmissionID.png

With the submission ID and page number, you can find the page in the application. Then, you can create a layout variation for it from the layout variation listed in Associated Layout Variation Name.

If the page is an exact match to a layout variation that's not included in a live release, you can create a copy of a live release, add that layout variation to the copy, and deploy that copy. For more information, see Add the new layout variation to a release.

3.  Create layout variations from layout variation alerting.

To create a layout variation for a page marked as No Layout Variation Found:

  1. In the application, go to Submissions > No Layout Variation Found, and find the page in the table.

  2. Click on the Page ID number to view an image of the page.

  3. Use the image to find or create a blank version of the form contained in the page.

  4. Using the layout variation named in the alert as a starting variation, create a new layout variation by following the steps in Adding a Variation to a Layout.

4.  Add the new layout variations to a release.

If you've created a new layout variation or found one that matches the page, you need to add it to a release and deploy that release in order for pages to be matched to that variation.

You cannot edit a live release. Instead, you can copy a live release and edit the copy. To do so:

  1. Go to Library > Releases, find the release you want to copy, and click on its name.

  2. In the upper-right corner of the page, click Copy to New Release.

  3. In Release Name, enter a name for the release.

  4. Click Next.

  5. Find the layout that contains the layout variation that you've created or found for the page, click on the arrow next to its checkbox, and select the checkbox for the layout variation.

  6. Click Create.

In order for pages to be matched to the layout variation, you need to assign its release to a flow and deploy that flow. For more information, see Assigning a Release to a Flow.

Was this article helpful?
0 out of 0 found this helpful