# Tally

This document outlines the integration with the Tally connector, enabling OvalEdge to connect with Tally Prime for external integrations via the Tally XML protocol using a Tally Gateway Service. Since Tally does not provide a native REST API, all communication is performed through XML requests routed by the Gateway, which must have network access to the Tally XML Server.

The connector supports metadata extraction via crawling and data preview for entities and reports. Authentication and security are enforced at the Gateway using HTTP Basic Authentication to ensure only authorized requests from OvalEdge CSP Apps are allowed. The Tally XML Server does not enforce authentication.

<figure><img src="https://content.gitbook.com/content/ztcvwwOJCeaE1n6oHp4C/blobs/77wYN7k89OMclLFUKqXb/unknown.png" alt=""><figcaption></figcaption></figure>

### Overview

#### Connector Details

| Connector Category                                           | Application           |
| ------------------------------------------------------------ | --------------------- |
| OE Application Version                                       | R8.0                  |
| Connectivity \[How the connection is established with Tally] | Tally XML via Gateway |
| Authentication                                               | HTTP Basic (Gateway)  |
| Protocol                                                     | Tally XML (TDL-based) |

#### Connector Features

| Feature                           | Availability |
| --------------------------------- | :----------: |
| Crawling                          |       ✅      |
| Profiling                         |       ❌      |
| Query Sheet                       |       ❌      |
| Data Preview                      |       ✅      |
| Auto Lineage                      |       ❌      |
| Manual Lineage                    |       ❌      |
| Secure Authentication via Gateway |       ✅      |

#### Tally Gateway Service

The Tally Gateway Service is an HTTP proxy component that acts as an intermediary between OvalEdge Application and the Tally XML Server. It exposes standardized HTTP endpoints (typically on default port 8888) to receive XML-based requests from OvalEdge and forwards them to the Tally XML Server (typically running on default port 9000).

These port values are default configurations and may vary based on the deployment environment.

The Gateway manages authentication, request forwarding, encoding conversion, and response relaying to ensure secure and reliable communication.

#### Tally Gateway Capabilities

<table><thead><tr><th width="253.3333740234375">Capability</th><th>Description</th></tr></thead><tbody><tr><td>HTTP Interface</td><td>Exposes HTTP endpoints to accept Tally XML requests</td></tr><tr><td>Authentication</td><td>Enforces HTTP Basic Authentication for secure access</td></tr><tr><td>Request Forwarding</td><td>Routes XML requests to the Tally XML Server</td></tr><tr><td>Response Relay</td><td>Returns XML responses back to the connector</td></tr><tr><td>Encoding Handling</td><td>Converts payloads to UTF-16LE as required by Tally</td></tr><tr><td>Connection Management</td><td>Manages request routing and connection pooling</td></tr></tbody></table>

#### Tally Connectivity Design Considerations

Tally exposes data only through the Tally XML Server, which is designed primarily for local usage and does not provide a REST API. Due to network access limitations, encoding requirements, and security constraints, direct integration with the XML Server is not suitable for enterprise environments. The Tally Gateway Service is used to enable secure, standardized, and scalable connectivity between OvalEdge and Tally.

#### Constraints of Direct Tally XML Server Access

<table><thead><tr><th width="250">Area</th><th>Description</th></tr></thead><tbody><tr><td>Network Reachability</td><td>XML Server may not be accessible from OvalEdge environments</td></tr><tr><td>Encoding Format</td><td>Requires UTF-16LE encoding and specialized handling</td></tr><tr><td>Security Exposure</td><td>Direct access may require firewall changes and open network ports</td></tr><tr><td>Access Governance</td><td><p>No centralized authentication or access management.</p><p>Tally lacks role-based access control APIs.</p></td></tr><tr><td>Scalability Support</td><td>No built-in connection pooling or optimized routing</td></tr></tbody></table>

#### Communication Flow

The connection is configured using the Tally Gateway URL, username, password, and company name which is optional.

