RCG Product Process API - Implementation Template

(0 reviews)

home

This API implementation template is a component of the MuleSoft Accelerator for Consumer Goods, which accelerate the implementation of essential integration use cases.

The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.


Overview

This integration template implements the RCG Products Process API specification. It can be used to create, and update Products.

Getting started

bulb.png The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications.

Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.

Prerequisites

This implementation template has the following dependencies:

Please review the use cases described on the MuleSoft Accelerator for Consumer Goods solution pages for more information about dependencies on other APIs and services.

API dependencies

The following table lists all endpoints used by this API (assuming all syncronization targets are enabled).

API nameEndpointAction
RCG SAP S/4 HANA Products System APIget:/productsSearch for an existing customer
RCG SAP S/4 HANA Products System APIpatch:/products/{productId}Update an existing customer
RCG Salesforce Consumer Goods Cloud System APIpost:/productsCreate a new customer
RCG Salesforce Consumer Goods Cloud System APIpost:/products/idsSearch for Consumer Goods Cloud Ids

Deployment

Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).

For additional details, please refer to the Application Deployment section of the Getting Started Guide.

Preparation

Ensure the Maven profile CloudHub-RCG-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).

Required property overrides

Many templates can also be run from Anypoint Studio without having to customize the Run/Debug profiles. However, some templates make use of hidden deployment properties to protect sensitive information (e.g., passwords and secret keys). These properties must be supplied to the runtime by updating the configuration profile and adding them as VM arguments. At a minimum, the following properties must be customized to reflect the target deployment environment.

Property NameDescription
api.autodiscovery-idRequired if using API Manager to secure this API
products-prc-api.http-client.client-idClient Id provided for Products Process API to interact with all System API's
products-prc-api.http-client.client-secretClient Secret provided for Customer Process API to interact with all System API's
sap-hana-sys-sys.hostSAP S/4 HANA System API Instance Hostname
sap-hana-sys.portSAP S/4 HANA System API Instance Port
sap-hana-sys.base-pathSAP S/4 HANA System API Instance base path
cgcloud-products-sys.hostSalsify System API Instance Hostname
cgcloud-products-sys.portSalsify System API Instance Port
cgcloud-products-sys.base-pathSalsify System API Instance Base path
anypoint-mq.server-urlAnypoint MQ URL where the message Exchange, Topics, queues have been created
anypoint-mq.client-idAnypoint MQ Client Id to access messages from MQ
anypoint-mq.client-secretAnypoint MQ Client Secret to access messages from MQ

Additional resources


Reviews

TypeTemplate
OrganizationMulesoft Inc.
Published by
MuleSoft Solutions
Published onOct 16, 2023
Asset overview

Asset versions for 2.7.x

Asset versions
VersionActions
2.7.4
2.7.2