MuleSoft Accelerators - Setup Guide
home
Accelerator components
The MuleSoft Accelerators for Salesforce Clouds include production-ready APIs, connectors, and integration templates that help unlock critical data from external systems such as SAP, ServiceNow, and Jira, all the while guiding you to adopt best practices synthesized from thousands of customer implementations.
Quick start
To get started, you must set up your local build environment with the required software and Maven build configuration. Next, download and configure the assets required for the use cases you wish to implement. Some use cases will require changes to the systems being integrated (e.g., SAP, Salesforce Service Cloud, etc.) - be sure to read and follow the instructions specified in the use case page(s) carefully. In many instances additional details are provided in the README.md of individual projects.
Once configured, applications can be deployed individually to your own CloudHub instance, either manually or by using simple Maven commands. There are also some helper profiles available for deploying multiple components at once.
Asset types
The following table provides more information about the types of accelerator assets provided and how they fit into the overall solution.
| Type | Purpose | Example |
|---|---|---|
| API Spec Fragments | Shared RAML specifications reused by multiple APIs. These define standard characteristics, data types and response codes common across most APIs. | Accelerator Global Resources |
| REST APIs | RAML specifications describing the resources and methods an API makes available to consumers. They are categorized into layers - System, Process, Experience - as per MuleSoft's API-led approach. | Accelerator OMS System API |
| Templates | Runtime implementations of individual APIs and other integrations. These must be customized and deployed to your own Mule runtime environment (e.g., CloudHub) to implement desired use cases. | Accelerator OMS System API - Implementation Template |
| Custom | Documentation and downloadable components that do not fit into other categories. | Accelerator POM Parent |
Obtaining accelerator assets
All accelerator assets are available from our main Anypoint Exchange site and are freely downloadable. For API specification and implementation project names referenced in this document, search for each asset in Exchange or visit the solution landing page to see the full list of assets.
Deploying accelerator components
In this release, all accelerator components can be individually configured and deployed to your own environment using a text editor and some simple Maven commands. With the exception of the Accelerator Salesforce OData API, all component dependencies will automatically be resolved from Exchange and other Maven repositories.
Refer to the sections in the page navigation menu on the left for more information about configuring, building and deploying applications.