RDM String Selection Criteria

String selection criteria allow you to select information about the job or text from the current page. For example, you might choose to control report definition selection based on the job title or job ticket name or decide to create new subreports when the contents of a region on the current page does not match the region’s contents on the previous page. For more information, see the ASG-Cypress Knowledge Builder and Expression Criteria User’s topic.

This table contains a list of string selection criteria available from RDM. The criteria in this list can be used with both expressions and functions. For a list of string selection criteria that can only be used with functions, see String Selection Criteria.

Function	Description
creator	The creator of the report that RDM is processing.
current_page	The page of the report that RDM is currently processing. Can be used in conjunction with other string selection functions to retrieve information about or text on the current page.
date	The current date, in YYYYMMDD format.
dist_id	The subreport’s distribution identifier.
doc_inx	The value of a document index. Specify the index name as the parameter. For example: doc_inx("Account Number") The doc_inx function itself does not validate that the index specified actually exists as an index. When configuring the RDM criteria in the UI, the specified index name is simply stored in the compiled criteria. At run-time, when RDM is processing the document, it will obtain the document index value if the document has been indexed by it. If there is no such index, or if the document has not been indexed by it, an empty string is returned.
doc_var	The value of a document variable. Specify the variable name as the parameter. For example: doc_var("Account Number")
first_page	The first page of the report that RDM is processing. Can be used in conjunction with other string selection functions to retrieve information about or text on the first page.
jtic_computer	The computer on which a user created the report that RDM is processing.
jtic_creator	The user who sent the report that RDM is processing.
jtic_desc	The job ticket (JTIC) description.
jtic_name	The name of the JTIC.
last_page	The last page of the report that RDM is processing. Can be used in conjunction with other string selection functions to retrieve information about or text on the last page.
next_page	The page of the report after the page of the report that RDM currently is processing. Can be used in conjunction with other string selection functions to retrieve information about or text on the page after the current page.
page	A particular page in a report that RDM is processing. Can be used in conjunction with other string selection functions to retrieve information about or text on a particular page.
page_inx	The value of a specified page index from the corresponding page. For example, first_page.page_inx("Doc Type") returns the value of the Doc Type index from the first page of the document. If the page has been indexed by more than one value (for that index) the first value encountered will be returned. Like the region_text, text, and page_var functions, specifying page_inx without a preceding page specifier will use the current page. In other words, page_inx("Doc Type") is equivalent to current_page.page_inx("Doc Type").
page_number	Number of the current page.
page_orientation	Returns the orientation of the page being referenced, in degrees clockwise (0, 90, 180, 270).
page_var	The value of a page variable. Specify the variable name as the parameter. For example: page_var("DID")
previous_page	The page of the report before the page of the report that RDM currently is processing. Can be used in conjunction with other string selection functions to retrieve information about or text on the page before the current page.
region_text	The contents of a region to be retrieved. For example: region_text("header")
text	Retrieves the contents of a region. This function takes four numeric parameters that describe a rectangle on the page. The parameters are the X and Y location of the upper left corner and the X and Y location of the lower right corner. These values are all in meters. For example: text(0.01, 0.02, 0.03, 0.04) describes the rectangle with an upper left corner of (0.01, 0.02) and a lower right corner of (0.03, 0.04) (i.e. a 2 cm square). ASG recommends that you use the region_text function instead, because it is much more convenient.
title	The name of the report that RDM is processing.

The current_page, first_page, next_page, previous_page, and last_page functions are all used as a prefix for functions like region_text, text, page_var, and page_orientation, and describe which page that content is to be extracted from. They precede the functions separated by a dot. For example:

previous_page.region_text("account") next_page.page_var("Invoice Num")

If a function such as region_text is used without any of these prefixes, then the data will be extracted from the current page by default. Thus, putting current_page. in front of a function is not necessary.