Customizing the SSOSessionTimeout.jsp page for Kofax Front Office Server 3.5.2 Date July 23, 2014 Applies To Kofax Front Office Server (KFS) 3.5.2.10 Summary This application note provides instructions for customizing the SSOSessionTimeout.jsp page for Kofax Front Office Server 3.5.2.10. It also provides a description of what the SSOSessionTimeout.jsp.page is used for. Revision 1.0 Customizing the SSOSessionTimeout.jsp page Single Sign-on (SSO) used with Kofax Front Office Server (KFS) allows a user who is linked in Kofax Capture to automatically log into the KFS Administration Console or the Thin Client without being prompted. Additional information on this type of configuration can be found in the Kofax Front Office Server 3.5.2 Administrator s Guide. A client.session.sso.timeout.logout=false property was added to the kfsportal.properties file in KFS 3.5.2.10. When this property is enabled, it redirects the KFS user s Web browser to the SSOSessionTimeout.jsp notice page when the SSOsession times out. This application note focuses on customizing the SSOSessionTimeout.jsp notice page. NOTE: The KFS user will only see this page if they have logged in using SSO and the KFS Thin Client or Administration Console session has expired. Shortcuts The links below will provide a way to move quickly to the key sections in this document. 7-Zip Important Information (read before configuring the SSOSessionTimeout.jsp page) Configuring the SSOSessionTimeout.jsp page
7-Zip 7-zip is a third-party open source file archiving utility with a high compression ratio, which can be used to open the KFS archive files and save the changes while preserving the archive's internal folder structure. 1. Download the appropriate 7-zip for Windows installer (32-bit or 64-bit) from http://www.7-zip.org. 2. Install 7-zip using the default options. 3. For more information regarding the installation and use of 7-zip, please refer to the documentation available from http://www.7-zip.org. Important Information! (Please read before configuring the SSOSessionTimeout.jsp page) Kofax recommends that the steps provided in this article be first configured and tested in a development environment. After testing the customized SSOSessionTimeout.jsp page and confirming it works in the desired manner, the above changes are ready to be rolled out into a production environment. Always back up all files to be edited to a secure location before making any changes. When opening a KFS archive file, Kofax recommends that an archiving utility, such as 7-Zip (which will preserve the archive s internal folder structure) be used. Failure to preserve the internal folder structure when saving changes to a KFS 3.5 archive file will cause KFS to cease functioning. Installation of a KFS 3.5.x Service Pack or Fix Pack will overwrite the files modified in this application note s procedure. When making a backup copy of the KFS.ear file, make sure the copy is moved outside of the deploy folder. Java will attempt to deploy any and all files in the deploy folder, so the presence of backups in that folder will cause startup delays and needless error log entries. Single sign-on will not work when logging in the Thin Client from the local KFS Server. Configuring the SSOSessionTimeout.jsp page NOTE: The instructions below assume that you have downloaded and installed the 7-Zip utility. 1. Stop the KofaxServer service. 2. Navigate to C:\Program Files\Kofax\Front Office Server\Avalin\jboss\server\avalin\deploy. 3. Make a backup copy of the KFS.ear file and save it to a folder located outside of the deploy folder. NOTE: The changes to the KFS.ear file should be made to the original KFS.ear file located in the path outlined in Step 2. The changes should not be made to the backup or any other copy of the KFS.ear file. Page 2
4. Right-click on the KFS.ear file and select 7-Zip Open archive. 5. Inside 7-Zip, navigate to C:\Program Files\Kofax\Front Office Server\Avalin\jboss\server\avalin\deploy\KFS.ear\DESPortal.war\WEB- INF\classes\com\kofax\des\shared\. 6. Right- click the viewres_en.properties file and select Edit. 7. Locate the following string at the end of the file. VIEW_SESSION_TIMEOUT_MESSAGE Page 3
8. Modify the value of VIEW_SESSION_TIMEOUT_MESSAGE, beginning after the = sign, to the custom message. HTML tags can be used to format content. 9. Save the changes and close the text editor. 10. Cick Yes to confirm saving changes to the viewres_en.properties file when prompted by 7-Zip. 11. Click OK to confirm that you want to update the archive. 12. Within 7-Zip, navigate to the root of KFS.ear C:\Program Files\Kofax\Front Office Server\Avalin\jboss\server\avalin\deploy. Page 4
13. When prompted by 7-Zip, confirm updating the DESportal.war file. 14. Close 7-Zip to exit KFS.ear. 15. Navigate to C:\Program Files\Kofax\Front Office Server\Avalin\jboss\server\avalin\. 16. Delete the tmp and work subfolders. NOTE: The tmp and work subfolders will be recreated after restarting the KofaxServer service. 17. Start the KofaxServer service. Page 5