Situation Handling Framework – UI Text Guidelines

Configuration texts:

Configuration texts describe technical objects defined by extensibility specialists and key users. Meaningful names and proper descriptions support the user in modeling situations using these apps:

• Manage Situation Types
• Manage Situation Types – Extended
• Manage Situation Scenarios
• Manage Situation Objects

End user texts:

End user texts describe the business situation displayed to the users who are responsible for solving a situation. A precise description and recommendations on how to solve a situation support the user and ultimately optimize the business process. The user texts are displayed through various channels:

• My Situations
• My Situations – Extended
• SAP Fiori launchpad notifications
• Email notifications
• Related business apps

There are three types of configuration text:

• ID
• Name
• Description

These elements are often used in combination. Make sure that they complement each other.

Don’t use the terms “object”, “scenario”, “situation”, “situation handling”, or “notification” (or abbreviations or variants thereof, such as “sit” ). The use is already implicit from the context of the object.

Example of configuration texts: (1) ID (2) Name (3) Description

• After the prefix, use a descriptive name.

• Situation object: SD_SALES_QUOTATION
• Situation scenario: SD_QUOTATION_VALIDITY
• Situation template: SD_OBSOLETE_SALES_QUOTATION

Guidelines

• Use nouns.
• Use title case.
• Explain the object referring to the ID. You can use the same structure you used in the ID without the business area or industry prefix: Example ID: WLF_FCADOC, corresponding name: Freight Cost Allocation Document.
• Remember not to mention the terms “object”, “scenario”, “situation”, “situation handling”, or “notification” (or abbreviations or variants thereof, such as “sit”).
• Use a meaningful text that will help the user find the right object in the subsequent configuration steps. Don’t just copy the ID.
• Be as concise as possible to save space. Leave out unnecessary articles or verbs.
• Don’t end with a period.

Examples

• Situation object: Sales Quotation
• Situation scenario: Sales Quotation Validity

Name for Template and Trigger

Template and trigger name are special cases. Sometimes, they show the result of a process, a changing status, or an action that has already been performed or will be performed. This means you can add the participle of a verb. Additionally, the trigger refers to the object on which the action has been performed.

• Template and event-based trigger name
  • Use a noun to name the corresponding template or trigger object, for example, Contract
  • Use a participle to describe the action that has happened in the past or will happen, for example, Created, Approaching
  • Use the pattern: Object – Participle

Examples

• Contract Created
• Project Budget Threshold Exceeded
• Cancellation Deadline Approaching

• Batch-based trigger name
  • Because batches are periodically performed checks, use the pattern: Periodical – Object – Check

Example

• Periodical Contract Check

Guidelines

For guidelines about the Button Description and Situation Text Description fields, refer to End User Texts > Buttons or End User Texts > Situation Display.

• Don’t just copy the name.
• Start with a verb.
• If there are similar objects, make sure you provide a description that clearly distinguishes them and emphasize the differences.
• End with a period.

Examples

• Situation object: Describe how this object is used in Situation Handling and which of its features are relevant. Example name: Collector, corresponding description: Contains all system messages that are relevant for Financial Accounting.
• Situation scenario: Describe the business scope, which is covered by the scenario: Covers all application jobs in Financial Accounting and its associated system messages that can be used to monitor occurring messages.
• Situation template: Describe the specific use case: Inform the financial accounting specialist if there are issues in payment dunning runs.

Guidelines

• Phrase the text with the end user in mind. This may differ from the template name you defined.
• Use title case.
• Don’t end with a period, even if your text is a (short) sentence.
  Reason: The short descriptions can also appear in a list (table), so a consistent format is required. Most short description texts will not be a complete sentence.

Examples

• Staffing Request Updated Soon
• Digital License Nearly Used Up
• Blocked Invoice Overdue Soon
• Ticket Sales Low
• Overbooked Flight

Guidelines

• Don’t just repeat the short description or title.
• Start with describing the condition or facts that have happened.
  • Present: Delivery date of item <item> of purchase requisition <requisition> is about to expire.; The flight <airline> <connection> on <date> has a critical eco index of <index>%.
  • Past: An error occurred while requesting market data.
  • Future: The purchase contract <contract> will expire soon.
• Continue with a call to action: Check the inconsistencies. Only use “please” if it’s absolutely necessary.
• Write full sentences in sentence case.
• End with a period.
• You can use a maximum of 15 variables. If you include variables, ensure that their meaning is clear in your context.

Texts for public notification channels do not allow variables because they appear outside the SAP Fiori launchpad (for example, email notifications). They are not allowed to contain sensitive information.

Examples

• The project manager has updated the staffing requirements in the resource request. Check the staffed resources in the Resource Management app.
• You have used 80% of your digital access entitlement. Please renew the license if you want to continue using this service.
• A staffing request was updated. Check the staffed resources in the Resource Management app.
• You have nearly used up your digital access entitlement. Please renew the license if you want to continue using this service.

You can configure the buttons for the My Situations – Extended app that are displays on the situation page for solution proposals and navigation to related business apps. The configuration takes part in the Manage Situation Objects app. A button consists of a name and a description.

You can see a preview of the button in the Manage Situation Objects app.

Definition of buttons in the Manage Situation Objects app

Use

Callback actions are transactions that close situations. The buttons for callback actions are displayed in the My Situations – Extended app under “Solution Proposals”.

Buttons under "Solution Proposals"

Guidelines

• Use title case.
• Start with a verb describing which action is triggered followed by a noun.
• Don’t end with a period.

Examples

• Cancel Bookings
• Release Collective Settlement Document

Guidelines

• Don’t just repeat the button name.
• Describe in detail which action is performed.
• Don’t end with a period.

Examples

• Set flight status to unscheduled
• Change bookings to the next flight with the same airline and connection ID
• Upgrade economy passengers to business class

Navigation targets under "Related apps"

Guidelines

• Use the app name in title case.

Example

• Manage Purchase Contracts

Guidelines

• Don’t just repeat the button name.
• Provide additional information such as the specific page that opens in the target app or which specific item is displayed.
• Use sentence style.
• Don’t end with a period.

Examples

• Maintain flight booking details
• Check the key fields of the freight cost allocation document

Elements and Controls

• Designing Intelligent Systems (guidelines)
• Situation Handling (guidelines)
• Ranking (guidelines)
• Recommendations (guidelines)

Implementation

• [internal_only]Creating Standard Situation Templates
  (internal wiki)[/internal_only]

Visual Design

• No links