Where to Find Help
You can find help for SBM in the following locations:
- Documentation Center
Visit the Documentation Center to find help systems, PDFs, release notes, and videos. The Documentation Center is a public portal that enables you to search, browse, or download the latest SBM documentation or view older versions in the extensive documentation archive.
- Knowledgebase
Visit the extensive, searchable knowledgebase to find troubleshooting information, tips, and tricks. You can search for terms and phrases in the SBM documentation and the KB will return PDFs with matching results. Note that you must have a registered user account to view items in the KB. Register for a free account if you do not already have one.
- The Community
Visit the Community website to find helpful blog posts and videos. You can also test your knowledge and become certified in SBM.
Check out the User Forums to interact with other users and learn more about other products. You can view and search for information, but you must create and log in to a forum account to respond to articles and interact with other users.
In addition, solutions such as Service Support Manager and Release Control include solution-based help, which is provided to help users take advantage of the features and functions that are provided by custom forms throughout each solution.
Documentation Summary
The SBM documentation is summarized by audience below.
- Release Notes
- Documentation for Users
- Documentation for Process App Designers and Administrators
- Documentation for System Administrators
- Documentation for Developers
- SBM Mobile Documentation
Release Notes
The SBM Release Notes contain important information about a particular SBM release, including what's new, additional changes, and steps for upgrading from a prior verison of SBM. Refer to the SBM Release Notes for each SBM upgrade that you perform.
The SBM Release Notes are located on the Documentation Center.
Documentation for Users
| Title | Location | Description | Comments |
|---|---|---|---|
|
SBM Work Center Guide |
|
Provides guidance on using the Work Center interface. Covers using feeds, dashboards, activity views, calendar views, backlog views and more. |
The help link in Work Center takes you to the help system hosted on the Documentation Center. To learn about moving from User Workspace to Work Center, refer to the SBM Work Center Transition Guide. |
|
SBM Reporting Guide |
Provides guidance on using the SBM's robust reporting engine found in Work Center. |
Intended for Work Center users. |
Documentation for Process App Designers and Administrators
| Title | Location | Description | Comments |
|---|---|---|---|
|
SBM Composer Guide |
|
Provides details on using SBM Composer to create tables, fields, workflows, forms, and other process app design elements. Information about saving, versioning, importing, and exporting process apps is also provided. Intended for individuals who want to design and maintain process apps. |
The SBM Composer help is also installed with SBM. |
|
SBM Orchestration Guide |
|
Provides information about using SBM Composer to create orchestrations that use Web services to coordinate the interaction between an SBM application and one or more external systems. |
The SBM Orchestration Guide is also included with the SBM Composer help. |
|
SBM Application Administrator Guide |
|
Explains how to configure deployed applications. Instructions for managing projects, user and group accounts, and notifications are included. |
Documentation for System Administrators
| Title | Location | Description | Comments |
|---|---|---|---|
|
SBM Quick Start Guide |
Provides steps for installing and configuring SBM with the sample database. This guide is intended to help administrators set up an SBM system for testing or demo purposes. |
||
|
SBM Installation and Configuration Guide |
|
Provides information on installing SBM and creating a database. Database and Web server configuration information is also provided. |
The SBM Installation and Configuration Guide includes a copy of the SBM Configurator help. |
|
SBM Application Repository Guide |
|
Provides information on deploying process apps to runtime environments and promoting configured applications from one environment to another. |
The help link in Application Repository takes you to the help system hosted on the Documentation Center. |
|
SBM System Administrator Guide |
|
Provides information on administering the SBM Application Engine. Instructions for database utilities and system settings are included. |
The SBM System Administrator help is also installed with SBM. |
|
SBM Licensing Guide |
|
Explains how to manage licenses for SBM. License types are discussed, along with instructions for installing and using the License Manager. This guide is intended for administrators who will install and implement SBM. |
|
|
Moving to SBM |
|
Provides migration information for existing TeamTrack customers who are moving to SBM. It explains how to upgrade your existing system, and it explains the expanded SBM paradigm in relation to the TeamTrack paradigm. |
|
|
SBM Work Center Transition Guide |
|
Provides information and tips for transitioning from User Workspace to Work Center. |
|
|
SBM Security Bulletin |
|
Describes security improvements that were introduced in an SBM release. |
Only available to registered customers who log in to the Support site. |
Documentation for Developers
| Title | Location | Description | Comments |
|---|---|---|---|
|
SBM Web Services Developer's Guide |
|
Provides an overview of all SBM Web services, including descriptions for all calls, arguments, and responses. |
The SBM Web Services Developer's Guide is also included with the SBM Composer help. |
| SBM JSON API Guide |
|
Describes the SBM JSON API, which provides a set of functions that enable you to make inbound REST calls that read and update SBM items. |
The SBM JSON API Guide is also included with the SBM Composer help. |
|
SBM JavaScript Library Guide |
|
Provides information about using the functions in the SBM JavaScript library to create dynamic custom forms. |
The SBM JavaScript Library Guide is also included with the SBM Composer help. |
|
SBM AppScript Reference Guide |
|
Provides information on customizing SBM using SBM AppScript, a programming language built around VBScript 4.0. Intended for VBScript programmers who want to use SBM AppScript to implement custom features in an SBM system. |
The SBM AppScript Reference Guide is also included with the SBM Composer help. |
|
SBM ModScript Transition Guide |
|
Provides information and tips for transitioning from SBM AppScript to SBM ModScript. |
|
|
SBM ModScript Reference Guide |
|
Provides information on customizing SBM using SBM ModScript, a programming language built around ChaiScript. Intended for programmers who want to use SBM ModScript to implement custom features in an SBM system. |
The SBM ModScript Reference Guide is also included with the SBM Composer help. |
|
SBM Database Schema Reference Guide |
Completely describes the Application Engine database schema. |
||
|
SBM API Reference Guide |
Completely describes the SBM Application Engine API. |
Helpful Tips
Review the following useful information about the SBM documentation.
- For upgrades from earlier versions of SBM, refer to the SBM Release Notes for help. For upgrades from TeamTrack, refer to the Moving to SBM guide.
- The on-premise
SBM Composer help provides
everything you need to know about
SBM Composer
and it also contains the following guides:
- SBM Web Services Developer's Guide
- SBM JSON API Guide
- SBM JavaScript Library Guide
- SBM Orchestration Guide
- SBM ModScript Reference Guide
- SBM AppScript Reference Guide
- The SBM Documentation Set .zip contains all of the core SBM PDFs. This bundle does not include the SBM Database Schema Reference Guide or the SBM API Reference Guide. However, both of these are available individually from the Documentation Center.
- You can also find integration documentation the SharePoint Connector, SourceBridge, and TaskTop in the SBM Integrations tab on the Documentation Center.