<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="DOCIDXTAG (Document Index Tag ) keyword in printer files" />
<meta name="abstract" content="Use this record keyword to create an indexing tag in the document for use by presentation systems such as Advanced Function Printing), or postprocessor applications such as Content Manager OnDemand." />
<meta name="description" content="Use this record keyword to create an indexing tag in the document for use by presentation systems such as Advanced Function Printing), or postprocessor applications such as Content Manager OnDemand." />
<meta name="DC.subject" content="DOCIDXTAG (Document Index Tag) keyword, Document Index Tag (DOCIDXTAG) keyword" />
<meta name="keywords" content="DOCIDXTAG (Document Index Tag) keyword, Document Index Tag (DOCIDXTAG) keyword" />
<meta name="DC.Relation" scheme="URI" content="rzakdmstprkey.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakdmstdocidx" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>DOCIDXTAG (Document Index Tag ) keyword in printer files</title>
</head>
<body id="rzakdmstdocidx"><a name="rzakdmstdocidx"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">DOCIDXTAG (Document Index Tag ) keyword in printer files</h1>
<div><p>Use this record keyword to create an indexing tag in the document
for use by presentation systems such as <span class="keyword">Advanced Function Printing™</span>),
or postprocessor applications such as <span class="keyword">Content Manager OnDemand</span>.</p>
<div class="section"><p>The format of the keyword is:</p>
<pre> DOCIDXTAG(attribute-name | &attribute-name-field
attribute-value | &attribute-value-field
tag-level | &attribute-tag-level-field) </pre>
<p>The
attribute-name parameter is required and defines the name of the indexing
attribute (for example, "Policy Number"). The maximum number of characters
in the attribute name is 250. Blanks are allowed as part of the attribute
name.</p>
<p>When you specify the attribute-name parameter as a program-to-system
field, the field must exist in the same record format as the DOCIDXTAG keyword.
It must be defined as length of 1-250, type A (character) and usage P (program-to-system).</p>
<p>The
attribute-value parameter is required and defines the value of the indexing
attribute (for example, "43127").The maximum number of characters in the attribute
value is 250. Blanks are allowed as part of the attribute-value.</p>
<p>When
you specify the attribute-value parameter as a program-to-system field, the
field must exist in the same record format as the DOCIDXTAG keyword. It must
be defined as length of 1-250, type A (character) and usage P (program-to-system).</p>
<p>The
tag-level parameter is required and defines the level of the indexing tag.
There are two special values allowed for this parameter. GROUP and PAGE. GROUP
specifies that the attribute name and value are attached to the current group.</p>
<div class="note"><span class="notetitle">Note:</span> Group
level tags are selectable using the SELECT GROUP function of the AFP™ Viewer. PAGE
specifies that the attribute name and value are attached to the current page.</div>
<div class="note"><span class="notetitle">Note:</span> Page
level tags are selectable using the GO TO function of the AFP Viewer. Group
level tags are selectable using the SELECT GROUP function of the AFP Viewer. PAGE
specifies that the attribute name and value are attached to the current page.</div>
<p>When
you specify the tag-level parameter as a program-to-system field, the field
must exist in the same record format as the DOCIDXTAG keyword. It must be
defined as length of 5, type A (character) and usage P (program-to-system).</p>
<p>This
keyword is valid with DEVTYPE(*AFPDS). If DEVTYPE is changed to anything other
than *AFPDS, the keyword will be ignored and a warning message will be issued
at print time.</p>
<p>Option indicators are valid for this keyword.</p>
</div>
<div class="section"><h4 class="sectiontitle">Example</h4><pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
A
A R RECORD1
A 02 DOCIDXTAG('Policy Number' '43127' +
A GROUP)
A R RECORD2 DOCIDXTAG( &ATTNAM &ATTVAL PAGE)
A ATTNAM 20A P
A ATTVAL 10A P
A</pre>
<p>In the example, RECORD1 specifies an indexing attribute name
of 'Policy Number' and an attribute value of '43127'. This is a group level
tag. RECORD2 allows the application program to specify the attribute-name
and attribute-value by specifying variables ATTNAM and ATTVAL. This is a page
level tag.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakdmstprkey.htm" title="See the valid keyword entries for defining printer files in this topic.">Keyword entries for printer files (positions 45 through 80)</a></div>
</div>
</div>
</body>
</html>