The Online Help for any release of the Stewardship Tier (since 7.0) can be accessed here: https://dsphelp.syniti.com/
Below you'll find information detailing the Online Help.
Navigation
Tutorial Video
Watch Video: Online Help Basic Navigation
Access Online Help
Click the ? icon to open online help for that page. On nearly every page of the Stewardship Tier components, the documentation icon displays to the right of the filter box.
Once the online help opens, a page description topic displays for the current page.
Navigate Help
Users have several options for navigating within the help. To find a specific topic, use the search bar and filter results by the component.
To see a list of tasks performed in the component, either:
- Select the component name from the Products menu, or
- Click the Syniti logo in the header to return to the home page and select the component's name from the four center tiles.
Each component displays a Table of Contents in the right, listing all topics related to the component.
Release Notes
The What’s New topic lists new features, enhancements, and bug fixes. For more information about these changes, a link to the topic in the online help is provided. Links to release notes for earlier versions of the product display at the bottom of the What’s New topic.
The release notes are accessed via the top navigation menu titled What's New. Navigate to a heading by clicking it in the right side menu.
At the bottom of the What’s New topic, the last help build date displays.
Horizontal and Vertical View Help
For pages that have a Horizontal and Vertical view, online help is provided in the same topic. Click a link under the headings to navigate to a different view or tab within the topic.
Back to Top
To return to the top of any page, click the Top button that appears in the bottom right of a page when scrolling.
Organization
The contents are organized by the functions of components. Migration, Data Quality, Master Data Management, and Stewardship Tier.
Components that display below Migration are: ADM, Console, Target Design, Construct, Map, Transform, SQL AutoGen and Data Services AutoGen.
Depending on the version of the product and the license(s) installed, Data Quality includes Data Quality and Mass Maintenance.
Stewardship Tier includes Assemble, Collect, Common, Integrate, Syniti Connect, System Administration, Add-Ons, and Application Development.
Each component and solution has three standard topics:
- Overview: Provides a high-level introduction to the component and links to configuration topics for that component.
Access the overview topic for a component by either:
- Clicking the component name button in the header
- Clicking the component name button on the home page
- Clicking the component name in the Products menu
- Setup and Configuration for [solution/component name:] Describes all tasks related to configuration and setup that an Administrator must perform before users can start working with the component or solution. Access these topics through the overview topic.
- Setting up Security for [solution/component name]: Details steps to configure security for the solution/component. Access these topics in the Set Up and Configuration list in the overview topic.
Additionally, each component contains use cases and page descriptions.
Use cases describe tasks a user performs or tasks that the component performs.
When a user clicks the ? icon on a page in the Stewardship Tier, the page description for that page is displayed.
All fields, icons, buttons and other elements on the page are described with the exception of standard page functionality, such as edit, delete and status.
The navigation steps to access the page in the product are provided, as well as links to the tasks performed on that page.
Features
Click the Print button on the topic toolbar located above the topic title.
Remove Highlights
Click the Remove Highlights button to remove highlighted search words from a topic's text.
Footer Links
The following elements are available in the footer of every topic:
- Links to Syniti's Terms of Use, Trademarks and Privacy Policy.
- Links to Contact Support, Access the Product Ideas Portal and Request Product Training.
- Links to access the Glossary and information concerning product licenses.
Feedback
Every topic page contains a feedback button for providing feedback about that topic.
When a user clicks the button, the email associated with the client's browser opens. Enter feedback in the email body, and click Send. The feedback is sent to the Documentation team.
Current Version
The current version of the Stewardship Tier displays in the What's New topic title. The current version of the help, represented by the help build date, displays at the bottom of the What's New topic.
Search Tips
To search the online help, enter a search term in the search bar in the header, and click the Search button, which is the magnifying glass. The search results display, and the matching results show how many times the term is mentioned. A link to each of the topics containing the search term displays.
To return to the search results after clicking on a link to one of the topics, click your browser's back button.
Multiple Word Search
Use quotes around multiple word search terms (for example, “data source”) to view the topics that contain an exact phrase.
When a topic is opened from the search results page, the search terms are highlighted.
Users can remove highlighting by clicking the Remove Highlights button on the topic toolbar located above the topic title.
Search within a Topic
Use Ctrl+F to search in the current topic.
Case Insensitive
Search terms are not case sensitive and include matches with variant endings. For example, a search for "Sync Map with Target Design" returns "Syncing Map with Target Design" and "Synced Map with Target Design."
Boolean Operators
The following Boolean operators are also allowed:
- AND
- OR
- ()
NOTE: Use parentheses to combine search terms with Boolean operators. For example, search for Events and (validations or rules) to return a list of topics containing the terms events and either the terms validations or rules.
- ^
NOTE: Use the carat symbol (^) for NOT expressions. Enter (^) between terms to search for topics containing one term but not the other. For example, to search for topics that contain Org Units but not positions, enter "Org Units" ^ Positions. The word NOT cannot be used as part of an expression when searching, only the ^ is allowed.
NOTE: Wildcard searches are not allowed.
Filter by Component
Click the Filter button and select a component from the drop-down to limit the search to a specific component.
Searching All Files allows a full text search of the online help across all components and solutions.
Glossary
The Glossary provides definitions for important terms used throughout online help.
To view the Glossary, click the Glossary link in the footer on all pages in the help.
To navigate the Glossary, click a letter in the alphabet navigation bar at the top of the page. The entries that begin with the selected letter display. Letters that are dimmed do not have entries. To display all of the Glossary entries, click the All link in the alphabet navigation bar.
Prior Versions
In Syniti Solutions version 6.0.x through 6.7.x, all Online Help documentation is embedded within the product and not provided as separate documents.
Search in 6.6.x through 6.7.x
Search allows a full text search of the online help across all components and solutions.
To search help, enter a search term, and click the Search icon, a magnifying glass on the Page toolbar. The search results are displayed, and the matching results show how many times the term is mentioned. A link to each of the topics containing the search term is displayed.
The results include the component name for each topic. To search within a component, enter the component name + the search term. In the example below, the search results include only those topics in Map that contain the word “target.”
Use quotes around multiple word search terms (e.g., “data source”) to view the topics that contain the exact phrase.
When a topic is opened from the search results page, the search term is highlighted. To turn off highlighting, click the Remove Highlights icon.
Use Ctrl+F to search in the current topic.
Search terms are not case sensitive and include matches with variant endings. For example, a search for "Sync Map with Target Design" returns "Syncing Map with Target Design" and "Synced Map with Target Design."
The following boolean operators are also allowed:
- AND
- OR
- ()
NOTE: Use parentheses to combine search terms with boolean operators. For example, search for Events and (validations or rules) to return a list of topics containing the terms events and either the terms validations or rules.
- ^
NOTE: Use the caret symbol (^) for NOT expressions. Enter (^) between terms to search for topics containing one term but not the other. For example, to search for topics that contain Org Units but not positions, enter "Org Units" ^ Positions. The word NOT cannot be used as part of an expression when searching, only the ^ is allowed.
NOTE: Wildcard searches are not allowed.
To return to the search results, on the toolbar, click the Go to previous topic in browser history icon.
Search in versions prior to 6.6.x
Below are some tips to improve the results received when searching the online help for versions of DSP, ISA and ADM (DSMA) prior to the 6.6 release.
- Start searching with basic terms, such as the component name and a field name on a page (dspCompose Org Units) or a general concept (CTS).
- To search for an exact phrase, use double quotes, e.g., “Enrichment Construction” or “add a target”. The results return pages that use the words in that order.
- Use Boolean operators AND, OR and NOT. To use these operators, uncheck the Show Results that include all search words option in the Search pane and do not use quotes in the search terms, for example, Wave AND NOT Hierarchical structure.
- Enter a page name exactly as it appears in the DSP. The field descriptions for that page display, with a link to related topics.
- See the section How to Use Online Help, accessible from the Table of Contents pane, for additional information.
Please also note the following:
- Search terms are not case-sensitive.
- Online help does not, as a rule, describe customization outside of the DSP or site-specific solutions.
- These break characters:
- @ $ ^ ( ) ~ ? / { } [ ] + = ! * - %
indicate to search that the words on each side of the character are separate terms. For example, the hyphen means that the term e-mail returns all pages with e and mail. To search for “e-mail” enclose it in double quotes.