VQL Mode

{   "filter": {
        "actor.name": {"$ne": "Rob C"}},
    "process": []}

How to Append Data

{   "filter": {},
    "process": [{
        "$addFields": {
            "context.extensions.http://myExtension*`*com": "Some Value"}}]}

How to Anonymize Actor Data

{   "filter": {},
    "process": [{
        "$addFields": {
            "actor": {
                "account": {
                    "homePage":"http://anonymous.com",
                    "name": {"$hash": "$actor"}}}}}]}

How to Conditionally Alter Data

{   "filter": {},
    "process": [{
        "$addFields": {
            "actor": {
                "$switch": {
                    "branches": [{
                        "case": {"$eq": ["$actor.name", "Rob C"]},
                        "then": {
                            "account": {
                                "homePage": "http://anonymous.com",
                                "name": {"$hash": "$actor"}}}}],
                    "default": "$actor"}}}}]}

When You Can Use Saved Scripts

Statement Forwarding

1. In the left menu, click Management > Statement Forwarding.
   
2. Click the Create Forwarding Rule button.
   
3. In the Create a New Upstream LRS dialog, select or enter all the needed information.
   
4. At the bottom, in the Transform Script pull-down menu, select the saved script you want to use.
   
5. Click the Create Upstream LRS button.
   

Access Key Write/Read

1. In the left menu, click Management > Access Keys.
   
2. To use a script in an existing key, click the More button () in the lower-left of the card.
   
3. In the Edit Access Key dialog, make any other changes as needed.
   
4. At the bottom, in the Write Transform Script or Read Transform Script pull-down menu, select the saved script you want to use.
   
5. Click the Save button.
   

JavaScript Mode (Deprecated)

JavaScript Mode

Due to security considerations, JavaScript mode is no longer available.

Some logic can be difficult to express in VQL. You may write imperative JavaScript. JavaScript executed by our servers runs in a sandbox JavaScript interpreter. Because of this important security consideration, execution can have low performance. If performance is a concern, rewrite your logic in VQL. The JavaScript environment has no access to any global state, NPM modules, external scripts, HTTP, DOM or any other resources — it can only be used to express logic over strings, objects and numbers.

When writing JavaScript scripts, there are two special case variables to be aware of:

1. $input — this is the array of input statements
   
2. $output — this is the resulting array. You must populate this with an array value

We do expose a very limited set of functions to the interpreter for your convenance. You can use normal JavaScript language features like Math.random or Array.isArray

1. $hash — compute a hash from any JavaScript object
   
2. $uuid — generate a random UUID
   

The below example filters the data. When statements are received, if they are any actor.name ;other than Rob C, they will pass, either to the upstream, to the database (when attached to the "write" command on an access key), or the API results (when attached to "read"):

{
    let out = [];
    for(let i in $input)
    {
        if($input[i].actor.name !== "Rob C")
        {
            out.push($input[i])
        }
    }
    $output = out;
}

You can also append additional data. This adds an extension to all statements. Note that we must manually escape this extension name, and that for simplicity's sake, this example destroys the existing extensions.

{
    let out = [];
    for(let i in $input)
    {
        $input[i].context = {
            extensions: {
                "http://myExtension*`*com": "Some Value"
            }
        }
        out.push($input[i])
    }
    $output = out;
}

You can reference existing values and modify them with expressions. This script makes the actor anonymous in a deterministic way.

{
    let out = [];
    for(let i in $input)
    {
        $input[i].actor = {
           account: {
               homePage: "http://anonymous.com",
               name: $hash($input[i].actor)
           }
        }
        out.push($input[i])
    }
    $output = out;
}