In addition to caterer coordination, Gourmet Pages requires further tasks in the created project within the SAP S/4HANA Cloud Public Edition. Therefore, a business logic extension in the Poetry Slam Manager application is necessary. This extension enables customers to enhance the logic for creating project tasks.
Based on the capire documentation Extending SaaS Applications and the SAP Oyster SDK, you can extend the Partner Reference Application for a specific consumer while keeping the core application unchanged for others.
To explore this feature with the Poetry Slam Manager, you have two options:
-
Clone the repository of the Partner Reference Application. Check out the main-multi-tenant branch and enhance the application step by step.
-
Alternatively, check out the main-multi-tenant-features branch where the feature is already included.
The following describes how to enhance the main-multi-tenant branch (option 1).
-
As you enhance the logic to create projects in SAP S/4HANA Cloud Public Edition, follow all the enablement steps of the Integrate the SAP BTP Application with SAP S/4HANA Cloud Public Edition and the Configure the Integration with SAP S/4HANA Cloud Public Edition chapters first.
-
To enable tenant-specific extensions as a SaaS provider, follow the steps described in the previous chapter: Enable Consumer-Specific Extensions.
-
Add the SAP Oyster SDK to extend the runtime. This addition provides the capability to execute tenant-specific custom code securely in a sandbox environment.
-
Open a terminal. Ensure you're in the project's root folder.
-
Run the command to add the SAP Oyster SDK npm package.
npm add @sap/cds-oyster -
Navigate to the
mtx/sidecarfolder.cd mtx/sidecar -
Run the command to add the SAP Oyster SDK npm package to the mtx sidecar.
npm add @sap/cds-oysterNote: The @sap/cds-oyster package is an alpha release.
-
-
Enable code-extensibility in the application by enhancing the cds-requires-section of the package.json file in the root directory of the project.
"code-extensibility": {
"runtime": "oyster",
"maxTime": 1000,
"maxMemory": 4
}Note: The maxTime property specifies the maximum execution time, in milliseconds, allowed for the extension's code. The maxMemory property sets the maximum memory, in megabytes, that the extension can utilize.
- Configure code-extensibility and allow extensions for CRUD, function and action by enhancing the cds-requires-section in the package.json file of the mtx sidecar.
"cds.xt.ExtensibilityService": {
"element-prefix": [
"x_"
],
"namespace-blocklist": [],
"extension-allowlist": [
{
"for": [
"*"
],
"kind": "entity",
"annotations": [
"*"
],
"code": [
"CREATE",
"READ",
"UPDATE",
"DELETE",
"action",
"function"
]
},
{
"for": [
"sap.samples.poetryslams.Visitors"
],
"kind": "entity",
"code": [
"CREATE",
"READ",
"UPDATE",
"DELETE",
"action",
"function"
]
},
{
"for": [
"PoetrySlamService"
],
"kind": "service",
"code": [
"CREATE",
"READ",
"UPDATE",
"DELETE",
"action",
"function"
]
}
]
}-
Extend the Poetry Slam service with a function used for business logic extensibility.
-
Define data types for the project data that is set as parameter for the function.
type s4HCProjectDataElements { ProjectElement : String(24); ProjectElementDescription : String(60); PlannedStartDate : String(20); PlannedEndDate : String(20); }; type s4HCProjectData { Project : PoetrySlamService.S4HCProjects:project; ProjectDescription : PoetrySlamService.S4HCProjects:projectDescription; ProjectStartDate : String(20); ProjectEndDate : String(20); EntProjectIsConfidential : Boolean; ResponsibleCostCenter : PoetrySlamService.S4HCProjects:responsibleCostCenter; ProfitCenter : String(10); ProjectProfileCode : PoetrySlamService.S4HCProjects:projectProfileCode; ProjectCurrency : String(5); to_EnterpriseProjectElement : array of s4HCProjectDataElements; };
-
Add a new function called
extendProjectData. This function can be implemented in a customer-specific extension with business logic to enhance the project data.// ------------------------------------------------------------------------------- // Extend service PoetrySlamService with extension points for business logic extensibility: // Function to extend the project data extend service PoetrySlamService with { function extendProjectData(ProjectID: s4HCProjectData) returns s4HCProjectData; }
-
-
Enhance the
getRemoteProjectDatamethod of the connectorS4HC.js to call the extension point for the business logic extensibility. TheextendProjectDataextension point takes the project record as parameter. A customer-specific extension can enhance the project data with business logic and returns the enhanced project record. The Poetry Slam Manager then uses the enhanced project record to create the project in SAP S/4HANA Cloud Public Edition.try { // Call extension point for business logic extensibility let projectData = await cds.services.PoetrySlamService.extendProjectData( this.projectRecord ); if (projectData) { this.projectRecord = projectData; } } catch (e) { // Move on with application although there is an issue with business logic console.error( `Action getRemoteProjectData: Error while processing business logic extensibility: ${e.message}` ); }
-
Run the command in your project root folder to install the required npm modules.
npm install -
Build and deploy the application.
Note: For detailed instructions on deployment, refer to Deploy Your SAP BTP Multi-Tenant Application.
This tutorial covers extension possibilities in the Partner Reference Application. The partner-reference-application-extension repository provides examples and guidance on creating extensions for specific customers.