Predefined RDM Variables

This topic lists predefined RDM variables.

TRUE is a valid condition for each variable. If you set the condition to TRUE, the data field will be evaluated for every page of the report.

See the topic on Expression Criteria in the ASG-Cypress Knowledge Builder and Expression Criteria User’s online documentation for complete expression criteria options supported by RDM and other Cypress modules.

cyp:doc_title

This variable specifies what will appear in the Title field of the input document’s job tickets (JTICs). It also sets the input document’s Document Title system index. If you do not set a value for cyp:doc_title, the Title field and the Document Title system index will retain their current value. The maximum length you can use for this variable is 199 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
true	"Annual Sales Performance"	Sets the title of the input document to Annual Sales Performance.
true	region_text("header")	Uses the contents of the region named header as the input document’s title.

cyp:doc_title changes the title of the input document, not the documents created by this subreport. In addition, Cypress does not set cyp:doc_title until after it finishes processing all subreports. For this reason, the title used by the documents created by the subreports is the original document title, not the new title. To retitle the documents created by the subreport, use the doc_title variable instead.

doc_creator

This variable determines what will appear in the Creator field on the Document tab of JTICs generated by this subreport. It also sets the Document Creator system index. If you do not set a value for doc_creator, the Creator field and Document Creator system index will be set to RDM. The maximum length you can use for this variable is 63 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	creator	Uses the original JTIC’s creator as the new subreport’s creator.
on_begin	"PeopleSoft"	Sets the creator field to the string PeopleSoft. Some sites set each subreport’s creator to a specific string so that the number of pages produced by each subreport can be calculated.
on_begin \|\| on_break	region_text("dept_number")	Sets the creator field to the contents of the region named dept_number. This allows you to specify a unique creator for each subreport.

doc_export_template

This variable specifies which template will be used in a report or subreport for exporting document content into a Microsoft Excel file. The maximum length you can use for this variable is 31 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
TRUE	"accounting_export"	Uses the accounting_export template when exporting document content into a Microsoft Excel file.

doc_title

This variable specifies what will appear in the Title field of the subreport’s JTICs. It also sets the Document Title system index. If you do not set a value for doc_title, the Title field and the Document Title system index will be set to the subreport’s description specified on the General tab. If the description is blank, the name of the subreport definition will be used. The maximum length you can use for this variable is 199 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	title	Uses the original JTIC’s title as the title of the new subreport.
on_begin	"Annual Sales Performance"	Sets the title of each document that is created by this subreport definition to Annual Sales Performance.
on_begin \|\| on_break	region_text("header")	Uses the contents of the region named header as the subreport title.

This variable retitles the documents created by the subreport. To change the title of the input document, use cyp:doc_title instead.

dtic_note

When a subreport distributes documents to one or more recipients, this variable enables the sender to add a brief message about the subreport. This message will appear in the recipient’s Inbox Viewer. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	region_text("sales")	Uses the contents of the sales region as the document ticket’s (DTIC’s) note. The value will be reset only when the subreport’s begin criteria expression evaluates to TRUE.

dtic_subject

When a subreport distributes documents to one or more recipients, this variable enables you to add a subject heading to a new DTIC. This subject heading will appear in the recipient’s Inbox Viewer. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("support")	Uses the contents of the support region as the DTIC’s subject heading.

job_address

This variable is designed to be used in the banner attached to the subreport. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("mail stop")	Uses the contents of the mail stop region as the job address.

job_computer

This variable determines what will appear in the Computer field on the General tab of JTICs generated by this subreport. This value represents the computer from which the subreport originated. If you do not specify a job computer, job_computer will be set to the server’s name. The maximum length you can use for this variable is 31 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	jtic_computer	Uses the original JTIC’s computer as the new subreport’s computer.
on_begin	"mainframe"	Sets the Computer field to the string mainframe.
on_begin \|\| on_break	region_text("recip_computer")	Sets the Computer field to the contents of the region named recip_computer.

job_creator

