Migrating to iPool Suite

This page is for users moving from Apollo and iPool 26.x or earlier to iPool Suite 1.0.0. It explains how to bring your existing configuration, databases, bid files and batch files across so they work with the new engine.

Migration Guide (PDF)

Overview

Who needs this page

• You have a C:\IENERGY\Defaults.csv from an earlier iPool.
• You have Microsoft Access databases (.mdb), binary bid files (.bid) or dynamic bid rule files (.ibd).
• You run iPool from your own batch files (.bat), for example one that starts with call DefInit.bat.

If you are new to iPool and have none of these, you only need System Installation and Licensing.

What changed at a glance

Item	Apollo / iPool 26.x and earlier	iPool Suite 1.0.0
Programs	Apollo, plus iPool.exe (or a renamed copy such as iPool24.exe) and the bid tools iBidAgg, iYBidWESM, iBidEzy	One program, iPoolSuite.exe. The engine iPool.exe is in the same folder; the Bid Manager programs are in resources\engine
Install folder	C:\Program Files (x86)\iEnergy	%LOCALAPPDATA%\Programs\iPool (only for me) or C:\Program Files\iPool (all users), unless you chose another folder
Settings file	C:\IENERGY\Defaults.csv	Same file and place. Add DirSub; database names end in .db (Step 1)
Databases	Microsoft Access .mdb	SQLite .db (Step 2)
Bid files	Binary .bid	SQLite .bidx (Step 3)
Dynamic bid rules	Binary .ibd	SQLite .ibdx, or a CSV rules file (Step 3)
Batch files	Old program names, folders and file names	Converted automatically (Step 4)
Start-up batch file	DefInit.bat	Not used: Defaults.csv and the Directory Initializer do its job
History input files	Demand_, DemandHr_, MRGCFac_, MRHCFac_<ID>.csv	Dem_, DemHr_, Gen_, GenHr_<ID>.csv
Results	Many CSV files in the scenario folder	Results in the scenario's .isdb file plus the main CSV files

The four migration steps

1. Defaults.csv: add DirSub and change database names to .db.
2. Databases: convert .mdb to .db.
3. Bids: convert .bid to .bidx and .ibd to .ibdx.
4. Batch files: convert them with the batch file converter.

Do the steps in this order. Shortcut: the batch file converter in Step 4 can also convert the databases and bid files your batch files use, in one go. You then only need Steps 2 and 3 for files that no batch file uses.

Before You Start

• Back up your C:\IENERGY\Defaults.csv, your database folder, your bid files, your scenario folders and your batch files. All converters below write new files and leave the originals alone, but keep a copy anyway.
• Install iPool Suite 1.0.0 as described in System Installation and Licensing (Scenario B, new installation). You do not have to uninstall Apollo or the older iPool first; they can stay installed. The older iPool can still use its .mdb databases as long as its batch files start with call DefInit.bat: keep the .db and .mdb files side by side in the same DirDB folder so both versions can run, and keep a copy of your old C:\IENERGY\Defaults.csv.
• Note your install folder. The examples on this page use C:\Program Files\iPool, the folder for an all users installation. If you installed Only for me, iPool Suite is in C:\Users\<your name>\AppData\Local\Programs\iPool (in batch files: %LOCALAPPDATA%\Programs\iPool); use that path wherever the examples say C:\Program Files\iPool. AppData is hidden in File Explorer: type the path in the address bar, or right-click the iPool shortcut and choose Open file location.
• Start iPool Suite once and activate your license.

Carried over

• License: if Apollo was licensed on this computer and the license is still valid, iPool Suite finds it and does not ask again.
• Folder settings: iPool Suite reads the same C:\IENERGY\Defaults.csv.

Not carried over

Apollo's own settings (theme, layouts, recent folders) are not imported. Set them again in iPool Suite.

Step 1 — Update Defaults.csv (DirSub)

C:\IENERGY\Defaults.csv holds your folder and database settings, one Key,Value per line. iPool Suite, the engine and the Bid Manager programs all read it. If you used iPool before iPool Suite, your Defaults.csv cannot be used as it is. Check three things:

Add DirSub before you initialize

Defaults.csv files from before iPool Suite have no DirSub line. If you run the Directory Initializer over such a file as it is, iPool Suite will crash. Add the DirSub line first (below).

1. Add DirSub

Old Defaults.csv files often have no DirSub line — add one. DirSub is the bid submission folder: the folder where Bid Manager writes the bid file it makes. When the aggregator is run with -s NAME, the file is saved as <DirSub>\NAME.bidx. If DirSub is missing, DirBid is used instead. Set DirSub to the same folder as DirBid, so the bid files Bid Manager makes are where iPool looks for bid files.

2. Database names end in .db

PoolDB (system database) and TimeDB (time periods database) name files in DirDB. Change .mdb to .db once you have converted the databases (Step 2).

3. Folders for the Bid Manager generator

The Bid Manager generator (which replaces iYBidWESM) reads the market files from DirYBid (the RTDOE folder). Make sure it points to your WESM FILES\RTDOE folder.

Optional: Historical Store folder (DirHistStore)

You do not need to add this line. iPool Suite keeps its Historical Store (its historical data store and the historical scenarios exported from it) in C:\iEnergy\Historical Store. To use another folder, for example on a larger drive, choose it in iPool Suite under Settings → Historical Store → Change… rather than editing the file by hand. iPool Suite checks the folder (a folder on a local drive, not a network share; no comma or quote mark; at most 85 characters) and saves it in Defaults.csv as DirHistStore, so other iPool tools use the same place. The change takes effect after you restart iPool Suite. Your existing files are not moved: copy them to the new folder yourself before you restart. Reset to defaults in that section goes back to C:\iEnergy\Historical Store.

Example

Old (iPool 26.x)

DirDB,C:\IENERGY\WorkingFolder\Databases
DirBid,C:\IENERGY\WorkingFolder\Bids
DirEvt,C:\IENERGY\WorkingFolder\Events
...
PoolDB,SysWESM2603Z.mdb
TimeDB,TimePeriods.mdb

New (iPool Suite 1.0.0)

DirDB,C:\IENERGY\WorkingFolder\Databases
DirBid,C:\IENERGY\WorkingFolder\Bids
DirSub,C:\IENERGY\WorkingFolder\Bids
DirEvt,C:\IENERGY\WorkingFolder\Events
DirYBid,C:\IENERGY\WESM FILES\RTDOE
...
PoolDB,SysWESM2603Z.db
TimeDB,TimePeriods.db

Two ways to make the change

• In a text editor: open C:\IENERGY\Defaults.csv (for example in Notepad), add the DirSub line, change the database names and save.
• In iPool Suite: Scenario Studio → Directory Initializer. Click Upload Defaults.csv to read your old file (add the DirSub line to it first), or type a Working Folder and click Apply: this sets both DirBid and DirSub to its Bids sub-folder. Then click Next: Database Initializer → to choose the databases.

Good to know

• Some engine options save themselves into Defaults.csv for later runs: -bdir sets both DirBid and DirSub, and -ipdb / -tpdb set PoolDB / TimeDB.
• DatabaseType,MSAccess and MarketDataSource lines are left over from the old program. The new engine does not use them; they do no harm.

Step 2 — Convert Databases (.mdb → .db)

The iPool Suite engine reads only SQLite .db databases. It cannot open a Microsoft Access .mdb: a run that points to one stops with the message "a legacy .mdb cannot be opened by the headless engine".

Shortcut

If you convert a batch file with the tick box "Also convert the .bid and .mdb files it uses" ticked (Step 4), the databases and bid files that batch file names are converted for you, and you can skip this step for them.

Convert every database you use. They are usually:

Database	Typical name	Engine option
System	SysWESM….mdb	-ipdb (Defaults.csv PoolDB)
Time periods	TimePeriods.mdb	-tpdb (Defaults.csv TimeDB)
Bid	iBidWESM.mdb	-ibdb
Flow	iFloWESM.mdb	-ifdb
Scenario	iScen.mdb	-isdb

In iPool Suite

1. Open the Database Editor tab and click Convert Database.
2. Choose Single file, or Multiple files (Whole folder) to convert every .mdb in a folder at once.
3. Choose the Input and Output, then click Convert. Each output keeps the name and gets the .db extension, for example SysWESM2603Z.mdb → SysWESM2603Z.db.
4. Put the .db files in your database folder (DirDB).
5. In Scenario Studio → Directory Initializer → Next: Database Initializer, choose the new databases. This list shows only .db files.

An existing .db is replaced

If the output .db already exists, the converter replaces it. Choose a new output name or folder if you want to keep a .db you already have.

See also Convert Database.

From the command line

You can also convert databases from a batch file, without opening iPool Suite. A ^ at the end of a line continues the command on the next line.

REM CONVERT EXISTING MDB DATABASES TO DB
REM ==================================================================

REM One database: -o is the .mdb file. The .db is written next to it.
"C:\Program Files\iPool\iPoolSuite.exe" -updatedb -conv ^
  -o "C:\IENERGY\WESM2610\Databases\SysWESM2610.mdb"

REM Every .mdb in your database folder (DirDB in Defaults.csv): leave out -o.
"C:\Program Files\iPool\iPoolSuite.exe" -updatedb -conv

pause

Option	What it does
-updatedb -conv	Convert .mdb to .db. Both are needed, in this order.
-o <file.mdb>	Convert only this file. The .db gets the same name, in the same folder. Without -o, every .mdb in DirDB is converted (not its subfolders).

The .mdb files are kept. An existing .db of the same name is replaced. The result is shown in the window and saved in a log file: SysWESM2610.cli.log next to the database for one file, or conv-batch.cli.log in DirDB for a whole folder.

Step 3 — Convert Bid Files (.bid → .bidx, .ibd → .ibdx)

Shortcut

If you convert a batch file with the tick box "Also convert the .bid and .mdb files it uses" ticked (Step 4), the databases and bid files that batch file names are converted for you, and you can skip this step for them.

Bid files: .bid → .bidx

Old binary .bid files must be converted; renaming them is not enough. The engine refuses a binary bid file under either extension. A converted file is a SQLite .bidx with the same name, and your original .bid is kept.

In iPool Suite: open Bid Manager → Convert Legacy .bid. Choose Single file or Whole folder, choose the input and the output, and click Convert.

From the command line (a whole folder at once): use bidmanager-converter.exe in <iPool Suite folder>\resources\engine. A ready-made sample, resources\batch files\converter.bat, is installed with iPool Suite. Example:

REM CONVERT EXISTING BID FILES TO BIDX
set "PATH=C:\Program Files\iPool\resources\engine;%PATH%"

REM -all converts every old .bid file in the -in-dir folder
bidmanager-converter.exe -in-dir "C:\IENERGY\WESM2609\Bidsold" ^
  -out-dir "C:\IENERGY\WESM2609\Bids" -all ^
  -source-db "C:\IENERGY\WESM2609\Databases\SysWESM2609.db"
pause

Option	What it does
-in-dir <folder>	Folder with the old .bid files. Required.
-out-dir <folder>	Folder for the new .bidx files. Required, and the folder must already exist.
-all (or -file all)	Convert every .bid in -in-dir.
-file NAME.bid	Convert only this file. Repeat for more files.
-source-db <file.db>	Optional system database (.db) used for every file.
-market WESM|AEMO	Market of the bid files. Default WESM.

Change the folders and the database to your own. A .bidx of the same name in -out-dir is replaced.

Old names in batch files still work

When a command names X.bid, the engine looks for X.bidx first and then X.bid. If both exist, X.bidx is used. The batch file converter (Step 4) still changes the names to .bidx so your files and batch files agree.

Dynamic bid rules: .ibd → .ibdx

The engine's dynamic bidding option (-ib) reads .ibdx or CSV rule files. It does not read old .ibd files.

In iPool Suite:

1. Open Bid Manager → Convert Legacy .ibd.
2. Choose Single file or Folder (tick Include subfolders if it is shown and you need it).
3. Choose the Market (WESM or AEMO). Use the market of the system that made the files.
4. Check the Output folder. It defaults to your DirBid folder.
5. Click Convert and read the result for each file.

From the command line (a whole folder at once, without opening iPool Suite). Example:

REM CONVERT EXISTING IBD FILES TO IBDX
REM ==================================================================

REM -indir  folder with your .ibd files
REM -outdir folder to save your .ibdx files
"C:\Program Files\iPool\iPoolSuite.exe" -ibd2ibdx ^
  -indir "C:\IENERGY\WESM2610\Bids" ^
  -outdir "C:\IENERGY\WESM2610\Bids" -all -overwrite

pause

Option	What it does
-ibd2ibdx	Convert .ibd to .ibdx. Required, first.
-indir <folder>	Folder with the old .ibd files. Required.
-outdir <folder>	Folder for the new .ibdx files. Required; it is created if it does not exist. It can be the same folder as -indir.
-all	Convert every .ibd in -indir.
-file NAME.ibd	Convert only this file. Repeat for more files. Use either -all or -file, not both.
-overwrite	Replace an .ibdx that already exists. Without it, that file is skipped.
-market WESM|AEMO	Market of the rule files. Default WESM.

Each file is listed as OK, SKIP (already exists) or ERROR. The same list is saved in ibd2ibdx.log in the -outdir folder. The .ibd files are kept.

Step 4 — Convert Batch Files

Your old batch files name old programs, folders and file types. iPool Suite converts them for you. It saves a new file next to the old one; the old file is never changed.

Convert a batch file in 5 steps

1. Open the converter. In iPool Suite, go to Scenario Studio, click Load ▾ and choose Convert old batch file. Pick your old .bat file.
2. Check the tick box. The tick box "Also convert the .bid and .mdb files it uses" is ticked already. Keep it ticked: iPool Suite then also converts the databases (.mdb → .db) and bid files (.bid → .bidx) that the batch file uses, so you do not have to do Steps 2 and 3 for them by hand.
   Already did Steps 2 and 3? If you are sure all the databases and bid files this batch file uses are already converted, you do not need the tick box: untick it, and only the batch file is converted. (Leaving it ticked does no harm either: files that already exist are skipped and listed as Already exists.)
3. Look over the changes. The Changes tab lists what will change. The Side by side tab shows the old and new file next to each other. You do not have to change anything here.
4. Save. Click Save converted. (Or click Convert and load to also open the converted file in Scenario Studio.)
5. Check the result list. Each database and bid file is listed with what happened to it. Most say Converted or Already exists; both are fine. If one says Not found or Failed, convert that file yourself (Steps 2 and 3).

What you get

Next to RunHST.bat you now have RunHST_converted.bat (the new batch file) and RunHST_converted_report.txt (what was changed, and any lines you need to check yourself). Your original file is unchanged.

Before you run the converted file

• Open the _converted_report.txt file and read the lines to check.
• Open the _converted.bat file in Notepad and delete the line call DefInit.bat if it has one (see DefInit.bat Is No Longer Used below).
• If the batch file calls another batch file, convert that one too.

Good to know

• An existing .db or .bidx file is never overwritten; it is listed as Already exists.
• The converter sets the report level to -rep 3. To keep your old -rep 1 or -rep 2, untick that rule in the Changes tab before you save.
• If the names are already taken, the new files are called _converted_2, _converted_3 and so on.

Converting many files at once

Drag and drop: select your old .bat files in Windows Explorer and drag them onto Convert-OldBatch.bat in the iPool Suite folder. A window shows the result. You get the same _converted.bat and report files as above.

Command line (for IT staff or scripts):

"C:\Program Files\iPool\iPoolSuite.exe" --convert-bat "C:\IENERGY\RunHST.bat" --convert-files

Put one or more batch file names after --convert-bat. Optional extras after the file names: --convert-files also converts the .mdb and .bid files the batch file uses; --keep-rep keeps your -rep 1 / -rep 2; --out <folder> saves the converted files in another folder.

Reference: what the converter changes

Old	New
set "PATH=c:\Program Files (x86)\iEnergy"	The iPool Suite folder and its resources\engine folder are put in front of PATH; the rest of PATH is kept
iPool24.exe, iPool_headless.exe, any other iPool….exe	iPool.exe
-ipdb / -tpdb / -ibdb / -ifdb / -isdb X.mdb	X.db
-bf X.bid, and copies of bid files the engine makes	X.bidx
iBidAgg.exe	bidmanager-aggregator.exe, same options
iYBidWESM.exe	bidmanager-generator.exe, same options
iBidEzy.exe	Turned into a comment: there is no direct replacement. Redo this step in Bid Manager.
-rep, -rep 1, -rep 2	-rep 3 (adds unit-level reports). Untick the rule, or use --keep-rep, to keep your level.
-g MRGCFac_X.csv / MRHCFac_X.csv	Gen_X.csv / GenHr_X.csv
-d Demand_X.csv / DemandHr_X.csv	Dem_X.csv / DemHr_X.csv
-nowin, -IsdbResults	Removed (they do nothing now)

