iadsx Protocol Handler
Overview
IADS provides basic API support using a custom protocol handler.
IADS registers iadsx with Windows as a protocol handler so that any URLs beginning with "iadsx:" are forwarded to IADS. This enables certain activities in IADS without requiring any code to be written. An example of this is the Search Result export in IADS. Links in the Excel Spreadsheet work by default because Windows knows that iadsx links should be opened by IADS (using the same mechanism used to associate http or https links with a default web browser).
This type of interface is inherently limited because it only enables one-directional communication to IADS. For many use cases, this is perfectly acceptable, but in more advanced scenarios where bi-directional communication is required, the protocol handler is not sufficient.
Syntax
All command line operations follow one of three basic formats
iadsx: | Intentionally blank - launches IADS with no arguments. |
iadsx:<argument> | <argument> - Standalone argument outside of the command/parameter format below. This may be a “.iads” file to install, a Dataset ID, or an XML file to open. |
iadsx:command=<cmdName>;param=<parameter> | <cmdName> - Command name identifying operation to perform. Note that this name is case sensitive and must match one of the following: SetConfiguration, SelectDataset, BuildPackage, IndexGraphics, or Search. <parameter> - Optional parameter associated with the command. |
Supported Commands
Operation | Argument | Command | Parameter | Sample |
|---|---|---|---|---|
Start IADS | No argument | “iadsx:” | ||
Install Dataset | .iads file name and path | “iadsx:d:\install\data\dataset.iads” | ||
Load and permit access for this dataset only | Dataset ID | “iadsx:CH-47D” | ||
Open a file in IADS4. | XML or graphic file name and path | “iadsx:C:\Data\workpackage.xml” | ||
Change the workspace location and reset | SetConfiguration | The new shared workspace folder (resets to default if no param is specified) | “iadsx:command=SetConfiguration;param=C:\IadsShared” | |
Open the dataset for user access. | SelectDataset | Dataset ID or associated MDS | “iadsx:command=SelectDataset;param=UH-60L” | |
Build a package file for the active IADS4 dataset. | BuildPackage | File name and path of the package file to create | “iadsx:command=BuildPackage;param=C:\Data\NewDataset.iads” | |
Add search indexes for CGM and SVG graphics in the dataset. | IndexGraphics | Dataset ID or associated MDS | “iadsx:command=IndexGraphics;param=UH-60L” | |
Perform a simple search on the current dataset. | Search | Search string | “iadsx:command=Search;param=transducer” | |
| Perform SV (export optional) for the active IADS4 dataset | SourceVerify | Filepath for generated xlsx export (no export if param is not specified) | "iadsx:command=SourceVerify;param=C:\Data\Helmet\SourceVerifyExport.xlsx | |
| Close IADS (and optionally don't save State) | CloseApplication | ClearState if state should not be saved, otherwise we auto-default to saving state. | "iadsx:command=CloseApplication" (Saves state) "iadsx:command=CloseApplication;param=ClearState" (clears state upon exit) |
Notes
Windows will attempt to start IADS for each iadsx link opened. If another instance of IADS is running, the new instance will determine during startup if it should forward the request to an already-running instance or allow the newly created instance to continue loading. This determination is based on the "Enable Multiple Instances" user settings (also configurable via registry setting).