To control the custom user audit function. The supported types are:

• count:  Increments the string key value with 1

audit.count(key);

• sum: Sums up the total amount

audit.sum(key,value);

• set: Sets an input value. Data entry using the set function can be used with any data type. The output of the sum function will show the accumulated amount. 

audit.set(key,value);

An object that contains logging functionality for the severity levels: info, warning, and error.

log.info("foo"); - Logs something to the log. See Logs.

payload

meta

The meta variable provides generic information (metadata) about a payload (record). Metadata is data that provide information about other data. Metadata summarises basic information about data, thereby making finding and working with particular instances of data easier.

Refer to Amazon S3 to know about metadata that is accessible from the Transform tab :

The following metadata is accessible using the Script Flush tab:

• lastCall: A boolean flag set to true for the final transaction. lastCall can be used to create a summary or audit for the processed data at the final transaction.
  
  To initiate action(s) triggered by the recent transaction:
  

  Code Block
  if (meta.lastCall)  { <action(s) needed> }

  
  

To send data downstream. You need to invoke this Function using await syntax.

To send data to the next Function(s) in the stream.

This is to keep the state across records. The state is only available during one stream execution. The information stored in the state variable is not persisted between executions and is cleared at the end of each stream execution.

The state variable contains two scopes:

• node: To save the state locally for this Function. 
  
• stream:  To save the state globally for the stream. 

These three operations functions as a key-value store. The key must be a string. Value can be of any type, for example: string, number, date, JSON object, and array.

You need to invoke this Function using await syntax:

• get: To get a value

• set: To set a value of a key 
  

  Code Block
  title Syntax
  await store.set("<key>", <value>);

  
  And, to set the duration (in seconds) of how long the key is stored.
  

  Code Block
  title Syntax
  await store.set("<key>", <value>,{ttl:<storage duration in number of seconds>});

  
  
  

  Excerpt
  Note title Note!  Sets the value for a key for the defined duration. The ttl parameter is optional and the default value is 30 days, that is, 2 592 000 seconds. A key can be stored for a maximum of 60 days (5 184 000 seconds), however, this duration gets extended every time store.set is called within these 60 days.

  
  

• del: To delete a value

  Code Block
  title Syntax
  await store.del(<key>)

  
  

With shared persistent storage, streams can access the same data. For example, one stream writes data to the shared persistent storage that can be used by one or more streams. The key must be a string. Value can be of any type, for example, string, number, date, JSON object, and array.

You must use the await syntax for the Function:

• sharedStore.get: To get a value.
  

  Code Block
  title Syntax
  await sharedStore.get("<key>");

  
  

• sharedStore.set: To set a value of a key and the duration (in seconds) of how long the key is stored. 
  
  

  Code Block
  title Syntax
  await sharedStore.set("<key>", <value>);

  
  And, to set the duration (in seconds) of how long the key is stored.
  

  Code Block
  title Syntax
  await sharedStore.set("<key>", <value>,{ttl:<storage duration in number of seconds>});

  Insert excerpt
  Script Script nopanel true

  
  
  

• sharedStore.del: To delete a value.
  
  

  Code Block
  title Syntax
  await sharedStore.del("<key>");