Managing Tenant Settings

Objective

After completing this lesson, you will be able to manage your tenant properly.

Manage Tenant Connections

In this lesson, we delve deeper into the advanced administrative capabilities within the Universal Model, focusing on managing tenant connections, tenant-specific settings, container management, and archiving activities. These functionalities are essential for tailoring the system to meet specific organizational needs, ensure efficient data management, and maintain system performance.​

The Administration tab is selected, displaying tiles for Manage Tenant Settings, Manage Tenant Connections, Manage Containers, and Manage Archives.

App Functions

ApplicationFunction
Manage Tenant Settingscreate, update and delete Tenant specific settings
Manage Tenant Connectionscreate, update and delete Tenant specific connection settings
Manage Containersmanage containers or import or export an environment
Manager Archivesmanage archiving activities

Manage Tenant Connections

Overview: The Manage Tenant Connections application allows you to create and customize connections that are specific to each tenant. This capability is crucial for directing data flows correctly and setting up connections in different environments such as development, QA, and production.​

Key Features:

Create Tenant-Specific Connections: Establish connections that are tailored to tenant requirements.​

Schema Mapping: Point connections to different schemas, depending on the target environment.​

Detailed Steps:

Navigate to the Manage Tenant Connections application.​

Choose or create the desired connection. Ensure that you specify the appropriate schema. For instance, a reader connection can initially point to a UM demo schema in the development environment.​

Environment-Specific Settings:​

Adjust the connection settings for different environments. If the schema is different in QA, such as QA demo, ensure the connection points to this schema.​

Update the target system settings by specifying the correct schema in the QA environment under Manage Tenant Connections.​

Tenant-Specific Overrides:

Mark the connection as tenant-specific. It ensures that the system uses the specified settings in Manage Tenant Connections rather than the default settings.

Manage Tenant Settings

Overview: Manage Tenant Settings is designed to configure tenant-specific settings, including e-mail notifications and other administrative capabilities. This feature enables tailored communication and operational controls per tenant.​

Key Functionalities:

E-mail Configuration: Set up e-mail templates for various scenarios.​

Operational Controls: Adjust system-wide settings, including deactivating runtime environments.​

E-mail Notification Configuration:​

E-mail Templates:

Process Reset Notification: Configure templates for notifying users when a process is reset. If a user is part of the reader-writer group for the process, they receive an e-mail notification upon reset.​

Activity Status Change Notification: Set up templates for notifications when an activity changes status, such as moving from active to confirmed or rejected.​

AI Activation and Deactivation:

Deactivation: You can deactivate runtime environments across the system using the deactivation options within Manage Tenant Settings.

Manage Containers

Overview: The Manage Containers application allows you to perform vital export and import operations for environments. This functionality is essential for backing up environments, moving them across tenants, or creating new instances within the same tenant.​

Key Tasks:​

Environment Export: Save a copy of the current environment configuration.​

Environment Import: Restore or replicate environments by importing them into different or the same tenants.​

Manage Archives

Overview: The Manage Archives application supports the archiving and management of data records from active tables into flat files. This process helps optimize storage usage and system performance while ensuring important data can be retrieved when necessary.​

Key Tasks:

Data Archiving: Export data from active tables into flat files, and optionally, delete the data from the source tables.​

Retention Management: Maintain archived data for compliance and retrieval purposes.​

Manage E-Mail Templates and Runtime Deactivation

Advanced Administration: Managing E-mail Templates and Runtime Deactivation

In this section, we explore the advanced features of the Manage Tenant Settings application within the Universal Model. We focus on creating and deleting e-mail templates and performing mass deactivations of runtime objects. These functionalities are essential for maintaining system communication and optimizing resource usage.

SAP Manage Tenant Settings screen with an empty table showing the message No data found.

App Functions

ApplicationFunction
Undeploy AllMass deactivation of all runtime objects for all environments - rarely used
CreateCreate Activity notifications – email templates for notifications when Activities change Status
DeleteDelete Activity notifications – deletion of email templates

