Exalate

https://docs.exalate.com/docs
Admin
Exalate is a synchronization and integration solution that enables seamless data exchange and...
Tokens:14,043,689
Snippets:246,597
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Exalate for GitHub on Docker

Source: https://docs.exalate.com/docs/accept-the-connection-invitation-in-script-mode-for-jira-on-premise

Guide to installing Exalate for GitHub via Docker. This enables a containerized setup for seamless integration with GitHub repositories.

```bash
# Obtain the Exalate Docker image for GitHub:
# docker pull exalate/exalate-github
# Launch the container, specifying ports and any required environment variables:
# docker run -d --name exalate-github -p 8080:8080 exalate/exalate-github
```

--------------------------------

### Exalate Connection Setup - Python Example

Source: https://docs.exalate.com/docs/jira-performance-issues-related-to-multiple-issue-views-open-at-the-same-time

Demonstrates how to establish an Exalate connection using Python, likely interacting with Exalate's API or configuration files. This snippet is useful for programmatic control.

```python
import requests

def setup_exalate_connection(api_key, instance_url, config):
    headers = {
        'Authorization': f'ApiKey {api_key}',
        'Content-Type': 'application/json'
    }
    response = requests.post(f'{instance_url}/api/connections', json=config, headers=headers)
    return response.json()
```

--------------------------------

### Exalate FAQs: How to Start from Scratch

Source: https://docs.exalate.com/docs/jira-on-premise-version-511

This FAQ explains the process of setting up Exalate from a completely fresh start. This includes instructions on installation, initial connection setup, and configuring basic synchronization rules, useful for new users or when resetting an existing setup.

```markdown
### How Can I Start from Scratch with Exalate?

To start from scratch, uninstall any existing Exalate instances. Then, follow the installation guide for your specific platform (Jira, etc.). Once installed, create a new connection, configure the connection details (URL, credentials), and set up your initial sync rules. It's recommended to start with a simple sync to verify the connection before adding complexity.
```

--------------------------------

### Set up a Connection in Basic Mode for Zendesk

Source: https://docs.exalate.com/docs/configure-the-connection-in-script-mode-for-azure-devops

This example demonstrates setting up a basic connection in Exalate for Zendesk. Basic mode simplifies the configuration for common ticket synchronization needs.

```json
{
  "connectionName": "ZendeskBasicSync",
  "mode": "Basic",
  "remoteInstance": {
    "url": "https://your-subdomain.zendesk.com",
    "credentials": {
      "username": "api_token_email",
      "apiKey": "your-api-token"
    }
  },
  "syncRules": {
    "fields": [
      {"source": "subject", "target": "subject"},
      {"source": "description", "target": "description"},
      {"source": "status", "target": "status"}
    ]
  }
}
```

--------------------------------

### External Scripting Setup Example (Groovy)

Source: https://docs.exalate.com/docs/jira-on-premise-version-534

Illustrates how to set up and use external scripts within the Exalate environment. This involves defining script files and potentially importing them into the main synchronization logic for better organization and reusability.

```Groovy
// Example: Importing and using a function from an external script
import com.exalate.scripts.Versions
def versions = new Versions()
versions.syncVersions()
```

--------------------------------

### Install Exalate for GitHub on Docker

Source: https://docs.exalate.com/docs/set-up-exalate-in-servicenow-using-an-update-set

This guide explains how to install Exalate for GitHub using Docker. Containerization with Docker simplifies the setup and ensures compatibility across different environments.

```docker
FROM exalate/exalate-github

# Set up required environment variables for GitHub integration
# ENV GITHUB_APP_ID=your-github-app-id
# ENV GITHUB_PRIVATE_KEY=your-github-private-key
```

--------------------------------

### Set up Connection in Basic Mode for Salesforce

Source: https://docs.exalate.com/docs/accept-the-connection-invitation-in-script-mode-for-xurrent

Guides on setting up a basic Exalate connection for Salesforce, simplifying the initial integration.

```javascript
exalate.connection.create('salesforce', {
  mode: 'basic',
  instanceUrl: 'https://your-domain.my.salesforce.com'
});
```

--------------------------------

### Install Exalate for Jira Cloud on Docker

Source: https://docs.exalate.com/docs/accept-the-connection-invitation-in-script-mode-for-freshdesk-and-freshservice

Guide for installing Exalate for Jira Cloud using Docker. This method allows for a containerized deployment of Exalate, simplifying setup and management.

```bash
# Ensure Docker is installed and running
docker run -d -p 8080:8080 --name exalate-jira-cloud exalate/exalate-jira-cloud:latest
# Access Exalate via http://localhost:8080
# Follow the on-screen instructions for Jira Cloud integration.
```

--------------------------------

### Install Exalate for Azure DevOps on Docker

Source: https://docs.exalate.com/docs/unexalate-operation

Instructions for installing Exalate for Azure DevOps on a Docker environment. This allows for running Exalate in a containerized setup for Azure DevOps integrations.

```dockerfile
FROM exalate/exalate-azure-devops:latest

# Ports and environment variables specific to Azure DevOps
EXPOSE 8081

ENV AZDO_ORG_URL="https://dev.azure.com/your-organization"
ENV AZDO_PROJECT_NAME="YourProject"
```

