-
Notifications
You must be signed in to change notification settings - Fork 22
W-16420474 Updates to Connecting Salesforce orgs #350
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.
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
Open
valkyrie69
wants to merge
60
commits into
latest
Choose a base branch
from
W-16420474-connecting-salesforce-anypoint-vh
base: latest
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
60 commits
Select commit
Hold shift + click to select a range
28071db
W-16420474 Updates to Connecting Salesforce orgs
valkyrie69 f4a9f94
Updates
valkyrie69 af96389
Adding content
valkyrie69 ec402da
Content updates
valkyrie69 fc164ab
Doc updates
valkyrie69 68639d9
Adding info about invocable actions
valkyrie69 a7a7f16
Removing file
valkyrie69 ed4fb37
Content updates
valkyrie69 a8439a8
Merge branch 'latest' into W-16420474-connecting-salesforce-anypoint-vh
valkyrie69 4af711e
content updates
valkyrie69 355bf3a
Edits
valkyrie69 b19a29d
Adding info
valkyrie69 3d67157
Adding info
valkyrie69 4b79291
nav fix
valkyrie69 f9f3056
Many additions
valkyrie69 afd34fd
Update connecting-salesforce-orgs.adoc
valkyrie69 463d946
Updates
valkyrie69 6d28362
Updating for Salesforce terminology
valkyrie69 b11a957
feedback
valkyrie69 f3ae272
Tech review feedback
valkyrie69 514e974
Merge branch 'latest' into W-16420474-connecting-salesforce-anypoint-vh
valkyrie69 98a24eb
Tech review feedback
valkyrie69 c6ba428
Added info about the SF org tenant key and the Anypoint Platform org key
bjoson-mulesoft b57775c
Added a link to the API Catalog doc
bjoson-mulesoft 6fe6861
Edit
bjoson-mulesoft 02c8e4b
Changed organization ID to organization key in all places
bjoson-mulesoft 0f7856a
Commented out the question to reviewers
bjoson-mulesoft abd9486
Fixed xref
bjoson-mulesoft 03b3dd8
Updates
valkyrie69 bc19767
Merge branch 'W-16420474-connecting-salesforce-anypoint-vh' of ssh://…
valkyrie69 6d3b0bf
Merge branch 'latest' into W-16420474-connecting-salesforce-anypoint-vh
valkyrie69 bf3e0bf
Update manage-capabilities.adoc
valkyrie69 b24d503
Merge branch 'W-16420474-connecting-salesforce-anypoint-vh' of ssh://…
valkyrie69 c6a7abd
Moving Einstein to a different branch
valkyrie69 8a27433
moving image to a different branch
valkyrie69 2ad79a4
Updates
valkyrie69 c6c80e3
Updates
valkyrie69 ac122c0
edit
valkyrie69 d26b0c8
Edits
valkyrie69 a7e9eff
Edit
valkyrie69 83da64b
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 e9cc81a
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 1dc0933
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 62c6920
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 b8dbac9
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 ab7a8ad
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 1f06ee1
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 fd1c60f
Update modules/ROOT/pages/manage-capabilities.adoc
valkyrie69 cbf967a
Update modules/ROOT/pages/manage-capabilities.adoc
valkyrie69 41a654b
Update modules/ROOT/pages/manage-capabilities.adoc
valkyrie69 92ad2cf
Update modules/ROOT/pages/manage-capabilities.adoc
valkyrie69 966fcf9
Update modules/ROOT/pages/managing-connected-salesforce-orgs.adoc
valkyrie69 5711d61
Update modules/ROOT/pages/managing-connected-salesforce-orgs.adoc
valkyrie69 1e2ef2b
Update modules/ROOT/pages/managing-connected-salesforce-orgs.adoc
valkyrie69 0f4f6b3
Update modules/ROOT/pages/managing-connected-salesforce-orgs.adoc
valkyrie69 bb49643
Update modules/ROOT/pages/managing-connected-salesforce-orgs.adoc
valkyrie69 23044b5
Update modules/ROOT/pages/connecting-salesforce-orgs.adoc
valkyrie69 ddeb4fc
Merge branch 'latest' into W-16420474-connecting-salesforce-anypoint-vh
valkyrie69 4f456e9
Hanna edits
valkyrie69 234aee0
Removed adding permission
valkyrie69 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+148 KB
modules/ROOT/assets/graffle files/connected-salesforce-org-api-catalog-enabled.graffle
Binary file not shown.
Binary file added
BIN
+145 KB
modules/ROOT/assets/graffle files/connected-salesforce-org-invocable-actions-enabled.graffle
Binary file not shown.
Binary file added
BIN
+193 KB
modules/ROOT/assets/graffle files/einstein-enabled-in-salesforce.graffle
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+108 KB
modules/ROOT/assets/images/connected-salesforce-org-api-catalog-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+109 KB
modules/ROOT/assets/images/connected-salesforce-org-invocable-actions-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
. Sign in to Anypoint Platform using an account that has the Organization Administrator permission. | ||
. Sign in to Anypoint Platform using an account that has the root Organization Administrator permission. | ||
. In the navigation bar or the main Anypoint Platform page, click *Access Management*. |
5 changes: 5 additions & 0 deletions
5
modules/ROOT/pages/_partials/include-salesforce-mulesoft-setup-nav.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
. Log in to your Salesforce organization with your admin credentials. | ||
. Go to *Setup*. | ||
+ | ||
image:salesforce-setup.png["Salesforce Setup menu with Setup selected"] | ||
. From *Setup*, in the Quick Find box, enter `MuleSoft`, and then select *MuleSoft > Anypoint Platform Setup*. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
= Establish a Tenant Relationship With a Trusted Salesforce Organization | ||
|
||
Establishing a tenant relationship between an Anypoint Platform organization and a Salesforce organization enables users in your organization to: | ||
|
||
* 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. | ||
* Make MuleSoft APIs available in the connected Salesforce organization's API Catalog. | ||
|
||
When you establish the tenant relationship, you can initiate, complete, and manage the tenant relationships. You can also enable, disable, and remove connections. | ||
|
||
These are the ways to establish a tenant relationship: | ||
|
||
* A Salesforce organization is provisioned with the tenant relationship with an Anypoint Platform organization already established. In this case, the Anypoint Platform organization administrator just needs to xref:managing-connected-salesforce-orgs.adoc#enable-disable-connection[enable the connection] in Anypoint Platform. | ||
* The Anypoint Platform organization administrator initiates the tenant relationship in Anypoint Platform and the Salesforce organization administrator completes the setup in the Salesforce organization. | ||
|
||
In some cases, the Anypoint Platform organization administrator and Salesforce organization administrator are different people, and in some cases, they are the same person. | ||
|
||
== Before You Begin | ||
|
||
Anypoint Platform organization administrators must have: | ||
|
||
* Anypoint Platform Organization Administrator permission at the root organization level | ||
* Salesforce tenant key of the Salesforce organization to connect | ||
+ | ||
The Anypoint Platform organization administrator can get the tenant key from the Salesforce organization administrator. | ||
|
||
Salesforce organization administrators must have: | ||
|
||
* Salesforce administrator permission set | ||
* Anypoint Platform organization key | ||
+ | ||
The Salesforce organization administrator can get the Anypoint Platform organization key from the Anypoint Platform organization administrator. | ||
|
||
[connect-orgs] | ||
== Connect With a Salesforce Org in Anypoint Platform | ||
|
||
As an Anypoint Platform organization administrator, you can start the process of connecting to a trusted Salesforce organization. | ||
|
||
You must have the Salesforce organization's connection key (tenant key) before you can connect to a Salesforce organization. Contact the Salesforce organization admin to get the tenant key. | ||
|
||
TIP: Salesforce admins get the Salesforce organization tenant key and enable MuleSoft features in their Salesforce organization Setup in *MuleSoft > Anypoint Platform Setup*. | ||
|
||
include::partial$include-nav-steps-org-admin.adoc[] | ||
|
||
. Click *Salesforce*. | ||
. Click *Add Salesforce Org*. | ||
. Enter the Salesforce organization tenant key, and click *Confirm*. | ||
valkyrie69 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
+ | ||
The format for the Salesforce tenant key is `cloud/env/org-id`. | ||
. In the *Add the Salesforce Org* dialog, verify the information and click *Add*. | ||
. Click *Copy* to copy the Anypoint Platform organization key. | ||
. If you are the admin for the Salesforce organization you are adding, click *Manage in Salesforce* to continue setting up the relationship in Salesforce. | ||
+ | ||
If you are not the Salesforce admin, provide the Anypoint Platform organization key to the Salesforce admin so they can finish the connection process in Salesforce. | ||
|
||
When the connection process is complete, the Salesforce organization appears in the *Salesforce Orgs* section of the *Salesforce* page. | ||
|
||
[complete-organization-connection] | ||
== Complete the Organization Connection in Salesforce | ||
|
||
As a Salesforce organization administrator, you complete the connection between your organization and the Anypoint Platform organization when the connection process is initiated in Anypoint Platform. You must have the Anypoint Platform organization key to complete the connection. | ||
|
||
include::partial$include-salesforce-mulesoft-setup-nav.adoc[] | ||
|
||
. In *Your connected Anypoint Platform Organization*, click *View Connection Info*. | ||
. In the *Connection to MuleSoft Anypoint Platform* dialog, enter the Anypoint Platform organization key in the *Anypoint Platform Organization ID* field, and then click *Connect*. | ||
+ | ||
NOTE: The Anypoint Platform organization key is the universally unique identifier (UUID) for the Anypoint Platform organization ID. | ||
+ | ||
If you don't have the Anypoint Platform organization key, contact the Anypoint Platform organization administrator. | ||
+ | ||
You return to the *Connection to MuleSoft Anypoint Platform* page. The page shows the connected Salesforce organization details, including the enablement status of the capabilities associated with the connected Salesforce organization. | ||
|
||
image::connected-salesforce-org-invocable-actions-enabled.png["The connected Salesforce organization with API Catalog disabled and Invocable Actions enabled"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice alt text! |
||
|
||
== See Also | ||
|
||
* xref:trusted-salesforce-org.adoc[] | ||
* xref:managing-connected-salesforce-orgs.adoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
= Managing Capabilities for a Connected Salesforce Organization | ||
|
||
When you establish a tenant relationship and enable the connection between your Anypoint Platform organization and a trusted Salesforce organization, you can enable and disable capabilities associated with the Salesforce organization. | ||
|
||
[[enable-disable-api-catalog]] | ||
== Enable or Disable API Catalog in Anypoint Platform | ||
|
||
Enable a connected Salesforce organization to access and import 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. | ||
|
||
To enable this feature: | ||
|
||
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*. | ||
. In *Settings for Anypoint APIs in Salesforce*, click *Continue*. | ||
. In the *Settings* page, select the Anypoint Platform business groups that allow the selected Salesforce organization to import Anypoint Platform APIs into its API Catalog, and click *Save Settings*. | ||
+ | ||
[NOTE] | ||
Within the selected business groups, only APIs that have specs published in Exchange with active instances can be imported into Salesforce. | ||
. In the *Capabilities Managed in Anypoint Platform* section, switch between *Enabled* or *Disabled* in the *Make MuleSoft Anypoint Platform APIs Available in Salesforce* section. | ||
+ | ||
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[]. | ||
+ | ||
. After the APIs are imported, the Salesforce administrator selects individual API instances and operations and converts them into invocable actions for access by selected Salesforce developers. | ||
. A client ID is created and an access request for the selected Salesforce developers is sent to the Anypoint Platform owner of that API through API Manager. | ||
+ | ||
After the request is accepted, the selected Salesforce developers can start using the API. | ||
|
||
[[enable-disable-invocable-actions]] | ||
== Enable or Disable Invocable Actions in the Salesforce Org | ||
|
||
When the invocable actions capability is enabled by the Salesforce admin in Salesforce, MuleSoft automation developers can publish invocable actions directly from their Robotic Process Automations (RPA) and Composer flows to the connected Salesforce org. | ||
|
||
. In Salesforce Setup, go to the *Quick Find* box and enter `MuleSoft`, then select *MuleSoft > MuleSoft Anypoint Platform*. | ||
. In *Your connected Anypoint Platform Organization*, click *View Connection Info* to open a new dialog. | ||
. In the *Connection to MuleSoft Anypoint Platform* window, switch between *Enabled* or *Disabled* in the *Enable Invocable Actions from MuleSoft Anypoint Platform Automations* section. | ||
|
||
== See Also | ||
|
||
* xref:trusted-salesforce-org.adoc[] | ||
* xref:managing-connected-salesforce-orgs.adoc[] |
106 changes: 106 additions & 0 deletions
106
modules/ROOT/pages/managing-connected-salesforce-orgs.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
= Managing Connected Salesforce Orgs | ||
|
||
As an Anypoint Platform organization administrator, you can: | ||
|
||
* <<enable-disable-connection,Enable or disable the connection>> to a Salesforce organization. | ||
* <<removing-connections,Remove the connection>> to a Salesforce organization. | ||
* <<repairing-org-connection,Repair the connection>> to a Salesforce organization. | ||
* <<edit-org-name,Edit the Salesforce organization name>>. | ||
|
||
[enable-disable-connection] | ||
== Enable or Disable a Connection in Anypoint Platform | ||
|
||
Enable or disable the connection to a Salesforce organization that has an established tenant relationship with your Anypoint Platform organization. | ||
|
||
[NOTE] | ||
Tenant relationships that are automatically provisioned for your Anypoint Platform organization are disabled until you enable them. | ||
|
||
Disabling the connection between your Anypoint Platform and a connected Salesforce organization doesn't remove the connection to the Salesforce organization. | ||
The Salesforce organization still appears in the list of available organizations with a status of `Disabled`. | ||
You can't publish assets from your Anypoint Platform organization to the Salesforce organization or use any of the other features associated with the connected Salesforce organization until the connection is reenabled. | ||
|
||
include::partial$include-nav-steps-org-admin.adoc[] | ||
|
||
. Click *Salesforce*. | ||
+ | ||
If your organization has at least one established tenant relationship with a Salesforce organization, a list of Salesforce orgs appears, showing the name, organization ID, and status of the tenant relationship connection. | ||
. Click *Enable* or *Disable* for the Salesforce organization you want to enable or disable the connection for. | ||
|
||
[[removing-connections]] | ||
== Remove the Connection Between Anypoint Platform and Salesforce Organizations | ||
|
||
When you remove the connection between your Anypoint Platform organization and Salesforce organization, the Salesforce organization no longer appears in the list of connected organizations. The connection still exists in the Salesforce organization until it's removed by the Salesforce organization administrator. | ||
|
||
To reestablish the connection between Anypoint Platform and removed Salesforce organizations, administrators with the appropriate permissions in both Anypoint Platform and Salesforce organizations must recreate the connection. | ||
|
||
[removing-connection-anypoint-platform] | ||
=== Remove a Connected Salesforce Org in Anypoint Platform | ||
|
||
An Anypoint Platform organization administrator can remove the connection between their Anypoint Platform organization and a connected Salesforce organization. | ||
|
||
When you remove a connection to a Salesforce organization, any capabilities that are associated with the Salesforce organization, such as API Catalog, are removed. | ||
|
||
To remove the connection to a Salesforce organization: | ||
|
||
include::partial$include-nav-steps-org-admin.adoc[] | ||
|
||
. Click *Salesforce*. | ||
. Click the *Actions* menu (*...*) in the Salesforce organization to remove the connection from and select *Remove Salesforce Org*. | ||
. In the *Remove Salesforce Org* dialog, click *Remove Org*. | ||
|
||
[removing-connection-salesforce] | ||
=== Remove a Connected Anypoint Platform Organization in Salesforce | ||
|
||
A Salesforce organization administrator can remove the connection between an Anypoint Platform organization and Salesforce organization using the Salesforce user interface. | ||
|
||
To remove the connection to an Anypoint Platform organization in Salesforce: | ||
|
||
include::partial$include-salesforce-mulesoft-setup-nav.adoc[] | ||
|
||
. In *Your connected Anypoint Platform Organization*, click *View Connection Info*. | ||
. From *Go To Anypoint*, select *Remove connection*. | ||
. In *Remove connection to Anypoint Platform*, click *OK*. | ||
|
||
Alternatively, if you want to temporarily prevent Anypoint Platform users from publishing assets to Salesforce from the Anypoint Platform side, you can instead <<enable-disable-connection,disable>> the connection temporarily. | ||
|
||
For more information about managing this relationship from the Salesforce user interface, see the https://help.salesforce.com/s/articleView?id=sf.external_services_manage_your_mulesoft_anypoint_platform_connection.htm&type=5[Salesforce documentation]. | ||
|
||
[[repairing-org-connection]] | ||
== Repair the Connection to a Salesforce Organization | ||
|
||
If the Salesforce *My Domain* is changed in the connected Salesforce organization, you can rediscover the Salesforce organization and repair the connection. | ||
|
||
include::partial$include-nav-steps-org-admin.adoc[] | ||
|
||
. Click *Salesforce*. | ||
. Click the *Actions* menu (*...*) in the Salesforce org and select *Repair Org Info*. | ||
. Click *Repair* to rediscover the Salesforce org. | ||
|
||
[[edit-org-name]] | ||
== Edit the Salesforce Organization Name | ||
|
||
You can edit the Salesforce organization display name in your Anypoint Platform organization. The name of the Salesforce organization within Salesforce remains the same. | ||
|
||
To edit a Salesforce organization name: | ||
|
||
include::partial$include-nav-steps-org-admin.adoc[] | ||
|
||
. Click *Salesforce*. | ||
. Click the *Actions* menu (*...*) in the Salesforce org and select *Edit Org Name*. | ||
. Enter the name for the Salesforce org and click *Save*. | ||
+ | ||
The Salesforce organization name appears in Anypoint Platform anywhere the organization is referenced. | ||
|
||
== Copy Your Anypoint Platform Organization ID | ||
|
||
include::partial$include-nav-steps-org-admin.adoc[] | ||
|
||
. Click *Salesforce*. | ||
. Click the *Actions* menu (*...*) and select *Get Anypoint Platform Organization ID*. | ||
. Click *Copy*. | ||
|
||
|
||
== See Also | ||
|
||
* xref:trusted-salesforce-org.adoc[] | ||
* xref:manage-capabilities.adoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.