Available in: Axsy Mobile for Salesforce, Axsy Field Service, Axsy Public Sector, Axsy Retail Execution
When publishing a new config version, the Axsy Config Tool provides an option to includes the generation of a file that encapsulates the Salesforce metadata needed for Salesforce Flows, Salesforce Translations, Salesforce Page Layouts and Salesforce Validation Rules. Accordingly, through having access to this file, Axsy Mobile App users will not need to have admin permissions enabled on the Salesforce Platform to directly access any of the included Salesforce metadata.
Requirements
The user that publishes a new config version with metadata generation enabled needs the following permissions enabled for their Salesforce User:
- Modify Metadata Through Metadata API Functions.
- View Setup and Configuration.
What's Included
The following table breaks down what metadata is included:
Metadata Item | Details |
|---|---|
| flows | Metadata for Salesforce Flows (and their Subflows) deployed by Quick Actions, deployed by Lightning Actions, included in Flow Tasks, and referenced in an Axsy Plugin's settings in the Axsy Config Tool. A new config version needs to be published whenever a new version of a Flow is available. |
| translations | All translations configured in the org. |
| objects | All Salesforce objects identified from sync relationships, across all aspects and scopes in the Axsy Config Tool. Includes any object validation rules. |
| layouts | All layouts for Salesforce objects that require Actions, including Lightning Actions, for all objects included in the Axsy Config Tool. |
| plugins | All standard and custom Axsy Plugins. A new config version needs to be published when a new plugin version is created or updated. |
NOTE: When changes are made to any of the metadata listed above, a new config version needs to be published with metadata generated in order to see those changes in the app.
Steps to Generate Metadata
When publishing a new config version, select the Generate Metadata checkbox and then select Publish.
When the new config version is published, the metadata will have the status of one of the following:
Status | Meaning |
|---|---|
| Not Required | Generate Metadata was not selected when publishing. In this scenario, the Axsy Mobile App will fall back to querying Salesforce directly to retrieve the metadata, and the mobile user will therefore need to be granted the permissions listed above. Note: Flow translations are not available in this scenario and are only supported with metadata generation. |
| Pending | Metadata generation is still ongoing. Config versions that have the metadata status "Pending" will not be available in the mobile app. |
| Available | The metadata has successfully been generated and will be picked up when logging in to the app. |