This variable determines what will appear in the Creator field on the General tab of JTICs generated by this subreport. Think of this value as the subreport’s sender. If you do not specify a job creator, job_creator will be set to RDM. The maximum length you can use for this variable is 31 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	creator	Uses the original JTIC’s creator as the new subreport’s creator.
on_begin	"mainframe"	Sets the creator field to the string mainframe.
on_begin \|\| on_break	region_text("last_name")	Sets the creator field to the contents of the region named last_name.

job_description

This variable appears on the JTIC’s General tab. The maximum length you can use for this variable is 199 characters.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	"quarterly tax report for Department" + region_text("dept_number")	Sets the value of the job description to a string literal concatenated with the contents of the region dept_number.

job_email_bcc_list

When a subreport is to be distributed through e-mail, this variable determines who will be on the blind carbon‑copy distribution list. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	"admin@companyabc.com"	Sets the value of the variable to admin@companyabc.com.
on_begin \|\| on_break	"admin@companyabc.com;" + region_text("dept_mgr") + "@companyabc.com"	Specifies two members of the BCC list: admin@companyabc.com and the department manager specified in the dept_mgr region.

job_email_cc_list

When a subreport is to be distributed through e-mail, this variable determines who will be on the carbon-copy distribution list. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	"admin@companyabc.com"	Sets the value of the variable to admin@companyabc.com.
on_begin \|\| on_break	"admin@companyabc.com;" + region_text("dept_mgr") + "@companyabc.com"	Specifies two members of the CC list: admin@companyabc.com and the department manager specified in the dept_mgr region.

job_email_from

When a subreport is to be distributed through e-mail, this variable determines who will appear as the e-mail message’s sender. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
TRUE	"ljbenton@companyabc.com"	Sets the sender of the e-mail to ljbenton@companyabc.com.

job_email_message

When a subreport is to be distributed through e-mail, this variable enables the sender to add a brief message about the subreport. This message will appear as the text of the e-mail message. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	region_text("tech_note")	Uses the contents of the tech_note region as the e-mail message. The value will be reset only when the subreport’s begin criteria expression evaluates to TRUE.

job_email_subject

When a subreport is to be distributed through e-mail, this variable specifies the e-mail message’s subject. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("support")	Uses the contents of the support region as the e-mail message’s subject.

job_email_to

When a subreport is to be distributed through e-mail, this variable specifies the recipient of the e-mail message. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("email")	Uses the contents of the email region as the outbound e-mail address.

job_fax_note

When a subreport is to be distributed via fax, this variable enables the sender to add a brief message about the subreport. This message will appear on the fax’s cover sheet, if one exists. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin	region_text("tech_note")	Uses the contents of the tech_note region as the fax note. The value will be reset only when the subreport’s begin criteria evaluate to TRUE.

job_fax_num

When a subreport is to be distributed via fax, this variable determines the outbound fax number that will be used. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("fax number")	Sets the outbound fax number for the current subreport to the contents of the fax number region.

job_identity

This variable is designed to be used in the banner attached to the subreport. There is no limit to the length of characters you can use for this variable.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("dept_num")	Uses the contents of the dept_num region as the job identity.

job_name_suffix

The content of this variable is inserted into the end of the first level of the JTIC name. You can use this variable to send the document title to the display of a DocuSP printer or whenever you want to provide more information in the JTIC name.

The content of this variable, plus the other items that are included in the JTIC name (i.e., the hex number, three letter abbreviation, and the rest of the name), has a maximum length of 210 characters.

This example shows how you can set the content of this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	title	The document’s title is inserted into the JTIC name.

job_recipient

This variable is designed to be used in the banner attached to the subreport. If you are distributing a subreport to a recipient, this variable will be set to the recipient’s name. There is no limit to the length of characters you can use for this variable.

Setting this variable will not cause the document to be distributed to the recipient. For information on using the Destination tab to distribute a document to a recipient, see Distributing Subreports to Recipients.

This example shows how you can set this variable:

Condition	Data Field Input	Result
on_begin \|\| on_break	region_text("user_id")	Uses the contents of the user_id region as the job recipient.