Service Data Sheet

Product Specifics / SAP BTP Services

There are 2 kinds of data sheet topics used to transport common content about the service or tool from the DITA CMS to SLM (Service Lifecycle Management):

• Data Sheet for a Service (this section)
• Data Sheet for a Tool

A data sheet topic has to be created for each service on SAP BTP in the DITA CMS.

It contains common content (text fragments, images and help links) with all of the important information about the service.

1. Reuse of Data Sheet Topic Content

2. Container Setup

3. Create the Data Sheet

4. Add Content to the Data Sheet

• 1. Add Texts to Data Sheet
• 2. Add Resource Links to Data Sheet
• 3. Add Media Files (Images, Videos) to Data Sheet
• 4. Add Service Plan Texts
• 5. Add Links to the SAP API Business Hub
• 6. Update the Data Sheet

5. Add Data Sheet Topic to Buildable Maps

• 1. Use Data Sheet Content in Documentation
• 2. Use Data Sheet Content in the SAP Discovery Center

6. Sync Content from Data Sheet on UACP to SLM

• 1. Update existing content in SLM
• 2. FYI - Additional Assets Not Provided in the Data Sheet

7. Update the Discovery Center

8. Remove a Service from the Discovery Center

9. Troubleshooting the Data Sheet

Reuse of Data Sheet Topic Content

The content of the data sheet topic is reused:

• In the overview topic of the service guide and in the central FSD of SAP BTP. The reusable text fragments are referenced using conkeyrefs in the DITA CCMS.
• In the service catalog of SAP Discovery Center. Text fragments are retrieved from the Help Portal using an API and are transferred to the SLM tool. SLM (Service Lifecycle Management) is the backend repository of the service catalog.

Container Setup

• Use the container that you use for documenting your service. Either the ODS_NEO container or the separate container for your service.
• Add your container as a child to the CP_TOP (loioe822305a6b524b71964d5d2a6f465e40) container. Use the to-be-published (maybe SHIP) version of your container.
• If you clone your service-specific container, always update the dependency tree of the CP_TOP container with the correct version of your container.
• If you want to use a service-specific container for your service but have not yet created it, create it and then run it (preferably) in a push-to-ship mode.

See also: Initial Technical Setup

Create the Data Sheet Topic

• Search for the data sheet template topic in the DITA CMS:
  REFCONT: TEMPLATE Data sheet for TECHNICAL COMPONENT NAME
  (loio4d5dbfc67fcf4f5b867e3e6d375e3ff4)
• As a UA developer, use Copy with new loio to create your own data sheet topic in your service-specific container.
• Access your new data sheet topic, for example, in the Documents view under Recent Operations.
• Rename it according to the naming convention: "REFCONT: Data sheet for <technical component name/service short name>"
  Make sure to remove "TEMPLATE" from the title.
• Together with the product/service owner, agree on the content and then enter it into the data sheet topic.
• Release the data sheet topic.
  If you work in a push-to-ship container setup, push the data sheet topic to the SHIP version of your product container. The status of your topic is automatically set to Authoring:done in the SHIP version.
  If you work in a cloned container, set the status of your topic at least to Authoring:validation so that it is translated in the central CP_DATA_SHEETS buildable map.

Add Content to Data Sheet Topics

1. Add Texts to Data Sheet Topics

Follow the instructions in the data sheet topic form when entering text for the following items:

• Official short and long name
• Short and long description
• Up to eight features with a feature title and a feature description. Adhere to the following guidelines: Service Features.

While the DITA CMS allows you to go over the maximum character restrictions listed below, in SLM the (step 5) will fail.

2. Add Resource Links to Data Sheet Topics

Complete the list with links to related topics.

Each link is associated with a "classifier" that uniquely describes the meaning and the purpose of this link.

See the meaning of each link in the explanations in the data sheet topic form.

Most important are the links to the product page and to the overview topic of your service guide.

3. Add Media Files (Images, Videos) to Data Sheet Topics

Make sure to add images (preferably a solution diagram provided by your PM) and videos to visually attract and inspire a customer. Otherwise, the Service Catalog looks neglected and customers ask whether anybody is still working on that service.

• Images must have been uploaded to the DITA CMS before you can link them from the data sheet topic.
• Videos must have been uploaded to a public YouTube channel.

Enter the of previously and into the data sheet topic.

Add Service Plan Texts

Enter the restrictions with descriptions in the respective table in the data sheet. See the guidelines for service plan names.

• If there is no row for Service Plans, then copy it fom the table in the topic REFCONT: TEMPLATE Data sheet for TECHNICAL COMPONENT NAME loio4d5dbfc67fcf4f5b867e3e6d375e3ff4.

Example of Service Plans Row

2. Open your service data sheet in mode, and then paste this row into the table after the row.

3. Add content as provided by your PO.

• Content for free service plans: Determine what content to use with your PO.
• For the free service plan, the metrics probably need to be restricted to limit cost for the test version.
• How can the service be used with these limitations as compared to the standard service plan? What can't the user do?
• What was the reason for creating this free service plan?
• In general, document technical differences between the plans.
• It's possible to add links to the service plan description. Use the following format:
  [ <url> | linked text]

