Salesforce MuleSoft Developer key terms
Salesforce MuleSoft Developer · Get comfortable with the vocabulary.
- RAML
- Related: API specification, Trait, API Designer
RESTful API Modeling Language: a YAML-based, human-readable syntax for describing an API's resources, methods, parameters, request bodies and responses. Anypoint Platform's designers use it to create and publish API specifications.
- OpenAPI Specification
- Related: API specification, APIkit Router, Anypoint Exchange
A widely used, language-agnostic standard written in JSON or YAML for describing REST APIs. Anypoint Platform can import OAS documents, generate flows from them, and publish them to Exchange.
- API specification
- Related: RAML, Mocking service, APIkit Router
A machine-readable contract describing an API's endpoints, operations, data types and error responses. It drives mocking, flow generation, request validation and documentation before any implementation logic exists.
- Trait
- Related: RAML, Resource type
A reusable RAML fragment that applies a set of method-level properties, such as headers or query parameters, to several resources at once. Traits keep specifications short by avoiding repeated declarations.
- Resource type
- Related: Trait, RAML
A RAML fragment defining a reusable template for a resource: its methods, descriptions and expected responses. Applied with the type keyword, it standardizes how similar resources are described across an API.
- Mocking service
- Related: API specification, Anypoint Exchange
A hosted, simulated version of an API generated from its specification. It lets consumers send real requests and see example responses before the actual implementation is built or deployed.
- Anypoint Exchange
- Related: Mocking service, API Designer, Client ID enforcement
A catalog where an organization publishes and discovers reusable assets such as API specifications, connectors, templates, examples and policies. It provides documentation, mocking and access requests for those assets.
- API Designer
- Related: RAML, Anypoint Exchange, Mocking service
A web-based editor in Anypoint Platform for writing and validating RAML or OpenAPI specifications. It offers suggestions, a built-in mocking service, and can publish the finished specification straight to Exchange.
- API instance
- Related: API Manager, Autodiscovery, SLA tier
The API Manager record that represents a deployed implementation of an API, identified through autodiscovery. Policies, SLA tiers and alerts are configured on the instance rather than in the application code.
- API Manager
- Related: API instance, Autodiscovery, Rate limiting policy
The Anypoint Platform section for governing APIs: registering instances, applying policies, defining SLA tiers and checking analytics. Enforcement happens at the API gateway layer, outside the Mule flow itself.
- Autodiscovery
- Related: API instance, API Manager
A setting that links a running Mule application to a specific API instance in API Manager, usually through an API ID and the main flow name. The link is what allows gateway policies to be enforced.
- CloudHub
- Related: Runtime Manager, API instance
MuleSoft's fully managed, hosted runtime plane where Mule applications run in the cloud. Deployments, worker sizes, regions and logs are configured through Runtime Manager.
- Runtime Manager
- Related: CloudHub, API instance
The Anypoint Platform console for deploying, starting, stopping, scaling and monitoring Mule applications across CloudHub, customer-hosted servers and Runtime Fabric. It also exposes logs, alerts and application properties.
- Client ID enforcement
- Related: SLA tier, API Manager
An API Manager policy that requires callers to send a client ID and secret issued to an application registered in Exchange. It authenticates consuming applications and supports contractual rate limits.
- SLA tier
- Related: Client ID enforcement, Rate limiting policy
A named set of request limits, such as gold, silver or bronze, defined on an API instance. Client applications are assigned to a tier when they request access, and policies enforce those limits.
- Rate limiting policy
- Related: SLA tier, API Manager
An API Manager policy that caps how many requests a client may send within a time window and rejects the excess with HTTP 429. It shields backend systems from overload and abusive traffic.
- Flow
- Related: HTTP Listener, Sub-flow, Mule event
The basic unit of processing in a Mule application: an ordered sequence of message processors that receives, transforms, routes and responds to an event. A flow may have one message source and its own error handling.
- HTTP Listener
- Related: HTTP Request, APIkit Router, Flow
A message source that opens an HTTP endpoint and starts a flow whenever a request arrives at its path. It returns the resulting payload to the caller as the response.
- HTTP Request
- Related: HTTP Listener, Flow
A connector operation that makes an outbound HTTP call from a flow to an external service and puts the response into the event. It supports headers, query parameters, authentication and error handling.
- APIkit Router
- Related: API specification, HTTP Listener, Error type
A generated message processor that matches incoming requests to flows based on the API specification. It validates the path, method, query parameters and body against the contract before the flow logic runs.
- Sub-flow
- Related: Flow, Mule event
A reusable block of processing with no message source that is invoked only through a flow reference. It cannot declare its own error handler, so errors propagate back to the calling flow.
- Global element
- Related: HTTP Listener, Flow
A configuration declared once at application level, such as an HTTP listener config, database connection or property placeholder, and reused by many components. It centralizes shared settings and credentials.
- Mule event
- Related: Flow, Payload, Attributes
The unit of data travelling through a flow, made up of a message (payload plus attributes) and a set of variables. Each message processor reads and possibly changes it.
- URI parameter
- Related: APIkit Router, Attributes
A variable segment of a request path, declared in the specification with braces, such as /orders/{orderId}. In a flow it is read from attributes.uriParams and used to look up the right record.
- DataWeave
- Related: Transform Message, Payload, Map
MuleSoft's functional language and engine for transforming data between formats such as JSON, XML, CSV and Java objects. It selects, maps and reshapes fields inside the Transform Message component.
- Transform Message
- Related: DataWeave, Output directive
The Mule component that runs a DataWeave script. It takes the current event as input and writes its result to the payload or to a variable named in the output directive.
- Output directive
- Related: DataWeave, Transform Message
A DataWeave header statement declaring the MIME type and structure of the produced data, for example output application/json. It tells the engine how to serialize the script's result.
- Payload
- Related: Attributes, Mule event, DataWeave
The body of the Mule message: the actual business data being carried through the flow. DataWeave scripts refer to it with the payload keyword, which is the implicit root of the script.
- Attributes
- Related: Payload, URI parameter
Metadata about the message rather than its content, such as HTTP headers, query parameters, URI parameters and status codes. DataWeave reads them with the attributes keyword.
- Map
- Related: MapObject, Reduce, DataWeave
A DataWeave function that applies an expression to every element of an array and returns a new array of the same length. Inside the expression, $ is the current element and $$ its index.
- MapObject
- Related: Map, DataWeave
A DataWeave function that walks the key-value pairs of an object and returns a new object. Inside it, $ is the value, $$ the key and $$$ the index.
- Reduce
- Related: Map, DataWeave
A DataWeave function that collapses an array into a single value by applying an expression to each element together with an accumulator, starting from a supplied initial value.
- Choice router
- Related: Scatter-Gather, Flow
A routing component that evaluates DataWeave conditions in order and sends the event down the first route whose condition is true, with an optional default route when none match.
- Scatter-Gather
- Related: Choice router, Flow
A router that sends the same event to several routes in parallel and merges their outputs into an array of payloads. It shortens response time when the downstream calls are independent.
- On Error Propagate
- Related: On Error Continue, Error type, Global error handler
An error handler scope that runs its processors and then rethrows the original error to the caller, rolling back the current transaction. Use it when a failure must not be hidden or converted to success.
- On Error Continue
- Related: On Error Propagate, Error type
An error handler scope that runs its processors and returns their result as the flow's outcome instead of throwing. Use it when the application can recover and reply with a meaningful fallback.
- Error type
- Related: On Error Propagate, Global error handler
A hierarchical identifier describing what went wrong, such as HTTP:NOT_FOUND or VALIDATION:INVALID_BOOLEAN. Error handlers match on error types to decide which handling strategy applies to a failure.
- Global error handler
- Related: On Error Propagate, Error type
An error-handling configuration declared once at application level and referenced by several flows, so common failure logic is written in one place instead of repeated everywhere.
- Raise Error
- Related: Error type, On Error Propagate
A Mule component that throws a custom error with a chosen error type from inside a flow. It lets developers signal business rule violations that error handlers can catch and format.