Managing E-Mail Templates

Overview: In the Manage Tenant Settings application, you can create, update, or delete e-mail templates. These templates are crucial for automated notifications related to system activities, such as process resets and activity status changes.​

Key Capabilities:​

Create E-mail Templates: Set up new e-mail templates tailored to specific events.​

Update or Delete Templates: Modify existing templates or remove them as needed.​

Mass Deactivation of Runtime Objects: Deactivate multiple runtime objects to optimize system performance.​

E-mail Templates:​

Process Reset Notification: Configure templates for notifying users when a process is reset. If a user is part of the reader-writer group for the process, they receive an e-mail notification upon reset.​

Activity Status Change Notification: Set up templates for notifications when an activity changes status, such as moving from active to confirmed or rejected.​

AI Activation and Deactivation:​

Deactivation: You can deactivate runtime environments across the system using the deactivation options within Manage Tenant Settings.​

Mass Deactivation of Runtime Objects

Overview: The Manage Tenant Settings application also allows for mass deactivation of runtime objects. This functionality is useful for managing system resources and ensuring that only actively used environments remain operational.​

Key Tasks:

Undeploy All: Deactivate all runtime objects to reset the system and free up resources.​

Selective Reactivation: Users can reactivate only the environments they actively use, optimizing system performance.

Mail Connection Setup

In this section, we cover the detailed steps to set up a mail connection within an SAP Business Technology Platform (SAP BTP) subdomain. This configuration is necessary for enabling automated e-mail notifications from your Universal Model system. Proper setup ensures that system notifications, such as process resets and status changes, are reliably sent to the intended recipients.

The SAP BTP Cockpit Destination Configuration page showing the filled-out settings for a mail service.

Steps to Set Up Mail Connection

Step 1: Define the Mail Destination

Assign a Name to the Mail Destination:

Navigate to the destination configuration section within your BTP subdomain.​

Provide a meaningful name for your mail destination. This helps in easily identifying and managing the connection.​

Specify Connection Type:

Set the connection type to MAIL. It specifies that the destination is intended for e-mail services.​

Add a Description:​

Add a descriptive text explaining the purpose of the mail destination. It assists in understanding the connection's role and context.​

Step 2: Configure Proxy and Authentication​

Proxy Type:​

Set the proxy type to Internet. It indicates that the mail server is accessed over the internet.​

Authentication Method:

Choose Basic Authentication for logging into the mail server.​

User ID and Password: Input the credentials of a mail server account that has the necessary permissions to send e-mails. Ensure that these credentials are securely stored.​

Step 3: Set Additional Properties​

SMTP From:

Specify the mailbox of the user from which the messages are sent. It is the e-mail address that appears in the From field of the sent e-mails.​

Ensure that this mailbox user is set up and active on the specified mail server.​

Mail SMTP Host:​

Enter the address of the SMTP host. It is the server that handles the e-mail sending process.​

Mail SMTP Port:​

Specify the port number for the SMTP server. Common ports include 25, 465 (for SSL), or 587 (for TLS).​

Step 4: Test the Mail Connection

Run Tests:​

After setting up, perform tests to ensure that the mail connection is correctly configured and operational.​

Send a test e-mail to verify that the e-mails are being sent and received without errors.​

Access Manage Tenant Settings

Overview: When accessing the Manage Tenant Settings application, it's not always immediately clear if settings have been configured. The interface can show as blank, making it challenging to determine the status of existing configurations. To resolve this, you can add a log ID to verify the presence of settings.

The SAP Manage Tenant Settings screen showing one created tenant setting in the list.

Detailed Steps:

Access Manage Tenant Settings:

Navigate to the Manage Tenant Settings application. It is where you can configure various tenant-specific settings, including e-mail notifications, deactivation of runtime objects, and more.​

Check for Existing Settings:​

If the settings interface appears blank, it can be difficult to find out if any settings have previously been configured.​

Add Log ID:

