Follow

How to: Customize Terminology of End User Portal

Applies To:

Venafi Trust Protection Platform 14.4+

 

Summary:

The End User Portal is coupled with the Aperture Framework.  This allows the End User Portal, like Aperture, to support persistent changes to terminology and styles that will generally continue to work across upgrades.

 

Details:

  1. Download the "End User Portal Custom Terminology and Style (EN-US).zip" that is attached to this article.  
  2. Assuming you have used the default install paths for both TPP and the End User Portal, extract the contents to the root of your C:\ Drive.
  3. The following files will be extracted:
    C:\Program Files\Venafi\User Portal\public\plugins\EndUserPortal\terminology-custom-en-us.js
    C:\Program Files\Venafi\Web\Aperture\Client\Plugins\EndUserPortal\terminology-custom-en-us.js
    C:\Program Files\Venafi\User Portal\public\js\terminology-custom-en-us.js
    C:\Program Files\Venafi\Web\Aperture\Client\Js\terminology-custom-en-us.js
    C:\Program Files\Venafi\User Portal\public\plugins\Authorize_Password_EndUserPortal\terminology-custom-en-us.css
    C:\Program Files\Venafi\User Portal\public\plugins\EndUserPortal\terminology-custom-en-us.css
    C:\Program Files\Venafi\Web\Aperture\Client\Plugins\Authorize_Password_EndUserPortal\terminology-custom-en-us.css
    C:\Program Files\Venafi\Web\Aperture\Client\Plugins\EndUserPortal\terminology-custom-en-us.css
  4. The following four files are simply placeholders. Their mere presence is what tells the End User Portal that it should be using Custom Terminology for the English United States language, the contents should not be modified, however you will need to modify the file names to reflect the language/location of the intended browser. For example if you are in Great Britain, you would rename terminology-custom-en-us.js to terminology-custom-en-gb.js:
  • Venafi\Web\Aperture\Client\Plugins\Authorize_Password_EndUserPortal\terminology-custom-en-us.css
  • Venafi\Web\Aperture\Client\Plugins\EndUserPortal\terminology-custom-en-us.css
  • Venafi\Web\Aperture\Client\Plugins\EndUserPortal\terminology-custom-en-us.js
  • Venafi\Web\Aperture\Client\Js\terminology-custom-en-us.js

 

 

More Information:

  • To get a full list of ISO country codes see the following link:
    • https://www.iso.org/obp/ui/#search/code/

 

  • This file is what contains the actual changes to the terminology of the end user portal.  You will want to review the terminology listed.  Terminology that you do NOT make changes to should be removed from the file.  The end result of your terminology file should only be terminology variables and values that have been customized from the default text.
    • Venafi\User Portal\public\plugins\EndUserPortal\terminology-custom-en-us.js

 

  • This file can be used to change the company name.  This will affect Aperture as well:
    • Venafi\User Portal\public\js\terminology-custom-en-us.js

 

  • This file is used for the styles for the login page of the End User Portal:
    • Venafi\User Portal\public\plugins\Authorize_Password_EndUserPortal\terminology-custom-en-us.css

 

  • This file is used for customizing the styles after the user has authenticated to the End User Portal:
    • Venafi\User Portal\public\plugins\EndUserPortal\terminology-custom-en-us.css

 

  • After you are done with your files, restart IIS for the changes to take place.  After IIS knows about the presence to both files, you can make further modifications to the files and they will take effect immediately without restarting IIS.
  •  A useful peice of code that can be saved to a .html file and when ran it will tell you the local of your browser:

    <!DOCTYPE html>
    <html>
    <body>

    <h2>The Navigator Object</h2>

    <p>The language property returns the browser's language:</p>

    <p id="demo"></p>

    <script>
    document.getElementById("demo").innerHTML =
    "navigator.language is " + navigator.language;
    </script>

    </body>
    </html>

  • If the End User Portal is not installed on the same server as Aperture, then some of the customized files in the example zip (attached to this article) will need to be placed on the Aperture server where the End User Portal is pointing to. The files are:
    • C:\Program Files\Venafi\Web\Aperture\Client\Js\terminology-custom-en-us.js
    • C:\Program Files\Venafi\Web\Aperture\Client\Plugins\EndUserPortal\terminology-custom-en-us.js
    • C:\Program Files\Venafi\Web\Aperture\Client\Plugins\Authorize_Password_EndUserPortal\terminology-custom-en-us.css
    • C:\Program Files\Venafi\Web\Aperture\Client\Plugins\EndUserPortal\terminology-custom-en-us.css
      Important note: End User Portal remote installation is scheduled for deprecation, for more information check Functionality Scheduled For Deprecation.
Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

  • Avatar
    David Firestone

    Very useful, worked like a charm.  There are additional customizable fields not in the terminology-custom-en-us.js file in the provided .zip (such as "SuccessSupportText").  These can be discovered by interrogating the "plugin.js" file in the appropriate folder to find the necessary values to put in the custom js file.