Contact Free trial Login

Update API Community Manager

Keep your Anypoint API Community Manager instance up to date to take advantage of new and improved functionality in your community.

For information about updates, see Important Notifications.

After you install an update with this process, it is not possible to undo the installation and return to a previous version. Follow this best-practice workflow:

  1. Keep a partial copy sandbox or a full copy sandbox as a long-term staging environment.

    The staging environment will have a partial or full copy of the data in the production environment.

  2. Create a short-term developer sandbox.

  3. Install the update in the developer sandbox and test it.

  4. Discard the developer sandbox.

  5. Install the update in the staging sandbox and test it.

  6. Install the update in your production environment.

To update your API community:

  1. Before performing any steps, read all the steps, including pre-install and post-install.

  2. If necessary, notify your customers and stakeholders of the update, and that APIs, docs, and client app pages may not work during the update during the time after installing the new package and before completing the required configuration changes.

  3. Ensure that your Salesforce organizations have the External Data Change Tracking for OData 4.0 Adapter feature enabled:

    1. Before upgrading the package in your production or sandbox organization, check that your organization has this feature enabled by going to Setup > External Data Source and editing the Exchange data source.

    2. If you don’t see an Eligible for External Change Data Capture checkbox, raise a support case through the MuleSoft support portal and list the IDs of all your Salesforce API Community Manager organizations, including the IDs of all production and sandbox organizations.

      Attempting to upgrade the package without this feature enabled causes the process to fail with errors due to missing objects and fields related to a missing ChangeEvent object.

  4. Open the API Community Manager control panel.

  5. In the same browser session, open the package update installation link provided by your MuleSoft representative.

  6. Verify the version number and name of the release.

  7. If you are upgrading from a package version before 1.26, follow the Pre-Install Steps When Upgrading from a Version before 1.26 and then continue with these instructions.

  8. If you are upgrading from a package version before 1.74, follow the Pre-Install Steps When Upgrading from a Version before 1.74 and then continue with these instructions.

  9. Select Install for admins only.

  10. Select Upgrade.

    This starts the installation process.

    When the upgrade finishes, you receive a notification email.

  11. If you are upgrading from package version 1.62 or earlier, follow the Post-Install Steps When Upgrading from Version 1.62 or Earlier and then continue with these instructions.

  12. If you are upgrading from a package version before 1.69, follow the Post-Install Steps When Upgrading from a Version before 1.69 and then continue with these instructions.

  13. If you are upgrading from a package version before 1.74, follow the Post-Install Steps When Upgrading from a Version before 1.74 and then continue with these instructions.

  14. If you are upgrading from a package version before 1.77, follow the Post-Install Steps When Upgrading from a Version before 1.77.

Pre-Install Steps When Upgrading from a Version before 1.26

If you are upgrading from a package version before 1.26, follow these steps:

  1. Go to Salesforce Workbench: https://workbench.developerforce.com/

  2. Select Standard.

  3. Enter your username and password.

  4. Click the Login button.

  5. In the Queries menu, click SOQL Query.

  6. In the Object list, select NavigationLinkSet.

  7. In the Fields list, select Id and MasterLabel.

  8. Click the Query button.

  9. The query results are displayed as a list of records.

  10. Find the records with the MasterLabel field set to NTO_Nav0 and acm_template_Nav0.

  11. Click the Id of the record with the MasterLabel field NTO_Nav0.

  12. Click the Delete button.

  13. Click the Confirm delete button.

  14. Click the Id of the record with the MasterLabel field acm_template_Nav0.

  15. Click the Delete button.

  16. Click the Confirm delete button.

  17. Continue with normal package installation.

Return to the main list of update instructions and continue to follow them.

Pre-Install Steps When Upgrading from a Version before 1.74

If you are upgrading from a package version before 1.74, follow these steps:

  1. Create a new named credential:

    1. Click Setup > Named Credentials.

    2. Copy the configuration information from the named credential anypoint_mulesoft.

    3. Create a new named credential with the name Anypoint and matching configuration.

  2. Update the external data source:

    1. Click Setup > External Data Source > Exchange > Edit.

    2. Set URL to callout:Anypoint/odatabridge/odata.svc/.

    3. Ensure that Eligible for External Change Data Capture is enabled.

    4. Save.

  3. Update the previous named credential:

    1. Click Setup > Named Credentials.

    2. Modify the named credential anypoint_mulesoft.

    3. Set Identity Type to Named Principal.

    4. Set Authentication Protocol to Password Authentication.

    5. Set Username to the placeholder value user.

    6. Set Password to the placeholder value pass.

    7. In the section Callout Options, enable Generate Authorization Header, Allow Merge Fields in HTTP Header, and Allow Merge Fields in HTTP Body.

Return to the main list of update instructions and continue to follow them.

Post-Install Steps When Upgrading from Version 1.62 or Earlier

