RCG Salesforce Marketing System API - Implementation Template
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.
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.
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
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 |
sfdc-mc.subdomain | Salesforce Marketing System sub domain |
sfdc-mc.client-id | Salesforce Marketing System Installed Package Client Id for API Integration |
sfdc-mc.client-secret | Salesforce Marketing System Installed Package Client Secret for API Integration |
sfdc-mc.auth-url | Salesforce Marketing System Auth URL of Installed Package for API Integration |
sfdc-mc.soap-url | Salesforce Marketing System SOAP URL of Installed Package for API Integration |
Running the application from Anypoint Studio
The following instructions are for running applications from Studio but apply to debugging as well.
- Update the
src/main/resources/config/config-local.yaml
file and provide values for the properties described above. - Right-click the project and select
Run As -> Mule Application (configure)
- If hidden deployment properties (e.g., Anypoint MQ credentials) are required, select the
Arguments
tab and add the property definitions to theVM arguments
section. For example:-M-Danypoint-mq.client-id=<client id> -M-Danypoint-mq.client-secret=<client secret>
- Click
Run
to launch the application.
To debug an application, choose Debug As -> Mule Application (configure)
in the second step instead.
Next steps
Visit the Data mappings tab to learn more about how the request and response data structures are mapped between the API interface and salesforce system.