Service Plan Names and Descriptions
Product Specifics / SAP BTP Services
Introduction
Service Plan Names, Service Plan and Entitlement Descriptions, Service Plan Features
To guarantee consistency for service plan names, descriptions and features, refer to the following process and guidelines.
Service Plan names and descriptions for the Free Tier model need to follow some extra guidelines. These are included and marked in the following general guidelines.
Getting Started
The service plans and their definitions that appear in the SAP Discovery Center are entered by UA developers via the use of the Data Sheet. Please make sure what you enter for the SAP Discovery Center (Data Sheet) matches what you enter in the Service Marketplace in the cockpit.
The following guidelines will show you how to create
- A new service plan name
- A service plan or entitlement short description
- Service plan features and service plan feature descriptions
- Technical service plan names
Guidelines
Creating a New Service Plan Name
There are service plan display names and service plan technical names: the display name should match the technical name as much as possible. While technical service plan names don't use whitespaces, display names can and should use them.
Example: Technical name: "blocks_of_100_records", Display name: "Blocks of 100 Records"
- Service plan names must be as descriptive as possible. If you offer more than one service plan, make sure to clarify the context between them (“Is one more advanced than the other?” “Do they have anything to do with each other?”, etc.) Descriptive names also help with scalability, for example if you're planning on adding more service plans later.
- Sizes, figures and numbers in service plan names are okay. For example, "Blocks of 100 Records", "Small", "Medium", "Large".
- Don't use your service name in the name of your service plan as this would not be descriptive or scalable.
- Service plan names are always written in upper case and consist of nouns and adjectives. Don't use verbal phrases like "Connect to…".
- The maximum length allowed for service plan display names is 100 characters, including whitespaces.
- Add a meaningful description to your service plan in the SAP Discovery Center and the Service Marketplace See section Creating a Service Plan or Entitlement Short Description for service plan description guidelines.
- Free” - use this term if your service plan is free of charge.
- "Enterprise" - use this term to express that this service plan is more robust, scalable and made for larger entities.
- "Employer" - use this term if the service plan is made for B2E scenarios and you want to specify the scenario in the service plan name.
- "Business" - use this term if the service plan is made for B2B scenarios and you want to specify the scenario in the service plan name.
- "Consumer" - use this term if the service plan is made for B2C scenarios and you want to specify the scenario in the service plan name.
- "Standard" - only use this if you can't find a more descriptive name and you want to express that this is the "basic" service plan offering.
The following terms should not be used since they are not adding any value for the customer or are redundant.
- “Freemium”
- "application"
- "basic edition"
- "default"
- "edition"
- "version"
- "option"
Creating a Service Plan Short Description in SAP Discovery Center or SAP BTP Cockpit
Terminology
- In the SAP Discovery Center, a service plan is a commercial plan.
- In the SAP BTP Cockpit, a service plan is a technical implementation of the service plan described in the SAP Discovery Center that the customer can activate. In most cases, there is a one-to-one relationship between service plan in the SAP Discovery Center and service plan in the SAP BTP Cockpit. Another common case is when there are 2 service plans in the BTP Cockpit for 1 service plan in the Discover Center (instance + application/UI). And for the minority, there is a 1-to-n relationship between the Discovery Center and the BTP Cockpit.
Guidelines for Service Plans Descriptions
Content
- Describe what the customer can achieve with the service plan in 1-2 sentences. When the customer select the service plan, what exactly is going to happen?
- Describe what the technical implementation means and how it fits to the commercial service plans.
- Include all information about dependencies to other technical implementations or service plans.
- Answer the question: Why does the customer need to activate this service plan?
Wording
- Directly address the customer.
- Keep it short and simple, briefly convey the essence of the service plan, do not repeat what the service plan display name already says. Start the sentence with an imperative (such as "Create...", "Build...").
- Do not use the service plan name in the description.
- Avoid words like “enables”, “helps”, and “provides”. Everything we deliver at SAP is aimed at helping our customers – tell them how.
- Do not use the word “cloud” if possible. Customers already know they are on the cloud platform, they expect cloud services/tools.
Formatting
- The maximum length of a description is 512 characters, including possible disclaimers.
- End the description with a period.
- Do not use bulleted lists.
- Do not use the em dash ( – ). You can use the hyphen if a dash is needed ( - ).
- Do not use quotation marks.
- Do not use hyperlinks - those can be added to the dedicated link sections in the cockpit and in the marketplace.
- Do not use HTML tags like <br>, etc.
Please note: If you are offering a "Free" service plan, you need to add specific disclaimers to the service plan and entitlement descriptions. The maximum description length being 512 characters, remember to take into account the length of the disclaimer when writing the description.
In the SAP Discovery Center, add the following diclaimer to the description:→ “Only community support is available for free tier service plans and these are not subject to SLAs”.
In the cockpit service marketplace, add the following disclaimer including the provided link:→ "Please note, only community support is available for free service plans and these are not subject to SLAs. Use of free tier service plans are subject to additional terms and conditions as provided in the Business Technology Platform Supplemental Terms and Conditions linked below:
Business Technology Platform Supplemental Terms and Conditions"
Examples
capabilities of SAP Build Process Automation, you also must subscribe to
the standard entitlement at no additional cost.
and a certain amount of API calls and storage. In API-driven use cases or with a very many process instances, additional licensing could be needed for API calls and storage.
Service Plan Features and Service Plan Feature Descriptions
The service plan features can consist of the feature name, quantity, description and an additional info link.
- Feature Name: Consists of the metric including the unit of measure. Written in title case. Max. 512 characters per feature.
For example, "API Calls per Month", "Quota Limit per Hour". - Feature Quantitiy: (If applicable) State only the amount, no unit of measure. For example, "300", "5". Max 256 characters.
- Feature Description: Explain the feature in one or two short sentences. Max. 2048 characters.
- More Info: Link to additional documentation, use a descriptive link title.
Technical Service Plan Names
- The technical plan name must be all lowercase, alphanumeric (no spaces, underscores, or special characters are allowed, except for hyphen "-").
- Max 40 characters.
- Must be the same as the service plan in the payload you report to the metering service.
- If you have a broker, it must be the same as the plan name in your broker catalog.
If you have questions, please reach out to Holger Neuert, Shay Barry, Hanna Salamon, and Anja Nicole Kretz.