How can we help?

Configure USS Dialog Messages

Anthony - Versasec Support
Anthony - Versasec Support
  • Updated

Introduction

It is possible to configure some of the message popup dialogs that the USS application displays when performing card operations with the USS. For example, it may be required to customize a popup message dialog when an end user attaches their smart card token that is blocked. If the end user starts the USS application manually or the USS is running in the system tray, then the USS will automatically popup an unblock dialog with customized information displayed in the dialog.

In order to configure this there are 2 places where this needs to be done, i.e. on the server side and on the USS application. 

Configure on Server Side

From file menu select the Program Settings and enable the check box Enable message dialog management.

Click the Configure Message Dialog button to configure the messages that can be customized. In this dialog, all available customizable message dialogs will be listed.

Self-service change PIN

From here it is possible to customize the message content that will pop up in a dialog when a smart card is attached to a client host where the USS application is either manually started or the USS is running in the system tray and the attached smart card PIN requires its PIN to be changed.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Self-service change PIN fails

From here it is possible to customize the message content that will pop up in a dialog when performing the previous operation and this operation fails for whatever reason.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Enable the Show details check box which will result in the message dialog presenting more detailed technical information that can be useful in troubleshooting scenarios.

Enable the Show support ticket check box which will add a unique system generated support ticket variable that can be attached to the message content. If this is enabled, then you can add this variable to the user defined message configured from the Edit Message button.

Enable the Enable Notification check box if it is required that an email or SMS be sent to a configurable person(s) when the message dialog appears. Click the Configure button to configure the email or SMS that can be sent in this case. This may be useful if it is required to notify an administrator if the operation failed with details that can be used for troubleshooting purposes.

Self-service PIN unblock

From here it is possible to customize the message content that will pop up in a dialog when a smart card is attached to a client host where the USS application is either manually started or the USS is running in the system tray and the attached smart card PIN requires its PIN to be unblocked.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Self-service PIN unblock fails

From here it is possible to customize the message content that will pop up in a dialog when performing the previous operation and this operation fails for whatever reason.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Enable the Show details check box which will result in the message dialog presenting more detailed technical information that can be useful in troubleshooting scenarios.

Enable the Show support ticket check box which will add a unique system generated support ticket variable that can be attached to the message content. If this is enabled, then you can add this variable to the user defined message configured from the Edit Message button.

Enable the Enable Notification check box if it is required that an email or SMS be sent to a configurable person(s) when the message dialog appears. Click the Configure button to configure the email or SMS that can be sent in this case. This may be useful if it is required to notify an administrator if the operation failed with details that can be used for troubleshooting purposes.

Self-service update card

From here it is possible to customize the message content that will pop up in a dialog when a smart card is attached to a client host where the USS application is either manually started or the USS is running in the system tray and the attached smart card requires to be updated. For example, the certificate on the smart card needs to be updated.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Self-service update card fails

From here it is possible to customize the message content that will pop up in a dialog when performing the previous operation and this operation fails for whatever reason.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Enable the Show details check box which will result in the message dialog presenting more detailed technical information that can be useful in troubleshooting scenarios.

Enable the Show support ticket check box which will add a unique system generated support ticket variable that can be attached to the message content. If this is enabled, then you can add this variable to the user defined message configured from the Edit Message button.

Enable the Enable Notification check box if it is required that an email or SMS be sent to a configurable person(s) when the message dialog appears. Click the Configure button to configure the email or SMS that can be sent in this case. This may be useful if it is required to notify an administrator if the operation failed with details that can be used for troubleshooting purposes.

Self-service issuance

From here it is possible to customize the message content that will pop up in a dialog when a smart card is attached to a client host where the USS application is either manually started or the USS is running in the system tray and the attached smart card should be issued.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Self-service issuance fails

From here it is possible to customize the message content that will pop up in a dialog when performing the previous operation and this operation fails for whatever reason.

Select the entry in the list and click Edit.

In the Message section, the Default radio button will present the default message.

Select the User defined radio button and click the Edit message button to customize the message.

If you wish to customize the message as HTML enable the HTML check box and enter valid HTML5 into the edit window. Alternatively click the Sample Message button and sample HTML will be populated into the edit window. Click the Test button to display what the message will look like when displayed by the USS application.

If you wish to enter plain text instead of HTML enter this into the edit dialog and click the Test button to display what the message will look like when displayed by the USS application.

System variables can be added to either the HTML or plain text to extend the information that can be displayed in the message dialogs. Select a variable from the available drop-down list and click the Copy button. Then paste the variable into the edit window. The variable value will then be displayed in the message dialog when shown in the USS application.

Enable the Show details check box which will result in the message dialog presenting more detailed technical information that can be useful in troubleshooting scenarios.

Enable the Show support ticket check box which will add a unique system generated support ticket variable that can be attached to the message content. If this is enabled, then you can add this variable to the user defined message configured from the Edit Message button.

Enable the Enable Notification check box if it is required that an email or SMS be sent to a configurable person(s) when the message dialog appears. Click the Configure button to configure the email or SMS that can be sent in this case. This may be useful if it is required to notify an administrator if the operation failed with details that can be used for troubleshooting purposes. 

Configure on USS Side

By default, the USS will show notifications by a balloon popup message dialog. In the scenario here we will override this default behaviour and replace it with the customized content in the configurable dialogs described in the previous section.

It will be necessary to configure this in the USS. On a client where the USS is installed open up a command window and go to location where the USS is installed, typically here C:\Program Files\Versasec\vSEC_CMS Self-service.

Run the command which will open up USS configuration dialog:

Command
vSEC_CMS_T_USS.exe -configure

This will open the USS configuration dialog.

From the Settings tab click the Configure button.

From this dialog, you can enable Popup which will override the default balloon behaviour. Also, if you want to ensure that the message dialog is always on top enable the check box to set this.