Remote Repository

Defines a connection to an external Grooper repository via API Services for cross-repository publishing or batch transfer.

Remarks

A Remote Repository enables Grooper to communicate with and transfer content to another Grooper repository instance using HTTP-based API Services.

• Used for scenarios such as publishing Projects or Batches to a remote environment, migrating configuration, or supporting distributed/multi-tenant solutions.
• Configured on the Root node of the Design page, under the 'Remote Repositories' property.
• Requires the Grooper API Service to be installed and configured on the target repository server.

---

Usage Scenarios

• Publish To Repository: Deploy configuration objects or projects to a remote Grooper instance.
• Batch Transfer: Move or copy batches between repositories for processing, archiving, or migration.
• Integration: Enable distributed workflows or multi-site deployments.

---

Configuration and Best Practices

• Ensure the API Service URL and API Key are correct and correspond to the target repository.
• Use secure (HTTPS) endpoints and strong API keys for production environments.
• Test the connection after configuration to verify access and compatibility.
• Use descriptive names for each remote repository to clarify its role (e.g., "Production", "Test", "Archive").

Properties

Name	Type		Description
URL	String	►	The URL endpoint for the remote Grooper API Services. Requiredtrue Enter the full URL to the Grooper API Service (e.g., https://server.domain.com:port). The URL can be copied from the API Service configuration on the target server. To locate the correct URL, select the Machine node in the Design page, then select the Grooper API Service. The URL must be well-formed and accessible from the current Grooper environment. Changing the URL will reset the repository connection and require re-validation.
API Key	String	►	The API Key used to authenticate with the remote API Services. Requiredtrue API keys are managed in the configuration for the Grooper API Service on the target server. To obtain or manage API keys, select the Machine node in the Design page, then select the Grooper API Service. The API Key must be valid and correspond to the remote repository's configuration. Changing the API Key will reset the repository connection and require re-validation. Use strong, unique API keys for each environment and restrict access as appropriate.
Repository Name	String	►	The display name of the remote Grooper repository. This value is set automatically after a valid URL and API Key are provided and the connection is tested. Used throughout the UI to identify the remote repository in publishing, transfer, and integration scenarios. Read-only; cannot be set manually.

Used By

RootBatch Transfer