1. The connector validates Gateway connectivity.
2. The Gateway forwards XML requests to the Tally XML Server.
3. Metadata Service retrieves companies, entities, and reports.
4. Query Service executes entity and report queries.
5. Responses are returned in XML format and converted into structured data.

#### Metadata Mapping

The following objects are crawled from Tally and mapped to the corresponding UI assets.

<table><thead><tr><th>Source</th><th width="194.3333740234375">Object Type</th><th>OvalEdge Asset</th></tr></thead><tbody><tr><td>Tally Company Name</td><td>Container</td><td><p>Database for Tables</p><p>Domain for Reports</p></td></tr><tr><td>Tally Collection Type</td><td>Entity</td><td>Table</td></tr><tr><td>Tally Report Name</td><td>Report</td><td>Report</td></tr><tr><td>Entity/Report Column</td><td>Field</td><td>Table Column/ Report Column</td></tr></tbody></table>

### Set up a Connection

#### Prerequisites

The following are the prerequisites to establish a connection:

Before configuring the connector, the Tally environment must be prepared with the Tally Gateway service, gateway authentication credentials, and required connectivity settings within Tally Prime. These prerequisites are essential for enabling secure communication with Tally and ensuring reliable access to company data. For detailed instructions on setting up these prerequisites, click [here](https://docs.ovaledge.com/release8.0/connectors/connector-repositories/application/tally/tally-access-configuration).

**Whitelisting Ports**

Ensure the port on which the Tally Gateway application is running is whitelisted for OvalEdge to connect to Tally.

{% hint style="warning" %}
If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and Tally is properly established.
{% endhint %}

**System & Software Requirements**

<table><thead><tr><th width="252">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>Tally</td><td>Must be running with Tally Prime with XML Server enabled</td></tr><tr><td>Tally Gateway Service</td><td>Must be installed and accessible</td></tr><tr><td>Gateway Credentials</td><td>Required for HTTP Basic Authentication</td></tr><tr><td>Network Access</td><td>The Tally Gateway Service must have network access to the Tally XML Server running on Tally</td></tr></tbody></table>

**External Supporting Services**

<table><thead><tr><th width="252">Service Name</th><th>Description</th></tr></thead><tbody><tr><td>Tally Gateway Service</td><td>Proxy between OvalEdge and Tally</td></tr><tr><td>Tally XML Server</td><td>Processes XML requests</td></tr></tbody></table>

{% hint style="warning" %}

* Tally does not provide a REST API.
* All communication occurs through XML via the Gateway.
* Gateway must be running and authenticated.
* An active company must be open in Tally.
  {% endhint %}

#### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Tally, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="220.66668701171875">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Tally" is displayed as the selected connector type.</td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Tally connection              </p><p>(Example: "Tally_Prod").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Tally Gateway URL*</td><td>Enter the base URL of the Tally Gateway Service (for example, http://192.168.1.100:8888). All XML requests from OvalEdge are routed through this gateway to reach the Tally XML Server.</td></tr><tr><td>Gateway Username*</td><td>Enter the username configured for HTTP Basic Authentication on the Tally Gateway Service. This credential is required to authenticate and authorize access before requests are forwarded to the Tally XML Server.</td></tr><tr><td>Gateway Password*</td><td>Enter the password associated with the Gateway Username. This password is used to securely authenticate all incoming requests to the Tally Gateway. Ensure credentials match the Gateway configuration to avoid authentication failures.</td></tr><tr><td>Tally Company</td><td>Enter the Tally Company name to specify the company context for the connection. If left empty, the connector automatically uses the currently active company in Tally. This field is optional and useful when multiple companies exist in Tally.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="221.33331298828125"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr></tbody></table>

1. After entering all connection details, the following actions can be performed:

* Click Validate to verify Gateway connectivity.
* Click Save to store the connection for future use.
* Click Save & Configure to apply additional settings before saving.

2. The saved connection will appear on the Connectors home page.

### Manage Connector Operations

#### Crawl

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The Crawl/Profile button allows users to select one or more schemas for crawling.

1. Navigate to the Connectors page and click Crawl/Profile.
2. Select the schemas to crawl.
3. The Crawl option is selected by default.
4. Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
5. After a successful crawl, the information appears in the Data Catalog > Databases/Reports/Tables tab.

The Schedule checkbox allows automated crawling at defined intervals, from a minute to a year.

1. Click the Schedule checkbox to enable the Select Period drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click Schedule to initiate metadata collection from the connected source.
4. The system will automatically execute the Crawl operation at the scheduled time.

#### Other Operations

The Connectors page in OvalEdge provides a centralized view of all configured connectors, including their health status.

Managing connectors includes:

* Connectors Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

Nine Dots Menu Options:

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* Edit Connector: Update and revalidate the data source.
* Validate Connector: Check the integrity of the connection.
* Settings: Modify connector settings.
  * Crawler: Configure data extraction.
  * Business Glossary Settings: Manage term associations at the connector level.
  * Others: Configure notification recipients for metadata changes.
* Delete Connector: Remove a connector with confirmation.

#### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="89">S.No.</th><th width="211.6666259765625">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Missing Gateway URL</td><td><p>Error Description:</p><p>The Tally Gateway URL field in the connector configuration is empty or not provided, preventing the connector from routing XML requests through the Gateway service. Note: This field maps internally to the system variable TALLY_GATEWAY_URL.</p><p>Resolution:</p><ul><li>Provide a valid TALLY_GATEWAY_URL in the connection attributes.</li><li>Ensure the URL follows the correct format and that the Gateway service is reachable over the network.</li></ul></td></tr><tr><td>2</td><td><p><br></p><p>Gateway authentication errors</p></td><td><p>Error Description:</p><p>The Gateway Username or Password is incorrect or does not match the credentials configured in the Tally Gateway Service, resulting in HTTP Basic Authentication failure.</p><p>Resolution:</p><ul><li>Verify the Gateway Username and Password entered in the connector configuration.</li><li>Ensure credentials match the Gateway authentication settings.</li></ul></td></tr><tr><td>3</td><td>No companies found</td><td><p>Error Description: Tally is not running or no company is currently open, preventing the connector from retrieving company metadata.</p><p>Resolution:</p><ul><li>Ensure Tally is running and a company is open before validating or crawling the connector.</li></ul></td></tr><tr><td>4</td><td>Empty results for Voucher</td><td><p>Error Description: Voucher queries require a valid date range. If start_date and end_date are not provided, results may return empty.</p><p>Resolution:</p><p>Provide a valid date range using start_date and end_date when executing Voucher  data preview.</p></td></tr></tbody></table>

#### Additional Notes

<table><thead><tr><th width="221.33331298828125">Topic</th><th>Description</th></tr></thead><tbody><tr><td>Date Ranges</td><td>Transaction entity queries support start_date and end_date parameters to define the data retrieval period.</td></tr><tr><td>Default Date Ranges</td><td>Voucher queries default to the current financial year. Report discovery defaults to the last 30 days when dates are not provided.</td></tr><tr><td>Gateway Endpoint</td><td>All requests are internally routed to the Gateway endpoint {gateway}/api/tally/xml.</td></tr><tr><td>Query Execution</td><td>Entity queries use Tally XML COLLECTION TYPE requests. Report queries use Tally XML REPORT NAME requests.</td></tr><tr><td>Gateway Requirement</td><td>The Tally Gateway Service must be accessible and properly configured to connect to the Tally XML Server.</td></tr><tr><td>Company Selection</td><td>Company name is optional. If left empty, the connector uses the currently active company in Tally.</td></tr><tr><td>Error Handling</td><td>Gateway connectivity and credentials are validated during connection setup. Field validation falls back to static lists when dynamic validation is unavailable.</td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA