Main Window
Linked Pages | Allows you to link documentation pages to your Integration components. I can assure you that this is the feature for documenting your components that you’ve always been looking for! | /files/w7V3JJpYm1yf8uBlCzlK | /pages/tDOEl2YFA3X15qRONA0Z |
Deploy Assist | Simplifies component deployment and provides an overview of all independent references and their versions on the target system. | /files/wnPgez4igrO9ltptTbeg | /pages/sG8nHu3BLmCoGPoA9d3B |
Dependency View | Shows the dependencies of your components: parent components, as well as dependent and independent child components. It also shows you, which folders these components are located in. An indispensable tool for keeping track of the references. | /files/XADtRkMgHMiGsajRRm1I | /pages/pTq4wvOL6535wLPgZ6c3 |
Smart Copy | This is the smart component copying feature you need. It’s not about copying without any dependent components, nor is it about copying with all dependent components: It’s about copying those components you actually need! | /files/StCkKRWSJ6g5dsmbNLgp | /pages/A5E3sk9AN6cUuzQvyunY |
Document | HTML documentation can be generated for selected component types. | /files/BJNHP6R8urkShc4bSBrA | /pages/lGUqIdnwou5c9l5tL49p |
A ticket as the source of all activities.
Invoice Read implementation started
From the ticket we create a new link to the current component.
Open linked-pages from the Boomi component.
Open the Boomi process from the ticket.
An example process
Documentation in Confluence
Form the documentation page, linke it to the current component.
Copy Hyperlink
Quickly navigate to parent components
This use case occurs, for example, when you **change a web service endpoint**. In this case, you must deploy the endpoint service together with the API component. If an **independent subprocess changes**, the route component and the calling processes may need to be redeployed. #### How do Power-Tools for Boomi Integration help?You current process
Open the documentation
Open you linked page from the component.
Process documentation on Confluence
Link this (Confluence) page to the current component
Two pages linke to your current component.
Oview Page
Doc 01 - Update and Create process and the folders where the referenced components are
A process with a local mapping and profiles, and a shared referenced sub-process and connector.
| Child Name | Type | Folder |
|---|---|---|
| j.FirstLast | profile.json | /#Examples/90 - ScriptEase/Documentation/02 - MapScriptSimple |
| j.FirstLastFull | profile.json | /#Examples/90 - ScriptEase/Documentation/02 - MapScriptSimple |
| msgSimple | script.mapping | /#Examples/90 - ScriptEase/Documentation/02 - MapScriptSimple |
Boomi API User and Token
Team Sync Settings
Confluence special handling
Invalid ComponentId
I have seen the follwong message in two cases. > Error:IDTest is not a component. It is a DataHub Model!
1 Open the documentation page - 2 open the Component - 3 Link-Page
Open a linked-page from Boomi's Process Designer
IntelliJ - Editing with syntax highlighting & code-completion, debugging and unit testing
Several unit tests ensure the function of the script at all times
ChatGPT generated
Local Atom
The local Atom is required on your machine because we must reference the Atom binaries (Boomi’s Java libraries) and the bundled Java Run-Time (JRE). Atom installation typically takes \~5 minutes. A good Internet connection is and **Admin Rights** are required. [Install a local Atom](/boomi-scriptease/pre-requisites-7deb11c4cf894c33b76456ab85cad596/install-a-local-atom) There is no need to start the ATOM, and you may disable the Windows Service.Groovy 2.4.13 SDK
Boomi Integration uses **Groovy v2.4.13** to run Groovy scripts. I recommend using this version 13 because you will want to test and debug your scripts with the same run-time that the Atom uses. (Groovy v1.5 is not supportet!) * Download [Groovy **SDK v2.4.13**](https://archive.apache.org/dist/groovy/2.4.13/distribution/apache-groovy-sdk-2.4.13.zip) * Unzip into any directory you want. * I prefer using: **`%UserProfile%\.groovy\sdk\groovy-2.4.13`** {% code title="Using a Terminal Window" lineNumbers="true" %} ```batch md %UserProfile%\.groovy\sdk ``` {% endcode %} **Note** There are [newer version of Groovy Script](https://groovy.apache.org/download.html), there are other 2.x versions and there are older versions, like v1.5. Do not download or install any of them! Boomi Integration uses **Groovy Script `v2.4.13`** and that is the only version we want!JetBrains IntelliJ IDEA - Groovy IDE
*ScriptEase* uses [**JetBrains IntelliJ IDEA**](https://www.jetbrains.com/idea/download/)**.** While I recommend using the Ultimate Edition for professional use, the Community Edition is good enough to get started.Download Atom Installer
You will need the installation token later
Setup -Atom
Chose destination
Services: LocalAtom settings
Service Start Type = Manual (manuell=German)
BoomiScripts folder populated with the unzipped project template.
Open MyScripts with IntelliJ
Open Module Settings
Platform Settings in IntelliJ
| Name | Library Path |
|---|---|
| ATOMSphere Libs | C:\Program Files\Boomi AtomSphere\LocalAtom\lib |
| Groovy SDK | %UserProfile%\.groovy\sdk\groovy-2.4.13\lib |
Global Libraries configured
ATOM JDK selected
Validate Project Settings
Hello World with active Breakpoint
Run Test
Debugger Window: Code execution stopped at breakpoint
IntelliJ on halt - breakpoint hit
Script output
Debugger Execution Controls
Map Script in Boomi
Process Script Test and Script Context
Copy & Paste documents from a test execution.
Four files containing test data
pasted from a Boomi execution.
Reading test data from file.
Test data full-path.
Generic Disk v2 operation
Directory: Fix project path + relative testData directory for this process.
Use DDP_FileFilter in the operation's parameters.
Process execution with the same four files from local disk.
create a new package
Boomi Integration - Process Script with Null functionality
psgNull pasted into IntelliJ, with warnings
Null script with breakpoint
Create a test from a template: the test needs the name of the script.
Haltet script
The Use-Case
We have any number of incoming JSON documents of the following profile (type): ```json { "articleNo" : "string", "price" : 1.23 } ``` There can be more than one document referring to the same article number but a different price. All documents should be consolidated into one outbound document containing an array of unique articles as follows: ```json [ { "articleNo" : "...", "maxPrice" : 1.23, "minPrice" : 0.98, "priceCount" : 2, "prices" : [ 0.98, 1.23 ] } ] ```Example Documents
Four documents referring to two different articles **Document 1** ```json { "articleNo" : "a001", "price" : 1.23 } ``` **Document 2** ```json { "articleNo" : "a002", "price" : 2.00 } ``` **Document 3** ```json { "articleNo" : "a001", "price" : 1.05 } ``` **Document 4** ```json { "articleNo" : "a001", "price" : 0.98 } ```Expected Result
```json [ { "articleNo" : "a001", "maxPrice" : 1.23, "minPrice" : 0.98, "priceCount" : 3, "prices" : [ 1.23, 1.05, 0.98 ] }, { "articleNo" : "a002", "maxPrice" : 2.00, "minPrice" : 2.00, "priceCount" : 1, "prices" : [ 2 ] } ] ```Script setup
Create a folder (aka Package) called ***AggregatePrices***The documents passed to the script are defined in the Test class
The Script Header
```groovy /* ************************************************************************** Aggregate prices on JSON documents. IN : JSON documents of profile j.Price { "articleNo" : "a001", "price" : 1.23 } OUT: JSON documents of profile j.Prices (plural=array) [ { "articleNo" : "a001", "maxPrice" : 1.23, "minPrice" : 0.98, "priceCount" : 3, "prices" : [ 1.23, 1.05, 0.98 ] },{ "articleNo" : "a002", "maxPrice" : 2.00, "minPrice" : 2.00, "priceCount" : 1, "prices" : [ 2 ] } ] ------------------------------------------------ 13.06.2024 mspro - Created ************************************************************************** */ ```JsonSlurper instance
IntelliJ adding Imports
Prepare to debug the script
Debugging the script
Test your Script in Boomi AtomSphere
\ You can copy and paste the script code into the `psgAggregatePrices`script componentVariables
The Test Class output
Script Code in Boomi
q.e.d.
Add input Documents from code (inline)
Use the `Document.`**`fromText`**`()` factory method to add any number of documents to the `ProcessScriptContext.inputDocuments` list. ```groovy ProcessScriptContext context = new ProcessScriptContext( inputDocuments: [ Document.fromText('{ "firstname" : "Walter", "lastname" : "Schmidt" }'), Document.fromText( JsonOutput.toJson( [ firstname : "John", lastname : "Doe" ])), Document.fromText(''' { "firstname" : "Walter Jr.", "lastname" : "Miller" }'''), // Groovy multi-line text support ]) _testScript.run(context) ```Add input Documents from file
Use a `TestFilesHelper _testFiles` instance to support access to files in a specified sub-directory.final TestFilesHelper _testFiles = new TestFilesHelper( "testData", _sourceUri)
ProcessScriptContext context = new ProcessScriptContext(
inputDocuments: [
Document.fromFile( _testFiles.get( "doc01.json")),
Document.fromFile( _testFiles.get( "doc01.json"))
])
_testScript.run(context)
Mixed input documents
You can mix `fromText` and `fromFile` as you want. The input documents do not care where they are coming from. ```groovy ProcessScriptContext context = new ProcessScriptContext( inputDocuments: [ Document.fromFile( _testFiles.get( "doc01.json")), Document.fromText( '{ "firstname" : "Walter", "lastname" : "Schmidt" }') ]) ```Add input Documents with Dynamic Document Properties
Use the `Document.fromText()` factory method to add any number of documents to the `ProcessScriptContext.inputDocuments` list. Dynamic Dcoument Properties are represented as [Groovy Map](https://www.tutorialspoint.com/groovy/groovy_maps.htm), which is a `key : value` list. ```groovy // Add three documents with DDP_Prop1 and DDP_Prop02 each ProcessScriptContext context = new ProcessScriptContext( inputDocuments: [ Document.fromText('Doc Content01', [ DDP_Prop01: "Doc1_Value1", DDP_Prop02: "Doc1_P2" ]), Document.fromText('Doc Content02', [ DDP_Prop01: "Doc2_Value1", DDP_Prop02: "Doc2_P2" ]), Document.fromText('Doc Content03', [ DPP_Prop01: "Doc3_Value1", DPP_Prop02: "Doc3_P2" ]) ]) _testScript.run(context) ```Standard
```groovy ProcessScriptContext context = new ProcessScriptContext( inputDocuments: [ ... ], dynProcPros: [ DPP_DynProcProp01 : 1, DPP_DynProcProp02 : "Value01" ] ) _testScript.run(context) ```Explicit assignment to the script context
```groovy ProcessScriptContext context = new ProcessScriptContext() context.dynProcPros.DPP_ProcPropString = "My Process Property" context.dynProcPros.DPP_IntValue = 0 context.inputDocuments = [ Document.fromText('abc') ] _testScript.run(context) ```Process Property Ids
Standard Initialization
```groovy final String ppMessageContext = "b91d87a4-7e8b-4a98-8ea8-a85e32bb5677" final String ppKeyServiceIncident = "fcc4749d-5135-4eaa-a9cf-1b2ddc1ad12" final String ppKeySenderAddress = "anotherGuid" // Wrap keys in parenthesis // so that the variables (Ids) are taken and not the text as a string ProcessScriptContext context = new ProcessScriptContext( inputDocuments: [Document.fromText("abc")], procPros: [ (ppMessageContext): [ (ppKeyServiceIncident): "Incident_01", (ppKeySenderAddress) : "mailto@google.com" ] ]) _testScript.run(context) ```The ScriptEase library
The **ScriptEase library** `scriptEaseLib-x.y.z.jar` provides the magic to edit, debug and test Boomi Process- and Map-Scripts on your local machine using JetBrains IntelliJ. If you have an **existing ScriptEase project on your local machine, to update** the library. {% hint style="success" %} ### Latest Version 1.3.4 - 2025-04-08 :dvd: [DOWNLOAD - Latest ScriptEaseLib](https://github.com/MarkusSchmidtPro/MSPro.Boomi.ScriptEase/tree/main/MyScripts/lib).jar * Licensing optimized * `ExecutionUtil` completely re-written to better emulate the Atom implementation. * Logging optimized {% endhint %}Version History
1.3.0 - 2025-03-22 * Licensing implemented (see [Licensing](/boomi-scriptease/licensing) ) 1.1.4 - 2025-02-06 * Fixed: `outputDocuments` are empty when more than one script is executed on the same test. #### 1.1.3 - 2024-12-10 * Logging `DefaultFormatter` no longer uses Thread, to support JDK 23 and JDK11. * `testFileHelper` supports `getText()` #### 1.1.1 - 2024-12-04 * Fixed compatibility issues when using logging with Java 11. * Fixed typos on property names * Changed some property names on `ExcutionContext`. #### 1.1.0 - 2024-12-03 **Please update to v1.1.1** * All `scriptEaseLib` classes use: `@CompileStatic` and `@TypeChecked` * `ProcessExecutionProperties` fixed * Better *typed*, library internal classes restricted to `@PackageScope` #### 1.0.2 - 2024-11-18 * Finally renamed to ***ScriptEase***. * MGF (Markus\`s Groovy Framework) became *ScriptEaseLib*\ to avoid any confusion with the PSO Boomi *Framework*. * **NEW** Licensing implemented * **FIX** No more *HashMap*, uses *Map* everywhere to improve compatibility with JavaPersonal Versions (pre-release)
#### 0.6.1 - 2024-08-22 * **FIX** *getStream( docNo=0) called more than once.* error when passing empty documents to the script. #### 0.6.0 - 2024-08-08 * **NEW** `Document.fromByteArray()` and `Document.fromStream()` added * **NEW** Text encoding added to `Document.from` functions so that it is no longer UTF-8! * **FIX** After calling `Document.toString()` the document was empty #### 0.5.0 - 2024-07-04 Major changes for MapScripts were required to correctly simulate a Map context and the lifetime of map script objects. As long as the MapScript ran on a single property, everything was fine. However, to support a MapScript running on an Array (for each single array element) the new updates were required. ~~`MapScriptContext`~~ was replaced by `ProcessContext` which can optionally be provided in the `MapScript` constructor. ```groovy OLD 0.4.x and earlier ---------- def scriptContext = new MapScriptContext([ a: 5, b: 7]) _testScript.run(scriptContext) NEW 0.5.x ---------- final MapScript _testScript = new MapScript("msg" + SCRIPT_NAME + ".groovy", _sourceUri, new ProcessContext()) void Test() { def variables = _testScript.run([a: 5, b: 7]) assert variables.total != null, "Script did not set 'total' as output parameter!" assert variables.total == (variables.a as int) + (variables.b as int), "Calculation result does not meet expectations!" } ``` ... continuous evolution ...Use IntelliJ Templates
Create a new Boomi Process Script based on a template
Create a new Test Class for MyFirstScript
Run or debug script
(Local) Atom Startup Properties
Using a different Java SDK
Process ScriptContext example
The following examples demonstrates how to setup all kind of properties and documents to run a process script. ```groovy ProcessScriptContext context = new ProcessScriptContext() // Initialize // * Execution context : executionContexts // * Dynamic Process Properties : dynProcPros // * Process Properties : procPros // * Documents : inputDocuments // incl. Dynamic Document Properties // -------------------------------------------------------------- // context.executionProperties.ACCOUNT_ID = "My Account ID" context.dynProcPros.DPP_ProcPropString = "My Process Property" context.dynProcPros.DPP_IntValue = 0 // region Process Property final String PROCESS_PROPERTY_COMPONENT_ID = "8fb41f63-a988-4778-8cc8-0144f30ace81" final String VAL1_ID = "eea9e988-cb14-4a84-ba37-ee455451a741" final String VAL2_ID = "2c68fb60-8431-46cc-9da9-cbe10d446a0e" // Wrap key in parenthesis so that the variables (Ids) are taken // and not the text as a string def procPropValue1 = 4711 def procPropValue2 = "Markus Schmidt" context.procPros = [ (PROCESS_PROPERTY_COMPONENT_ID): [ (VAL1_ID): procPropValue1, (VAL2_ID): procPropValue2 ]] // endregion // region Documents final String DDP_Name = "DDP_IntValue" int[] ddpValues = [ 10, 11, 12] context.inputDocuments = [ Document.fromText(''' { "firstname" : "Walter", "lastname" : "Schmidt" }''', [(DDP_Name): ddpValues[0]]), Document.fromFile( _testFiles.get( "demoDoc01.json") , [(DDP_Name): ddpValues[1]]), Document.fromFile( _testFiles.get( "demoDoc02.json") , [(DDP_Name): ddpValues[2]]) ] // endregion _testScript.run(context) ```Java SDKs in the project - found and added by IntelliJ
Searching for "java.exe" - using Everything
Nothing is listed under "Apps" (Windows)
rmdir /s /q "C:\Program Files\Amazon Corretto\jdk21.0.6_7\bin\"
rmdir /s /q "C:\Users\marku\.jdks\corretto-23.0.1\bin"
rmdir /s /q "C:\Users\marku\.jdks\corretto-23.0.2\bin"
rmdir /s /q "C:\Users\marku\.jdks\jbr-17.0.12\bin"
rmdir /s /q "C:\Users\marku\.jdks\openjdk-23.0.1\bin"
Gradle
Gradle is a Java build tool. You may have it or not but you may notice it is **even worse than Java:**.gradle Cache files
Gradle is downloading
Windows environment settings
Orphaned Java SDKs in IntelliJ
ClassNotFoundException - GroovyStarter
Remove Version Control Settings
BoomiConsole in Action
Windows Console (Terminal) runs BoomiConsole Command
Recommended directory to store the binaries: %UserProfile%\Documents\BoomiConsole\bin
Run-Once: Initial setup
Environment Variables
Running *install.bat* sets two environment variables which are used in later context: `BC_EXE` and `BC_DIR`. To check whether they are set properly, run **`set BC_DIR`** from any command prompt. ``` c:\> set BC_DIR BC_DIR=C:\Users\...\AppData\Local\Programs\BoomiConsole ``` Be aware, if you run *BoomiConsole.exe* once from a command prompt, you must **close and re-open the terminal** window, to activate the changes to the environment variables.Google Drive spoiler!
***DO NOT USE Google Drive***** ****to store your Workspace!** Google Drive is not really compatible with Windows File System, and I encountered serious and strange issues. For example: I tried to create a directory and I got the message "*already exists*" and when I tried to navigate to there the message was "c*annot find directory*": `md "g:\...\bc\Out"` -> A subdirectory or file *g:\\...\bc\Out* already exists.\ `cd "g:\...\bc\Out"` -> The system cannot find the path specified.The BoomiConsole Workspace, opened in Visual Studio Code
Get a Process ComponentId
Process Components in the Repository
Visual Studio Code shows Components rendered using /t compList.CSV
The RAW Groovy script as a file in the file-system.
.\doc\_packageVersions\2024-07-23-msc.01m.md
A Groovy Script in Visual Studio code, all Script on the local drive, respecting the folder structure in Boomi
/ComponentId, /c
Pull one or more specified component only./CodeDirectory, /wd /cd /d /out
Default: `Code` Specify the folder where to put the code. The directory is relative to the current Workspace, or absolute./Folders, /f /base
Specify one or more Boomi folder names - semicolon separated list, from where to pull the code. The folder comparison is: full folder path starts with "specified folder". If you specify `/f Com` a ***Com**mon* folder is considered as well as a **Com**pany folder. Subfolders are always included. The Full Folder Path is compared! If you have a folder, like: `script\98 - Sandbox` you should specify the path from the beginning `/f "script\98 - Sandbox"` - incl. quotes because of whitespaces.A Packaged Component's manifest as JSON
Packaged Component Documentation for package version 2024-10-14-msc.09
containing three packaged components
Deployments on Runtime
Deployment Overview for example: BC DEPLOY GET /c 54222e4e-e9c1 -t deployOverview.csv
Three (packaged) components in one deployment - with the same version number
Deployment History
Packaged Components
Two components in a Component Package, using Component Package deployments
/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 `~/Set, /s
[The Set Argument in Detail](/boomi-console/commands/arguments/common-arguments/components-set)/QueryFilter, /q
Specify a file (relative to the current Workspace) that contains a Boomi Query Filter -> [Query Filter](/boomi-console/commands/arguments/common-arguments/query-files)/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](/boomi-console/commands/arguments/common-arguments/allow-multi)/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](/boomi-console/help-text/target-path-resolution)/workDir, wd
Specify a workspace directory for the current execution. This directory is used a the base for `/OutDir`, `/LogDir` and `/DocDir`, which are all relative to current workDir./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. 2. Application Templates Path \[DEFAULT]\ `%BIN_DIR%\Templates\Freemarker`DEMO_Service Component Set documentation with readme.md in the out folder
/SetDir
Default = `Packages` The directory where to look for package files (e.g. iPack.jsonc). Unless you specify an absolute path, the directory is relative to /ProjectDir. The directory must exist, it is not created automatically!PackageLibDir
Default = `Lib`,`Lib\Shared,Work` Support Multiple Specify a list of relative search folders (relative to /PackageDir) where to look for packages. Use this to keep your packages in pre-defined folders. If you store, for example, you packages in the `Work`folder in the /PackageDir packages are resolved by their name: `/p FWK` (the folder name is enough because the package file has the default name: `iPack.jsonc`). query\DBProfiles - MetadatXML and the native DB profile: SQL Scripts