Deploying the Redirector

Updated on

To deploy the VA Redirector on your website follow these steps:
  1. Add the VA Redirector iPart to the page that you wish to manage.
  2. Publish the page using RiSE.
  3. Visit the page using a System Administrator (SysAdmin) account such as "Manager".
  4. Update the Redirector's settings as needed.
  5. Test and deploy as usual.
More information on each step is provided below:

1. Add the VA Redirector iPart to a Page

If you have configured a Content Type then simply add the VA Redirector iPart to any page that you wish to do. Pro Tip: Best practice is to place the Redirector at the top of the page so it is always visible.

2. Publish the page using RiSE

Once you have added the VA Redirector to a page, use the "Save and Publish" option to publish the page to your website. Whenever you are working in RiSE you will see the message "Configuration Panel not available in Edit Mode" which reminds you to visit the page to complete the configuration (Click on the "Publish location" highlighted below to do this).

3. Visit the Page using a System Administrator Account

Once the page is published, a special configuration panel is displayed for System Administrators. Click on the update settings button to open the configuration panel.

4. Update Redirector Settings

The VA Redirector assesses each condition in order from top to bottom and stops processing and executes your instructions as soon as a criteria is met. The following settings and options are available:
  • Add Redirection - You can add as many redirections as you wish to the page. For example, you may have one redirection for non-members, another for regular members and a third one for premium members. At least one row is required for each redirection target.
  • Save - Updates the page's configuration file. If your IQA is missing then you will receive an error message when you attempt to save the file.
  • Expand - If you have multiple criteria, use the "Expand" option to display all of the rows you have defined.
  • Debug - Debug mode will reveal the Redirector on the page and identify which criteria will be acted upon without actually executing the redirection. This is very useful when testing a page with complex criteria.
  • Selection - Three options are available "Include IDs from" which looks for an iMIS ID returned from a Redirection IQA, Enter the full path to the IQA starting with the "$/" and include the full name of the IQA. In addition to the IQA options you can also use "All authenticated" which returns true for all logged-in users and "All unauthenticated" which returns true for anyone who is not logged in. Normally "All authenticated" and "All unauthenticated" are used as the final or "catch all" selections after other conditions have been tested for.
  • ID and SEQN Options - By default, the VA Redirector uses the logged-in (or selected) user criteria to evaluate an IQA, however, in some cases you may want to use other fields as part of your IQA's logic to create advanced process flows. By default, the VA Redirector will pass the values of "ID" and "SEQN" to the IQA if they are found in the URL, however, you can optionally override these defaults to pass any field through to the IQA as needed.
    • Example #1 - A logged-in user is a Mentor to a student member. In order to gain access to a page related to the Mentoring program their iMIS ID must be stored on an approved mentee's record which is not their own. In this case the user would pass the parameter of "MENTEE" into the IQA.
    • Example #2 - A person is employed by a company that may be a parent, affiliate or subsidiary of a target company whose profile they are entitled to view. In this case the user would pass their ID as parameter 1 but use a second parameter of "CO_ID" to identify the company that may be a parent, affiliate or subsidiary of their company so an IQA can validate if this relationship exists.
    • Example #3 - A person is only allowed to access a page if they have filed an annual return. In this case a secondary parameter of "YEAR" would be used to check to ensure that they have filed an annual return for the year in question.
  • Stay on Page - The "Stay on Page" option stops the Redirector from processing and allows the page to display if the appropriate criteria is met.
  • Redirection Target - The Redirection Target is the destination page for the user if they are included in the selection criteria. Examples would be a "Join now" page for non-members or a friendly "Oops!" page to explain policy or conditions that the user has not met.

5. Test and Deploy

As a final step, be sure to test your VA Redirector (use the Debug mode) to ensure that the Redirector works in all use cases as expected.