SAP Notes

Deliverables / Support Portal

The main goal of this page is to collect information and best practices that will help you to quickly get started when you are supposed to create SAP Notes. It does not contain BTP specific guidelines.

Introduction

SAP Notes are part of the official SAP documentation. They are documents in standardized form that contain information about SAP products, or instructions about how to handle known errors in SAP systems. SAP Notes offer extended help for customers and SAP employees. Their readability, quality of information, and look and feel influence how the customer perceives and values the quality of our products. Therefore, they must meet certain criteria with regards to quality, credibility, and comprehensiveness.

Depending on its category, an SAP Note may contain information about:

Typically, SAP Notes have their own publishing cycle, which is loosely connected to the product delivery

cycle. Their content has more of a dynamic or short-lived nature.

SAP Notes are restricted to a certain topic and created because of a specific problem. They are used for reactive and preventive measures. SAP Notes may contain applicable prerequisites, interactions, and references to post-processing activities.

Types of SAP Notes

Statuses of SAP Notes

During their creation and maintenance SAP notes can go through the following statuses:

<div> <div><em>Status</em></div> <div><em>Usage</em></div> <div> <p><em>Visibility to</em></p> <p><em>Customers</em></p> </div> </div> <div> <div>In Process</div> <div>Status if the note is not released.</div> <div> <p>Customers cannot find the note while searching.</p> <p>The note is not visible for them, even if it is attached to an incident.</p> </div> </div> <div> <div>For Checking</div> <div> <p>Status to fulfill the <a href="https%3A%2F%2Fsap.sharepoint.com%2Fteams%2FSAPOneAssets%2FLibrary%2Ffunctional_areas_services_and_support%2F332_Dual_control_principle.pdf">Dual control principle</a>.</p> <p>Assign to another processor to test and release the note.</p> </div> <div> <p>Customers cannot find the note while searching.</p> <p>The note is not visible for them, even if it is attached to an incident.</p> </div> </div> <div> <div>Released Internally</div> <div>Status used only if the note is not relevant to customers</div> <div>Not visible for customers</div> </div> <div> <div>Released for Customer</div> <div>Status if note has been tested successfully and released</div> <div>Visible for all customers</div> </div> <div> <div>To Be Archived</div> <div> <p>Status can be set if the note is invalid or obsolete.</p> <p>The note cannot be archived if a support package entry exists.</p> </div> <div>Not visible for customers</div> </div> <div> <div>Pilot Release</div> <div> <p>Status for a standard preliminary correction (SPC) or a modification note or temporarily for delayed release in SPs.</p> <p>An SPC corrects an error in a standard SAP function.</p> <p>Modifications are special customer solutions, often as a workaround for missing or nonexistent standard functionality.</p> </div> <div>Only available to certain registered customers</div> </div>

Creating an SAP Note

