RCG Baseline Prediction Process API - Implementation Template
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 Baseline Prediction Process API specification. It can be used to integrate the prediction baseline data from Salesforce CRM Analytics to Hyperforce.
Getting started
|
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:
- Outbound connection to Amazon S3 from CRM Analytics.
- RCG Salesforce Volume Management System API
Please review the use cases described on the MuleSoft Accelerator for Retail and 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 name | Endpoint | Action |
|---|---|---|
| RCG Salesforce Volume Management System API | get:/transactions/{transactionId}/status | Search an Transaction status |
| RCG Salesforce Volume Management System API | post:/transactions | Create a Transaction |
| RCG Salesforce Volume Management System API | post:/volumes/measures | Create a Volume Measure |
| RCG Salesforce Volume Management System API | post:/volumes | Create a Volume in Hyperforce |
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 Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| volume-mgmt-sys.host | volume-mgmt-system HostName. |
| volume-mgmt-sys.port | volume-mgmt-system Port. |
| volume-mgmt-sys.base-path | volume-mgmt-system Base path. |
| rcg-baseline-prediction-prc-api.http-client.client-id | Client Id provided for Baseline Prediction Process API to interact with all System API's. |
| rcg-baseline-prediction-prc-api.http-client.client-secret | Client Secret provided for Baseline Prediction Process API to interact with all System API's. |
| s3.accessKey | Amazon S3 access Key. |
| s3.secretKey | Amazon S3 secret Key. |
Additional resources
- The Data mappings describes how the request and response data structures are mapped between the API interfaces.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.