External Users

To make user preferences available to an external user, you need to make both client and server changes. These changes are described below.

For the client, you need to set the USER_PREFS_PAGE attribute to true within a <link> element. Please see the Cúram Web Client Reference Manual for further details on setting this element.

The ExternalAccessSecurity interface is used to retrieve information for an external user. This class contains 2 new methods, getUserPreferenceSetID() that reads user preferences for an external user and modifyUserPreferenceSetID() that updates user preferences for an external user. These methods must be implemented in order to retrieve user preferences for an external user. Please see the Customizing External User Applications chapter in the Cúram Security Handbook guide for further details on the ExternalAccessSecurity interface.

Once the client and server changes have been implemented, you must ensure that the relevant user preferences are visible to the external user. The <externalVisible> element within the DefaultPreferences.xml allows you to manage the visibility of each user preference to an external user. This element is described in User Preferences Definition.

If you want to make user preferences available for external users and <externalVisible> is set to false or is not defined for all user preferences, then there will be no user preferences displayed for an external user. If you do not wish to have any user preferences displayed for external users, it is recommended that the User Preferences link should not be available within the external user application.