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
  • Component Source Arguments
  • Directories
  • Templates
  1. Commands
  2. Arguments

Common Arguments

Common arguments which can be used with many commands.

Get supported arguments

If you are not sure which arguments are supported by a command, ask for help using the -? option: bc comp get -? lists all arguments supported by the "COMP GET" command, for example.

Component Source Arguments

For more details how these component parameters work see Component Resolution.

/ComponentId, /c

The component Id(s) for the current command.

To get the current version of a component, specify the component id only 53e9908b-8c82-4b64-...

If you want to retrieve a specific version you must add the ~<VersionNo>, for example: 53e9908b-8c82-4b64~12 to get version 12 of that component.

Allow Multi

/Set, /s

The Set Argument in Detail

/QueryFilter, /q

Specify a file (relative to the current Workspace) that contains a Boomi Query Filter -> Query Filter

/ExcludePath, /x

Exclude one or more folder paths from querying components. If a component is located in any folder that starts with an exlusion tag, this component is excluded.

bc comp get /c e4bc4a53-... /ExcludePath=Temp;Sandbox

Allow Multi

Directories

/outDir, o

Specify an absolute or workspace relative path where all outputs go to.

Default: ./Out or the the name of a package, if specified. Package output is stored in the package folder.

Target Path Resolution

Templates

/TemplateDir, /td

A directory relative to the current workspace where BoomiConsole will look for workspace-specific, user-defined Freemarker templates. If provided, this directory has the highest priority when resolving templates.

  1. Application Templates Path [DEFAULT] %BIN_DIR%\Templates\Freemarker

Last updated 7 months ago