> For the complete documentation index, see [llms.txt](https://doc.moost.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.moost.io/platform-manual/rules/rule-language/operations/format.md). # Format ### Description Formats numbers, time and timestamp. Format on Vector will result in a comma-separated list of formatted values. \ E.g.: `Device Link Car, Fronius Symo` Format on GroupedScalar will result in a comma-separated list of group identifier, double-quote and formatted value; the group identifier is rendered as *device name*, if grouped by device, else the time span index is taken.\ E.g.: `'Device Link Car': 1035, 'Fronius Symo': 8012` Format on GroupedVector will result in a slash-separated list of group identifier, double-quote and comma-separated formatted values; the group identifier is rendered as *device name*, if grouped by device, else the time span index is taken.\ E.g.: `'Device Link Car': 1035, 2012, 3097 / 'Fronius Symo': 8012` ### Number/Event | Text ```java Scalar | Scalar → Scalar Vector | Scalar → Scalar GroupedScalar | Scalar → Scalar GroupedVector | Scalar → Scalar ``` Format pattern semantic, see [Java's DecimalFormat](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/text/DecimalFormat.html) *** ### Time | Text ```java Scalar | Scalar → Scalar Vector | Scalar → Scalar GroupedScalar | Scalar → Scalar GroupedVector | Scalar → Scalar ``` Format pattern semantic, see [Java's SimpleDateFormat](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/text/SimpleDateFormat.html) *** ### Timespan | Text ```java Scalar | Scalar → Scalar Vector | Scalar → Scalar GroupedScalar | Scalar → Scalar GroupedVector | Scalar → Scalar ``` Format pattern semantic, see [Java's SimpleDateFormat](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/text/SimpleDateFormat.html) *** ### Timespan | '(ADAPTIVE|SECONDS|MINUTES|HOURS|DAYS):(WORD|SYMBOL)' ```java Scalar | '(ADAPTIVE|SECONDS|MINUTES|HOURS|DAYS):(WORD|SYMBOL)' → Scalar Vector | '(ADAPTIVE|SECONDS|MINUTES|HOURS|DAYS):(WORD|SYMBOL)' → Scalar GroupedScalar | '(ADAPTIVE|SECONDS|MINUTES|HOURS|DAYS):(WORD|SYMBOL)' → Scalar GroupedVector | '(ADAPTIVE|SECONDS|MINUTES|HOURS|DAYS):(WORD|SYMBOL)' → Scalar ``` Format pattern semantic

Value	Description
ADAPATIVE	Means that it chooses the time unit automatically depending on the value size
SECONDS	Redners the value in seconds.
MINUTES	Renders the value in minutes.
HOURS	Renders the value in hours.
DAYS	Renders the value days.
WORD	Is in the word form (e.g. Hours)
SYMBOL	Is in the abbreviation of the unit (e.g. h)

### Examples Format the Result of the AVG($Consumption) function (which is a Scalar\

AVG($Consumption) | '#.##0'

Format the Timestamp of the $Event (which is Scalar\) as hours and minutes. ```java $Event::Timestamp | 'HH:mm' ``` Fromat the resulting Timestamp as Hours suffixed with the word Hours. ```java (now - $Event::Timestamp) | 'HOURS:WORD' ``` --- # 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://doc.moost.io/platform-manual/rules/rule-language/operations/format.md?ask=&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.