Product Pages

Deliverables / SAP Help Portal

Note

These guidelines applies to all SAP BTP services.

There are separate guidelines for overview pages. To differentiate them from product pages, overview pages remove the content category icons. For the time being, custom banner images should only be used for level 1 (portfolio category) and level 2 (solutions) pages, but not for product pages.

Introduction

Every commercialized SAP BTP service has to provide a product page that includes a defined set of categories. We have agreed on a common look and feel for the service product pages. To that end, we determined a subset of possible configuration and layout options that are available for custom product pages. The details are listed on this page.

If you receive a Jira item, please update the Jira status and the BTP UA Initiatives Status Excel (located in MS Teams -> SAP BTP User Assistance -> General -> Files -> BTP UA Initiatives Status.xlsx).

Getting Started

Product Page Topic

If you already have a product page that was done as a buildable map, create a new product page topic. See Converting a Product Page in the User Guide.
For every commercialized service, use a product page topic created with the template, and insert it into a buildable map. Assign the translation languages to the buildable map
Use only one tab page: Create all your content categories on the Discover tab, or move the migrated content categories there.

To use our order of content categories, make sure that the spp-metadata contains "Merge content: No".

Metadata - Product Page Title

1. Use the long name of your service as the name of your product page. Don’t add "for the Neo Environment" to your title! Update the product_name attribute to contain only the service name as shown in the image below. If you are a Neo service, mention it in the description. (See 2)

2. Reuse the short description from the data sheet topic for your service as a description of the product.

If you are a Neo service, make sure to mention the Neo environment in your description (only for the product page, do not add this to your data sheet!)

Content Categories

Choose the appropriate content categories.

For the custom categories, use the icons mentioned in the column. Do not add the ODS_NEO_REUSE container to your dependency tree just to use the icons. Instead clone them to your container using . Then make sure to use the new LOIO in your data sheet topic.

<div> <div>No</div> <div>Name</div> <div>Content</div> <div>Mandatory / Optional Category</div> </div> <div> <div>1</div> <div><em>About This Service</em></div> <div> <ul> <li>Internal link (xref link) to complete service guide (What Is...)</li> <li>Link to Feature Scope Description (if your service has a separate FSD)</li> <li>Link to pricing information in the Discovery Center, see <a href="https%3A%2F%2Fwiki.wdf.sap.corp%2Fwiki%2Fdownload%2Fattachments%2F1935422014%2FPP-Disco.pptx%3Fversion%3D2%26modificationDate%3D1604652344000%26api%3Dv2">PPT</a>:<br><br>Link text: <strong>Pricing and Regions Information</strong><br>Link description: Learn more about pricing and usage of<br><service name> in our service catalog on SAP Discovery Center. See also in which regions the service is available.</li> <li>Do <strong>not</strong> replace "This Service". The service name is stated at the top of the page</li> <li>Use the <em>About This Service</em> icon (loioe19bfc9fe037407a9782d3e2682613d6) for this custom category. See <a href="https%3A%2F%2Fwiki.wdf.sap.corp%2Fwiki%2Fpages%2Fviewpageattachments.action%3FpageId%3D1935422014%26preview%3D%2F1935422014%2F2220392935%2FIcons.msg">attachment</a>.</li> </ul> </div> <div><strong>Mandatory</strong></div> </div> <div> <div>2</div> <div><em>What’s New</em></div> <div> <p>Link to the central SAP BTP <em>What’s New</em>:</p> <ol> <li>Open the <em><a href="https%3A%2F%2Fhelp.sap.com%2Fdoc%2F43b304f99a8145809c78f292bfc0bc58%2FCloud%2Fen-US%2F98bf747111574187a7c76f8ced51cfeb.html">What’s New</a></em> <a href="https%3A%2F%2Fhelp.sap.com%2Fdoc%2F43b304f99a8145809c78f292bfc0bc58%2FCloud%2Fen-US%2F98bf747111574187a7c76f8ced51cfeb.html">viewer</a>.</li> <li>Filter the <em>Component</em> column for your service.</li> <li>Add <em>Valid_as_Of=2022-01-01%3A2050-12-31</em> to the URL to show that all of the release notes are displayed. Please note that all <strong>&</strong> sybmols have to be replaced with <strong>&</strong> in the editor of Ixia CCMS.</li> <li>Copy the URL and use it as the link target.</li> </ol> </div> <div><strong>Mandatory</strong></div> </div> <div> <div>3</div> <div><em>Getting Started</em></div> <div> <ul> <li>Link to a <em>Getting Started</em> tutorial in the Tutorial Navigator.</li> <li>If you don't have one, link to service-specific <em>Getting Started</em> information in the documentation or in blogs.</li> <li>Users look for a <em>Getting Started</em> section to understand the basic use of the service's features. They are put off if they can't achieve anything.</li> <li>Do <strong>not</strong> link to the <em>Initial Setup</em> topic in the service guide.</li> </ul> </div> <div> <p>Optional,</p> <p>but strongly recommended</p> </div> </div> <div> <div>4</div> <div><em>Development</em></div> <div> <ul> <li>Link to the development section in your service guide</li> <li>Link to API documentation (if any)</li> <li>Link to library documentation (if any)</li> </ul> </div> <div><strong>Mandatory</strong></div> </div> <div> <div>5</div> <div><em>Administration</em></div> <div>Link to service-specific administration information</div> <div>Optional</div> </div> <div> <div>6</div> <div><em>Security</em></div> <div>Link to security section in your service guide</div> <div><strong>Mandatory</strong></div> </div> <div> <div>7</div> <div><em>End-User Information</em></div> <div>Internal link to end-user guide (if any)</div> <div>Optional</div> </div> <div> <div>8</div> <div><em>Reference</em></div> <div>Link to reference information (if any)</div> <div>Optional</div> </div> <div> <div>9</div> <div><em>Training and Education</em></div> <div>Links to learning journeys, tutorials, and so on</div> <div>Optional</div> </div> <div> <div>10</div> <div><em>Troubleshooting</em></div> <div> <p>Link to guided answers tree.</p> <p>Use the standard category <em>Troubleshooting</em>. We missed that it exists as we first had <em>Support</em>.</p> </div> <div>Optional</div> </div> <div> <div>11</div> <div><em>Neo Environment</em></div> <div> <p>If your service is available in the Neo environment, too:</p> <p>Create the custom content category to link to the new Neo-only deliverable.</p> <p>Do not insert an icon. This way, the default icon is used.</p> </div> <div><strong>Mandatory (if your service is available on Neo)</strong></div> </div> <div> <div>Last</div> <div><em>Go to SAP BTP</em></div> <div> <p>Link to <a href="https%3A%2F%2Fhelp.sap.com%2Fviewer%2Fproduct%2FBTP%2FCloud%2Fen-US%3Ftask%3Ddiscover_task">https://help.sap.com/viewer/product/BTP/Cloud/en-US</p> <p>Link text: SAP Business Technology Platform (SAP BTP)</p> <p>Link description: Get information about the broader context of this service - SAP Business Technology Platform.</p> <p>Use the Go to SAP Business Technology Platform (SAP BTP) icon (loio0ed7736c380e4b41a14838e9388447b5) for this custom category.</p> </div> <div><strong>Mandatory</strong> (as long as still needed)</div> </div>

