---
sourceDocument: Australia Build or modify applications
sourceDocumentLink: https://www.servicenow.com/docs/r/application-development

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Build or modify applications

ft:clusterId :

    - cadev

bundleId :

    - cadev

workflow :

    - Development, Data, and Analytics


---

# ServiceNow Fluent

# ServiceNow Fluent {#ariaid-title1}

* Release version: Australia
* 
* Updated March 12, 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read

Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of ServiceNow Fluent

ServiceNow Fluent is a declarative, domain-specific language (DSL) built on TypeScript designed to define application metadata files (sysmetadata) such as tables, roles, ACLs, business rules, and Automated Test Framework tests.
It enables developers to create and modify application metadata efficiently using code instead of traditional form or UI builder tools.
This approach integrates seamlessly with applications developed or converted using the ServiceNow IDE or SDK.
Show full answer Show less  
ServiceNow Fluent supports two-way synchronization, allowing metadata changes made in the ServiceNow AI Platform interfaces to be reflected in source code and vice versa, ensuring consistency across the instance.

## Key Features

* **APIs for Metadata Types:** Provides dedicated APIs for various metadata, with the Record API available for those without specific APIs. A current list of supported APIs and examples is maintained in the Fluent API reference and the ServiceNow SDK GitHub repository.
* **Source Code Structure:** Metadata definitions are placed in `.now.ts` files using Fluent API objects and require imports from `@servicenow/sdk/core`. Server-side scripts can leverage JavaScript modules.
* **Metadata Types Not Supported:** Certain metadata like Metadata Snapshots and UX Assets remain as XML files and are not converted to Fluent code.
* **Code Directives:** Developers can control synchronization behavior using directives such as `@fluent-ignore`, `@fluent-disable-sync`, and `@fluent-disable-sync-for-file` to manage warnings, errors, and syncing at granular or file-level scope.

## Practical Application

Developers define metadata declaratively in code, for example:

* Creating tables with columns and choice fields
* Defining client scripts that execute on record load
* Creating business rules that run server-side logic on record updates

This code compiles into the standard application metadata files on the ServiceNow instance, enabling automated, consistent, and version-controlled application development.

## Getting Started and Resources

To begin using ServiceNow Fluent, customers should leverage the ServiceNow IDE or SDK, which supports Fluent development workflows. The Fluent API reference and SDK GitHub examples provide detailed guidance and up-to-date API information.

This approach streamlines metadata management for ServiceNow applications, boosts development efficiency, and maintains synchronization between source code and instance metadata.  
Define application metadata in source code using the ServiceNow Fluent domain-specific programming language.

## Overview of ServiceNow Fluent {#servicenow-fluent__section_jnb_vvg_z1c}

ServiceNow Fluent is a declarative, domain-specific language (DSL) based on TypeScript for defining the metadata files \[sys_metadata\] that make up applications and includes APIs for the different types of
metadata, such as tables, roles, ACLs, business rules, and Automated Test Framework tests.

Developers define this metadata in a few lines of code instead of through a form or builder tool user interface. Applications created or converted with the ServiceNow IDE or ServiceNow SDK support development in ServiceNow Fluent.

ServiceNow Fluent supports two-way synchronization, which allows changes to metadata to be synced from other ServiceNow AI Platform user interfaces into source code and changes to source code to be synced back to metadata across the instance.

