Basic Considerations

This chapter is optional and only required if your service offers functionality that is configurable or visible within the consuming application. It may, therefore, contain the configuration information that is relevant for the application administrators or user information that is relevant for the end-users of the application.

In contrast to all other chapters in the service guide, this chapter contains information that is relevant at the run time of an application. At this stage, the service has already been bound to the application and is running as part of the application. All other chapters contain information that is relevant during the development of this application (design time), explaining how the service is bound and how the service functionality is integrated into the application functionality.

Within this chapter, it is important to differentiate between configuration information relevant for the application administrators and end-user information relevant for the end-users of the consuming applications:

Provide the configuration and end-user information separately in dedicated subtopics.
Consider that the authors of the consuming applications might want to reuse your subtopics in their application documentation, especially if the UIs are integrated into the Fiori launchpad of the consuming applications without any change.

<div> <div>Target group</div> <div>Application administrator, application end-user</div> </div> <div> <div></div> <div>Optional</div> </div> <div> <div></div> <div>Possible chapters or (grouped under root topic )</div> </div>

Basic Considerations

The following questions might help you when trying to determine whether this chapter is relevant for you:

Does the service provide configuration or end-user UIs?
Does the service provide UI components that can be integrated into UIs of the consuming applications?
Does the service provide functionality that can be integrated into application UIs?
Does the service provide content that is visible from an application UI?

Multiple Topics

Depending whether the information relates to configuration or to the end-user, provide a respective subtopics.

Always use "Configuring <Service Name>" or "Using <Service Name>" as titles of these subtopics.

Topic Content

Title: Service Consumption at Application Runtime

Use "Consuming the Service at Application Runtime" as title of your (root) topic. Do replace it with another title. Use this root topic in all cases, even if you are only including one subtopic.

Introduction (without section title)

You can use the following standard formulation:

Configuring [Service Name]

This chapter summarizes the configuration tasks in conjunction with the service to be performed by the administrators of the consuming applications (SaaS layer). These tasks mainly include configuration tasks related to the business content that may be part of the functionality of the service. As this content sometimes includes an authorization concept, you will have to explain the roles delivered for this content. The tasks described in this subchapter differ from the technical configuration tasks described in "Initial Setup," which have to be performed by the account administrator on the PaaS layer.

<div> <div>Target group</div> <div>Application administrator</div> </div> <div> <div></div> <div>Optional</div> </div> <div> <div></div> <div>Multiple topics possible (grouped under root topic )</div> </div>

Basic Considerations

The following questions might help you when trying to determine whether this chapter is relevant for you:

Does the service provide configuration UIs?
Does the service provide content that has to be or can be configured within the consuming applications?
Does the service deliver role templates for the configuration of the content?
Is there a sequence in which the configuration tasks have to be performed?

Multiple topics

You may want to provide more than one topic to describe the single configuration tasks (or configuration UIs). Group all of these topics under the root topic "Configuring <Service Name>".

Topic Content

Title: Configuring <Service Name>

Use "Configuring <Service Name>" as title of your (root) topic. Do replace it with another title.

Sections within topic

You may structure the content according to the configuration tasks. If there is a sequence of configuration steps, provide the structure accordingly.

Defining and Bundling Roles

If your service delivers UIs (configuration UIs or end-user UIs), include this information in this chapter. You can either include this information in this topic or, in case of multiple topics, as a separate topic. Use the following table to provide information about which delivered role template gives access to which tile on the SAP Fiori launchpad. Delete the example entries and enter the role templates for your service.

<div> <div>Role Template</div> <div>Description</div> <div>Available Attributes</div> <div>Tiles on SAP Fiori Launchpad</div> </div> <div> <div></div> <div></div> <div></div> <div></div> </div>

Building Roles and Role Collections for Applications

Using [Service Name]

This chapter is optional and is only necessary if your service offers functionality that is visible to end-users of the consuming applications.

<div> <div>Target group</div> <div>Application end-user</div> </div> <div> <div></div> <div>Optional</div> </div> <div> <div></div> <div>Multiple topics possible (grouped under root topic )</div> </div>

Basic Considerations

The following questions might help you when trying to determine whether this chapter is relevant for you:

Does the service provide functionality that can be integrated into application UIs?
Does the service provide content that is visible from an application UI?

guideline

Reuse of chapter within documentation of consuming applicationsAs this part of the service guide contains information that is relevant for the end-users of the consuming applications, your topics might be reused within the end-user documentation of the single consuming applications. There are different degrees to which this information can be reused:Service UIs are consumed without change and are visible within the Fiori launchpad of the consuming applications

In this case, we recommend to provide a separate end-user guide containing the end-user information for these UIs. This end-user guide can be reused within the end-user documentation of the consuming applications. For more information, please see End-User Guide.
Service functionality is consumed without change and is integrated within the UIs of the consuming applicationIn this case, it might be possible that some of your topics provided within this part of the service guide will be reused within the end-user documentation of the consuming documentation. The authors of the consuming applications will have to decide whether they want to reuse your topics or whether they will have to rewrite the documentation to match the different context in which the functionality appears.
Service functionality or content (UIs or UI fragments) is adjusted by the consuming application before it is integrated into the UIs or the Fiori launchpad of the consuming applicationsIn this case, no reuse of of this part of the service guide or of single topics is possible. Authors providing the end-user documentation of the consuming applications will have to create the end-user documentation themselves. If possible, they may use the content of this part of the service guide as a basis.

You may structure the information to be provided in this chapter according to the single UIs or functions visible to the end-users. If your service UIs appear without change in the Fiori launchpads of the consuming applications, provide the information in a separate End-User Guide.

Topic Content

Title: Using <Service Name>

Use "Using <Service Name>" as title of your (root) topic. Do not replace it with another title.

Sections within concept topics

There are fixed sections or section titles for the single topics. The sections and their content entirely depend on your specific service.