<div> <div>Section</div> <div> <p>Quality Standard</p> <p>Description</p> </div> </div> <div> <div>Responsible</div> <div> <ul> <li>The person <strong>Responsible</strong> is the owner of the note. Тhis is independent of the current note status.</li> <li>This is the contact person for all note-related questions.</li> <li>Person responsible can be changed if that person is no longer available to respond to queries in relation to the note or if the responsibility for the note has been passed to another person.</li> </ul> </div> </div> <div> <div>Component</div> <div> <ul> <li>Specify all applicable components.</li> </ul> </div> </div> <div> <div> <p>Other</p> <p>Component</p> </div> <div> <ul> <li>Specify all applicable components in Other Component, for example, to derive the country information for Legal Changes related notes.</li> </ul> </div> </div> <div> <div>Category</div> <div> <p>The category is set to <strong>Program error</strong> by default. Make sure that you change it to the correct category.</p> <p>The following list describes the categories that you can set for SAP Notes:</p> <ul> <li>Program error – Symptom results from a program error</li> <li>Consulting – Refers to a consulting or user error</li> <li>Customizing – Symptom results from insufficient customizing</li> <li>Advance Development – When development from future releases is sent in advance to individual customers with an SAP Note</li> <li>Special Development – Refers to customer-specific development</li> <li>Documentation error – Note corrects a documentation error</li> <li>Translation error – Note corrects a translation error</li> <li>Legal change – Note contains adaptations to the existing software according to legal requirements</li> <li>Installation Information – Note provides up-to-date information about upgrades in SAP systems</li> <li>FAQ – Note contains answers to frequently asked questions</li> <li>Modification – Note provides customers with a modification solution</li> <li>Exit added – Note contains an exit. Allows the usage of several software components in one SAP system</li> <li>Performance – Note describes how the customer can improve performance or provides a correction to improve performance</li> <li>Release planning information – Note contains current information about release planning and platform versions</li> <li>Correction of legal function – Note corrects legal functions</li> <li>Upgrade information – Note provides important upgrade information</li> <li>Workaround for missing functionality – Note specifies a workaround for missing functionality</li> <li>External error – Information about a non-SAP error</li> <li>Help for error analysis – Note provides information about how to analyze typical issues</li> </ul> </div> </div> <div> <div>Priority</div> <div> <p><strong>HotNews:</strong></p> <ul> <li>A serious problem that may lead to further losses in customer systems</li> <li>Has a defined mandatory workflow</li> <li>Acute risk of data loss or system downtime</li> <li>Preventive action by the customer is essential</li> <li>You cannot set this priority by yourself. You can request this priority after the note is released</li> </ul> <p><strong>High:</strong></p> <ul> <li>Productive business flow is seriously affected</li> <li>Risk of data inconsistencies</li> <li>Error or restriction in important or frequently used functionality</li> <li>Preventive action by the customer is necessary</li> </ul> <p><strong>Medium:</strong></p> <ul> <li>Productive business flow is affected</li> <li>Error or restriction in frequently used functionality</li> <li>Preventive action by the customer is recommended</li> </ul> <p><strong>Low:</strong></p> <ul> <li>Productive business flow is marginally affected</li> <li>Error or restriction appears in individual cases</li> <li>Preventive action by the customer is usually not necessary</li> </ul> <p><strong>Recommendations; additional info:</strong></p> <ul> <li>Tips and tricks</li> <li>Documentation patches</li> <li>No preventive action necessary</li> </ul> </div> </div> <div> <div>Title</div> <div> <ul> <li>Use title case - all words longer than 3 characters start with an uppercase letter. For more information, see <a href="https%3A%2F%2Fhelp.sap.com%2Fdocs%2FSNG_FOR_UA%2Fe33c591ae4494a659a3f5f983c9d1161%2F1c06558f75ef45c686c83e6e73195142.html%3Flocale%3Den-US%26state%3DDRAFT">English: Capitalization (Sentence Style and Title Case)</a>.</li> <li>Do not use past tense - you're describing an existing problem</li> <li>Use only common abbreviations (refer to <a href="https%3A%2F%2Fr%2FAJBm3mxhWNo7BNa_NVW2KU8RZdjst2eszljfXVaHE-k">SAPterm)</a></li> <li>If possible, start the title with a significant term (such as “Cross selling: xxx”)</li> <li>Use quotation marks when quoting error messages</li> </ul> </div> </div> <div> <div>Symptom</div> <div> <ul> <li>Enter a clear and accurate description of the error from the perspective of the customer</li> <li>Use present tense</li> <li>Use full sentences</li> <li>Use the exact error message text</li> <li>If you have a crash with a unique crashdump, provide it in an indented block, mask/remove memory addresses and crash time, and mark important frames.</li> <li>Describe the effects of this error as experienced by the user.</li> </ul> </div> </div> <div> <div>Other Terms</div> <div> <ul> <li>We recommend listing all of the relevant and useful terms that are <strong>not</strong> already in the symptom text, as well as terms that can be used to search for the note.</li> <li>List the important terms from the Symptom so that the note will have a higher ranking when the user searches using these terms.</li> <li>Place commas between each term. The Other terms section cannot be empty, so you need to make at least one entry.</li> </ul> </div> </div> <div> <div> <p>Reason and</p> <p>Prerequisites</p> </div> <div> <ul> <li>Technical information that clearly describes the conditions in which the note applies.</li> <li>Remember to mention any prerequisites that exist for the error, such as special customizing settings, other application prerequisites, and so on.</li> <li>If the error is caused by a program error resulting from a note that already exists or a correction with side effects, indicate this clearly in your Reason and Prerequisites text.</li> </ul> </div> </div> <div> <div>Solution</div> <div> <ul> <li>The solution should always be concise, comprehensible, and complete.</li> <li>If the customer must carry out any actions or follow-up steps, for example to correct data inconsistencies, describe these actions in a clear and concise manner.</li> <li>If modifications, consulting information, FAQs, or workarounds related to this solution exist, refer to them.</li> <li>Internal SAP information for colleagues should not be released to customers. For notes with information of this type, set the status to <strong>Released Internally</strong>.</li> </ul> </div> </div> <div> <div>Validity</div> <div> <p>The validity of the SAP Note is set by default to be release independent.</p> <p>The validity is release dependent and is maintained automatically if the recommended process to create the note from the corrective measure has been used. If the SAP Note is not created from the corrective measure, the validity must be maintained manually.</p> </div> </div> <div> <div> <p>Support Packages</p> <p>& Patches</p> </div> <div> <p>Shows all of the Packages where the corresponding correction of the note is included.</p> <p>The entries are automatically created whenever a correction request with the note attached is set to status <strong>Released</strong>.</p> </div> </div> <div> <div>References</div> <div>Reference the SAP Notes of the affected releases and SPs.</div> </div>

Actions with SAP Notes

You will probably need to refer to other SAP Notes in the text of your SAP Note. Always link to the actual SAP Note instead of just adding its number as plain text.

You don't need to identify the link to use and then link it manually. Just highlight the number in the text, right-click it, and choose Link as Note.

Use ACROLINX IQ as a spellchecker to avoid typos and deprecated terms.

SAP Notes are machine translated. To avoid awkward versions in other languages, you need to mark the terms/phrases/abstracts that you don't want to be translated. To do so, highlight the text and click the No Translation icon.

Best Practices

1
do
false
  • Use short, clearly structured, complete, and logically correct sentences
  • Use correct spelling and grammar
  • Use the ACROLINX IQ to spellcheck SAP Notes
  • Use active voice
  • Use correct and consistent terminology and standard abbreviations (SAPterm / system entries)
  • Write out dates in their long form (for example, March 1, 2012)
  • Use the Dual control principle
  • Whenever possible use an SAP Note template
1
dont
false
  • Don't use unclear commands or unclear sentence structures
  • Don't use arbitrary abbreviations
  • Don't use unnecessary words or capitalization
  • Avoid passive voice
  • Don't use “please”

Support

If you have feedback or questions, please contact Adriana Daskalova.