Report Variables

Document Variables

~date~

Returns the current date using the current regional format. Formatting options below are case sensitive, may be combined, and may be applied also to the variable ~samp,date~.

Example
If the date was March 14, 2002, ~date,%d-%b-%Y~ would resolve to "14-MAR-2002". If the time were 08:12:59, ~date,%M past %H~ would resolve to "12 past 08".

~date,[param]~

See the [Parameters] above for a complete list of available date parameters.

~doc,[param]~

Returns information related to the CM4D document.

~doc,label~

Returns the saved name of the document, excluding the file extension.

~doc,title~

Returns the saved name of the document, including the file extension.

~doc,path~

Returns the entire folder path of document, excluding the filename.

~page~

Returns the page number of the current sheet (within a SheetSet). Same as ~sheets~.

~page,count~

Returns the number of sheets in the SheetSet, not including the title sheet.

~page,label~

Returns the sheet label. This variable will not return a value when used on the title sheet.

~pages~

Returns the number pages in the SheetSet. Same as ~sheets~.

~sheet~

Returns the page number of the current sheet (within a SheetSet). Same as ~page~.

~sheet,setlabel~

Returns the SheetSet label. The total number of sheets will not include the title sheet.

~sheet,setcontent~

Builds a table of contents for the SheetSet.

~sheets~

Returns the number sheets in the SheetSet. Same as ~pages~.

~time~

Returns the current time. Additional Date/Time parameters may be added to this variable to specify specific information to display, or some particular format. See here for a complete list of parameters.

Annotation Variables

~annot~

Returns the label of the annotation.

~annot,label~

Returns the label of the annotation.

~annot,type~

Returns the type of annotation.

~annot,error~

Returns the text from Resolve Errors.

~graphtype~

Returns the type of a graph. The graph types are Trend, XBar-R, XBar-S, X-MR, MA-MR, Box_Whisker, Six Sigma, Pareto, Normality, Benchmark, Target, and Six Sigma Projection.

~limittype~

The ~limittype~ variable determines whether a control chart is using Trial Control Limits or Process Control Limits (e.g. "Trial XBar-R" or "Control XBar-R").