Use at least the mandatory categories.
To make your product page searchable, add an internal link to the complete service guide buildable map in the About This Service category. For links in the other categories, use internal links - or if you use profiling - external links to point to the entry topics.
Make sure that your deliverables use the same metadata as your product page (see Onboarding).
Large services that use additional content categories for specific deliverables should add the respective icons to the categories:
- Learning Journeys: loio39b6c46bd85a4b85b57690bd79629e15 (icon in ODS_NEO_REUSE)
- Multicloud Foundation: loio2f8123675b6147469af33a0b64fe52a2
- Extensibility: loio2d6203e56f0a4f7f8da36add1a353627

2. Note on translation:

Does your product page need translation? Assign the translation languages to your buildable map and set the topic to status authoring:validation. If you use the project map of the SAP BTP projects, your product page is translated within the translation cycles of these projects. If you have your own project for the service, then set up translation with your translation coordinator.

You can provide the exact links for the translated versions using loc-comments. Note that you have to escape the & character using "&".

Link Titles and Short Descriptions

Link Titles

Make the title of a deliverable speak for itself. You can use to replace the topic title. In addition, use spp-linkdesc to add a short description to the link.

What’s New: Don't simply repeat the content category title but add the "UA" short name of the service.
Example: What’s New for SAP Application Logging Service

Short Descriptions

Start with a verb and avoid “This guide describes...”

Examples for starting a short description:

Get an overview
Learn how (to) / Learn about
Get onboarded
Explore

Example: Sidebar with Icons

On the Discover tab of your product page, use a sidebar to add supplementary information that either does not belong to any of the categories or should be promoted:

Videos: If inserting the video under About This Service creates a lot of whitespace, insert it in the sidebar instead.
Emphasize deliverables: List them in addition on the sidebar but always link them in the specific content category. Links to the SDK or the SAP API Business Hub go under Development, tutorials usually belong to Training and Education or Getting Started.
A sidebar is not a must have.

Important: If you use icons, adhere to the icon size (77x77 pixels) as defined in the User Guide. Use the same style icons as for the content categories. Make sure you do not use an existing content category icon.

General remark: Consider that sidebar links should contain content that is relevant to all categories as the sidebar runs over the whole page.

Examples

Services project page with short descriptions: SAP Workflow Service
More short descriptions on the SAP Business Technology Platform (SAP BTP).

Support

If you have feedback or questions, please contact Astrid Herbst.