Messages

Pipelines v2.1

StageManager messages	Home
Index
Stage Command messages
Index

There are two types of message issued by Pipelines; the first type are those issued by the StageManager; which is responsible for parsing the pipeline, allocating resources for the multi-stream environment and servicing stage i/o requests. The second type of message are those issued by a stage; these are messages that inform you about invalid or missing stage arguments and errors encountered while processing its input and output streams.

StageManager messages

StageManager messages have a standard message format which details the; date, time, (name of the Pipelines file, if appropriate), message number and message description; where each description has a unique index number in the range 1000+. There are two types of message; a warning message, indicating that you should take note, and an error message; indicating a terminal condition.

Type	Meaning
Warning	A warning message is issued by the StageManager when it determines that a condition has occurred that should be noted; however the StageManager continues to process and dispatch its input stages.
Error	An error message is issued by the StageManager when it determines that an un-recoverable condition has occurred.

The following example shows a typical StageManager message; the value specified for the ENDCHAR control option is invalid; only a single character is expected, not two characters. The message description states exactly what is wrong with the definition:

01/05/2007 10:54:34 PIPE: Error processing file: mypipe.rex
| | 1015: Pipe(0): Invalid ENDCHAR: '??', single character expected.
| | | | 
| | | message description
| | message number
| (time)
| hh:mm:ss
(date)
dd/mm/yyyy
 

The table below lists the StageManager message descriptions along with a brief explanation of what each one means.

Index	Description
1000	Rc: %d, Missing, corrupted or empty registry entry, for: '%s\%s\%s' Pipelines could not find the specified registry entry. Try re-installing Pipelines to fix the problem.
1001	No stage DLLs have been found. Cannot run Pipelines! Pipelines could not find any stage DLLs in either the builtin loadlib or the user loadlib. Try re-installing Pipelines to fix the problem.
1002	Closing command-line quote missing, '"', expected A closing quotation mark is missing from the Pipelines argument.
1003	Pipelines file: '%s', not found or failed to open, Rc: %d, Reason: %s. The pipeline file could not be found or failed to open. Check that the spelling of the file is correct and if the file is not in the current working directory, you should specify a fully qualified path.
1004	File: %s, is invalid. Command 'PIPE', expected. Pipelines expects the first word in a Pipelines file to be: pipe.
1005	Stall detected, writing dump to: %s The pipeline has stalled. Usually, stalls are caused by stages that read multiple input streams in a particular order or that need records to be available on more than one stream at the same time. A stall occurs when the preceding stages do not deliver records in the order needed or do not provide multiple records concurrently. Pipelines issues this message and the current status of each stage is written to the specified stall-file. The stall-file is written to the current working directory. Inspect the file to determine the combination of stages that caused the stall.
1006	Pipe(%s),Stage(%d), Null stage found, command expected. Pipelines expects the name of a stage. This error message may be issued because there are no stages specified at all, or because you have specified two or more consecutive stage separator characters. Pipelines expects a stage command, followed by a stage separator followed by a stage command and so on.
1007	Pipe(%s),Stage(%d): Bad command: '%s'. Pipelines could not find a stage with the given name.
1008	Pipe(%d): missing argument: '%c', expected. Pipelines expects the specified character.
1009	Pipe(%d): Invalid argument: '%c', option keyword expected. Pipelines expects a control option keyword.
1010	Pipe(%s): Unknown option keyword: '%s'. Pipelines expects a control option keyword.
1011	Unused.
1012	Pipe(%s): Option: '%s' already defined. The control option keyword has already been specified.
1013	Pipe(%s): Invalid %s: '%s', the characters: '%s', are reserved or already assigned. The character specified as the control option value is a reserved character and cannot be assigned. Replace the character with another one.
1014	Pipe(%s): Missing %s assignment, %s expected. A required argument is missing. The message explains what Pipelines expects.
1015	Pipe(%s): Invalid %s option: '%s', %s expected. The specified argument is invalid. The message explains what Pipelines expects.
1016	On %s. Return code from WaitForMultipleObjects(): %d. The operating system reported an error whilst waiting for the specified thread set to complete. Try running the pipeline again and if the problem persists; contact me.
1017	On %s dispatch. Rc: %d, Reason: %s. The operating system reported an error whilst trying to dispatch the specified thread. The combined number of threads for dispatch may be more than the system can load at this time; you should first review the number of stages specified by the pipeline and if this is not significant, try running the pipeline again. If the problem persists; contact me.
1018	Unused.
1019	Unused.
1020	'%s' is not a valid Pipelines stage DLL. Pipelines has found a stage DLL in either the builtin or user loadlib that is not a valid Pipelines stage DLL. Remove, or relocate the DLL to another directory.
1021	Pipe(%s),Stage(%d): Label: '%s', undefined. The stage refers to an input or output stream label which is not yet defined. A label must be defined before it can be referred to.
1022	Pipe(%s),Stage(%d): At label: '%s', command expected. Pipelines expects a stage command to follow the specified label.
1023	Pipe(%s),Stage(%d): Label: '%s', already defined by: Pipe(%s),Stage(%d). The label has already been defined by another stage. Choose another label name.
1024	Stage type(%s), requires a %s input stream. The stage requires the specified input stream to be defined and connected. Without the connection the stage cannot run.
1025	Invalid input stream(s): %s, for Pipe(%s),Stage(%d),Type(%s). In this position, Type(%s) allows: %d input stream(s). There are: %d defined. Connection(s) from: (Pipe,Stage,Stream): %s are invalid! The connections for the specified pipeline/stage/stream cannot be made because the stage does not read from more than a certain number of input streams. Or, the target stage or stages do not write to the corresponding output streams.
1026	Stage type(%s), requires a %s output stream. The stage requires the specified output stream to be defined and connected. Without the connection the stage cannot run.
1027	Invalid output stream(s): %s, for Pipe(%s),Stage(%d),Type(%s). In this position, Type(%s) allows: %d output stream(s). There are: %d defined. Connection(s) to: (Pipe,Stage,Stream): %s are invalid! The connections for the specified pipeline/stage/stream cannot be made because the stage does not write to more than a certain number of output streams. Or, the target stage does not read from the corresponding input stream.
1028	filename or pipeline expected! PIPE filename[.rex] [arguments] PIPE “file name[.rexl]" [arguments] PIPE “stage|stage|stage|.." [arguments] [[arg1] [“arg 2“] ..] Pipelines expects the name of a Pipelines file (.REX) and its command argument(s) or a pipeline specified directly on the command-line.
1029	Pipe(%s),Stage(%d): Unassigned argument(s) '%s' The argument place-holder: &argn has not been assigned; there is no corresponding command-line argument. The message is issued in order to identify a stage argument which corresponds to an argument place-holder, but which may or may not be intended as one.
1030	Cannot create TRACE shared segment: %s. The TRACE swap-file shared segment cannot be created. Try running the pipeline again and if the problem persists; contact me.
1031	Cannot write to TRACE shared segment: %s. Pipelines could not write to the TRACE swap-file shared segment. Try running the pipeline again and if the problem persists; contact me.
1032	Cannot read from TRACE shared segment: %s. Pipelines could not read from the TRACE swap-file shared segment. Try running the pipeline again and if the problem persists; contact me.
1033	Invalid TRACE command: '%s'. %s Usage: <enter>|End|HeLP|Off|SouRCe|Run <count|*> The command is invalid – specify one of the commands listed in the Usage help message.
1034	PIPE sub-command '%s' can only be specified in an ooRexx program launched through the CALLPIPE stage command.", The specified sub-command can only be used in an ooRexx program that has been launched through the CALLPIPE stage command.
1035	%s requires an ooRexx variable, stem or array operand.", The specified sub-command requires an ooRexx variable, stem or array argument as an operand.
9999	Request made by: Pipe(%s),Stage(%d),Type(%s) to issue %s message no: %d failed, message not found!. The specified stage has tried to issue a message which is not defined. Pipelines assumes that the message was to indicate a critical error and terminates the pipeline.

Stage Command messages

A stage message has a standard format which details the; date, time, (name of the Pipelines file, if appropriate), pipeline number, stage number, stage command type, message number, message context and message description; where each description has a unique index number in the range 2001-2999. The two character message context indicates the operational phase of the stage; (I)nitialising or (R)untime, and the severity of the message; (W)arning or (E)rror.

The following table explains the meaning of the two character message context:

Character 1	Meaning
(I)nitialising	The message was issued during the initialisation phase; parsing the stage arguments and allocating the necessary resources.
(R)untime	The message was issued while the stage was running; processing its input and output streams. In addition to the standard format; the message includes the current input stream and record number.

Character 2	Meaning
(W)arning	A warning message is issued by a stage when it determines that a condition has occurred that should be noted; however the stage continues to process it input and output streams.
(E)rror	An error message is issued by a stage when it determines that an un-recoverable condition has occurred.

The following example shows a typical initialisation message; the LITERAL stage has issued message number 2015, indicating that an error has occurred parsing its argument. The message description states exactly what is missing from the stage argument:

28/04/2007 14:49:47 PIPE: Error processing file: mypipe.rex
| | Pipe(0),Stage(0),Type(LITERAL): 2015IE: Missing argument: '/' expected.
| | | | | | | |
| | | | | | | message description
| | | | | | message context
| | | | | message number
| | | | stage command type
| | | stage number
| | pipeline number
| (time)
| hh:mm:ss
(date)
dd/mm/yyyy

The following example shows a typical runtime message; the < stage has issued message number 2002; indicating that the specified file does not exist. The message includes the current input stream number (primary input stream) and the number of the record being processed (162). The message states exactly why the stage has terminated.

17/07/2008 09:52:03 PIPE: Error processing file: mypipe.rex
| | Pipe(0),Stage(1),Type(<): 2002RE: Stream: 0, rec: 162, Input file: 'myfile.txt' failed to open, Rc: 2,
| | Reason: The system cannot find the file specified.| |
| | | | | | | | | |
| |  | | | | | | | message description
| | | | | | | | current record number
| | | | | | | current input stream
| | | | | | message context
| | | | | message number
| | | | stage command type
| | | stage number
| |  pipeline number
| (time)
| hh:mm:ss
(date)
dd/mm/yyyy
 

The table below lists the stage message descriptions along with a brief explanation of what each one means.

