Launching Hyperview from the command line

Contents

Command line structure

The user can launch Hyperview via the command line and specify along with it the name of the project file to open, as well as, optionally, a particular document in the project to display when it first opens up. The basic command line configuration is: 

"C:\Program Files (x86)\GMCL\DBDOC\Programs\Hyperview.exe"
   <dbdoc or M14 filename> </document_switch=document_name>
   </additional_optional_switches>

where <dbdoc or M14 filename> is the location and name of the project file which you wish to open.

Information-noshadow.png Note: Misspelled switch names or switch arguments will be ignored. This will often give unexpected results. Information-noshadow.png Note: The command line that was actually used to run Hyperview can be seen in the About Dialog.

Opening the most recent project file with *

In lieu of the actual dbdoc or M14 filename, you can use the asterisk (*) wildcard to specify which project file to open. The asterisk tells Hyperview to look at all matching project files and open the newest version it can find.

To open the most recently built project file in a specified project directory, regardless of name, you can enter 

<project_path>\*.dbdoc

or 

<project_path>\*.M14

and Hyperview will look at all existing project files in the directory.

Information-noshadow.png Note: As long as a wildcard is included in the specification, .dbdoc and .M14 are completely interchangeable. For example, if you specify *.M14 but there is a newer .dbdoc file, then it is the newer .dbdoc file that is opened for you. (Or vice versa.)


You can also select specific files by combining the wildcard with other text. For example, if your project name is ATL_1 and your BuildRoot is C:\WORK, then you may specify the filename argument as 

C:\WORK\ATL_1\ATL_1*.M14

and Hyperview will look at all project files with names that start with ATL_1 and open the newest one.


If you do not specify a filename when you launch Hyperview, Hyperview will open the last viewed project file.

Specifying the document to be displayed at startup

Command line syntax

<document_switch> is one of the following arguments followed by the document_name (do not include the file extension in the name):

Argument Explanation Example
/doc Specify a document to open. The optional /type switch specifies the document type to be opened. The first document (of the specified type) that has a name with a leading substring that matches the string specified in /doc will be opened. If /type is not specified, then the first matching document of any type will be opened. /doc="G1WATER" /type=graphic
/tag Specify a Tag Name to open. An exactly correct specification is required — there is no substring matching. Hyperview will bring up the tag index in the Table of Contents panel and the CAD source (if it exists, otherwise the tag record) in the content pane. /tag="AMD-108"
/block Specify a loop-PCU-module-block to open. An exactly correct specification is required — there is no substring matching. The index pane will show everywhere the block is referenced. The content pane will display the CAD sheet source of the specified block. /block="Module 1,1,1 Block 1"

Supported document types

Document types which can be specified in the /type switch:

Argument Explanation Example
graphic Conductor/Operate IT/Process Portal B Graphic, i.e. any graphic file with a type of M1, DT, DR, DIS, CTL, PNG, G, or, UCBG /doc="G1WATER" /type=graphic
800xA Any 800xA graphic, which could be a PG2 graphic or a VB graphic /doc=pulpers/type=800xa
sodg Any SODG graphic, i.e. any graphic file with a type of DT, DR, or DIS /doc="G39" /type=sodg
vb 800xA VB (Visual Basic) graphic, file type CTL /doc=pulpers /type=vb
splus S+ (Symphony+) or PGP (Power Generation Portal) graphic /doc=auxelcov /type=splus
pg2 800xA PG2 graphic, file type PNG /doc=pulpers /type=pg2
pgp PGP (Power Generation Portal) or S+ (Symphony+) graphic, file type G or UCBG /doc=auxelcov /type=pgp
m1 Conductor/Operate IT/Process Portal B Graphic /doc="g1bfwdar" /type=m1
dt SODG Graphic /doc="G39" /type=dt
dr SODG Graphic /doc="G40" /type=dr
dis SODG Graphic /doc="G41" /type=dis
ctl SODG Graphic /doc="FIRESYS1" /type=ctl
logic CAD sheet of type CAD or CLD /doc="1010214A" /type=logic
cad CAD sheet name /doc="1010214A" /type=cad
cld CAD sheet name /doc="Control Logic Document 1" /type=cld
autocad Any AutoCAD type file of type DXF, DWG, or DGN /doc="17HS2W1" /type=autocad
dxf MicroStation/DXF file /doc="29L107" /type=dxf
dwg AutoCAD file /doc="17HS2W1" /type=dwg
dgn AutoCAD file /doc="0021" /type=dgn
lad Ladder rung. (Note that you can specify a particular rung to open with /rung=) /doc="EVAMTR" /type=lad
batch Batch file. (Note that you can specify a particular unit with /unit) /doc="1010201A" /type=batch
ab AB file /doc="addr01a" /type=ab
rtu RTU file /doc="10209" /type=rtu
doc Any txt (text), rtf, or html file /doc="notes" /type=doc
txt Text (.TXT) file /doc="notes" /type=txt
rtf RTF file /doc="notes" /type=rtf
html HTML file /doc="notes" /type=html
dy SODG symbol /doc="atnkfl" /type=dy
pnt Honeywell Point Index /doc="lime" /type=pnt

Deprecated command line options

These older document selection switches are no longer supported but may still work.

Information-noshadow.png Note: They will definitely not work in any context where a new Hyperview window is launched from a running Hyperview, for example using the File | New Window command or automatically launching an older version of Hyperview to view an M14 file. If you rely on any of these deprecated switches, please change to the new approach described above.

