Table of Contents

 

Capabilities for AutoBackup

TallyPrime Release 7.0 introduces an enhanced Auto Backup Scheduler framework that allows developers to automate, monitor, and extend backup operations using TDL.
This capability provides programmatic control over the Scheduler service, system validation hooks, and visibility into Connected Backup and TallyDrive usage.

What’s New for Developers

Release 7.0 adds the following TDL action and functions to help you manage backup workflows:

StartScheduler action – Install and control the Scheduler service

$$SchedulerInfo – Query Scheduler service details

$$IsAnyUserLoggedInForCB – Validate Connected Backup login state

$$GetUserTallyDriveInfo – Retrieve TallyDrive usage and limits

Action: StartScheduler

The StartScheduler action allows developers to install, start, and restart the Tally Scheduler service programmatically.
This action requires administrator privileges and it takes no parameter.

Syntax

StartScheduler

Behaviour

  • Installs the Scheduler service if not already installed
  • Starts the service if installed but not running
  • Stops and restarts the service if it is running or in an intermediate state (Paused, Start Pending, Stop Pending, etc.)
  • Reinstalls the service if a configuration exists but the service is missing
  • Requires tallyscheduler.exe to be present in the same directory as tally.exe
  • Ensures the service reaches a Stopped state before starting

Return Value

  • Returns TRUE on successful installation or start.
  • Returns KEY_ERROR if any failure occurs, after setting:
    • Last Result = FALSE
    • Last Error Message with the specific failure reason

Function: $$SchedulerInfo

The SchedulerInfo function is a new capability introduced in TallyPrime Release 7.0 which will allow developers to fetch various details about the Tally Scheduler service. It takes a predefined Name ID as input to determine what specific information to return.

Input Parameter: A predefined string-based Name ID

Return Type: Varies depending on input ( Logical, String, Number or Long)

Syntax

$$SchedulerInfo: <Name ID>

Name IDΒ 

PurposeΒ 

Return TypeΒ 

IsInstalled

Checks if Scheduler is installed (even if not running)

Logical

IsRunning

Checks if Scheduler is running

Long (Integer)

GetVersion

Gets Scheduler version as “major.minor.maintenance”

String

GetServiceName

Returns the Windows service name of Scheduler

String

GetPortNumber

Returns port number where Scheduler is configured

Number

GetTotalTasks

Gets total number of tasks configured in Scheduler

Number

GetServiceUserName

Returns Windows user under which the Scheduler service is running

String

Function: $$IsAnyUserLoggedInForCB

The function $$IsAnyUserLoggedInForCB is a new capability introduced in TallyPrime Release 7.0 which will allow developers to check if an Tally.netID is currently logged in for Connected Backup & Restore (CB) services. This is helpful when certain actions or features depend on the user’s login status for these services.

Syntax

$$IsAnyUserLoggedInForCB

It returns a Boolean (Logical) value to indicate the login status.

  • Yes – If a user is logged in for Connected Backup & Restore.
  • No – If no user is logged in.

Function: $$GetUserTallyDriveInfo

The function $$GetUserTallyDriveInfo is a new capability introduced in TallyPrime Release 7.0 which provides developers detailed information about TallyDrive usage linked to a license and a specific user. It returns a structured string containing multiple values separated by a pipe | symbol, in the format: X|Y|M|N|V

Where:

X = Number of users currently using TallyDrive in this license

Y = Total number of TallyDrive users allowed in this license

M = Usage by the current (logged-in) user

N = Usage by other users in the same license

V = TallyDrive storage validity date and time (as-is from EB)

This helps in understanding both the license-level and user-level usage of TallyDrive.

it takes 2 mandatory parameters

  • LicenseNumber – The license number for which TallyDrive info is to be fetched.
  • Email ID – The registered email ID of the user.

Syntax

$$GetUserTallyDriveInfo:<LicenseNumber>:<EmailID>

it returns a String formatted as: X|Y|M|N|V

TallyHelpwhatsAppbanner
Is this information useful?
YesNo
Helpful?
TARA