The MSPro Boomi Collection
About
Boomi Console
Boomi Console
  • Boomi Console
    • What is ...
  • Installation & Setup
    • Download & Install
    • Setup a Workspace
    • Connect your Workspace
    • Test your Workspace
  • Commands
    • COMP - Components
      • GET
      • DOC
    • PACK - Packaged Components
      • PACK GET
      • PACK DOC
    • DEPLOY - Deployments
      • GET - Deployments and Packages
      • EXEC - Deploy components
        • Deployment from Repos
        • Promotion to Env
      • DELETE - Undeploy Components
    • WORKSPACE CONNECT
    • ACCOUNT INFO
    • Arguments
      • Common Arguments
        • The Set Argument in Detail
        • Query Filter
          • Start date or time span
        • Arguments in a file
        • Allow Multi
        • Component Resolution
      • COMP Arguments
        • COMP GET Arguments
        • COMP DOC Arguments
      • PACK Arguments
      • DEPLOY Arguments
        • DEPLOY GET Arguments
        • DEPLOY EXEC Arguments
        • DEPLOY DELETE Arguments
  • Use-Cases
    • Analyze deployed components
    • Components in a Folder
    • Deploy Components
    • Reveal a Process
    • Reveal an API Component
    • Deployed Components Overview
    • Deployment Task Document
    • Create a cSet.jsonc file
  • Library
    • Component Set
      • The Components Set JsonC file
        • Create a package file
      • Set File resolution
    • The Report Engine
      • Render DataSets
        • DataSet Base
        • Component Metadata DataSet
          • Component Metadata Header
          • Component Metadata
          • CompDataSet With Counts
        • Deployed Packages DataSet
        • Package Content DataSet
        • Map Markdown Dataset
      • Components
        • Deployable Components
        • Orphaned Components
    • The Workspace
      • Manage your workspace
      • Components Set Workspace
      • Workspace folders
      • The project database
    • Configuration files
      • Application Settings
      • Workspace configuration file
      • boomiConsole.user.json
    • How to...
      • Use Excel to view CSV files
      • Local metadata and caching
      • Getting help
      • Environments
      • How to get a Component's Id
    • Referenced Pages
      • Lists
      • Documentation Snapshots
  • Download and Release History
  • Help Text
    • Documentation Links
    • Target Path Resolution
    • GitHub Emojis
    • Packaged Component and Versions
    • Components and Versions
    • Component Hierarchy
    • Referenced Components
Powered by GitBook
On this page
  • Query Filter File
  • Example
  1. Commands
  2. Arguments
  3. Common Arguments

Query Filter

Just another option to specify ComponentIds

Last updated 10 months ago

The /QueryFilter is just antoher option to for your commands. You can specify as the source for any command.

See also .

bc COMP GET -QueryFilter Query\qDBProfiles.json
{
  "QueryFilter": {
    "expression": {
      "operator": "and",
      "nestedExpression": [
        {
          "operator": "or",
          "nestedExpression": [
            { "property": "type",   "operator": "EQUALS",   "argument": [ "profile.db"   ] }
          ]
        },
        { "operator": "GREATER_THAN", "property": "modifiedDate",   "argument": ["{StartDateUtc}"]},
        { "operator": "EQUALS",       "property": "currentVersion", "argument": ["true" ]},
        { "operator": "EQUALS",       "property": "deleted",        "argument": ["false" ]}
      ]
    }}
}

Please notice, the QueryFilter functionality automatically handles the QueryToken so that the number of returned components is not limited to one page.

Query Filter File

Query Filters are specified as a JSON file. I recommend using the Query folder to store the queries there. I decided to use JSON over XML because it is much more readable. There is no option to provide XML queries.

Example

bc comp get /q query\qDBProfiles.json /outdir=query\DBProfiles

Specify /OutDir to redirect the output to the specified directory instead of writing it to the default Workspace\Out directory.

Once you have got the Metadata XML for profiles specified in the QueryFilter, you may want to see their natice specification:

bc create profile /outdir=query\DBProfiles

Boomi Console will run the query against the using ComponentMetadata/query. The returned components will be used as the input for your command. If you run COMP GET -QueryFilter <yourFilter>, for example, the query is executed and the returned list of components will then be retrieved from API.

specify component IDs
AtomSphere API Query Filters
Component Metadata Filter properties
Component Metadata API
query\DBProfiles - MetadatXML and the native DB profile: SQL Scripts