Help
SLM help provides users with a built-in knowledge base that explains how to use Safety Lifecycle Manager. Every SLM installation includes a dedicated Help module containing user guides, feature documentation, API information, document management guidance, and other technical resources.
Rather than searching through external documentation, users can access detailed help topics directly within the application. The Help module makes it easy to learn new features, understand system functionality, and find answers while working in SLM.
This guide explains how to open the Help module, navigate the available topics, print documentation, and access technical reference material.
What Is SLM Help?
SLM help is a built-in documentation module that provides guidance for every major area of Safety Lifecycle Manager.
The Help module contains comprehensive documentation covering:
- SLM overview
- User interface and common functionality
- User guides
- Document Management
- System Adapters
- Template Engine and Expressions
- API and Embedded Views
Because the documentation is built directly into SLM, users can quickly find answers without leaving the application.
If you’re new to the interface, see our General Layout guide.
Opening the SLM Help Module
The SLM help module is always available from the application’s title bar.
To open the Help module:
- Log in to Safety Lifecycle Manager.
- Select the Help button in the title bar.
- The Help module opens automatically.
The module displays an object tree containing all available help topics.
Browsing Help Topics
The object tree makes navigating SLM help simple and intuitive.
Available documentation includes:
- Overview
- SLM UI and Common Functionality
- User Guide
- Document Management
- System Adapters
- Template Engine and Expressions
- API and Embedded Views
Selecting any topic immediately loads the documentation into the main viewing area.
Each help topic is organised using hyperlinks, allowing users to quickly move between related subjects.
Printing Help Documentation
SLM help also includes built-in printing options.
Users can print documentation by selecting the Print button.
Printing options include:
- Generate a PDF.
- Print using your web browser.
- Change page size.
- Select page orientation.
- Adjust margins.
- Choose output options.
- Specify an output file name.
This makes it easy to distribute documentation or keep offline copies of important reference material.
Technical Reference Information
The Help module also contains detailed technical documentation for advanced users.
Topics include:
- Field Expressions
- Required parameters
- Field data types
- API documentation
- Authentication
- Embedded Views
These sections provide technical reference information for administrators, developers, and advanced users working with Safety Lifecycle Manager.
Benefits of SLM Help
SLM help provides immediate access to documentation without requiring users to search external websites.
Key benefits include:
- Built-in documentation.
- Searchable help topics.
- User guides.
- Technical reference material.
- Integrated printing options.
The Help module enables users to become productive more quickly while providing detailed reference material whenever additional guidance is required.
To learn more about Safety Lifecycle Manager, visit our Functional Safety Management Software page.
Learn More About Using SLM
The Help module is one of several built-in resources that support users throughout Safety Lifecycle Manager. Combined with dashboards, search, bookmarks, and user support, it provides quick access to information whenever you need it.
You may also find these guides useful:
For additional guidance on creating effective software documentation, visit the Google Developer Documentation Style Guide.
SLM-101 Help
0:08
Welcome to this Application Explainer video, part of our SLM 101 topic range.
0:13
In this video we’ll be covering the subject of Help within SLM.
0:19
Every instance of our SLM software comes with a mini help module dedicated to helping the user to navigate and understand the software.
0:27
The Help Mini module provides the following help topics, an overview, SLM UI and common functionality, user guide, document management, system adapters, template engine and expressions, and API and embedded views.
0:48
To access the Help mini module, all we need to do is navigate to the help button located here in the title bar.
0:59
Once we click this button, the help mini module is loaded.
1:03
If we scroll to the left, we have an object tree with the help topics listed.
1:09
All of these are hyperlinks and for example underneath overview we have how to use this help system and what is SLM.
1:16
If we wanted further information on what is SLM, simply click the hyperlink and the information will be loaded into the right hand window.
1:23
If we wanted to print this information, we can simply click on print and we have the option to either print APDF or print using the web browser.
1:33
We can also change the page size, the page orientation, the margins, the output options, and the output file name.
1:41
Under these help topics, you can see we have an overview, we have a user guide, Document management system, Information introduction, Add in documents, Advanced features of the document management system, Adapt to information template engine and expressions.
1:57
For example, if we look at field expressions, we can see for parameters, there’s the IDs, whether the field is required, the type of field that it is, whether it’s a string, a boolean, a description of the field, and an example of the field.
2:17
If we look at API and embedded views, we can see that we’ve got a document in there that covers introduction and security, authentication, and embedding views.
2:29
To navigate away from the Help module, simply come up to the module selector and select which module you want to view next.