User Tools

Site Tools


parsermonster_flags

ParserMonster Flags

ParserMonster flags are variables that can be either true or false. Flags may be predefined or created by tasks. See [sys][] or is it, see [sys] [foo]?

Predefined flags are stored in a hidden file named cx-Flags.txt. Since that file is read before any user-defined constants or user-defined tasks, none of the predefined flag names should be used for other purposes.

To set a flag to True, use the <true> directive. If the flag does not exist, it will be created and set to True.

To set a flag to False, use the <false> directive. If the flag does not exist, it will be created and set to False.

Tip: if you plan to test multiple flags, you can save time by commenting out <true> directives. Just place one flag on each line of your script, like this:

<true>ReportMerge
<true>ReportHeaderNoPath

To disable ReportHeaderNoPath, comment out the line:

<true>ReportMerge
'<true>ReportHeaderNoPath

To test whether a flag is True or False, use the <test> directive. If the flag does not exist, it will be created and set to False.

Main Window Flags

Tasks usually have no reason to interact directly with the Main Window. However, these flags can be used in a script designed specifically for setting up your working environment. In fact, the ParserMonster Framework recognizes two of them:

  • AutoRun.task executed whenever the application is launched.
  • AutoRun2.task executed after AutoRun.task completes successfully.

Source File Flags

Normally, you select the folder where one or more source files are to be processed. Sometimes, though, you may need to specify multiple files from all over the hard drive. If you don't want to have to keep browsing or dragging and dropping folders, one of these flags can help: readsourcefromfile ignores the Main Window's Read From box and gets file names from (should the file name be based on task name? If not, how do you determine file name? Keep in mind, exporting file lists is common and we do not want to force users to rename files unnecessarily.)

Output File Flags

Normally, you select a folder where all output is sent. Sometimes, though, you may need to specify multiple folders, multiple files and specific file names.

Report Flags

For each file that is processed, tasks may generate one or more reports. ParserMonster uses report flags to control output to disk files, as well as output to a report preview window.

By default, ParserMonster generates one report per file processed. Reports, previews and output can be modified by setting the following flags to <true>:

Output (to Disk)

Preview

HeaderNoPath

ReportOff suppresses writing reports to disk.

ReportMerge combines all reports into one file.

ReportPreview displays reports on the dashboard

ReportHeader outputs one or more report header variables

ReportFooter outputs one or more report footer variables

System Flags

These flags operate independently of their inclusion in a cx-file. Applications that don't ship with predefined constants will still recognize system flags.

Name Purpose
AdHoc Allows custom code to run before, during and after the major loops
AutoRun Set to true if autorun.task is detected during startup
AutoRun2 Set to true if autorun2.task is detected during startup

Undocumented Flags

These flags have been implemented and will be documented, eventually. AdHoc AutoRun AutoRun2 OverwriteSessionLog Pipe ProcessFileNames ReportCompact ReportFooter ReportHeader ReportHeaderNoPath ReportHeaderShortName ReportMerge ReportOff ReportPreview ReportPreviewCompact SafeBrowseReadFrom SafeBrowseWriteTo ScriptIcons StatusDisplayTaskInfo Trace TraceStartup

parsermonster_flags.txt · Last modified: 2015/08/15 18:06 by Mitch