To check for existing settings, look for a small dot or menu option within the settings interface.​

Select the option to Add Log ID. It enables the display of log information, allowing you to see if any settings have been created.​

The log ID provides details on whether existing settings are in place or if the settings box is indeed empty.​

Interpreting the Log ID:​

If a log ID appears, it indicates that settings have been configured.​

If no log ID is shown, the settings box is empty, signifying that no settings have been set up yet.​

Configuring and Managing Settings

Overview: Once you've determined the status of existing settings, you can proceed to create new settings or delete and recreate them as needed. This process ensures that your tenant-specific configurations are up-to-date and aligned with current requirements.

Steps to Create New Settings:

Create New Settings:​

If no existing settings are found, proceed to create new settings.​

Click on the option to add new settings.​

Configure the necessary parameters, such as e-mail templates for notifications, runtime deactivation settings, and other tenant-specific preferences.​

Delete and Recreate Settings:

If existing settings must be updated or reconfigured, you can delete the current settings.​

Select the option to delete the settings.​

After deletion, recreate the settings with the updated parameters to ensure they meet the current needs of your environment.​

Available E-Mail Templates

In this lesson, we explore the available e-mail templates within SAP that can be configured for process notifications. These templates are essential for keeping users informed about key events, such as process resets and activity status changes. We also highlight how to use dynamic variables to personalize the messages.

The e-mail templates tab in the SAP Tenant Setting screen, showing an editor for a process reset e-mail.

Available E-Mail Templates

1. Process Reset E-mail Template

Purpose: This template is used to notify users when a process is reset. The system automatically sends an e-mail based on this template whenever a reset occurs.​

2. Process Activity Status Change E-mail Template​

Purpose: This template is triggered when an activity changes status, such as moving from active to confirmed or rejected. It keeps users updated on the status of ongoing activities.​

Dynamic Variables: Dynamic variables personalize each e-mail message, ensuring that relevant information is included automatically. Some commonly used dynamic variables include:​

  • User Variable: Inserts the recipient's name directly into the e-mail (for example, Dear Daniel)
  • Process Variable: Includes the specific name of the process that triggered the notification (for example, Manage Companies Process).
  • Description Variable: Adds a description of the event or process to the e-mail.​
  • Environment Variable: Although its usage can be less common, it can provide context about the environment where the process is running.​

Test E-Mail Templates

Once you've set up the e-mail templates using the Manage Tenant Settings application, it's important to test them to ensure they work as expected. Testing confirms that notifications are correctly triggered and received by the specified recipients. This process involves resetting a process and verifying that the configured e-mail templates send the proper notifications.

A composite image showing the SAP Manage Processes screen, where clicking the 'Reset' button for a process triggers a 'Process reset' email notification.

Testing E-Mail Templates

Step 1: Set Up Reader and Writer Teams

Ensure that you have specified the reader and writer teams for the process. These teams are the recipients of the notifications.​

The reader team typically includes users who must be informed about the process status, while the writer team can include those who have editing or approval responsibilities.​

Step 2: Resetting a Process​

Navigate to Manage Processes:​

Go to the Manage Processes application within your Universal Model interface.​

Select the Process to Test:

Choose the process for which you want to test the reset functionality. A process where you have already configured an e-mail template for reset notifications.​

Reset the Process:​

Click the Reset button associated with the process. This action triggers the e-mail notification according to the configured reset e-mail template.​

Step 3: Verifying E-mail Notification

Check Your Inbox:

Shortly after resetting the process, check the inbox of the users specified in the reader and writer teams.​

Ensure that the notification e-mail has been received.​

Example of an E-mail Notification:​

Dear User,​

The Manage Companies Process (Update for Q3) has been reset.​

Sincerely,​

Universal Modeling Team​

If we need to completely remove tenant setting, we just need to click on the delete and it wipes out the whole settings. After that we can recreate it.

The SAP Manage Tenant Settings screen, showing a selected tenant setting and an arrow pointing to the Delete button.