4. Make sure to adhere to the guidelines for texts, especially for service plan names. The field lengths in the data sheet now reflect the guidelines.

5. Fill in the technical name. It's the ID used to assign the service plan to the service. You can check in SLM what service plans are available for your service.

6. Add more feature rows or plans using the buttons. Remove unused feature rows or plans by selecting and deleting them.

5. Add Links to the SAP Business Accelerator Hub

Nagham Alshaar adds this information to your technical asset in SAP Discovery Center.

• For new APIs – Send the API package URL in the SAP Business Accelerator Hub.
• For new tools – Provide the following:
  - Tool name
  - Short description (80 characters)
  - URL in the Help Portal

6. Update the Data Sheet Topic

Depending on the container strategy of your service-specific container, you have to consider the following after you have updated the data sheet topic:

• Push-to-ship strategy: Push your updated data sheet topic to the SHIP version of your container.
• Classical strategy with cloned containers: Include the newest version of your service-specific container into the dependency tree of the CP_TOP container.

Add Data Sheet Topic to Buildable Maps

According to the use cases of the data sheet topic, you have to include your topic in two buildable maps:

1. Use Data Sheet Content in Documentation

Insert the newly created data sheet topic as the last topic in the buildable map of your service guide.

Make the data sheet topic invisible in the output that is generated from that buildable map.

To do this:

• Select the data sheet topic in the buildable map of your service guide.
• Open the Properties view for that topic.
• For the processing-role property, search and choose the resource-only property.

2. Use Data Sheet Content in SAP Discovery Center

Insert your data sheet topic in the CP_DATA_SHEETS buildable map and assign the SLM asset to the topic.

To do this, proceed as follows:

• Lock the CP_DATA_SHEETS buildable map (loio3acabdabe0c74593b069d413434b5471), which is located in the CP_TOP container.
• Drag and drop your data sheet topic into the CP_DATA_SHEETS buildable map.
• Right-click your topic.
• Choose Classify Topics... from the context menu.
• In the Classification Maps popup, expand the structure under the CP_DATA_SHEETS_CLASSIFICATION entry node.
• Checkmark your asset in the list.
  The list is ordered alphabetically. It uses the technical name of the asset as maintained in SLM.
• Close the popup.
• Release the CP_DATA_SHEETS buildable map.

The draft buildable map with all data sheet topics is built and uploaded to the Help Portal regularly.

Sync Content from Data Sheet on UACP to SLM

The service owner who drives the commercialization process for the service in SLM asks the UA to create the data sheet topic.

• Open SLM.
• Choose Technical Asset.
• Search for your technical asset and open it.
• Choose Edit.
• Choose Sync with DITA CMS.
• Choose Start Sync.
• Check all entries for correctness.
• Choose Save.

In urgent cases, you can maintain the technical asset directly in SLM. Please be aware that these changes will be overwritten with content from the data sheet topic after the next sync.

For more information, see:

• SLM tool: https://veneziasubscriber-prod-slm-approuter-mtx.cfapps.eu10.hana.ondemand.com/cp.portal/site#shell-home
  SLM documentation (under construction): https://wiki.wdf.sap.corp/wiki/x/lbK0l
  SLM support: IMAS_FOX_MDM_PIM → for Incidents, SRAS_FOX_MDM_PIM → for Service Requests
• Task description for service owner:
  https://jtrack.wdf.sap.corp/browse/CISC-276

1. Update Existing Content in SLM

For existing services, there might already be content that was directly maintained in SLM and that has never been synced from a data sheet topic.

• Review the available content (short description, long description, features, links) carefully and make sure that all information, which is still relevant and not outdated, is also contained in the data sheet topic.
• Delete the available content in SLM.
• Import the content again as described above.

2. FYI - Additional Assets Not Provided in the Data Sheet

• SVG version of the service's software icon: Your PO should provide it. It is uploaded directly to SLM by anyone with access to SLM.
• Links to SAP API Business Hub: Added by Nagham Alshaar.
• Service Plan: Added by Holger Neuert.

Update Discovery Center

Assign a Jira item to Nagham Alshaar to ask her to produce the technical asset to SAP Discovery Center. If you updated the data sheet because of a Jira you can assign that Jira to Nagham. If you have updated the data sheet without input from a Jira, please create a Jira for NGPDOC.

You can add the content for new services whenever you want – in any case it won't appear on the productive SAP Discovery Center before the official price list update in which the services become available.

Free materials can be released once you or the service owners confirm they are ready from your perspective, seeing as this is content only.

Remove a Service from the Discovery Center

• Commercial services have to go through a formal deprecation notice period.
• Non-commercial services can be removed immediately by Nagham Alshaar.

Troubleshooting the Data Sheet

The service plan table displays errors after you insert a new line:

Troubleshooting in the CCMS

This happens when you deleted an existing table row. The insert action does not take into account that the actual number of rows is lower than the number used for the last row.

To fix this, switch to text mode and correct the numbering of the service plan feature by incrementing it. In the example, all instances "features_5" of the "fourth" table row must be updated to "features_4":