> For the complete documentation index, see [llms.txt](https://coldbox-orm.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox-orm.ortusbooks.com/v5.x/virtual-services/service-properties.md).

# Service Properties

Service Properties for Virtual Entity Services in CBORM

There are a few properties you can instantiate the virtual service with or set them afterwards that affect operation. Below you can see a nice chart for them:

| Property           | Type    | Required | Default                       | Description                                                                                                                |
| ------------------ | ------- | -------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `entityName`       | string  | true     |                               | The entity name to bind the virtual service with.                                                                          |
| `queryCacheRegion` | string  | false    | `#entityName#.defaultVSCache` | The name of the secondary cache region to use when doing queries via this service                                          |
| `useQueryCaching`  | boolean | false    | false                         | To enable the caching of queries used by this service                                                                      |
| `eventHandling`    | boolean | false    | true                          | Announce interception events on *new()* operations and *save()* operations: *ORMPostNew, ORMPreSave, ORMPostSave*          |
| `useTransactions`  | boolean | false    | true                          | Wraps all operations that save, delete or update ORM entities in a BoxLang `transaction{}` (unless one is already running) |
| `defaultAsQuery`   | boolean | false    | false                         | The bit that determines the default return value for `list(), executeQuery()` as query or array of objects                 |
| datasource         | string  | false    | System Default                | The default datasource to use for all transactions. If not set, we default it to the datasource of the bound entity.       |

To create a virtual service you can do this:

```java
class extends="cborm.models.VirtualEntityService" {

  UserService function init(){
      super.init( entityName="User", useQueryCaching=true, eventHandling=false );
      return this;
  }

}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox-orm.ortusbooks.com/v5.x/virtual-services/service-properties.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.