The history file names are changed automatically when the same batch file makes them with a history run. Otherwise the converter asks you to check, because a file such as Demand_Sep.csv may be your own.

Lines to check by hand are listed in the report and not changed: call of another batch file (convert that file too), a copy of Defaults.csv, a -bf placed before its -bt, the removed -emp2isdb option and -coopt (see Other Changes You Will Notice).

Example

Old RunHST.bat

call DefInit.bat
set "PATH=c:\Program Files (x86)\iEnergy"
iPool.exe -new BASE -t "3/2/2026" -ndays 7 -rep 2 -5mnDisp 1 -stor ALL -s -x
iPool.exe -o BASE -s HST -hist -rb -x
iPool.exe -o BASE -s BCAs0 -ab 1 -abf ALL -rb -run -x -bt DEF_PRIORITY -bf OM_HST.bid -e Ev_HST.csv -spin 0

RunHST_converted.bat

call DefInit.bat
set "PATH=C:\Program Files\iPool;C:\Program Files\iPool\resources\engine;%PATH%"
iPool.exe -new BASE -t "3/2/2026" -ndays 7 -rep 3 -5mnDisp 1 -stor ALL -s -x
iPool.exe -o BASE -s HST -hist -rb -x
iPool.exe -o BASE -s BCAs0 -ab 1 -abf ALL -rb -run -x -bt DEF_PRIORITY -bf OM_HST.bidx -e Ev_HST.csv -spin 0

The report lists call DefInit.bat as a line to check. See the next section.

DefInit.bat Is No Longer Used

Older batch files began with call DefInit.bat. That start-up file:

• copied a Defaults.csv to C:\iEnergy;
• ran the engine once only to choose the databases (-ipdb, -tpdb, -ibdb, -ifdb, -isdb, all .mdb);
• set 5-minute dispatch (-5mnDisp 1).

What replaces it

• Folders and databases: keep them in C:\IENERGY\Defaults.csv (PoolDB, TimeDB, 5mnDisp) and set them with the Directory Initializer (Step 1).
• A database for one scenario: put -ipdb <name>.db on that scenario's command line.
• 5-minute dispatch: put -5mnDisp 1 on the -new BASE line.

Then delete the call DefInit.bat line from the converted batch file. Keep your original DefInit.bat unchanged for the batch files you still run with the older iPool: it selects the .mdb databases for them. If you also want a DefInit.bat for iPool Suite, convert a copy: the converter changes its .mdb names to .db and removes -nowin.

A new-style batch file needs no start-up file: copy your Defaults.csv (optional), set PATH, then run the scenarios. For example:

copy /y Defaults.csv "C:\iEnergy\Defaults.csv"
set "PATH=C:\Program Files\iPool"
iPool.exe -new BASE -t "10/05/2026" -ndays 7 -rep 3 -5mnDisp 1 -stor ALL -port ALL -s -x
iPool.exe -o BASE -checkinputs -x
iPool.exe -o BASE -s Sample_HST -hist -rb -x

Other Changes You Will Notice

Where things are in iPool Suite

