Components 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.

Some user roles are included with the Special Handling Notes (com.sn_shn) plugin.

Table 1. Special handling notes roles
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.

Some properties are included with the Special Handling Notes (com.sn_shn) plugin.

The Special Handling Notes plugin adds the following properties.

Table 2. Special handling notes properties
Property	Description
Maximum number of notes displayed in the Special Handling Notes pop-up window [sn_shn.max_num_alerts]	Type: integer Default value: 20 Location: Special Handling Notes > Properties
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.

The business rules included with the Special Handling Notes plugin (com.sn_shn).

The Special Handling Notes plugin adds the following business rules.

Table 3. Business rules installed with the Special Handling Notes plugin
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.

The client scripts included with the Special Handling Notes plugin (com.sn_shn).

The Special Handling Notes plugin adds the following client scripts.

Table 4. 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.

The script includes included with the Special Handling Notes plugin (com.sn_shn).

The Special Handling Notes plugin adds the following script includes.

Table 5. Script includes for special handling notes
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.