To get started using the ServiceNow IDE or ServiceNow SDK, see the [ServiceNow IDE](https://www.servicenow.com/docs/eMYyriIe_g3dvPLBokdLyg "Create and develop applications in source code in an integrated development environment (IDE) on the ServiceNow AI Platform to improve collaboration across development teams and accelerate application development.") or [ServiceNow SDK](https://www.servicenow.com/docs/~gZiLOf42HSLacfuqryftg "Create and develop applications in source code locally in Visual Studio Code Desktop and upload changes to an instance using the ServiceNow software development kit (SDK).") documentation.

## ServiceNow Fluent APIs {#servicenow-fluent__section_nyj_y13_zbc}

ServiceNow Fluent includes APIs for many types of metadata. You can use the Record API to define application metadata that doesn't have a dedicated API. For the latest list of supported APIs and examples, see the [ServiceNow Fluent API reference](https://servicenow.github.io/sdk/) and [ServiceNow SDK examples repository](https://github.com/ServiceNow/sdk-examples) on GitHub.  
Note:  
A limited number of metadata types, such as Metadata Snapshots \[sys_metadata_link\] and UX Assets \[sys_ux_lib_asset\], can't be represented as ServiceNow Fluent code and aren't transformed. These metadata types remain as metadata XML files in the metadata directory of your application.

## ServiceNow Fluent usage {#servicenow-fluent__section_dgj_1b3_zbc}

In files with the .now.ts extension, use objects in the ServiceNow Fluent APIs to define metadata in the application. You must also include the required imports for the APIs from @servicenow/sdk/core. For objects with server-side scripts, such as the
BusinessRule object, you can import and use code from JavaScript modules.  
The following example includes the definitions of a table, client script, and business rule in the application. The client script uses a script from the client-script.js file. The business rule uses a function from the script.js JavaScript module.

    import '@servicenow/sdk/global'
    import { BusinessRule, ClientScript, DateColumn, StringColumn, Table } from '@servicenow/sdk/core'
    import { showStateUpdate } from '../server/script.js'

    //creates todo table, with three columns (deadline, status and task)
    export const x_snc_example_to_do = Table({
        name: 'x_snc_example_to_do',
        schema: {
            deadline: DateColumn({ label: 'Deadline' }),
            state: StringColumn({
                label: 'State',
                choices: {
                    ready: { label: 'Ready' },
                    completed: { label: 'Completed' },
                    inProgress: { label: 'In Progress' },
                },
            }),
            task: StringColumn({ label: 'Task', maxLength: 120 }),
        },
    })

    //creates a client script that pops up 'Table loaded successfully!!' message everytime todo record is loaded
    ClientScript({
        $id: Now.ID['cs0'],
        name: 'my_client_script',
        table: 'x_snc_example_to_do',
        active: true,
        appliesExtended: false,
        global: true,
        uiType: 'all',
        description: 'Custom client script generated by Now SDK',
        isolateScript: false,
        type: 'onLoad',
        script: Now.include('../client/client-script.js'),
    })

    //creates a business rule that pops up state change message whenever a todo record is updated
    BusinessRule({
        $id: Now.ID['br0'],
        action: ['update'],
        table: 'x_snc_example_to_do',
        script: showStateUpdate,
        name: 'LogStateChange',
        order: 100,
        when: 'after',
        active: true,
    })

The client script referenced from the ClientScript object:

    function onLoad() {
        g_form.addInfoMessage("Table loaded successfully!!")
    }

The JavaScript module referenced from the BusinessRule object:

    import { gs } from '@servicenow/glide'

    export function showStateUpdate(current, previous) { 
        const currentState = current.getValue('state')
        const previousState = previous.getValue('state')

        gs.addInfoMessage(`state updated from "${previousState}" to "${currentState}"`)
    }

After building the application, this source code generates the following application metadata files on the instance.
Figure 1. Application metadata generated from ServiceNow Fluent code  
Tip:  
You can use the following directives in a code comment to help manage your code:

* `@fluent-ignore`: Suppresses ServiceNow Fluent diagnostic warnings and errors in the following line of code.
* `@fluent-disable-sync`: Turns off syncing changes to a ServiceNow Fluent object. Use before a call expression (for example, `Record({ ... })`) to turn off syncing for that object and its child objects. Only use this directive if you want to ignore changes made outside of the source code to the object and never update it when syncing.
* `@fluent-disable-sync-for-file`: Turns off syncing changes to a ServiceNow Fluent file (.now.ts). Use in the first line of the file to turn off syncing for all code in the file. Only use this directive if you want to ignore changes made outside of the source code to the file and never update it when syncing.
{#servicenow-fluent__ul_dzm_xxw_ldc}
**Related tasks**   

* [Define application metadata in code with ServiceNow Fluent in the ServiceNow IDE](https://www.servicenow.com/docs/FafEkbbMzoRh6GCgC9gGQA "Define application metadata in code with ServiceNow Fluent in the ServiceNow IDE.")
* [Define application metadata in code with ServiceNow Fluent and the ServiceNow SDK](https://www.servicenow.com/docs/Btihta6wS1RTnOd_FVd69Q "Define application metadata in code with ServiceNow Fluent and the ServiceNow SDK.")  
**Related reference**   

* [ServiceNow Fluent API reference](https://www.servicenow.com/docs/fmk8mIvf1GXcsGx7sIjD9w "Use ServiceNow Fluent APIs to define the metadata that makes up scoped applications in source code with the ServiceNow IDE or ServiceNow SDK.")