If you are upgrading from package version 1.62 or earlier, after installing, ensure both Member and Guest profiles have field-level Read access to the ParentId field in the CommunityAPI object:

  1. Configure the Member profile:

    1. Click Setup > Profiles.

    2. Open the Member profile.

    3. Click Object settings > CommunityAPI.

    4. Ensure the ParentId field has Read access.

    5. Save.

  2. Configure the Guest profile:

    1. Click Community builder > Settings > General.

    2. Open the Guest profile.

    3. Click Object settings > CommunityAPI.

    4. Ensure the ParentId field has Read access.

    5. Save.

Return to the main list of update instructions and continue to follow them.

Post-Install Steps When Upgrading from a Version before 1.69

If you are upgrading from a package version before 1.69, update the permissions of the Member and Guest profiles on the SelfRegisterUserRequests object:

  1. Configure the Member profile permissions:

    1. Click Setup > Profiles.

    2. Open the Member profile.

    3. Click Object settings > SelfRegisterUserRequests.

    4. Ensure there are no object level permissions and no field level permissions for this profile on this object.

  2. Configure the Guest profile permissions:

    1. Open the community builder.

    2. Click Settings > General.

    3. Open the Guest profile.

    4. Click Object settings > SelfRegisterUserRequests.

    5. Ensure that object level permissions include only Create and Read.

    6. Ensure that field level permissions for all fields include only Read and Edit.

  3. Check that your permissions match those in the Configure Profiles and Permissions documentation.

Return to the main list of update instructions and continue to follow them.

Post-Install Steps When Upgrading from a Version before 1.74

If you are upgrading from a package version before 1.74, follow these steps:

  1. Click Setup > External Data Source > Exchange.

  2. In the section Custom HTTP Headers, set X-Auth-Proto to the value 'JWT', including the single quotes.

  3. Save.

  4. Upgrading to version 1.74 removes the Spec Downloader component from the community API Details page.

    In the community builder, in Pages > CommunityApi > API Detail, add the Spec Downloader component.

Return to the main list of update instructions and continue to follow them.

Post-Install Steps When Upgrading from a Version before 1.77

Potential degraded service of your community: Upgrading from a package version before 1.77 requires mandatory configuration updates. When the new package is installed, user access to assets in the community is disabled. When the configuration is complete, user access to assets in the community is enabled.

If you are upgrading from a package version before 1.77, follow these steps:

Configure sharing settings for guests:

  1. In Setup, search for Security using the Quick Find box and click Sharing Settings.

  2. Scroll to the CommunityAssetVersions Sharing Rules section near the bottom of the page and click New.

  3. In the Rule Name section, update Label with [Community Name] Sharing Rule.

  4. In the Select your rule type section, select Guest user access, based on criteria.

  5. In the Select which records to be shared section, add these criteria.

    1. Field: Community Name Operator: equals Value: [Community Name]

    2. Field: Visibility Operator: equals Value: Public

  6. In Select the users to share with, select [Community Name] Site Guest User.

  7. In Select the level of access for the users, select Read Only.

  8. Save.

  9. In the API Community Manager control panel, open Community Builder and click Settings > General.

  10. In the Guest user profile section, click [Community Name] Profile.

  11. For each of the four objects CommunityAssetVersions, AnypointAssetCategories, AnypointAssets, and AnypointAssetVersion, in Object Permissions ensure Read is enabled, and in Field Permissions ensure all fields have Read Access enabled.

  12. For the object CommunityAssetVersions, in Custom Object Permissions ensure Read is enabled.

  13. For the object AnypointApiInstances, in Field Permissions ensure that Version and VersionGroup have Read Access enabled.

  14. In External Object Permissions, ensure each item has Read enabled.

  15. Save.

Configure sharing settings for members:

  1. In Setup, search for Communities using the Quick Find box and click Communities Settings.

  2. Scroll to Sharing Sets and click Edit next to the set [Community Name] Sharing Set.

  3. In the Select Objects section, select CommunityAssetVersions from Available Objects and add it to Selected Objects.

  4. In the Configure Access section, select Set Up under the Action column next to CommunityAssetVersions.

  5. In the Access Mapping for *CommunityAssetVersions page enter these values.

    1. Account in the User list.

    2. acm_pkg__Account_c in the Target CommunityAssetVersions list.

    3. Read Only in the Access Level list.

  6. Update.

  7. Save.

  8. In Setup, search for Users using the Quick Find box and click Profiles.

  9. Repeat the following steps for each of the profiles for your users.

    There may be one or more user profiles to configure.

  10. Click the profile.

  11. In the profile page, click Edit.

  12. For each of the four objects CommunityAssetVersions, AnypointAssetCategories, AnypointAssets, and AnypointAssetVersion, in Object Permissions ensure Read is enabled, and in Field Permissions ensure all fields have Read Access enabled.

  13. For the object CommunityAssetVersions, in Custom Object Permissions ensure Read is enabled.

  14. For the object AnypointApiInstances, in Field Permissions ensure that Version and VersionGroup have Read Access enabled.

  15. In External Object Permissions, ensure each item has Read enabled.

  16. Save.

If you ever change the name of your community, be sure to update this configuration.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub