Fetch Salesforce Schema
Fetch sObject field metadata from Salesforce into a Multi FileFeed.
Fetch Salesforce Schema retrieves field metadata for one or more Salesforce sObjects and brings it into your Multi FileFeed (MFF). Use it to drive dynamic mapping or validation logic that needs to stay in sync with your Salesforce org's fields.
Availability: Beta. Requires the
WorkflowsSalesforceSchemaFetchfeature. Contact your OneSchema support representative if you do not see this transform.
What it does
- Input: source (no upstream input). This transform starts an MFF branch by connecting directly to Salesforce.
- Output: a file describing the fields (name, type, and other metadata) for each selected sObject.
- The transform calls Salesforce's metadata APIs for the sObjects you select and emits the field definitions for downstream transforms to use, for example to build column mappings automatically.
When to use it
- You want downstream mapping or validation to automatically reflect new or changed fields in Salesforce without manual updates.
- You're building an MFF that pushes data to Salesforce and want to confirm field names and types before mapping.
- You maintain documentation or a data dictionary that should stay in sync with Salesforce's schema.
How to configure it
In the MFF builder, add a Fetch Salesforce Schema node as a source at the start of your MFF.
Settings
| Setting | Description | Default |
|---|---|---|
| sObject types | The list of Salesforce sObjects to fetch metadata for, for example Account, Contact. | Empty |
| Include custom fields | When enabled, custom fields (ending in __c) are included in the output. | On |
| Include read-only fields | When enabled, read-only and system fields are included in the output. | Off |
| Include compound fields | When enabled, compound fields (like Address or Name) are included as single entries in the output. | Off |
| Salesforce account | The connected Salesforce credential to use for the fetch. | None selected |
Configuration tips
- Turn off Include read-only fields if you're using the output to build a mapping for records you plan to insert or update — read-only fields can't be written to.
- Include custom fields if your org relies heavily on custom objects and fields for the data you're mapping.
Example
Setup
sObject types: Account, Contact, with custom fields included and read-only fields excluded.
Output
A metadata file listing each writable field on Account and Contact, including custom fields, with its type (for example, Text, Picklist, Currency).
Troubleshooting
sObject not found
- Confirm the API name is correct, including the
__csuffix for custom objects. - Confirm the connected Salesforce account has access to the object.
Missing expected fields
- Check whether the field is read-only or compound, and adjust Include read-only fields or Include compound fields accordingly.
See also
Updated 1 day ago