SST Snippets
Create a snippet if text will be repeated more than once to single source s much as possible.
This table lists the current snippets in the help.
NOTE: This does not include the snippets used as buttons on the topics that, whcn clicked, returns the user to the WebApp overview topic.
Paragraphs have been added here so that the table is not hidden by the TOC on the right.
|
Snippet name |
Text |
Use when: |
|
ActionableReports |
NOTE: Actionable reports are error reports with a non-zero record count. Report types for error reports are: Error—Identifies reports that display data that must be fixed before it can be loaded into the target system.Target Readiness—Identifies reports with data that cannot be loaded into the target system, such as a record missing required fields, invalid check table values, or a field with an incorrect number of decimal places. These records will either produce an error on load or load incorrectly. Records on these reports are probably excluded from the target export.Business Readiness—Identifies reports with data that if loaded into the target system would decrease data quality or cause business errors in the data. This data could load into the target system (as in, loading this data would not cause errors). However, the data should not be loaded into the target system because it violates business rules. |
In Migration Reports and Transform mention the Actionable report type. |
|
Add Mode |
If no records exist, the page displays in add mode. Otherwise, click Add. |
Use in steps when a page opens with a blank row ready to add data. |
|
BusinessProcessPosition |
To add a scenario to a business process, you must configure security to include the position for the business process. Refer to Configure Business Processes in a Position for more information. |
MDM business process definition. |
|
ConnectionTimeout |
NOTE: If rule processing is timing out due to a large amount of data, review the Command Timeout field on the Vertical View of the Data Sources page in System Administration and increase this value if needed. |
Transform: This described an issue that could occur when running rules in Transform. It was repeated across all use cases about adding rules in Transform. |
|
CopyrightFooter |
BackOffice Associates, LLC d/b/a Syniti. and/or its affiliates. All rights reserved. Names appearing on the Site may be trademarks of their respective owners. |
This text is in the footer of our master pages. The only update is to the copyright date, and tat is controlled by a variable. |
|
DQSecurity |
NOTE: For information about setting user security to view reports, refer to Set Up Security for Data Quality. |
This note was added throughout the Manage Groups topic in Data Quality as requested by a consultant to make security clearer. |
|
DSP Supplied check box |
If checked, this content is installed with the Stewardship Tier and cannot be edited. If unchecked, the content was added by a user or process. NOTE: This is a display-only check box. It cannot be updated. |
Any time the System Supplied check box is on a page this si the page descritions. |
|
dspMonitorErrorCost |
Error cost is calculated by multiplying the number of errors on a report by the report's cost per failure, entered on the Vertical View of the Repository Reports page. Refer to Configure the Business Value Dashboard for more information. |
Included in all of the Data Quality page descriptions that start with “Your”. |
|
MultSelect |
NOTE: To select a contiguous range of records, hold down the Shift key and select the first and last records in the range. To select a noncontiguous range of records, hold down the Ctrl key and select each record. |
In steps where users can multi-select. This is a common task across the application tho, so I’m not sure we need to point it out. |
|
Org Unit Position |
To use an Org Unit, you must configure security to include the position for the Org Unit. Refer to Set a Role's Org Unit Value Assignments for more information. |
Used throughout the MDM topic Manage Org Units |
|
Quality Dimension |
Displays a recognized term used by data management professionals to describe a feature of data that can be measured or assessed against defined standards to determine data quality. Refer to Register Quality Dimensions for more information. NOTE: Data Quality is delivered with these industry-standard quality dimensions: Accuracy, Completeness, Conformity, Consistency and Validity. NOTE: All Error reports require a quality dimension. |
Linked from Data Quality “your” pages |
|
Role Position |
To add a task to a role, or to add a role to a scenario, you must configure security to include the position for the role. Refer to Configure Roles in a Position for more information. |
Included in MDM topics, Add a role, add a role to a scenario and add a task to a role |
|
SAP Support |
SAP Support using component XX-PART-SYN |
Any time we tell users to contact Syniti support,we should include this snippet as well for the solex version, and use the ISA CT for it. This snippet has the email set up. |
|
Syniti Support |
Syniti Support |
Use whenever we mention Syniti support, the snippet has the email set up. |
|
Table Rename |
Displays the table name of the renamed table in the target database. NOTE: If the Table Rename field is populated, the Rename Table Template field on the Target Sources page has no effect. |
Used throughout Collect in multiple topics to help clear up the Table Rename field. |
|
Trace Level Long |
Disabled - Debugging is disabled. Debug - All logs returned during execution of the process display on the debug log. Information - Only Information messages display on the debug log. Warning - Warning, Error and Fatal messages display on the debug log. Error - Error and Fatal messages display on the debug log. Fatal - Fatal messages display on the debug log. |
Used in one topic in Data Quality two times. This app |
|
Trace level short |
Debug - a detailed message displays to provide data about the process. Message - an information message displays to mark a landmark in the code. Warning - a message displays to inform the user that a problem could surface. Error - an error message displays while the process is executing; processing can continue. |
This appears once in a topic, I think we should copy the text into the topic and remove the snippet. |
|
View Reports |
Debug - a detailed message displays to provide data about the process. Message - an information message displays to mark a landmark in the code. Warning - a message displays to inform the user that a problem could surface. Error - an error message displays while the process is executing; processing can continue. |
Used in Transform and migration Reports any time viewing reports is mentioned. |
|
WaveCollationSecurity |
NOTE: Only users assigned to the System Administrator or the Migration Developer Advanced security roles can change the collation for the wave. Refer to Delivered Security Roles in System Administration for more information. |
Used in Console and Common to clarify access to this feature. |
|
WhenRequestaNewProductLicense |
Lots of text and an error message that displays when a license needs to be updated |
Used in the page descriptions for help on Product Licenses page and in the stand aalone licensing topic. |
