Differences

This shows you the differences between two versions of the page.

--- parsermonster_flags [2014/08/10 18:08]
Mitch created
+++ parsermonster_flags [2015/08/15 18:06] (current)
Mitch [System Flags]
@@ Line 1: / Line 1: @@
-ParserMonster flags are simply variables that can be true or false. Tasks and scripts can use a mix of predefined flags and temporary, local flags.
+====== ParserMonster Flags ======
-Both types of flags are read, set and tested by the same directives. The directives will create a local flag the first time it is used. For this reason, don't expect to use a predefined flag for your own purposes.
+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 [[recognized_filetypes|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.
@@ Line 7: / Line 10: @@
 To set a flag to False, use the <false> directive. If the flag does not exist, it will be created and set to False.
-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.
+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:
+<code>
+<true>ReportMerge
+<true>ReportHeaderNoPath
+</code>
+To disable **ReportHeaderNoPath**, comment out the line:
+<code>
+<true>ReportMerge
+'<true>ReportHeaderNoPath
+</code>
+<del>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.</del>
+===== 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|AutoRun.task]] executed whenever the application is launched.
+  * [[autorun2|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 [[reportpreviewwindow|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 ====
+==== Header ====
+||HeaderNoPath||
+==== Footer ====
+[[reportoff|ReportOff]] suppresses writing reports to disk.
+[[reportmerge|ReportMerge]] combines all reports into one file.
+[[reportpreview|ReportPreview]] displays reports on the dashboard
+[[reportheader|ReportHeader]] outputs one or more [[variables_in_reportheader|report header variables]]
+[[reportfooter|ReportFooter]] outputs one or more [[variables_in_reportfooter|report footer variables]]
+===== System Flags =====
+These flags operate independently of their inclusion in a [[constantfiles|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 [[parsermonsterloops|loops]] |
+| AutoRun | Set to true if [[autorun|autorun.task]] is detected during startup |
+| AutoRun2 | Set to true if [[autorun|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
-see [[liftofflags|List of Flags]]

ParserMonster Project

User Tools

Site Tools

Differences

Page Tools