Tally Prime Developer Reference

https://help.tallysolutions.com/developer-reference/
Admin
Tally Prime Developer Reference provides comprehensive documentation for TDL (Tally Definition...
Tokens:215,447
Snippets:1,441
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start Zip

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Starts a zip operation, specifying the target zip file and optionally whether to overwrite an existing file.

```APIDOC
## Start Zip

### Description
Starts a zip operation, specifying the target zip file and optionally whether to overwrite an existing file.

### Syntax
`Start Zip : <Target File> [: <Overwrite>]`

### Parameters
- **Target File** (string) - Required - The name of the resultant zip file, including the folder path.
- **Overwrite** (logical) - Optional - Specifies whether to overwrite the target file if it already exists. Values: YES or NO. Default is NO.

### Example
```
Start ZIP : "Target.zip" : Yes
```

### Notes
- If Overwrite is YES, the file will be overwritten. If NO, the file will not be overwritten and will remain as is.
```

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

### System Start event handler

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Defines a system event handler that calls the function MyAppStart when the Tally application is launched. The condition is TRUE, so the action always executes on System Start.

```TDL
[System : Events] 
AppStart1 : System Start : TRUE : CALL : MyAppStart
```

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

### Reinitialize Definition Example

Source: https://help.tallysolutions.com/developer-reference/tally-definition-language/what-are-symbols-and-prefixes-in-tdl

Shows how to use the '*' prefix to completely override an existing definition's attributes.

```TDL
[*Field : MyField] 
Width : 20% Page
Set as : “This Field has been reinitialized”
```

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

### Before/After Delete Object Events with Logging

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Shows the syntax and an example for the Before Delete Object and After Delete Object system events. These events trigger only when the user confirms deletion, and they are mutually exclusive. The example logs object details (Name, MasterID, Parent) before and after deletion of a Stock Item.

```TDL
[System : Events] 
<Label> : Before Delete Object : <Logical Condition Expr>: <Action Keyword > : <Action Parameters>
<Label> : After Delete Object : <Logical Condition Expr> : <Action Keyword > : <Action Parameters>
```

```TDL
[System : Event] 
BeforeStockItemDeletion : Before Delete Object : $$IsStockItem:Call:BeforeDeleteObjectFunc
AfterStockItemDeletion : After Delete Object : $$IsStockItem:Call:AfterDeleteObjectFunc
[Function : BeforeDeleteObjectFunc] 
00 : Log : “Before Delete Object Event starts here”
10 : Log : $Name + “under the Stock Group” + $Parent + “is being deleted by ” + $$CmpUserName
20 : Log : $MasterID
30 : Log : “Before Delete Object Event ends here”
[Function : AfterDeleteObjectFunc] 
00 : Log : “Stock Item ” + $Name + “ Deleted”
```

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

### Procedural Actions: Start Unzip, Extract Path, Unzip Exclude Path, End Unzip

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Procedural actions for partial or full unzip. Start Unzip initiates the process, Extract Path marks files/folders to extract, Unzip Exclude Path excludes specified paths, and End Unzip completes the operation.

```APIDOC
## Start Unzip

### Description
Starts the unzip process. Must be followed by Extract Path, Unzip Exclude Path, and End Unzip actions.

### Syntax
Start Unzip : <Source File> [: <Password>]

### Parameters
- **Source File** (string) - Required - Path of the zip file to be unzipped.
- **Password** (string) - Optional - Password to access the target zipped file.

## Extract Path

### Description
Specifies a folder/file path to be marked for extracting from the zip file.

### Syntax
Extract Path : <Folder/ File Path>

### Parameters
- **Folder/ File Path** (string) - Required - Path of the file/folder to extract.

## Unzip Exclude Path

### Description
Excludes specified folders/files from the unzipping operation.

### Syntax
Unzip Exclude Path : <Folder/ File Path>

### Parameters
- **Folder/ File Path** (string) - Required - Path of files/folders to exclude.

## End Unzip

### Description
Completes the unzip operation, extracting the marked files to the target folder.

### Syntax
End Unzip : <Target folder> [:<Overwrite> [:<Show Progress Bar>]]

### Parameters
- **Target Folder** (string) - Required - Path of the target folder where unzipped files need to reside.
- **Overwrite** (logical) - Optional - Specifies behaviour if files already exist. Default value is 'NO'.
- **Show Progress Bar** (logical) - Optional - Specifies if progress bar is shown. Default value is 'NO'.

### Examples
#### Example 3
Start Unzip: "D:Target.zip"
End Unzip : "D:Unzipped" : Yes

Unzips all files from D:Target.zip to D:Unzipped, overwriting existing files.

#### Example 4
Start Unzip : "D:Target.zip"
Extract Path : "*.txt"
Extract Path : "*.doc"
End Unzip : "."

Extracts only .txt and .doc files to the current Tally application folder.

#### Example 5
Start Unzip : "D:Target.zip"
Extract Path : "SamplesSupporting Files"
Unzip Exclude Path : "*.xls"
End Unzip : "."

Extracts all files and subfolders within 'Supporting Files' under 'Samples', excluding .xls files, to the current Tally application folder.
```

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

### Creating SQL procedures with _

Source: https://help.tallysolutions.com/developer-reference/tally-definition-language/what-are-symbols-and-prefixes-in-tdl

Shows how to prefix a collection name with _ to create an externally referenceable SQL procedure. The example defines a collection _LedBills with parameters and SQL values.

```tdl
[Collection: _LedBills] 
Type :Bills  
Child of : #UName SQLParms : UName  
SQLValues : Bill No : $Name  
SQLValues : Bill Date : $$String:$BillDate:UniversalDate
```

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

### SQL Query: Retrieve Closing Balance for a Specific Month

Source: https://help.tallysolutions.com/developer-reference/developer-reference-faq/tdl-faq

Use the $$FromValue and $$ToValue functions in a SQL query to get the closing balance of ledgers for a specific month. The example shows a query for April 2015.

```SQL
Select $$FromValue:"01-04-2015": $$ToValue:"30-04-2015":$Closingbalance from LedgerColl.
```

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

### Create a new folder in Windows using Make Dir action

Source: https://help.tallysolutions.com/developer-reference/developer-reference-faq/tdl-faq

Use the system action Make Dir to create a new folder in Windows. The example shows creating 'D:\TestNew'.

```TDL
[Function: Test Function]
11 : Make Dir: “D:\TestNew”
```

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

### Create Ledgers function with START BATCH POST

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Example TDL function that creates 1000 ledgers under 'Sundry Debtors' using batch posting with a batch size of 500. The function uses START BATCH POST and END BATCH POST to update objects in batches, improving performance by locking and releasing the database only twice instead of 1000 times. The batch size is set to 500, so the 1000 ledgers are updated in 2 batches.

```TDL
[Function : Create Ledgers] 
Parameter : pNumberofLedgers : Number : 1000
000 : START BATCH POST : 500
010 : For Range : i : Number: 1: ##pNumberofLedgers
020 : New Object : Ledger
030 : Set Value : Name : “Customer ” + $$String:##i
040 : Set Value : Parent : “Sundry Debtors”
050 : Create Target
060 : End For
070 : END BATCH POST
```

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

### Refresh Data with Timer Event Example

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Declares a Timer event named Refresh Timer that invokes the Refresh Data action at periodic intervals. Adds a key Enable Refresh to the Balance Sheet report; pressing Alt+R starts the timer every 300 seconds (5 minutes).

```TDL
[System : Event] 
Refresh Timer : TIMER : TRUE : Refresh Data
[#Form : Balance Sheet] 
Add : Keys : Enable Refresh
[Key : Enable Refresh] 
Key : Alt + R
Action : Start Timer : Refresh Timer : 300
```

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

### SLEEP Action Example

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Adds a menu item 'Trial Balance after 10 secs' that calls the function TBafterSleep. The function sleeps for 10 seconds and then displays the Trial Balance.

```TDL
[#Menu : Gateway of Tally] 
Add : Item : Trial Balance after 10 secs : CALL : TBafterSleep
[Function : TBafterSleep] 
00 : SLEEP : 10
10 : DISPLAY : Trial Balance
```

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

### NatLangQuery example: Create Ledger

Source: https://help.tallysolutions.com/developer-reference/actions-events-buttons/what-are-actions-events-buttons-and-keys-in-tdl

Example query that triggers the NatLangQuery event to create a ledger named RadheShyam under the group Sundry Debtors.

```TDL
Create Ledger RadheShyam SundryDebtors
```

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

### Exposing methods to ODBC with _

Source: https://help.tallysolutions.com/developer-reference/tally-definition-language/what-are-symbols-and-prefixes-in-tdl

Shows how to prefix a method with _ inside an object definition to expose it to ODBC. The example exposes _Difference as a method on the Ledger object.

```tdl
;; Exposing Methods within the Objects to ODBC
  
[#Object: Ledger] 
_Difference: $ClosingBalance – $OpeningBalance
```

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

### Retrieve System Information Parameter ($$SysInfo:MachineName)

Source: https://help.tallysolutions.com/developer-reference/developer-reference-faq/tdl-faq

Use $$SysInfo with a parameter to retrieve system information. The example shows MachineName, but other parameters include ApplicationPath, CurrentPath, SystemDate, SytemTime, SystemTimeHMS, SystemName, IsWindows, WindowsVersion, WindowsUser, IPAddress, and MACAddress.

```TDL
$$SysInfo:MachineName
```

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

### Reading data from a GET Request

Source: https://help.tallysolutions.com/developer-reference/tally-definition-language/objects-and-collections

Defines a collection that sends a GET request to a URL and receives a JSON response. Uses 'HTTP JSON' type and specifies a JSON object path.

```TDL
[Collection: TSPLGetBranchesColl] 
Data Source : HTTP JSON: ” http://localhost/HttpJson/getbranchlist.php”
JSON Object Path : “BranchName:1”
```

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

### Publish CHM Help File with Map IDs

Source: https://help.tallysolutions.com/developer-reference/developer-reference-faq/tdl-faq

Publishes a CHM help file for context-sensitive help. The example defines a system formula 'Testfield' with a Map ID of 25000 and a field 'test field' with a Help attribute referencing '@@testField'. Then it adds a menu button 'DIYHlp' that calls the 'DispHelp' function to display the CHM file.

```TDL
[System: Formula]
Testfield : 25000
[#Field: test field]
Help : @@testField
```

```TDL
[#Menu: Main Menu]
Add: Button: DIYHlp
[Button:DIYHlp]
Key : ALT + 4
Action : Call : DispHelp
[Function: DispHelp]
05 : DisplayHelp:"":"D:\Newhelp.chm"
```
Tokens:
Raw