To share content in a distributed collaboration with other organizations, you create a collaboration and collaboration workspace, link a group to the workspace, and invite participants to the collaboration. The organization that creates the collaboration is the host, and other participating organizations are guests. Creating the collaboration establishes trust between the participating organizations so that content can be shared among them.
Overview of the collaboration setup (host and guest)
The following is an overview of high-level steps to configure distributed collaboration. Each step indicates whether the action should be done by the collaboration host or guest. For detailed steps to set up collaboration as a host, see Create a collaboration and workspace. For detailed steps to set up collaboration as a guest, see Join a collaboration as a guest.
- Verify prerequisites to creating a collaboration have been met.
- Create a collaboration and workspace (applies to host).
- Invite a guest to the collaboration (applies to host).
- Accept an invitation to collaborate (applies to guests).
- Import an invitation response (applies to host).
- Join a workspace (applies to guests).
Once you've created a collaboration, you can manage it through your portal. See Manage collaborations for details.
Note:
Guest organizations can share content with the collaboration, receive content from the collaboration, or do both, depending on the access mode they are given by the collaboration host. When the host creates the collaboration invitation, they will decide how the guest is allowed to participate in the collaboration. An access mode specified for one workspace could differ from how it is defined in other workspaces.
Prerequisites to creating a collaboration
- As of the 10.5.1 release of ArcGIS Enterprise, ArcGIS Online can participate in distributed collaboration with ArcGIS Enterprise. ArcGIS Online must be established as the collaboration host.
- ArcGIS Enterprise deployments on Kubernetes can participate as a guest in ArcGIS Online collaborations, as well as either the host or guest in a collaboration with another ArcGIS Enterprise deployment. For more information, see Key concepts for collaboration and About distributed collaboration.
- If you are not an administrator for the organizations that will participate in the collaboration, ensure that you can communicate outside of ArcGIS Enterprise with other participant administrators to complete the workflow below.
- Enable the certificate only on your ArcGIS Enterprise organization.
- When inviting a guest organization to be part of a collaboration, its URL must be specified as HTTPS.
- To ensure secure communication among collaboration participants, each participant must trust the certificate used by the other participants. This means when ArcGIS Enterprise is the collaboration host, it must trust the certificate used on each of the guest participants and each guest participant must trust the certificate used on the collaboration host. If the certificates are not trusted, creating a collaboration will fail. See Configuring the portal to trust certificates from your certifying authority for details on how to trust certificates. If ArcGIS Online is the collaboration host, the certificates for the guest participants do not need to be imported.
- 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 both built-in and web-tier authentication.
Collaboration supports enterprise-wide single sign-on across ArcGIS Enterprise deployments.
If ArcGIS Enterprise participants in the collaboration use PKI, ensure that the domain root certificate has been imported into each of the participants. See Configuring the portal to trust certificates from your certifying authority for instructions. Note that the PKI certificate must be in pkcs12 format.
Note:
Kerberos-based Integrated Windows Authentication setups are not supported for distributed collaboration.
Create a collaboration and workspace
- Sign in to the host organization as a member with administrative privileges to manage the organization's collaborations.
- Browse to Organization > Settings > Collaborations.
- Click Create Collaboration.
- In the Create Collaboration window, fill in the Collaboration Name and Collaboration Description text boxes for the collaboration, and click Next.
Keep in mind character limitations when naming and describing a collaboration. The Collaboration Name can contain up to 100 characters and the Collaboration Description can contain up to 250 characters.
- Fill in the Workspace Name and Workspace Description text boxes for the first workspace associated with the collaboration, and click Next.
Keep in mind character limitations when naming and describing a collaboration workspace. The Workspace Name can contain up to 100 characters and the Workspace Description can contain up to 250 characters. You can create more collaboration workspaces after the collaboration has been created if necessary. See Manage collaborations for details.
- Choose the group that will be linked to the collaboration workspace. This can be an existing group, or you can create a new group for this purpose. Click Next.
A group can only be associated with one collaboration workspace. Host access to this workspace will be Send and receive.
- If you create a new group for the collaboration, it will be a private group where all group members can contribute content to the group. You can change the status and contribution settings after the group has been created as needed. See Create groups for more information about these settings. When you create a new group for a collaboration, you must specify tags for the group to proceed.
- If you choose to link an existing group, the drop-down menu will show a list of all the groups in the organization, including private groups.
The sync settings for the host in the collaboration workspace will be listed on the dialog box. Note that the default is set to sync immediately. To change the sync settings for the host, use the ArcGIS Portal Directory sharing API. Only the sync settings for guest portals can be configured from the user interface from either the Join Workspace or Edit Workspace dialog box.
Note:
In collaborations where ArcGIS Online is the host, sync settings will default to At scheduled intervals. The ArcGIS Enterprise participant controls the schedule at which group item content and feature layer edits are synchronized; the host does not control the sync schedule.
- Choose how hosted feature layers will be sent to the collaboration workspace.
- As references—Collaboration participants will receive live access to feature layers in the designated workspace. Collaboration participants must have access to view feature layers from their origin.
- As copies—Collaboration participants will receive feature layer updates at a scheduled interval.
- Allow two-way sharing of feature service edits to eligible participants—Introduced at 10.9, the owner and recipient of a feature layer can make and share edits between them. In previous versions, data edits in feature layers could only be shared from the owner to the recipient. By default, this is not enabled. This option is only available if Copies is selected under Feature layers and views in my portal are sent as when establishing the workspace sync settings. Once enabled on a workspace, this option cannot be disabled. To be eligible for the two-way sharing of edits, all ArcGIS Enterprise collaboration participants must be using a version of Enterprise that is 10.9 or later, with the collaboration workspace also having been created at version of 10.9 or later, and guests must have Send and Receive access to the collaboration workspace. Eligible feature services must be configured to use the ArcGIS Pro service runtime and support replica tracking and bidirectional sync.
- If unable to share as copies share as references—Introduced at 10.8.1. This option is available if Copies is selected when setting up workspace sync settings. If errors occur while sharing features as copies, affected items will be shared as references instead. By default, this will be enabled. Your selection can be updated when editing your workspace. For more information, see Manage collaborations.
When choosing to share feature layers as copies, keep the following in mind:
- Feature layers and views are shared as: copies must be selected in the collaboration workspace.
- A sync interval must be set in the collaboration workspace.
- Sync must be enabled on each feature layer in the collaboration before sharing.
- When feature layers are synced, they are initially extracted and published as hosted feature layers in each participant's organization. Each subsequent sync will be updated with added, deleted, or edited features.
- Click Save or Save and Invite to create the collaboration.
- Clicking Save creates the collaboration. The new collaboration can be viewed in the table on the Collaborations page.
- Clicking Save and Invite creates the collaboration and opens the Invite Guest Organization window.
Invite a guest to the collaboration
- Sign in to the host organization as a member with administrative privileges to manage the organization's collaborations.
- Browse to Organization > Settings > Collaborations.
- On the Collaborations page, in the table, click the name of the collaboration to which you want to invite a guest organization.
- Click View Guests.
The Guests page contains a list of guest organizations in the collaboration.
- Click Invite Guest.
- In the Invite Guest Organization window, enter the Guest Organization URL to the organization. Ensure that the URL is specified as HTTPS in the format https://webadaptorhost.domain.com/<webadaptorname>. Choose the Access to Workspaces option that the guest organization will have: Send Content, Receive Content, or Send and Receive Content.
For more information on these access modes, see Access modes for workspaces.
- Click Save Invitation to save the invitation file.
Note:
Once an invitation file has been created, it will expire after 24 hours. - Share the invitation file with the administrator of the guest organization. You must share the file outside of ArcGIS Enterprise; this can be done by email or another method you have arranged.
Import invitation response
- Sign in to the host organization as a member with administrative privileges to manage the organization's collaborations.
- Browse to Organization > Settings > Collaborations.
- On the Collaborations page, find the table entry for the collaboration whose invitation response you will import. Click the name of the collaboration. Click View Guests. You will see a list of participants in the collaboration. Click the Action button for the guest organization and click Accept Guest Organization.
- In the Accept Guest Organization window, browse to the invitation response file. Information about the guest organization, including the contact person and organization URL, will appear once you've chosen the file.
- If the guest organization requires web-tier authentication, select the Yes option, enter the credentials for the guest's web authentication, and click Accept Guest Organization.
- If the guest organization is secured using PKI client certificate based web-tier authentication, click Choose File and browse to a PKI user certificate in a .pfx file format. Click Accept Guest Organization.
The user credentials contained in the client certificate should be able to successfully authenticate against the PKI client certificate challenge from the guest. The user does not need to be a named user in the guest organization.
Note:
If the collaboration host does not trust the certificate on the guest organization, an error message will appear. The certificate must be trusted before the invitation response can be accepted. See Configuring the portal to trust certificates from your certifying authority for details on how to trust certificates.The guest organization's Status now shows as Active. The guest organization's administrator will receive a notification that they have joined the collaboration.
Once you've completed this workflow, the guest portal sync settings and other details of the collaboration can be further configured. When content is shared with a participant portal, a new folder is created under the participant administrator's folder. This is used to import the content and store the items, which are then shared to the group associated with the collaboration workspace. The folder is named based on the collaboration name.
The sync settings for the collaboration host's workspace are set to sync immediately and can only be changed in the ArcGIS Portal Directory sharing location.