Help
This allows you to access support resources, and clear your local storage, during any step of the shipping process. Note that the tray can be opened using the keyboard shortcut F1.
Support Options
The Support Options button provides context sensitive help based on the current App in use. Where [App Name] is referenced, this will be the name of the App. It contains the following elements:
- [App Name] Help - provides a link to relevant documentation.
- Ask a Question - loads an email prepopulated with the subject line: [App Name] Question.
- Submit a Feature Request - loads an email prepopulated with the the subject line: [App Name] Feature Request.
- Submit a Support Case - loads an email prepopulated with the subject line: [App Name] Support Case Request.
Configuration
The detail shown in the help tray is controlled by the following settings, configured in the All Settings page of the Administration App's Data tab:
|
Support Button Visible. Enables the Support icon in Apps. | True |
Support Documentation Site Url. Link to the relevant documentation site via Support Options. | http://documentation.transtream.com |
Support General Question Email Url. The email address used to prepopulate general question emails submitted via Support Options. | faq@pierbridge.com |
Support Submit Feature Email. The email address used to prepopulate feature request emails submitted via Support Options. | featurerequest@pierbridge.com |
Support Submit Support Case Email. The email address used to prepopulate support case emails submitted via Support Options. | help@pierbridge.com |
Support Account Title. The title of the account number field. | - |
Support Account Value. The client's account number. | - |
Support Site Title. Display text for the support site link. | Support Site |
Support Site Url. The Url to the relevant support site. | http://documentation.transtream.com |
Support Contact Title. Display text for the contact link. | - |
Support Contact Url. The Url to the relevant contact resource. | - |
Support Telephone Title. The title of the telephone field. | Tel: |
Support Telephone Value. The relevant support telephone number. | - |
Support Hours Title. The title of the hours field. | Hours: |
Support Hours Value. The relevant support telephone availability. | - |
Support LMS Title. The title of the learning management system (LMS) field. | Transtream University |
Support LMS Url. The Url to the relevant LMS resource. | http://transtreamuniversity.litmos.com |
Note that if the Value setting is not populated, the associated Title will not appear in the support tray. E.g. if Suppport Hours Value is not provided, the Suppport Hours Title will not display. If all Value settings are empty, the support tray is not shown.
The Clear Local Storage option clears any cached data that was retrieved using the PierbridgeListRequest. Alternatively, use the keyboard shortcut Alt + F5. This data is cached for an hour. Any changes are made to this data, E.g. enabling a carrier, do not display in the App until an hour has passed, or until the local storage is cleared.
Article last edited 23 March 2021