Create a distributed collaboration
To share content in a distributed collaboration with other organizations, create a collaboration and a workspace, link a group to the workspace, and invite participants to the collaboration.
Creating a distributed collaboration requires at least one administrator from each participating organization. As a collaboration administrator, you must work with administrators from each participating organization to complete the collaboration setup. Additionally, as the collaboration host, you are responsible for managing the collaboration and its workspaces.
Prerequisites for creating a collaboration
The following prerequisites must be met before creating a collaboration:
For collaborations between ArcGIS Enterprise and ArcGIS Online, ArcGIS Online must be established as the collaboration host.
ArcGIS Enterprise organizations on-premises or in the cloud can participate as guests in ArcGIS Online collaborations. They can also participate as either the host or the guest in collaborations with other ArcGIS Enterprise on Windows, Linux, or Kubernetes organizations. For more information, see Key concepts for collaboration.
Note:
Cloud deployments of ArcGIS Enterprise can be configured to use ArcGIS Data Store or a cloud relational store. For more information, see Considerations for using a cloud relational store.
If you aren't an administrator for the organizations participating in the collaboration, ensure that you can communicate with the other participant administrators outside of ArcGIS Enterprise to complete the workflow.
Enable the certificate only on your ArcGIS Enterprise organization.
When inviting a guest organization to participate in a collaboration, you must specify its URL as HTTPS.
To ensure secure communication among collaboration participants, each participant must trust the certificate used by the other participants. When ArcGIS Enterprise is the collaboration host, it must trust the certificate used by each guest participant, and each guest participant must trust the certificate used by the collaboration host. If the certificates aren't trusted, creating the collaboration fails. For information about trusting certificates, see Configure the portal to trust certificates from your certifying authority. If ArcGIS Online is the collaboration host, you don't need to import the certificates for guest participants.
To participate in an ArcGIS Online-to-ArcGIS Enterprise collaboration, or an ArcGIS Enterprise-to-ArcGIS Enterprise collaboration in which the organizations are on separate networks, configure the network firewall rules for each ArcGIS Enterprise organization to allow outbound communication over port 443. Collaborations between organizations on the same network may not require this change.
Enable pop-ups in your browser to allow invitation requests and responses to be downloaded.
Supported authentication modes
You can create a collaboration that includes ArcGIS Enterprise participants using either built-in or web-tier authentication.
Collaboration supports enterprise-wide single sign-on across ArcGIS Enterprise deployments.
If ArcGIS Enterprise participants in the collaboration use public key infrastructure (PKI)-based client certificate authentication, import the domain root certificate into each participant's organization. For instructions, see Configure the portal to trust certificates from your certifying authority. Note that the PKI certificate must be in pkcs12 format.
Create a collaboration and workspace
To create a collaboration and workspace, complete the following steps:
Sign in to your organization as a member of the default administrator role or a custom role with administrative privileges to manage the organization's collaborations.
At the top of the site, click Organization and click the Settings tab.
Click Collaborations on the side of the page.
Under the Distributed section, click Create collaboration.
The Create collaboration window appears.
Provide a collaboration name and description.
Note:
Members of groups linked to a collaboration workspace can view collaboration details on the Overview tab of the group page, including the collaboration name. Therefore, when naming the collaboration, you can avoid including its configuration settings in the name.
The Collaboration name text box can contain up to 100 characters, and the Description text box can contain up to 250 characters.
In the Item retention policy section, specify what happens to collaboration items when the collaboration or any of its workspaces is deleted.
For Items sent from my organization, select one of the following options:
Remove from participants—Items sent from your organization are removed from all collaboration participants.
Let participants decide—Collaboration participants decide whether to keep the items sent from your organization.
For Items received by my organization, select one of the following options:
Remove from my organization—Items received by your organization are removed.
Keep if permitted by contributing participants—You can keep the items received by your organization until the sending participants revoke permission to retain them.
Note:
The item retention policy is configured at the collaboration level and applies to all associated collaboration workspaces.
Click Next.
Provide a workspace name and description.
Note:
The Workspace name text box can contain up to 100 characters, and the Workspace description text box can contain up to 250 characters.
Choose an existing group or create a new group that will be linked to the collaboration workspace. A group can only be associated with one collaboration workspace. To learn more about groups and workspaces, see Understand distributed collaboration.
Note:
Members of groups linked to a collaboration workspace can view collaboration details on the Overview tab of the group page, including the collaboration name. Therefore, when naming a new group, you can avoid including the collaboration settings in the name.
Choose one of the following options to specify how feature layers and views are shared to the collaboration workspace:
References—Collaboration participants receive new layer items that reference the source feature layers or views. Data edits are accessible in real time. If an item is secured, users must sign in to the source organization to access it.
One-way copies—Collaboration participants receive new hosted feature layers that they own. Only edits from your organization are synchronized at a scheduled interval defined by the guest.
Two-way copies—Collaboration participants receive new hosted feature layers that they own. Edits from your organization and participating organizations are synchronized at a scheduled interval defined by the guest.
If you chose One-way copies or Two-way copies in the previous step, optionally turn on the If unable to share as copies, share as references toggle button to share feature layers and views as references if an error occurs while sharing them as copies.
Optionally, turn on the Allow participants to view services without signing into this organization toggle button to allow collaboration participants to access services shared as references without signing in to your organization. If you turn on this option, find and select a built-in account with Viewer privileges in the Viewer account search box and provide its password in the Viewer password field. All services shared as references by your organization will be updated to use the credentials of this Viewer account, allowing collaboration participants to access the services without signing in.
Click Create distributed collaboration.
Invite a guest to a collaboration
Once you have created a distributed collaboration and workspace, you can invite one or more organizations to the collaboration as guests.
To invite a guest organization to a collaboration, complete the following steps:
Sign in to your organization as a member of the default administrator role or a custom role with administrative privileges to manage the organization's collaborations.
At the top of the site, click Organization and click the Settings tab.
Click Collaborations on the side of the page.
Under the Distributed section, find and select the collaboration to which you want to invite the guest organization. Optionally, do any of the following to help you find the collaboration:
Type search terms in the search box.
Click Status and select a sort type and direction.
The collaboration window appears.
In the Guest organizations section, click Invite.
The Invite guest organization window appears.
Provide the guest organization’s URL, which must be specified as HTTPS in the format
https://organization.example.com/enterprise.Click Next.
Choose one of the following workspace access modes from the drop-down menu:
Guest can send content to this workspace—The guest organization can send to but not receive content from the workspace.
Guest can receive content from this workspace—The guest organization can receive from but not send content to the workspace.
Guest can send and receive content from this workspace—The guest organization can send and receive content from the workspace.
Click Prepare invitation.
Note:
Invitation files expire 24 hours after they are created.
Click Download invitation file.
Share the invitation file with an administrator of the guest organization.
Import an invitation response
Once a guest organization accepts the invitation to collaborate, you must import the invitation response file to complete the collaboration setup.
To import an invitation response, complete the following steps:
Sign in to your organization as a member of the default administrator role or a custom role with administrative privileges to manage the organization's collaborations.
At the top of the site, click Organization and click the Settings tab.
Click Collaborations on the side of the page.
Under the Distributed section, find and select the collaboration to which you want to import the invitation response. Optionally, do any of the following to help you find the collaboration:
Type search terms in the search box.
Click Status and sort by Invitations pending.
Note:
If a collaboration has pending invitations, the collaboration card displays the number of pending invitations.
The collaboration window appears.
In the Pending invitations section, find the guest organization and click Upload response
.The Upload response window appears.
Click Choose file, select the invitation response file you received from the guest organization, and click Open.
In the Webtier authentication section, select Yes if the guest organization requires web-tier authentication and choose one of the following authentication types:
Credentials—Provide the credentials for the guest organization’s web-tier authentication.
Certificate—Upload the guest organization’s PKI certificate and provide its password.
Click Upload response file.
Note:
If your organization does not trust the guest organization's certificate, an error message appears. The certificate must be trusted before the invitation response can be imported.
The guest organization is now listed in the Guest organizations section of the collaboration window. The guest organization's administrator receives a notification that they have joined the collaboration.