Categories

System Admin
Contacts
Activity Tracking
DXM
Redirects
Data
Approval Groups

Links

Attestation App – Customization

Description

The Attestation App applies a User’s country, investor type, and language settings to display appropriate Fund and Share Class information based on the aforementioned selection. The User usually needs to agree to some terms and conditions and the verity of the information they have provided before they can access site pages.

Wizard-style Attestations follow a software-wizard type format where choosing one option leads to a second option, and then the next option, etc. based on the User’s selections.

For Dropdown-style Attestations the user is prompted to use a dropdown list to select a country, language etc.; the user’s country selection will affect the language options and investor types which become available.

Attestation Apps can be customized to match the look and feel of a website as well as exist in a passive (a change must be made to show them) or active (they are always displayed) mode before a user may enter a site.

Table of Contents

Customizations

The Attestation app can be customized according to specific requirements, for example, multiple attestations can be allowed, Attestations can be passive or active on a home page, etc. Display languages can change dependent on the language selected by the user when attesting.

Customizations may be applied to either Wizard or Dropdown Style apps.

Active or Passive

Active attestations will appear on the landing page, the user cannot move to another page until the attestation has been accepted.

Passive attestations will appear if an attestation has already been accepted but the user would like to change the information (e.g. country, region, language, etc.) agreed to previously.

Active or Passive options are set in the embed code in the `div` section using the data-input-mode. Set this to “active” or “passive” as necessary.

    
    div
      data-ksys-app-template-id="ksys-app-attestation-2.0.0"
      data-input-culture="en-GB"
      data-input-language="en"
      data-input-country="ie"
      data-input-investor-type="intermediary"
      data-input-mode="active"
    div


Storage

There is an option to allow users to store their attest details so that they don’t need to attest every time they hit the site. 

  • Session storage which will store as long as the browser is open, or
  • Local storage which can be set for a number of days

Set this up by doing the following.

  1. Click Storage, either in the navigation pane or scroll down to the button under Configuration.
  2. Storage method* usually defaults to SESSION meaning that when the user finishes their session and closes their browser, the attested values will be cleared. 
  1. To change this to Local, use the dropdown arrow to select LOCAL.
  2. Click Add Element+.
  1. Select Expiry, then click Save.
  2. Click Expiry.
  1. Use the dropdown next to Period* to make a selection.
  2. Type a number value into the Value* field.
  1. Click Save.
  2. Type in a comment, then click Confirm.

On Change Options

Set conditions based on culture (language) selections to use translations for the attestation wording and disclaimers. When a user changes their language (or culture) selection (using the attestation options), the display language of the app text and prompts will change to match the language selected. This is dependent on Translations having been set up for fields, values, commentaries, disclaimers, etc. used in the Attestation.

  1. Click Add Element+.
  2. Select On Change Options, then click Save.
  1. Click On Change Options.
  2. Click +Create Culture Change*.
  1. Enter cultureChange as the Key*. This will use the culture as the deciding factor for the language change.
  2. Select CONDITIONAL_VALUE from the dropdown options as the Type*. This will allow values to be used as conditionals to change the cultures.
  3. Click Add Element+.
  4. Select Options, then click Save.
  1. Click Options.
  2. Click Add Row+.
  1. Click 1.No Label.
  2. Enter a Label* to provide the name for this row.
  3. Enter one of the cultures available in the Data Dictionary as the string Value*, e.g. fr-FR.
  4. Click Add Element+.
  1. Select Conditional, then click Save. Conditional will create a piece of logic for the culture change to take place.
  2. Click Conditional.
  1. Click +Create Conditions*.
  2. Click Add Row+.
  1. Click 1.No Label.
  2. Click Add Element+.
  1. Select Field, Operator and Value, then click Save.
  2. Enter country for Field.
  3. Use the dropdown to select in as the Operator.
  4. Use the dropdown to select string for Value, leave this blank.
  1. Switch to JSON <> view.
  2. Replace the empty quotes (“”) after value with [“fr”] for French.
  3. Repeat steps 10 to 26 for each culture in the Data Dictionary. 
  4. Switch back to the UI, and browse to Configuration | Components | Selection Wizard | Fields, (in the Wizard Attestation) or to Configuration | Components | Selection | Fields (in the Dropdown Attestation) then click the first Country row.
  1. Click Add Element+.
  2. Select On Change, then click Save.
  1. Click On Change.
  2. Use the dropdown to select cultureChange for Function Name*.
  3. Repeat steps 28 to 32 for each Country row where different cultures have been set up.
  4. Click Save.
  1. Type in a comment, then click Confirm.

Text with Translations changes when France is selected.

Geolocation

Activate geolocation settings to auto-fill a user’s location/country based on their browser’s settings, provided their location settings are public. The attestation will use the 3-letter ISO standard country codes to match the geolocation to the list of available countries and use the appropriate translation where it is available. The codes must be added for each country either as part of the Label-Value pair or as an additional element. Follow the steps below to do this.

  1. Browse to Configuration | Components | Selection, then click Add Element+.
  2. Select Geolocation, then click Save.
  1. Click Geolocation.
  2. Select Enabled, then click Save.

A “Know your location” pop up will display on your screen as soon as Geolocation is activated. If you have previously Blocked geolocation for another site, this will not display. The same applies if Location Settings have been deactivated on your computer.

Note: If you have not set up Country - Value with ISO 3166-1 Alpha-3 codes, you can either change them at this point or add them into your configuration.
  1. Browse to Configuration | Components | Selection | Fields, then click 1. Select your Country (or whatever you have labeled the prompt for country selection).
  2. Click Options.
  1. Click the first country in the list.
  2. Either change the Value to the ISO 3166-1 Alpha-3 code, e.g. fr will become FRA or
  3. Click Add Element+ to add Country Code.
  1. Select Country Code, then click Save.
  2. Enter the 3-letter ISO code for the country, e.g FRA for France.
  3. Repeat this for each country listed.
  1. Finish adding country codes, then click Save.
  2. Type in a comment, then click Confirm.

Geolocation – Regions and Countries

Note: If you are using Regions with Countries, you will need to add some additional configuration to match the two together.
  1. After enabling Geolocation, click Add Element+.
  2. Select Cascading Values, then click Save.
  1. Click Cascading Values.
  2. Click Add Row+.
  1. Click 1.No Label.
  2. Enter region for Key*, and the name of one of your regions (as per the value you used when creating the attestation) for Value*.
  3. Click Add Element+.
  1. Select Conditional, then click Save.
  2. Click Conditional.
  1. Click + Create Conditions*.
  2. Click Add Row+. Each row will add a condition for a specific country to be related to a specific region.
  1. Click 1.No Label (the first row).
  2. Click Add Element+.
  1. Select Field, Operator and Value, then click Save.
  2. Enter country for Field, and in for Operator.
  3. Use the dropdown to select string for Value
  4. Leave the value blank.
  1. Switch to <> (JSON) view.
  2. Delete the quotes next to value.
  3. Enter a pair of [ ] (square brackets).
  4. Press enter with your cursor between the square brackets so that a new line is created.
  1. Add double quotes with the country code (from the original country key value pair).
  2. To add more countries, enter a comma, then press enter, and repeat for as many countries are needed.
  1. Repeat these steps for the other regions.
  2. Click Save.
  3. Type in a comment, then click Confirm.

Read more on Wizard Styling or Dropdown Styling.