Apollo is now part of iPool Suite. Its tabs are Dashboard (results and charts), Scenario Studio (scenarios, command sequences and batch files, as Apollo's Command Module), Files Downloader, Bid Manager (replaces iBidAgg, iYBidWESM and iBidEzy), Event Hub and Database Editor.

Results and CSV files

Results are stored in the scenario's .isdb file, which the Dashboard reads. By default 23 detailed CSV files are no longer written, among them TraceGrp.csv, TraceUnt.csv, TraceSto.csv, BidUnit.csv and FuelPool.csv. Prices.csv, Summary.csv, ScenInfo.csv and SummLink.csv are still written. If Excel links or your own scripts read the detailed files, set the scenario's Output format to All CSV + .isdb, or add -csvout to the command line.

Engine options

• -bt before -bf: a -bf file is paired with the -bt in front of it. Write -bt DEF_PRIORITY -bf OM_HST.bidx, not the other way round.
• -coopt prices: co-optimized energy prices are calculated differently from earlier builds. Add -cooptprice legacy (or CoOptPrice,legacy in Defaults.csv) for the earlier prices.
• -nowin does nothing; the engine never opens a window.
• Bid files the engine writes (-opbid, storage bids) are now .bidx. Change any copy line that copies them as .bid.

Naming Scheme Tips

Scenario IDs

The scenario ID is also the name of the scenario's folder. Scenario Studio checks each ID you type:

• No spaces. Use _ or -: LINK_DERATING, not LINK DERATING.
• None of these characters: \ / : * ? " < > |
• Not ending with a dot, and at most 100 characters.
• Not a Windows reserved name: CON, PRN, AUX, NUL, COM1–COM9, LPT1–LPT9.
• Unique, ignoring case. Windows sees HST and hst as the same folder, so Scenario Studio warns when an ID is already in use.

Scenarios you already have that break these rules still load and run. The rules apply when you type a new ID.

Files

• Extensions: databases .db, bid files .bidx, dynamic bid rules .ibdx (or .csv), scenario results .isdb.
• History files are named after the scenario: Dem_<ID> and DemHr_<ID> in the demand folder, Gen_<ID> and GenHr_<ID> in the generation folder, Ev_<ID> in the events folder. A history run named HST makes Dem_HST.csv and Gen_HST.csv, which a backcast then reads with -d Dem_HST.csv -g Gen_HST.csv -e Ev_HST.csv.
• Do not reuse the old prefixes (Demand_, MRGCFac_, MRHCFac_) for new files of your own. The engine no longer writes those names.
• Keep one BASE scenario at the top of each batch file (-new BASE … -s -x) and make the others from it with -o BASE -s <ID>, as in the sample batch files.
• Converted files keep their names: OM_HST.bid becomes OM_HST.bidx. Do not keep a .bid and a .bidx of the same name for different data; the .bidx is always used.

Troubleshooting

What you see	What to do
The run stops: "no regions loaded … a legacy .mdb cannot be opened"	A database is still .mdb. Convert it (Step 2), put the .db in DirDB and change PoolDB or the -ipdb value to .db.
"Legacy CArchive .bid not supported"	The bid file is an old binary file. Convert it (Step 3).
A copy line cannot find a .bid file after a run with -opbid	The engine now writes .bidx. Change the copy line, or run the batch file converter.
Bid Manager aggregator: "ERROR: table bid_file already exists"	It does not overwrite an existing bid file. Delete the old output, or use a new -s name.
Bid Manager aggregator: "-s requires DirSub OR DirBid in Defaults.csv"	Defaults.csv has neither DirSub nor DirBid. Add both (Step 1).
Dynamic bidding (-ib) fails with an .ibd file	Convert it to .ibdx (Step 3) and use the .ibdx name.
CSV files such as TraceGrp.csv are missing	Set Output format to All CSV + .isdb, or add -csvout.
Folders are empty or wrong in iPool Suite	Check that C:\IENERGY\Defaults.csv exists, or set the folders in the Directory Initializer.
iPool Suite asks for a license	Enter your key or license file (see Licensing). Contact Support if it is refused.

Checklist

• Backed up Defaults.csv, databases, bid files, scenario folders and batch files.
• Installed iPool Suite 1.0.0 and checked the license.
• Defaults.csv: DirSub added (same folder as DirBid); PoolDB and TimeDB end in .db.
• All .mdb databases converted to .db and placed in DirDB.
• Old .bid files converted to .bidx; .ibd rule files converted to .ibdx.
• Batch files converted, reports read, call DefInit.bat lines removed.
• Scenario IDs without spaces.
• One converted batch file run as a test, and its results opened in the Dashboard.

Need help? Email support@ienergyglobal.com.au, or use Support in the top bar of iPool Suite. Please include your iPool Suite version (Settings → About iPool) and, for a batch file, the _converted_report.txt.