This chapter details the tasks for the application developer/operator to configure the service and ensure proper operation. Typical tasks to go here: setting up databases, assigning user authorizations, creating connectivity destinations, defining user roles, etc. Typical tools used: cloud cockpit, Cloud Foundry CLI, SAP HANA cockpit, and service-specific configuration UIs. This information might be provided within one or multiple topics.
Basic Considerations
Some initial configuration steps may have already been performed by the service operator/app developer to enable the service initially. Those steps were described in the Initial Setup section.
The current section contains configuration or administration tasks that the service operator may need to perform on a regular basis or on demand.
Topic Content
Title: Administration
Use "Administration" as the title of your topic. Do not replace it with another title.
Useful Links
Links to the central SAP BTP documentation that you might want to include in this chapter:
- Administration and Operations
- Administration and Operations in the Cloud Foundry Environment
- If relevant: additional links to working with CLI, cockpit, cloud connector, required databases, etc.
We recommend that you replace those generic links with specific topics from them relevant for the specific service administration operations you describe.
Configuring Backup
This chapter is required if your service provides a functionality for configuring backups managed by customers. It may, therefore, contain the configuration information that is relevant for the application administrators.
Basic Considerations
We've received questions from customers around the topics of configuration backups for services and recommended strategies for accidental deletion of configurations. As a result, we've created a topic on the matter (Configuring Backup) in the Best Practices for SAP BTP guide. However, the topic covers only a short list of services selected based on the number of customer questions that have been received. The preferred strategy would be to add a chapter in each service's documentation (if applicable) that summarizes such info so customers can find it easily. Hence, we've created this chapter template that you can use to create a chapter "Configuring Backup" in your service's documentation.
The following questions might help you when trying to determine whether this chapter is relevant for you:
- Does the service provide configuration capabilities - something that the application administrator at customer side configures?
- Does the service provide a feature for the application administrator at customer side to backup their configurations?
- Does the service provide a feature for the application administrator at customer side to restore their configurations from the backups they created? For example, in case of accidental deletion.
We've also created an epic, Best Practices Guide for Configuring Backups, where the progress of this initiative is tracked. The epic will include a number of tasks, each relevant for a specific BTP service. As an author, you should receive a notification from Jira when a task under this initiative is created for your service. Please make sure you put the task in the right status even if the initiative is not relevant for your service. For more information, you can always contact or .
Multiple Topics
Multiple subtopics are possible depending on how many configurations within your service can be backed up.
Always use "Configuring Backup for <Service Feature>" as titles of these subtopics.
Topic Content
Title: Configuring Backup
Use "Configuring Backup" 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.
Examples
Here are a few links to already existing topics for configuring backups of user-specific configurations: