Components installed with Special Handling Notes
Several types of components are installed with Special Handling Notes.
Tables installed with Special Handling Notes
The tables included with the Special Handling Notes plugin (com.sn_shn).
The Special Handling Notes plugin adds the following tables.
| Table | Description |
|---|---|
| Special Handling Notes\[sn\_shn\_notes\] | Stores the special handling notes. |
| Special Handling Configuration \[sn\_shn\_configuration\] | Stores the special handling notes table configurations. |
Roles installed with Special Handling Notes
Some user roles are included with the Special Handling Notes (com.sn_shn) plugin.
| Role | Description |
|---|---|
| sn\_shn.admin | Can read, create, update, and delete special handling notes. This role contains the sn\_shn.editor role. The sn\_customerservice\_manager role contains the sn\_shn.admin role. |
| sn\_shn.editor | Can read and update special handling notes. This role contains the sn\_shn.user role. The sn\_customerservice\_agent role contains the sn\_shn.editor role. |
| sn\_shn.user | Can read special handling notes. |
Properties installed with Special Handling Notes
Some properties are included with the Special Handling Notes (com.sn_shn) plugin.
The Special Handling Notes plugin adds the following properties.
| Property | Description |
|---|---|
| Maximum number of notes displayed in the Special Handling Notes pop-up window\[sn\_shn.max\_num\_alerts\] |
|
| Display special handling notes only once per session\[sn\_shn.note\_preferences\] | Special handling notes are displayed each time you access a record. Enable this property to display special handling notes only once per session. - Type: true \| false - Default value: false - Location: Special Handling Notes > Properties |
| Width of the Special Handling Notes pop-up window in pixels\[sn\_shn.popup\_width\] | The width of the Special Handling Notes pop-up window in pixels. The default width is 500. If you specify less that 300, the window automatically uses the minimum width of 300 pixels.- Type: integer - Default value: 500 - Location: Special Handling Notes > Properties |
To learn more about the special handling notes properties, see Configure special handling notes properties.
Business rules installed with Special Handling Notes
The business rules included with the Special Handling Notes plugin (com.sn_shn).
The Special Handling Notes plugin adds the following business rules.
| Business rule | Table | Description |
|---|---|---|
| Updating the table field | Special Handling Notes\[sn\_shn\_notes\] | Populates the Table field with the table label rather than the whole table name. |
| SHN Cache Table Entry | Special Handling Notes Configuration \[sn\_shn\_configuration\] | Stores the entries in the configuration table in a cache to avoid repeated queries. |
Client scripts installed with Special Handling Notes
The client scripts included with the Special Handling Notes plugin (com.sn_shn).
The Special Handling Notes plugin adds the following client scripts.
| Client script | Table | Description |
|---|---|---|
| On Load Message | Special Handling Notes Configuration\[sn\_shn\_configuration\] | On Load Message describing what the Special Handling Notes Configuration table is for. Create a configuration by selecting a table for which special handling notes can be created and displayed. Include notes for related entities by selecting the desired fields and adding them to the configuration. |
Script includes installed with Special Handling Notes
The script includes included with the Special Handling Notes plugin (com.sn_shn).
The Special Handling Notes plugin adds the following script includes.
| Script include | Description |
|---|---|
| SHNProcessor | A collection of APIs for special handling notes. |
| SHNTable | Provides a list of tables for which the user can create special handling notes. |