Index	Description
2001	Missing argument, Filename expected. The stage requires an input or output filename. If you do not specify a fully qualified path; the current working directory is selected.
2002	%s file: '%s', Rc: %d, Reason: %s. The input or output file specified could not be found or failed to open for either reading or writing. Check that the spelling of the filename is correct and if the specified file is not located in the current working directory; a fully qualified path must be specified. If the file cannot be opened for writing, it may be write-protected or locked by another stage or external application. Check that you do not have more than one occurrence of this stage in any executing pipeline that is trying to access the file.
2003	Failure reading file: '%s', Rc: %d, Reason: %s. The file read operation failed. The file or sections of the file may be locked for output by another stage or external application. Check that you do not have a stage in any executing pipeline that may have already locked the file for output.
2004	Invalid 'from-to' combination. from: %d to: %d. '%d' must be %s '%d'. An overlapping column range has been specified. The from column must be numerically less than or equal to the to column.
2005	Invalid argument: '%s', %s expected. The message explains the type of the argument which should be specified; this may be an operand, string or integer value.
2006	Creation of %s pipe failed, Rc: %d, Reason: %s. The stage failed to create an output-read or input-write pipe. This is an operating systems-level error; the message explains the reason why the creation failed.
2007	Invalid argument: '%s', operand: '%s' expected. The message indicates the specific operand which must be specified.
2008	Unused.
2009	Invalid argument: '%s', integer expected. An integer value must be specified.
2010	Buffer overflow during construction of pipeline argument. The argument to be passed to the called pipeline is longer than the space allocated for it. The maximum argument length is limited to 4095 characters.
2011	Invalid input stream number(s): '%s', valid streams for this stage are: '0 - %d'. The argument specifies a stream number which is greater than the current highest connected input stream. You cannot reference a stream which is not connected.
2012	Invalid argument: '%s', two byte hexchar expected. You must specify a two byte hexadecimal value in the range 01-FF with an x, X, h or H prefix. For example: xAB.
2013	Failure launching %s: '%s', Rc: %d, Reason: %s. The specified process has failed to launch; the message explains the reason why.
2014	Failure launching %s, Rc: %d, Reason: %s. The specified process has failed to launch; the message explains the reason why.
2015	Missing argument: '%s' expected. The stage expects a specific and required operand.
2016	Warning executing shell command. With arg: '%s'. Process Rc: %d, maximum allowed Rc: %d.",
2017	Invalid string: '%s', length: %d. A string of minimum length: %d, and maximum length: %d; is expected. You must specify an argument which resolves to an ASCII character string that is at least as long as the minimum required length, and no longer than the maximum allowed length.
2018	REGEXP: Error parsing expression: %s, Reason: %s The following messages are issued by the TR1 regular expression parser: The expression contains an invalid back reference. The expression contains an invalid range in a {} expression. One of *?+{ is not preceded by a valid regular expression. The expression contains mismatched '{' and '}' braces. The expression contains mismatched '[' and ']' braces. The expression contains an invalid collating element name. The expression is too complex to process. The expression contains an invalid character class name. The expression contains an invalid character escape sequence. The expression contains mismatched '(' and ')' parentheses. The expression contains an invalid range specifier. There are insufficient resources to process the expression. TR1 regular expression could not match the specified character sequence. An unspecified error condition. Reference the following chapter: Specifying pipe options, for details of the options that can be specified with the supporting regular expression parser.
2019	Missing argument, delimited string expected. The stage expects a literal string of characters.
2020	Missing argument, integer expected. The stage expects an integer value.
2021	Missing argument, operand %s expected. The stage expects an operand. When a single, known operand is expected; the message will tell you exactly what is required. However, when more than one operand is acceptable in this position; you must reference the relevant stage command documentation to determine the options.
2022	Missing termination delimiter: '%c' expected at end of string: '%s'. A closing string delimiter is missing; a literal string must start and end with the same delimiting character.
2023	NULL delimited string: '%s'. An empty/null delimited string is not allowed in this position.
2024	Invalid argument, non numeric character(s) in: '%s', integer expected. Only the decimal digits 0-9 are valid in an integer value.
2025	Overflow on integer: %d, maximum integer value is: %d. The stage has set a limit on the maximum size of the integer value that can be specified in this position.
2026	Overlapping groups: %d(%d-%d) and: %d(%d-%d). The specified groups have overlapping column ranges. The groups indicated in the message are the expanded versions; they indicate the absolute beginning and ending columns of each group.
2027	Write to pipe failed! Pipelines was unable to write to the input-write pipe. The message explains the reason why the write failed.
2028	_getdrives() failed with Rc: %d, Reason: %s. The operating system has failed to provide the bit-mask which describes the drives which are currently defined by the system.
2029	Failure positioning read pointer to eof, on file: '%s', Rc: %d, Reason: %s. Pipelines was unable set the file-pointer to the end-of-file position on the specified file. Try running the pipeline again and if the problem persists; contact me.
2030	Failure executing shell command. With arg: '%s'. Process Rc: %d exceeds the maximum allowed Rc: %d. The shell command/executed process has passed back a return code that is higher than the permitted return code. You should check the documentation of the specified command or process to determine the highest expected return code which represents the successful completion of the process. If you are executing a list or sequence of commands of differing return code completion levels; then you should specify the MAXERROR operand as an argument on each primary input stream record.
2031	Missing argument, double-precision floating-point value expected. The stage expects a double-precision floating point value.
2032	Invalid value: '%s', a properly constructed double-precision floating-point value expected. The stage expects a valid double-precision floating point value. Excluding the characters '. e, E, +, -' and the decimal digits 0-9; the value specified may contain non-numeric characters or it may simply be ill-defined.
2033	Unexpected argument(s): '%s'. The stage does not require any more arguments. Remove the extraneous argument(s).
2034	Invalid argument: '%s', operand expected. The stage expects an operand in this position. Check the corresponding stage documentation to determine which operand(s) you can specify.
2035	Missing argument, single character, two byte hexchar or eight byte binchar expected. The stage expects an argument that resolves to a single character.
2036	Invalid argument: %d, stream already specified. The stage does not allow the stream to be specified more than once.
2037	Invalid hexchar: '00', values in the range: '01-FF', expected. A value of zero is not allowed.
2038	The number of %schars in character or string definition: '%s', is not a multiple of %d. The number of characters in either a binary or hexadecimal value is not a multiple of 2 or 8, respectively.
2039	Invalid binchar: '00000000', values in the range: '00000001-11111111', expected. A value of zero is not allowed.
2040	Invalid argument: '%s', eight byte binchar expected. You must specify an eight-byte binary value in the range 00000001-11111111 with a b or B prefix. For example: b00000111
2041	Duplicate or out of sequence %s KEY: '%s'. The key field specified is not unique. You should ensure that consecutive key fields are not the same.
2042	Invalid double-precision floating-point value: %s, values in the range: %.0lf to %.0lf, expected. The stage expects a double-precision floating-point value in the range specified by the message.
2043	Invalid %schar(s) in character or string definition: '%s'. There is an invalid binary or hexadecimal character in the specified character or string definition.
2044	'SELECT' on undefined input stream(s): %s. Highest that can be selected is stream: %d. You cannot select a stream that is not connected; the message indicates that the SELECT operand specifies a stream that is greater than the highest connected stream number.
2045	Invalid operand: SECONDARY. A secondary input stream is not defined! The stage cannot read from the secondary input stream; as the stream is not defined.
2046	Invalid output group '%s', 'to/for' integer position or length expected. The stage expects an integer output position or output position and length specification.
2047	Invalid argument: '%s', single character, two byte hexchar or eight byte binchar expected. The stage expects an argument that resolves to a single character.
2048	Missing argument, eight byte binchar expected. The stage expects an eight byte binary value.
2049	Limit reached on: %s. Counting stopped at: %d. The maximum count limit has been reached. The stage stops processing before the count overflows.
2050	Missing argument, two byte hexchar expected. The stage expects a two byte hexadecimal value.
2051	Invalid integer: %d, signed values in the ranges: %d to %d, %d to %d, expected. The stage expects an integer value in the range specified by the message.
2052	Invalid integer: %s, unsigned values in the range: %d to %d, expected. The stage expects an unsigned integer value in the range specified by the message.
2053	Unable to erase file: '%s'. Rc: %d, Reason: %s. The stage has failed to erase the specified file. The message explains the reason why the operation failed.
2054	Unused.
2055	Unable to rename file: '%s' to '%s'. Rc: %d, Reason: %s. The stage has failed to rename the specified file. The message explains the reason why the operation failed.
2056	2056 Incomplete argument: '%s', %s expected.",
2057	The following drive(s) are not defined on this machine: '%s'. The argument specifies a drive or drives which are not defined by the system.
2058	%s entry '%s' contains one or more of the following invalid characters: '%s'. The Path operand must not contain of any of the characters: / : < > | ” The Filename and extension operands must not contain any of the characters: / : < > | ” \
2059	Unused.
2060	Missing argument, unsigned integer expected. The stage expects an unsigned integer value.
2061	Invalid argument: '%s', unsigned integer expected. The stage expects an unsigned integer value.
2062	Invalid argument, non numeric character(s) in: '%s', unsigned integer expected. Only decimal digits 0-9 are valid in an unsigned integer value.
2063	You cannot specify the NOWAIT operand in combination with the CMD operand. Each executing (system) SHELLEXECUTE command must be allowed to complete before the next (system) SHELLEXECUTE command is issued.
2064	Invalid delay interval: %I64d ms. A %s interval of: %ld ms is allowed. The number of milliseconds specified is greater the maximum allowed.
2065	ooRexx %s: '%s' is defined, but not properly initialised. Inspect the value of element: '%s'. Element '.0' does not contain an integer value that defines the number of elements in the specified ooRexx array or stem. In order to iterate the collection; the stage expects a whole integer value which defines the 1-based index of the last element in the collection.
2066	Missing argument, command expected. The SHELLEXECUTE stage command expects each input record to define a command to execute. The input record is either empty/null or does not specify a fully qualified command.
2067	Missing argument, ooRexx %s expected. The speciified ooRexx variable type is missing. This could be a variable/stem or array name.
2068	Undefined ooRexx %s: '%s'. The specified ooRexx variable, array or stem is not defined.
2069	You cannot specify the %s operand in this stage position! The operand cannot be used when the stage command is specified in this position. Reference the relevant stage command help file for details.
2070	Invalid ooRexx variable name: '%s'. The specified ooRexx variable name is invalid. See here for a description of the ooRexx variable name rules.
2071	Cannot %s shared file segment: %s. Rc: %d, Reason: %s. The specified swap-file shared segment could not be created, opened, read or written to. The message states exactly which operation has failed. Try running the pipeline again and if the problem persists; contact me.
2072	The record of length: %d, exceeds the maximum allowed length of: %d. The first 50 bytes of the record are: '%.50s' The specified record exceeds the maximum (default) length of 256K. If you need to process records that exceed this maximum record length; edit the following registry entry: HKEY_LOCAL_MACINE\SOFTWARE\TenFiftyTwo\Pipelines\Settings\MaxRecLength
2999	%s A generic third-party user defined stage message. The exact meaning is defined by the stage DLL which issues this message. If you are the author of a third-party stage and you would like a specific message template added to this list or you would like to have your stage DLL included in the builtin stage set for subsequent distribution (with acknowledgements of course); please contact: me.