OnePlace Solutions Error Dialogs - Support Information
In the event of an error in the use of the OnePlace Solutions
software, the error dialog that is presented to the user can be customized
to include support details of your company.
|
Property |
Mandatory / Optional |
Description |
|
action |
Mandatory |
Set to "insert" to change the default behavior
Set to "delete" to revert to default behavior |
|
name |
Mandatory |
"Phone" for phone number "Email" for email address "Website" for
website address
"SupportLabelText" for main support header text on dialog
"SupportDetailsText" for an instruction message |
|
value |
Mandatory |
Value of each of the name options above |
Example: Setting
support information.
Copy
Code
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<OPMErrorDialogValues>
<OPMErrorDialogValue action="insert" name="Phone" value="123456789"/>
<OPMErrorDialogValue action="insert" name="Email" value="[email protected]"/>
<OPMErrorDialogValue action="insert" name="Website" value="http://www.xyzcorp.com/support"/>
<OPMErrorDialogValue action="insert" name="SupportLabelText" value="Support Contacts"/>
<OPMErrorDialogValue action="insert" name="SupportDetailsText" value="Please contact one of the below numbers or addresses"/>
</OPMErrorDialogValues>
</configuration>
Custom Error Dialog Image
The error dialog image can be customized to have a company logo or any other
image. The image will replace the image shown below:
The image must be called OPMErrorDialogImage.jpg and must be placed in the
OnePlace Solutions install directory (by default C:\Program Files\OnePlace
Solutions).
The image size must be Width 302 pixels, Height 173 pixels.
General Error Messages
Many errors that appear can have customized text. Within the
<ErrorMessages> tags, each <ErrorMessage> tag must have the
following properties:
|
Property |
Mandatory / Optional |
Description |
|
action |
Mandatory |
Set to "insert" to set the default behavior
Set to "delete" to revert to default behavior |
|
tag |
Mandatory |
Defines the particular element you wish to customize |
|
text |
Mandatory (on insert) |
The replacement text for that element |
Example:
Inserting customized error messages
Copy
Code
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<UICustomization>
<ErrorMessages>
<ErrorMessage action="insert" tag="NavigationTreeNode_LoadingFolders" text="Error Loading Folders"/>
<ErrorMessage action="insert" tag="MessageBox_InvalidUrl_Title" text="Invalid Url"/>
<!--Note: The text for MessageBox_InvalidUrl_Body is prefixed with the location Url that is invalid. -->
<ErrorMessage action="insert" tag="MessageBox_InvalidUrl_Body" text="does not exist. The folder may have been deleted or renamed."/>
<ErrorMessage action="insert" tag="MessageBox_LoadingFolders_Title" text="Error Loading Folders"/>
<!--Note: The text for MessageBox_InvalidUrl_Body can have newlines added by adding '\n' (without the quotations) -->
<ErrorMessage action="insert" tag="SaveToSharePoint_LocationInaccessible_TabProperties" text="The selected location is unavailable.\nThis may be due to the location no longer existing or access being removed."/>
</ErrorMessages>
</UICustomization>
</configuration>
Example:
Deleting customized error messages
Copy
Code
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<UICustomization>
<ErrorMessages>
<ErrorMessage action="delete" tag="NavigationTreeNode_LoadingFolders"/>
<ErrorMessage action="delete" tag="MessageBox_InvalidUrl_Title"/>
<ErrorMessage action="delete" tag="MessageBox_InvalidUrl_Body"/>
<ErrorMessage action="delete" tag="MessageBox_LoadingFolders_Title"/>
<ErrorMessage action="delete" tag="SaveToSharePoint_LocationInaccessible_TabProperties"/>
</ErrorMessages>
</UICustomization>