Stibo Systems' solutions enable organizations to turn master data into a trusted asset by more effectively managing, gathering, sharing, and publishing master data across the information supply chain.
The online documentation accessible on this page is organized into main topics that cover the concepts and procedures recommended for using the Stibo Solutions Enterprise Platform (STEP), add-on components, and functionality specific to product lines.
Our master data management (MDM) platform is a dynamic tool and under continuous development. Because of Stibo Systems' dedication to improving its software offerings to meet our customers' evolving needs, it is possible your system may contain additional functionality not yet described in this online help. As with our software, the online help is under continuous development. Updates to the online help are typically released with each maintenance patch and feature release.
Important: Some functionality is controlled via licenses and therefore may not be available on your specific system. For additional information on licensing, contact Stibo Systems.
Styling on the workbench and Web UI images within the online help vary based on the operating system. While the same dialog in your own system may not look exactly like the one in online help, the functionality is not altered by the cosmetic differences.
Email address hyperlinks within online help require that you have a default email program / app. For assistance in assigning a default, search for the 'default email client' on your computer or the web.
Note: Some documentation is not part of the STEP Documentation online help.
-
The online help for Instrument UI is available via a separate documentation set that you can access from your system's Start Page, or go directly to the documentation using this URL: [your system URL]/help/doc/Instrument/Default.html
You can also use this direct link: STEP Instrument Documentation
-
PDX-specific update notes and online help are available within the PDX solution. Once logged into the PDX tool, click Help Center > Documentation using the left navigation panel. Documentation opens in a new tab.
Searching Online Help
When looking for documentation within online help, the following tips and tricks will help you find the information that you need:
- Look through the topics in the left navigation panel. These topics are organized with descriptive headings, and are grouped by an umbrella topic (e.g., Workflows). Clicking the headings with the label displays additional topics (e.g., Creating a Workflow, Workflow Terminology).
- Use the search field in the upper right corner to find help topics based on keywords. Surround your search terms by double quotes to find exact matches.
- Use keyboard shortcuts (ctrl+F / cmd+F) to search for terms in search results sets or within documentation displayed on the screen.
The information above helps you quickly find the information you need. Keep reading for more detailed information about using the online help search features and common words to avoid using in the search field.
Search Field, Filter, and Button
The search field allows you to limit the list of topics displayed based on the criteria set.
To search online help:
-
Click the filter button (
) to limit your search to the selected section of online help. -
Type a search query (single keyword or multiple words) in the text field. Use double quotes for an exact search.
-
Click the magnifying glass button (
) or press Enter to initiate a search. -
Review the results list for topics related to your search.
Searching Full Text and Phrases
The following table illustrates searched words and the results returned by the online help search option. Online help search is not case-sensitive and matches may include varying endings. As an example, entering the word 'search' returns 'search,' 'searches,' and 'searching.'
For more information on effective search methods, click the video below. This video describes six methods of searching the online help users can deploy to make the search results more relevant.
For each method listed in the table below, a short video segment from the longer video above is embedded in the cell for the 'Description' column. Each video segment demonstrates an example of the search method described in the table row.
|
Text in search field |
Results include topics containing |
Description |
|---|---|---|
|
"data quality" |
'data quality' but not 'quality data' nor 'data for enhanced quality' |
" " (double quotes) indicate an exact phrase and an exact order match is required
Note: If searching multiple keywords and any of them, but not all, contains some sort of formatting (e.g., data quality), then that instance is not considered an exact match. |
|
data quality data AND quality |
both words 'data' AND 'quality' regardless of the order in which they appear |
When separating terms with a blank space, the AND is always inferred. Additionally, AND between words indicate both words must appear in the same topic.
|
|
data OR quality |
either word 'data' OR 'quality' |
OR indicates that only one of the words must appear in a topic
|
|
data NOT quality |
the word 'data' and NOT the word 'quality' |
NOT indicates that the following word must not appear in a topic
|
|
data AND (sort OR tools) |
the word 'data' AND either the word 'sort' OR the word 'tools' |
( ) (parentheses) combines multiple search functions
|
|
data AND "sort tools" |
the word 'data' AND the phrase 'sort tools' |
Multiple search functions with an exact phrase search
|
| "data quality" but only in release notes | "data quality" in release and maintenance patch notes |
Selecting from the filtering dropdown which section of the online help to search
|
Within the list of returned topics, matches of the searched word(s) are typically highlighted. In some cases there is no search highlighting. One example where search results are not highlighted is when doing a 'Web UI' search versus a 'Web-UI' search, both return the same results but the 'Web-UI' search results do not have highlighted content.
Searching Synonyms
Within online help, some words are used interchangeably (like BGP and Background Process), and some have been updated over time (Portal and Web UI). To account for these scenarios, synonyms allow you to find the topics that likely address the search you are performing. For example, the words 'environment' and 'platform' are recognized as synonyms in online help. Searching for 'environment' can return topics where that word is not found, but 'platform' is, and it is likely that the topics include data about environments and/or platforms.
Searching Common Words
The common words in the table below are ignored when entered alone in the online help search field. If you use the words within a multi-word search, results are returned. For example, entering "Create From Template" in the search field yields the expected results, but searching for the word 'From' as a standalone word returns zero results.
| Words not searched | |||||
|---|---|---|---|---|---|
| a | been | have | may | several | under |
| about | between | he | me | she | until |
| after | but | her | med | some | use |
| against | by | his | more | such | was |
| all | can | however | most | than | we |
| also | come | in | near | that | were |
| among | do | include | no | the | when |
| an | during | into | non | their | where |
| and | each | is | not | then | which |
| are | early | it | of | there | who |
| as | for | its | on | these | with |
| at | found | late | only | they | you |
| be | from | later | or | this | your |
| became | had | made | other | through | |
| because | has | many | over | to | |
Logging out of Online Help
If configured to authenticate, you were prompted to enter a STEP username and password to enter online help. If you were not prompted to enter your login details, the functionality can be enabled by adding the property OnlineHelp.Documentation.Authentication.Enabled=true to the sharedconfig.properties file. Authentication is disabled by default.
Note: The authentication option does not work with any Single Sign On (SSO) solutions other than LDAP.
When you are done with online help, you should click the Logout icon / button located on the far right of the online help toolbar. Upon logging out, the documentation login screen displays.
If authentication is disabled, the Logout button still displays. In this scenario, clicking on the button displays the Online Help welcome page.
