> For the complete documentation index, see [llms.txt](https://doc.telosys.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.telosys.org/bundles/telosys-objects.md).

# Telosys objects

## Objects by categories

Telosys provides a set of predefined objects usable in the templates :

* Objects representing the model elements : 
  * [**$model**](https://www.telosys.org/doc/latest/objects/model.html)  (current model)
    * [**$entity**](https://www.telosys.org/doc/latest/objects/entity.html)  (entity defined in the model) \[0:N entities in each model]
      * [**$attribute**](https://www.telosys.org/doc/latest/objects/attribute.html)  (attribute defined in an entity) \[1:N attributes in each entity]
        * [**$fkPart** ](https://www.telosys.org/doc/latest/objects/fkPart.html) (part of foreign key, if attribute is involved in one or more FK)
      * [**$link**](https://www.telosys.org/doc/latest/objects/link.html)  (link defined in an entity) \[0:N links in each entity]
        * [**$linkAttribute** ](https://www.telosys.org/doc/latest/objects/linkAttribute.html) (attribute involved in link definition) \[1:N / link]
      * [**$fk** ](https://www.telosys.org/doc/latest/objects/fk.html)(foreign key defined in an entity) \[0:N FK in each entity]
        * [**$fkAttribute** ](https://www.telosys.org/doc/latest/objects/fkAttribute.html) (attribute involved in FK definition) \[1:N / fk]
      * [**$reference**](https://www.telosys.org/doc/latest/objects/reference.html)  (reference to other entity)  \[0:N references in each entity]
* Current environment and project :  
  * [**$env**](https://www.telosys.org/doc/latest/objects/env.html)  (environment configuration)
  * [**$project** ](https://www.telosys.org/doc/latest/objects/project.html) (project configuration)
* Generation in progress : 
  * [**$target** ](https://www.telosys.org/doc/latest/objects/target.html)  (current target file being generated)
  * [**$bundle**](https://www.telosys.org/doc/latest/objects/bundle.html) (bundle in use for current generation)
  * [**$generator**](https://www.telosys.org/doc/latest/objects/generator.html) (generator engine)
* Utility functions and tools : 
  * [**$fn**  ](https://www.telosys.org/doc/latest/objects/fn.html) (set of utility functions)
  * [**$const** ](https://www.telosys.org/doc/latest/objects/const.html) (set of constants)
  * [**$factory**](https://www.telosys.org/doc/latest/objects/factory.html) (a factory to create objects)
  * [**$file** ](https://www.telosys.org/doc/latest/objects/file.html) (to use files located on the file system) 
  * [**$loader** ](https://www.telosys.org/doc/latest/objects/loader.html) (to load your own utility classes)
  * [**$now** ](https://www.telosys.org/doc/latest/objects/now.html) (current date and time)
  * [**$values** ](https://www.telosys.org/doc/latest/objects/values.html) (literal values generator for attributes)
  * [**$h2**  ](https://www.telosys.org/doc/latest/objects/h2.html) (utility functions for H2 database)
* Objects dedicated to code generation of certain target languages :   
  * Java :  [**$java** ](https://www.telosys.org/doc/latest/objects/java.html)   [**$jpa** ](https://www.telosys.org/doc/latest/objects/jpa.html)   [**$jdbc**](https://www.telosys.org/doc/latest/objects/jdbc.html)    
  * C#  :  [**$csharp**](https://www.telosys.org/doc/latest/objects/csharp.html)  
  * PHP :  [**$php** ](https://www.telosys.org/doc/latest/objects/php.html)  
  * SQL :  [**$sql** ](https://www.telosys.org/doc/latest/objects/sql.html) 
  * HTML :  [**$html** ](https://www.telosys.org/doc/latest/objects/html.html) 
* Deprecated objects (do not use, just for backward compatibility) :  
  * ~~**$jdbcFactory**~~  (use **$factory** instead)
  * ~~**$today**~~ (use **$now** instead)
  * ~~**$beanValidation**~~ (all is now in **$java**)

## Objects reference documentation

The documentation reference for each object is available here :

* **Latest version** : 
  * [Telosys 4.3.0 - objects reference](https://www.telosys.org/doc/v430/objects/index.html)
* Previous version : 
  * [Telosys 4.1.0 - objects reference](https://www.telosys.org/doc/v410/objects/index.html)
  * [Telosys 4.0.0 - objects reference](https://www.telosys.org/doc/v400/objects/index.html)
  * [Telosys 3.3.0 - objects reference](https://www.telosys.org/doc/v330/objects/index.html)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.telosys.org/bundles/telosys-objects.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.