--------------------------------

### Set up a Connection in Basic Mode for GitHub

Source: https://docs.exalate.com/docs/configure-the-connection-in-script-mode-for-azure-devops

This example demonstrates setting up a basic connection in Exalate for GitHub. Basic mode is suitable for synchronizing issues between GitHub repositories.

```json
{
  "connectionName": "GitHubBasicSync",
  "mode": "Basic",
  "remoteInstance": {
    "url": "https://api.github.com/repos/owner/repo",
    "credentials": {
      "username": "your-github-username",
      "token": "your-github-personal-access-token"
    }
  },
  "syncRules": {
    "fields": [
      {"source": "title", "target": "title"},
      {"source": "body", "target": "body"},
      {"source": "labels", "target": "labels"}
    ]
  }
}
```

--------------------------------

### Working with External Scripts

Source: https://docs.exalate.com/docs/nodehelper-in-script-helpers

Comprehensive guide on using external scripts in Exalate, including setup, usage, and a library of examples.

```APIDOC
## Working with External Scripts

### Description
Guidance on implementing and managing external scripts for advanced customization within Exalate synchronization rules.

### Topics
* `Externalizing existing scripts`
* `How to set up an advanced scripting environment`
* `Adding basic external script`
* `External scripts with a bit of TLC`
* `How to Work with External Scripts in Jira On-premise`

### External Scripts Library
* `Versions.groovy`
* `Components.groovy`
* `IssueLinks.groovy`

### Examples of Using External Scripts
* `How to Move Issues Automatically in Jira On-premise`
* `How to Move Existing Scripts to the External Scripts Library`
* `How to Add an External Script in Jira On-premise`
* `How to Sync Status using External Scripts in Jira On-premise`
* `How to Match Custom Field Sync Using External Scripts in Jira On-premise`
* `How to Sync Sub Tasks Using External Scripts in Jira On-premise`
* `How to Sync Tempo Worklogs using External Scripts in Jira On-premise`
* `How to Sync Status using External Scripts in Jira Cloud`
```

--------------------------------

### Set up Connection in Basic Mode for GitHub

Source: https://docs.exalate.com/docs/sync-transaction-prioritization

This example shows how to set up a connection in Basic Mode for GitHub using Exalate. Basic Mode simplifies the configuration for synchronizing issues and other data between GitHub repositories.

```json
{
  "connection_mode": "basic",
  "source_platform": "github",
  "target_platform": "github",
  "sync_rules": {
    "issue_types": ["Issue"],
    "fields": ["title", "body", "state"]
  },
  "filter": "is:open"
}
```

--------------------------------

### Set up Connection in Basic Mode for GitHub

Source: https://docs.exalate.com/docs/accept-the-connection-invitation-in-script-mode-for-xurrent

Guides on setting up a basic Exalate connection for GitHub, facilitating initial integration.

```javascript
exalate.connection.create('github', {
  mode: 'basic',
  repo: 'owner/repo-name'
});
```

--------------------------------

### Start Issue Sync in Jira On-premise with Exalate

Source: https://docs.exalate.com/docs/jira-cloud-syncing-organizations-field-in-jira-service-desk

This guide explains how to initiate issue synchronization between Jira On-premise instances using Exalate. It covers the initial setup and activation of connections.

```Exalate Console
// To start sync, you typically create a connection between two Jira instances in Exalate.
// Then, you configure the sync rules and activate the connection.
```

--------------------------------

### Exalate External Scripting Setup Example

Source: https://docs.exalate.com/docs/jira-cloud-version-573

Illustrates how to set up an advanced scripting environment for Exalate, enabling the use of external script files for better organization and reusability.

```groovy
// In your main script:
include("Components.groovy")

// In Components.groovy:
def processComponent(issue) {
  // ... logic ...
}
```

--------------------------------

### Set up Exalate for ServiceNow on Docker

Source: https://docs.exalate.com/docs/initiate-a-connection-in-script-mode-for-asana

This guide provides instructions on installing and configuring Exalate for ServiceNow when using Docker containers. It covers the necessary Docker commands and configurations for a smooth setup.

```bash
# Example Docker commands for Exalate ServiceNow setup (conceptual):

docker run -d --name exalate-servicenow \
  -p 8080:8080 \
  -e SERVICENOW_URL=https://your-instance.service-now.com \
  -e SERVICENOW_USERNAME=your_username \
  -e SERVICENOW_PASSWORD=your_password \
  exalate/servicenow:latest

# Verify container status:
docker ps

# Access Exalate Admin Console via http://localhost:8080
```

--------------------------------

### Start Issue Sync in Jira On-premise

Source: https://docs.exalate.com/docs/internal-request-service-management

This guide details the process of initiating issue synchronization within Jira On-premise using Exalate. It covers the initial setup and activation steps required to begin syncing.

```N/A
// This action is typically performed through the Exalate UI within Jira.
// There is no direct code snippet for starting sync, but rather configuration steps.
// The process involves:
// 1. Navigating to the Exalate sync console for your Jira instance.
// 2. Selecting the connection to the remote system.
// 3. Clicking the 'Start Sync' or similar button.
// 4. Ensuring the sync rules and filters are correctly configured.

```
Tokens:
Raw