Pipes
2025.9 Pipes
2025.9 Pipes
  • Introduction
  • Configuration
  • Valves
    • API
      • HTTP Response Format Valve
    • Azure
      • Get User
      • Get User Role
      • Is User in Group
    • BankID
      • BidOperation
      • BidToItems
    • Cef event
    • Codecs
      • Base64 Encode
      • Base64 Decode
      • Base64 Converter
    • DateTime
      • Instant Generator
      • Instant Transformer
      • MS Date to Instant Transformer
      • Instant to MS Date Transformer
    • Debug
      • Dump Exports
      • Dump Request
      • Dump Session
      • Dump State
      • Wait
    • Delivery
      • Clean Mobile Valve
      • SMS Valve
      • Voice Valve
      • SMTP Valve
    • EntraID
      • Users
        • Create User
        • Update User
        • Delete User
        • Get User
        • List Users
        • Get Groups
        • List Groups
        • List Direct Reports
        • List Owned Objects
        • Reset Password
      • Groups
        • Create Group
        • Update Group
        • Delete Group
        • List Groups
        • Add Group To Users
        • Remove Group From Users
        • Add User To Groups
        • Remove User From Groups
        • Add Group Owner
        • Remove Group Owner
      • Directory
        • Restore Deleted Item
    • Exports
      • Exports Put
      • Exports Remove
    • Flow
      • Flow Fail
      • Flow State Add
      • Assert Value
      • Pipe Exec
      • Pipe Call
    • Freja
    • HTTP
      • GET
      • PUT
      • POST
      • DELETE
    • Item
      • Item Create
      • Item Merge
      • Item Match Merge
      • Item Remove
      • Items Remove
      • Item Property Add
      • Item Property Copy
      • Item Property Replace
      • Item Property Split
      • Item Property Rename
      • Item Property Hash
      • Item Property Token Replace
      • MV Property To Items
      • JSON To Items
      • MV Property Join
    • JDBC Query
    • JSON
      • JsonObjectCreate
    • JWT
      • CreateJwt
      • ParseJwt
    • LDAP
      • LDAP Search
      • LDAP Group Filter
      • LDAP Bind
      • LDAP Add
      • LDAP Delete
      • LDAP Modify
      • LDAP Move
      • DN Parse
    • Microsoft AD
      • Add Member To Groups
      • Remove Member From Groups
      • Add Group To Members
      • Remove Group From Members
      • GUID to string
    • Misc
      • Basic Auth
    • OTP
      • OTP Generation
      • OTP Validation
    • PKI
      • X509 Certificate Extractor
      • X509 Certificate Validator
      • Passcode Generator
    • PDF
      • Html2Pdf
      • PDFMerge
    • Request
      • RequestParameterExist
      • RequestParameterRename
    • ScriptEval
    • MobilSITHS
    • Session
      • Session Put
      • Session Create
      • CopyFromSession
    • Tokens
      • Token Authentication
    • WorkOrders
      • WorkOrderCreate
Powered by GitBook
On this page
  • Introduction
  • Common configuration
  • Iteration
  1. Valves

Item

The Flow Items valves

Introduction

The Flow Items API defines how to create, remove and iterate over uniquely identified objects stored in the currently executing Flow's state called items.

Valves that support item iteration is executed on each item surviving item filtering.

Common configuration

These configuration properties applies to all valves that support item iteration

Name
Description

item_include_expr

{
    "name":"ItemPropertyAdd",
    "config": {
        "item_include_expr":"item.id.startsWith('tmp_')",
        "name":"mv_pipe_exec",
        "value":"${utils.now}"
    }
}

Iteration

To control which items that are included in iteration you can enable item filtering. Filtering is based on a predicate expression (a boolean expression that returns true or false) deciding if the current item should be included or not.

The actual filter is an ECMA-script (JavaScript) that MUST evaluate to true, false or a function returning true or false.

// Skip all items
"item_include_expr": "false"

// Include items with property "mobile"
"item_include_expr": "item.mobile != null"

During expression evaluation data is made available in scopes. A scope is a map (i.e key-values or hash) where values are accessed using a name and plain dot notation.

// Get id of current item
item.id

// Get first value of item property displayName 
// Note: item properties are multivalue
item.displayname[0]

// or
item.displayname

// Get id of current session
session.id

// Get first value of multivalue "roles" stored in session
session.roles[0]

// Get value "otp" from state set by previous valve
state.otp

The following scopes are available:

Name
Description

item

The current item. All item properties are multi-value except for id.

session

The current session

state

The current (pipe) state

request

The current (pipe) request

exports

AuthN exports

items

List of all items

PreviousDELETENextItem Create

Predicate expression for controlling if an item should be included in ("item filtering").

iteration