Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

W-17246664 Enabling API Catalog #373

Open
wants to merge 6 commits into
base: latest
Choose a base branch
from
Open

W-17246664 Enabling API Catalog #373

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bed6094
W-17246664 Enabling API Catalog
valkyrie69 Nov 18, 2024
4a6230e
Adding content
valkyrie69 Nov 18, 2024
2b59014
Removing permission section
valkyrie69 Nov 18, 2024
97f21b6
Edits
valkyrie69 Dec 3, 2024
978cfd5
Update trusted-salesforce-org.adoc
valkyrie69 Dec 3, 2024
461f509
Update modules/ROOT/pages/enabling-api-catalog.adoc
valkyrie69 Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
** xref:connecting-salesforce-orgs.adoc[]
** xref:managing-connected-salesforce-orgs.adoc[]
** xref:manage-capabilities.adoc[]
*** xref:enabling-api-catalog.adoc[]
*** xref:enabling-einstein.adoc[]
*** xref:enabling-invocable-actions.adoc[]
* xref:allowlisting-trusted-domains.adoc[]
Expand Down
33 changes: 33 additions & 0 deletions modules/ROOT/pages/enabling-api-catalog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Enabling API Catalog

Enable a connected Salesforce organization to access and sync Anypoint Platform APIs into the Salesforce API Catalog and expose them as invocable actions. This capability is enabled in Anypoint Platform Access Management by an Anypoint Platform organization administrator.
valkyrie69 marked this conversation as resolved.
Show resolved Hide resolved

[[enable-disable-api-catalog]]
== Enable or Disable API Catalog in Anypoint Platform

include::partial$include-nav-steps-org-admin.adoc[]

. Click *Salesforce*.
. In *Capabilities Managed in Anypoint Platform*, click *Settings* for *Make MuleSoft Anypoint Platform APIs Available in Salesforce*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now these options don't seem to match what's in QAX. Is there a new design for this I should be using for the review?

. In *Settings for Anypoint APIs in Salesforce*, click *Continue*.
. In *Settings*, select the Anypoint Platform business groups that allow the Salesforce organization to import Anypoint Platform APIs into its API Catalog, and click *Save Settings*.
+
[NOTE]
Within the selected business groups, you can import only APIs that have specs published in Exchange with active instances into Salesforce.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are quite a prerequisites that have to be met for APIs to sync into API Catalog. I wonder if we could be a little less specific here and cross-reference the API Catalog "Before You Begin" (Name and link tbd) content in help.salesforce.com? Something like:
Within the selected business groups, you can sync only APIs from Exchange that have managed instances and meet the prerequisite conditions. For more information, see Salesforce Help.

The alternative might be to duplicate all of the prereqs here, which becomes a maintenance issue. It's a bit of a moving target now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, import should be changed to sync throughout the content and the UI text.

. In *Capabilities Managed in Anypoint Platform*, switch between *Enabled* or *Disabled* in *Make MuleSoft Anypoint Platform APIs Available in Salesforce*.
+
image:connected-salesforce-org-api-catalog-enabled.png["Connected Salesforce organization with both Invocable Actions and API Catalog enabled"]
+
The Salesforce organization administrator can then sync APIs into their catalog.
+
For details about syncing APIs and using API Catalog in Salesforce, see xref:general::api-catalog-in-salesforce.adoc[].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this link be replaced with a link to the topic in Salesforce Help? I have the planned link, but need to get the topic ID approved by a content strategist before I share it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bjoson-mulesoft Yes, it will need to link to the Salesforce help content.

. After the APIs are synced, the Salesforce administrator selects individual API instances and operations and converts them into invocable actions so Salesforce developers can access them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we're trying to document too much about API Catalog here? I recommend cross-referencing the API Catalog content in Salesforce Help here as well and simplifying to something a little less specific. I should have something for review by next sprint and we can put our heads together then on what makes sense to cover her for the Access Management admin.

+
A client ID is created.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to have Yining Zhao and/or Mariana Zurita review this. Salesforce admins create connections for the API instances either as part of activating actions or for existing actions, and these connections handle the authentication between Anypoint Platform and Salesforce based on credentials and permission sets. The Salesforce admin adds users (here called Salesforce developers) to permission sets. API Catalog can detect through the connection functionality when access needs to be requested, when access is rejected or revoked, and when a client contract has been deleted. API Catalog also has options for selecting SLA tiers. I'm still getting familiar with the details on this.

. An access request for the Salesforce developers selected by the Salesforce administrator is sent to the Anypoint Platform owner of that API through API Manager.
+
After the request is accepted, Salesforce developers can start using the API.

== See Also

xref:connecting-salesforce-orgs.adoc[]
1 change: 1 addition & 0 deletions modules/ROOT/pages/trusted-salesforce-org.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Enable cross-platform features between your Anypoint Platform organization and a

Establishing a tenant relationship between an Anypoint Platform organization and a Salesforce organization enables users in your organization to:

* Enable API Catalog for a connected Salesforce organization to view a catalog of MuleSoft APIs that are available for use in the connected Salesforce organization and sync APIs to get the latest changes and updates.
* Publish invocable actions directly from their Robotic Process Automations (RPA) and Composer flows.
* Enhance Anypoint Code Builder and Intelligent Document Processing (IDP) developer experiences with Einstein.

Expand Down