Argument Explanation Example
graphic Conductor/Operate IT/Process Portal B Graphic /graphic="G1WATER"
m1 Conductor/Operate IT/Process Portal B Graphic /m1="G1WATER"
cad CAD sheet name /cad="1010214A"
dt SODG Graphic /dt="G39"
dr SODG Graphic /dr="G40"
dis SODG Graphic /dis="G41"
dwg AutoCAD file /dwg="17HS2W1"
dxf MicroStation/DXF file /dxf="29L107"
lad Ladder rung /lad="EVAMTR" /rung=48 (Note: You can specify a particular rung to open to)
batch Batch file /batch="1010201A" /unit=2 (Note: You can specify a particular unit)
ab AB file /ab="16207"
rtu RTU file /rtu="10209"
txt Text (.TXT) file /txt="Notes"
rtf RTF file /rtf="My RTF file"

Other Hyperview command line switches

<additional_optional_switches> are switches that can be appended to the command line but are not necessary.


Argument Explanation Example
noOpen Use this switch to launch Hyperview with the Open file menu option disabled. This would prevent a Hyperview user from viewing any project file other than the one specified on the command line. /noOpen
noErrors Use this switch to launch Hyperview with the Error Browser and error markers disabled. /noErrors
snapshot This switch makes Continuous Mode live data unavailable. The user will still be able to use Slow Mode live data. /snapshot
update Enter the frequency in seconds that Hyperview will request live loop information from the CIU. The format will be as follows: /update= /update=10 (specifies that visible live data values should be fetched each 10 seconds if continuous live loop monitoring is turned on)
noedit With this switch specified, the Open Document and Explore to Document options in the pop-up menu are disabled. /noedit
save This option allows you to specify a default location where files will be saved (audit window, search results, gather live loop data on the "View" panel, print to file). This is specifed as follows: /save=<directory to save to>. /save="C:\Users\Bob\Documents\DBDOC\save"
MonitorOff Specify an interval after which live loop monitoring will be turned off. The format should be as follows: /MonitorOff=<time in minutes>. When monitoring is turned on, after the specified interval has elapsed, live loop monitoring will be automatically shut off. Each time the live loop monitoring button is toggled on will result in a fresh live loop monitoring interval. /MonitorOff=30 (automatically turns off continuous live monitoring after 30 minutes)
NewWindow This option overrides the reuse of an existing active Hyperview window to process the current command line. /NewWindow
datefmt This option allows the specification of date format as MMDD or DDMM. This specifies the default date format (used in the Watch Window). The date format can also be specified as Default Date Format in the View tab of the Options dialog. /datefmt=MMDD, /datefmt=DDMM
llfontsize This option allows the live loop annotation text size to be set. This font size can also be specified as Live loop annotation text size in the View tab of the Options dialog. Note that this font size only affects text whose size is not explicitly set during the compile. /llfontsize=20 (specifies that the default live data font size should be 20).
treeview In DBDOC 11.3, Treeview Table of Contents is back so this currently does nothing. This option forced the Treeview Table of Contents to be available in DBDOC 11.2. In DBDOC 11.2, the Treeview Table of Contents was no longer available by default. It became enabled automatically on some older systems. If you prefer to have the legacy Treeview Table of Contents available in other situations in 11.2, use the /treeview command line option. /treeview
exportdb This option causes Hyperview to run in non-interactive (command line only) mode, and export a subset of the dbdoc database to PROJECT.sqlite in the PATH folder. If PROJECT.dbdoc is not specified on the command line, the last opened project will be loaded, the same as when Hyperview is running interactively. The effect of running Hyperview with this option is the same as choosing Export Project Data... from the File menu inside Hyperview. This option is used by BuildPlus to automatically export a database after a build (see Exporting data from .dbdoc files for how to configure your build to do this). Although this option is generally only used internally by DBDOC, it could be used in any context where it is useful to convert a dbdoc database to a readable sqlite database that contains most of the same system information. [PROJECT.dbdoc] /exportdb=PATH
exportgraphics This option causes Hyperview to run in non-interactive (command line only) mode, and export all graphics information to the specified PATH folder. Hyperview will export a clean render of each of the graphics of PROJECT.dbdoc to .tif files. All the graphic metadata and hotspot data will be put into graphics_info.csv and tags_info.csv respectively, each with labelled columns. If PROJECT.dbdoc is not specified on the command line, the last opened project will be loaded, the same as when Hyperview is running interactively. [PROJECT.dbdoc] /exportgraphics=PATH
exportsigchange This option causes Hyperview to run in non-interactive (command line only) mode, and export the contents of the Significant Change Report to the specified PATH folder. The effect of running Hyperview with this option is the same as choosing Export Significant Change Report from the File menu inside Hyperview. This option is used by BuildPlus to automatically export the Significant Change Report during a build. Hyperview will export [project name]_sigchange.tsv and [project name]_sigchange_imports.tsv, each with labelled columns. If PROJECT.dbdoc is not specified on the command line, the last opened project will be loaded, the same as when Hyperview is running interactively. [PROJECT.dbdoc] /exportsigchange=PATH

Making a batch file or shortcut for running Hyperview

All command-line options can be used in a shortcut definition or in a batch file in the same way that they are used on the command line.

Hyperview is commonly run remotely from a shortcut.

Some DBDOC administrators might want to run Hyperview from a batch file, which would allow command line options to be predefined in a somewhat less accessible manner than with a shortcut.

See also