The MSPro Boomi Collection
Boomi Console
HomeScriptEase For BoomiBoomi Console
Boomi Console
HomeScriptEase For BoomiBoomi 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
  • 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

Last updated 2 months ago

Create documentation for the specified components.

Documenting a single Component

The simplest form of creating documentation is to document a single component. The documentation is created in the Markdown format and stored in the Out/Doc folder.

You can preview Markdown documents directly in Visual Studio Code:

Documenting a Packaged Component

By using the or arguments you can quickly document a packaged component. This will also create a nice readMe file for the package content.

  • Documenting a single Component
  • Documenting a Packaged Component
  1. Commands
  2. COMP - Components

DOC

Create Markdown documentation and process UML diagrams

bc create doc {Source}
bc COMP DOC /c {yourComponentId}
COMP DOC Arguments
#packageversion-pv
#packageid-p
609KB
processDoc.pdf
pdf
An PDF example containing a process documentation (printed Markdown)
.\doc\_packageVersions\2024-07-23-msc.01m.md