Add PDF Map Entry (QPQAPME) API
Required Parameter Group:
| 1 | Returned library name | Output | Char(10) |
| 2 | Qualified PDF map object name | Input | Char(20) |
| 3 | PDF map entry spooled file attributes | Input | Char(*) |
| 4 | Length of PDF map entry spooled file attributes | Input | Binary(4) |
| 5 | Format of PDF map entry spooled file attributes | Input | Char(8) |
| 6 | PDF mapping action | Input | Char(*) |
| 7 | Length of PDF mapping action | Input | Binary(4) |
| 8 | Format of PDF mapping action | Input | Char(8) |
| 9 | Add type | Input | Binary(4) |
| 10 | Error code | I/O | Char(*) |
Default Public Authority: *Use
Threadsafe: Yes
The Add PDF Map Entry (QPQAPME) API inserts an entry into the specified PDF Map object. You can retrieve the current entries by using the Open List of PDF Map Information (QPQOLPM) API.
This API allows you to set up PDF mapping entries for spooled files you want processed after they have been converted to PDF.
There are two types of entries. Segmented and non-segmented. Segmented entries are for spooled files that are divided into multiple PDF files. The division is be based upon the use of the STRPAGGRP DDS keyword and other products such as the AFP™ Toolbox or the Infoprint® Server. For all segmented entries of a spooled file, the input spooled file criteria(format APME0100), all the selection parameters should be the same except the mail tag information. Non-segmented entries are for spooled files that will be converted to one PDF file.
The entry consists of two parts:
- Selection for the input spooled file. You can specify which spooled file attributes should be used to match a spooled file being converted to PDF. This information is used by products , such as Infoprint Server to determine what additional processing needs to be done with the PDF file.
The selection for the input spooled file includes such spool attributes as output queue name and library, spooled file name, job name,user name, user data, form type, mail tag, and also a sequence number. To allow for the input selection criteria of multiple entries in the PDF map which can match a particular spooled file, the entries are sorted in the order of the sequence number specified. Multiple entries can be a match for a spooled file because generic and *ALL are supported as part of input selection criteria, for example output queue, file, job name, user name, user data, and form type.
- PDF map actions for the spooled file. For each spooled file or segmented entry of a spooled file, you may define one or more map actions and their associated parameters. The supported actions are e-mail, stream file, PDF respool, and AFPDS respool.
For e-mail, you can enter the following additional information:
- Tolist, Copy Control, and Blind Copy Control
- Subject of email
- Body of e-mail
- Attachments (in addition to PDF spool file)
- Reply to address
- Mail sender
For stream file, you can enter the following additional information:
- Full path name where stream file will be stored in Integrated File System
- Authority for PDF stream file
For re-spooling PDF file, you can enter the following additional information:
- Output queue name
- File name
- User data
- User defined data
- Form type
For re-spooling AFPDS file, you can enter the following additional information:
- Output queue name
- File name
- User data
- User defined data
- Form type
When you request to add an entry to a PDF Map object, the request may not be successful in the following situations:
- The entry you requested to add already exists in the PDF Map. For non-segmented entries, the sequence number must be unique. For segmented entries (which all have the same sequence number), the mail tag must be unique.
- The user profile storage limit is exceeded when an entry is added.
Authorities and Locks
- Library authority
- *EXECUTE
- PDF Map object authority
- *CHANGE
- PDF Map object lock
- *EXCL
Required Parameter Group
- Returned library name
- OUTPUT; CHAR(10)
The name of the library that contains the PDF map object to which the entry was added if it was added successfully. This parameter is not set if the entry was not successfully added. This information helps you identify the specific library used when *LIBL or *CURLIB is specified in the qualified PDF map object name parameter.
- Qualified Map object name
- INPUT; CHAR(20)
The Map object for which you would like to add information. The qualified object name has two parts. The first 10 characters contain the object name.
The second 10 characters contain the name of the library in which the object is located.
The following special values are allowed:
*CURLIB The job's current library is used to locate the object. If no library is specified as the current library for the job, the QGPL library is used. *LIBL The library list is used to locate the object.
The actual library that is used is returned in the Returned library name parameter.
- PDF map entry spooled file attributes
- INPUT; CHAR(*)
The PDF map entry spooled file attributes for the entry to be added to the PDF map object. The parameter uniquely identifies the entry in the PDF map object.
Specify which spooled file attributes should be used to match a spooled file being converted to PDF.
- Length of PDF map entry spooled file attributes
- INPUT; BINARY(4)
The length of the PDF map entry spooled file attributes parameter. This value must be greater than or equal to 4.
- Format of PDF map entry spooled file attributes
- INPUT; CHAR(8)
The format of the PDF map for the entry to be added to the PDF map object.
The valid format names are:
APME0100 Contains the input selection criteria for the entry. This includes a sequence number for the entry and spooled file information, such as output queue, spooled file name, job name, user name, user data, form type, and mail tag.
- PDF mapping action
- INPUT; CHAR(*)
The PDF mapping action for the entry to be added to the PDF map object.
See PMAP0100 Format for details on the data structure.
- Length of PDF mapping action
- INPUT; BINARY(4)
The length of the PDF mapping action parameter. This value must be greater than or equal to 8.
- Format of PDF mapping action
- INPUT; CHAR(8)
The format of the PDF mapping action to be added to the PDF map object.
The valid format names are:
PMAP0100 Contains the mapping action for the entry. This can include mail information, PDF stream file information, PDF and AFPDS spooled file information, and a spooled file segmentation indicator. - Add type
- INPUT; BINARY(4)
The type of add to be performed.
Valid values are:
1 Insert with replacement This value requests to replace the PDF map portion of the entry if the PDF map entry spooled file attributes is already in the PDF map object. If the entry does not exist, it will be added into the PDF map object.
2 Add without replacement This value requests to add the entry only if the PDF map entry spooled file attributes portion of the entry is not already in PDF map object. If the entry does not exist, it will be added into the PDF map object. If the entry is already in the PDF map object, an error is returned.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
APME0100 Format
For more details about the fields in the following table, see APME0100 Format Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Sequence number of entry |
| 4 | 4 | CHAR(10) | Output queue name |
| 14 | E | CHAR(10) | Output queue library name |
| 24 | 18 | CHAR(10) | Spooled file name |
| 34 | 18 | CHAR(10) | Job name |
| 44 | 2C | CHAR(10) | User name |
| 54 | 36 | CHAR(10) | User data |
| 64 | 40 | CHAR(10) | Form type |
| 74 | 4A | CHAR(250) | Mail tag |
| 324 | 144 | CHAR(2) | Reserved - initalized to null |
APME0100 Format Field Descriptions
Form type. The type of forms that should be loaded on the printer before this spooled file is printed. A least one form type or special value must be specified. This field can be used in conjunction with the output queue name, spooled file name, user, user data, and mail tag to select a spooled file to be processed.
The following special values can be used for the form type:
| *ALL | Specifies that all form types will be considered a match regardless of the value for form type. |
 *Generic*-form-type |
Specify the generic name of a form type. A generic name is a character
string followed by an asterisk(*). If you specify a generic name, all form types that begin
with the generic name are considered a match in the input selection.
|
A default of *ALL is assumed if the form type is not specified.
Job name. The name of the job for the spooled file. At least one job name or special value must be specified. This field can be used in conjunction with the output queue name, spooled file name, form type, and mail tag to to select a spooled file to be processed.
The following special values can be used for the job name:
| *ALL | Specifies that all job names will be considered a match for input selection regardless of the job name. |
| *Generic*-job-name | Specify the generic name of a job. A generic name is a character string followed by an asterisk(*). If you specify a generic name, all user names that begin with the generic name are considered a match in the input selection. |
A default of *ALL is assumed if the job name is not specified.
Mail tag. Specifies the mail tag for the spooled file. For non-segmented spooled files, the mail tag is specified on the CRTPRTF, CHGPRTF, or OVRPRTF commands using the USRDFNDTA parameter. For segmented spooled files, the mail tag is specified on the STRPAGGRP DDS keyword. This field can be used in conjunction with the output queue name, spooled file name, user, user data, and form type to select a spooled file to be processed.
Here is information on specifying a mail tag:
- Embedded blanks will be used as part of the mail tag.
- Do not use single quotes around the text string, as they will be interpreted as part of the text string.
- Case is preserved.
The following special values can be used for the mail tag:
| *ALL | Specifies that all mail tags will be considered a match in the input selection regardless of the value for mail tag. |
A default of *ALL is assumed if the mail tag is not specified.
Output queue library name. The name of the library where the output queue resides.
Output queue name. The name of the output queue in which the spooled file is located. At least one output queue or special value must be specified. This field can be used in conjunction with the spooled file name, user, form type, and mail tag to select to select a spooled file to be processed.
The following special value is used for the output queue name:
| *ALL | Specifies that all ouput queues will be considered a match in the input selection regardless of the output queue name. When this value is specified, the output queue library name must be blanks. |
| *Generic*-output-queue | Specify the generic name of an output queue. A generic name is a character string of one or more characters followed by an asterisk(*). If you specify a generic value, all output queues with the names that begin with the generic name are considered a match in the input selection |
Reserved - initalized to null. A reserved field.
Sequence number of entry. The user-defined sequence number for an entry in a PDF Map object. To allow for the input selection criteria of multiple entries in the PDF map that can match a particular spooled file, the entries are sorted in the order of the sequence numbers. Multiple entries can be a match for a spooled file because generic and *ALL are supported as part of input selection criteria, for example output queue, file, user name, user data, and form type.
Spooled file name. The name of the spooled file. At least one spooled file name or special value must be specified. This field can be used in conjunction with the output queue name, user, form type, and mail tag to to select a spooled file to be processed.
The following special value is used for the output queue name:
| *ALL | Specifies that all spooled file names will be considered a match in the input selection regardless of the spooled file name. |
| *Generic*-spooled-file | Specify the generic name of a spooled file. A generic name is a character string followed by an asterisk(*). If you specify a generic name, all spooled files with the names that begin with the generic name are considered a match in the input selection |
A default of *ALL is assumed if the spooled file name is not specified.
User data. The value of the user data. You must specify user data or a special value. This field can be used in conjunction with the output queue name, spooled file name, user, form type, and mail tag to selectto select a spooled file to be processed.
The following special values can be used for the user data:
| *ALL | Specifies that all user data will be considered a match in the input selection regardless of the user data. |
|
*Generic*-user-data |
Specify the generic name for user data. A generic name is a character
string followed by an asterisk(*). If you specify a generic name, all user data values that begin
with the generic name are considered a match in the input selection.
|
A default of *ALL is assumed if the user data is not specified.
User name. The name of the user that created the spooled file. At least one user name or special value must be specified. This field can be used in conjunction with the output queue name, spooled file name, form type, and mail tag to to select a spooled file to be processed.
The following special values can be used for the output queue name:
| *ALL | Specifies that all user names will be considered a match for input selection regardless of the user name. |
| *Generic*-user-name | Specify the generic name of a user. A generic name is a character string followed by an asterisk(*). If you specify a generic name, all user names that begin with the generic name are considered a match in the input selection |
A default of *ALL is assumed if the user name is not specified.
PMAP0100 Format
For more details about the fields in the following table, see PMAP0100 Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to mail information entry |
| 4 | 4 | BINARY(4) | Length of to mail information entry |
| 8 | 8 | BINARY(4) | Offset to PDF stream file information |
| 12 | C | BINARY(4) | Length of to PDF stream file information |
| 16 | 10 | BINARY(4) | Offset to PDF spooled file information |
| 20 | 14 | BINARY(4) | Length of PDF spooled file information |
| 24 | 18 | BINARY(4) | Offset to AFPDS spooled file information |
| 28 | 1C | BINARY(4) | Length of AFPDS spooled file information |
| 32 | 20 | CHAR(1) | Segmented entry |
| 33 | 21 | CHAR(50) | Text description |
| 83 | 53 | CHAR(49) | Reserved - initalized to null |
PMAP0100 Field Descriptions
Length of AFPDS spooled file information. The size, in bytes, of the AFPDS Spooled file information entry. For information on the format of a Spooled file information entry, see AFPDS Spooled File Information Entry.
Length of mail information entry. The size, in bytes, of the mail information entry. For information on the format of a mail information entry, see Mail Information Entry.
Length of PDF spooled file information. The size, in bytes, of the PDF spooled file information entry. For information on the format of a spooled file information entry, see PDF Spooled File Information Entry.
Length of PDF stream file information. The size, in bytes, of the PDF stream file information entry. This identifies the path where PSF/400 has written the PDF stream file. For information on the format of a stream file entry, see PDF Stream File Information Entry.
Offset to AFPDS spooled file information. The offset, in bytes, from the beginning of the PMAP0100 format structure, to an AFPDS Spooled File Information entry. If this value is 0, an AFPDS Spooled File Information entry is not specified.
Offset to mail information entry. The offset, in bytes, from the beginning of the PMAP0100 format, to a Mail information entry.
Offset to PDF spooled file information. The offset, in bytes, from the beginning of the PMAP0100 format, to a Spooled File Information entry.
Offset to PDF stream file information. The offset, in bytes, from the beginning of the PMAP0100 format, to a PDF Stream File Information entry.
Reserved - initalized to null. A reserved field.
Segmented entry. Indicates whether an entry is a segment. Segmented entries are for AFPDS spooled file that is divided into multiple PDF files. The division would be based upon the use of the STRPAGGRP DDS keyword, the Toolbox APIs, or sucs products as as Infoprint Server.
The following values are used:
| '0' |
The entry is not a segment. |
| '1' |
The entry is a segment. |
If the segmented entry indicator is not specified, then 0 is assumed (entry is not segmented).
Text description. A brief description of the PDF Map entry.
Mail Information Entry
Information in this table should be filled in when e-mail is being requested for a PDF map. If e-mail is not being requested, the length of mail information and offset to mail information fields above should be set to 0. For more details about the fields in the following table, see Mail Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to message text |
| 4 | 4 | BINARY(4) | Length of message text |
| 8 | 8 | BINARY(4) | Offset to subject |
| 12 | C | BINARY(4) | Length of subject |
| 16 | 10 | BINARY(4) | CCSID of message text and subject |
| 20 | 14 | BINARY(4) | Offset to ReplyTo e-mail address |
| 24 | 18 | BINARY(4) | Length of ReplyTo e-mail address |
| 28 | 1C | BINARY(4) | Offset to TO e-mail address entries |
| 32 | 20 | BINARY(4) | Number of TO e-mail address entries |
| 36 | 24 | BINARY(4) | Length of TO e-mail address entry |
| 40 | 28 | BINARY(4) | Offset to CC e-mail address entries |
| 44 | 2C | BINARY(4) | Number of CC e-mail address entries |
| 48 | 30 | BINARY(4) | Length of CC e-mail address entry |
| 52 | 34 | BINARY(4) | Offset to BCC e-mail address entries |
| 56 | 38 | BINARY(4) | Number of BCC e-mail address entries |
| 60 | 3C | BINARY(4) | Length of BCC e-mail address entry |
| 64 | 40 | BINARY(4) | Offset to Body of e-mail entries |
| 68 | 44 | BINARY(4) | Number of Body of e-mail entries |
| 72 | 48 | BINARY(4) | Length of Body of e-mail entry |
| 76 | 4C | BINARY(4) | Offset to attachment e-mail entries |
| 80 | 50 | BINARY(4) | Number of attachment e-mail entries |
| 84 | 54 | BINARY(4) | Length of attachment e-mail entry |
| 88 | 58 | BINARY(4) | Offset to TO e-mail stream file |
| 92 | 5C | BINARY(4) | Length of TO e-mail stream file |
| 96 | 60 | BINARY(4) | Offset to CC e-mail stream file |
| 100 | 64 | BINARY(4) | Length of CC e-mail stream file |
| 104 | 68 | BINARY(4) | Offset to BCC e-mail stream file |
| 108 | 6C | BINARY(4) | Length of BCC e-mail stream file |
| 112 | 70 | BINARY(4) | Offset to PDF file for e-mail |
| 116 | 74 | BINARY(4) | Length of PDF file for e-mail |
| 120 | 78 | CHAR(10) | Mail Sender |
| 130 | 82 | CHAR(10) | User password |
| 140 | 8C | CHAR(10) | Owner password |
| 150 | 96 |
CHAR(1) |
Encryption level |
| 151 | 97 |
CHAR(1) |
Print PDF file |
| 152 | 98 |
CHAR(1) |
Copy PDF file |
| 153 | 99 |
CHAR(1) |
Change PDF file |
| 154 | 9A |
CHAR(1) |
Change Comments in PDF file |
| 155 | 9B |
CHAR(1) |
Content Access to PDF file |
| 156 | 9C |
CHAR(1) |
Assemble Access to PDF file |
|
157 |
9D | CHAR(16) | Reserved - initialized to null |
|
173 |
AD |
CHAR(1) | Use stream file for TO e-mail address entries |
|
174 |
AE |
CHAR(1) | Use stream file for CC e-mail address entries |
|
175 |
AF |
CHAR(1) | Use stream file for BCC e-mail address entries |
|
176 |
B0 | CHAR(80) |
Reserved - initialized to null |
Mail Information Entry Field Descriptions
Assemble access in PDF file. This field is applicable only for an Encryption Level of *128RC4. Specifies whether users have assemble access to the PDF file.
The following values are used:
|
'0' |
Users do not have assemble authority to the PDF file. |
|
'1' |
Users have assemble authority to the PDF file. They can insert, delete, and rotate pages, and create bookmarks and thumbnails. |
CCSID of message text and subject. The CCSID associated with the message text and subject, if specified.
| 0 | Use the job's default CCSID. |
| ccsid-value | Specifies the CCSID. Values are in the range 1 to 65533. |
This field is used only when an SMTP mail server is specified in your PSF configuration object and must be set to zero otherwise.
This CCSID will be used to convert the data to Unicode for inclusion within the e-mail. The receiver of the e-mail may have to have the receiving e-mail program configured for the appropriate character set to be able to view the e-mail correctly.
Change Comments in PDF file. This field is applicable for Encryption levels *40RC4 and *128RC4. Specifies whether users are allowed to add or change comments (annotations) or form fields in the PDF file.
The following values are used:
|
'0' |
The user is not allowed to change comments and fill in form fields. |
|
'1' |
The user is allowed to change comments and fill in form fields. |
Change PDF file. This field is applicable for Encryption levels *40RC4 and *128RC4. The definition is different for the type of Encryption level.
For an Encryption level of *40RC4, Change PDF file specifies whether users are allowed to change the document, or to prevent them from creating form fields, as well as making any other changes.
When the Encryption level is *40RC4, the following values are used:
|
'0'
|
The user is not allowed to change the PDF file. |
|
'1'
|
The user is allowed to change the PDF file. |
For an Encryption level of *128RC4,
Change PDF file specifies the types of changes
which are allowed for the PDF file.
When the Encryption level is *128RC4,
the following values are used:
|
'0'
|
The user is not allowed to change the PDF file. |
|
'1'
|
The user is allowed document assemply to let user's insert delete, rotate pages, and create bookmarks and thumbnails. |
Content Access to PDF file. Specifies whether content accessibility for the visually impaired is enabled for the PDF file.
This field is applicable only for an Encryption Level of *128RC4.
The following values are used:
|
'0' |
Content accessibility for the visually impaired is disabled in the PDF file. . |
|
'1' |
Content accessibility for the visually impaired is enabled in the PDF file.. |
Copy PDF file. Specifies whether users are allowed to copy or extract text and graphics. Also specifies whether the accessibility interface is disabled.
This field is applicable for Encryption levels *40RC4 and
*128RC4.
The following values are used for Copy PDF file:
|
'0' |
The user is not allowed to copy and extract text and graphics in the PDF file. The accessibility interface is disabled. |
|
'1' |
The user is allowed to copy and extract text and graphics in the PDF file. The accessibility interface is enabled. |
Encryption level. The encryption level for the PDF file.
The following values are used for the encryption level:
|
'0' |
The file is not encrypted. |
|
'1' |
The PDF file is created with the 40-bit RC4 encryption level. This level of encryption has a lower level of security that is compatible with Adobe Acrobat Reader 3.X, 4.X, and 5. |
|
'2' |
The PDF file is created with the 128-bit RC4 encryption level. This level of encryption is has a higher level of security but is only compatible with Adobe Acrobat 5. |
Length of attachment e-mail entry. The size, in bytes, of each entry used for naming an e-mail attachment. Use one entry for each stream file. The entries must be concatenated, as in an array. For information on the format of a stream file entry, see Stream File Entry.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Length of BCC e-mail address entry. The size, in bytes, of each E-mail Address entry used for the BCC of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
Use stream file for BCC e-mail address entries should be set to '0'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Length of BCC e-mail stream file. The size, in bytes, of the Stream File entry which lists the BCCs used for an e-mail. For information on the format of an e-mail addresses entry, see Stream File Entry.
Use stream file for BCC e-mail address entries should be set to '1'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Length of Body of e-mail entry. The size, in bytes, of each entry used for naming a stream file placed into the body of the e-mail. Use one entry for each stream file. The entries must be concatenated, as in an array. For information on the format of a stream file entry, see Stream File Entry.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Length of CC e-mail address entry. The size, in bytes, of each E-mail Address entry used for the CC of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
Use stream file for CC e-mail address entries should be set to '0'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Length of CC e-mail stream file. The size, in bytes, of the Stream File entry containing the stream file which lists the CCs used for an e-mail. For information on the format of a stream file entry, see Stream File Entry.
Use stream file for CC e-mail address entries should be set to '1'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Length of message text. The size, in bytes, of the message text that getsplaced into the body of the e-mail.
If the length of the message text is 0, then the default message text is obtained from message PQT4133 in message file QPQMSGF.
If you do not want messsage text in the e-mail, specify a value of *NONE at the offset to message text and a value of 5 for the length of the message text.
Length of PDF file for e-mail The size, in bytes, of a File Name Entry. This identifies the name to be used for the PDF file produced from a spooled file, that is attached to an e-mail. For information on the format of a file name entry, see File Name Entry.
Length of ReplyTo to e-mail address. The size, in bytes, of an E-mail Address entry used for the ReplyTo of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
The following special values can be used for the ReplyTo e-mail address:
| *MAILSENDER | Replies will be sent to the FROM e-mail address. |
Length of subject. The size, in bytes, of the text that is used for the subject of the e-mail.
If the length of the subject is 0, then the default subject is obtained from message PQT4133 in message file QPQMSGF.
Length of TO e-mail address entry. The size, in bytes, of each E-mail Address entry used for the TO of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
Use stream file for TO e-mail address entries should be set to 0.
The following special values can be used for the TO e-mail address entry:
| *SPLF | The e-mail address to be used is specified as an attribute of the spooled file (USRDFNDTA('MAILTAG(e-mail-address)'). You can only specify one e-mail address on the USRDFNDTA parameter. The e-mail address can also be specified on the STRPAGGRP DDS keyword (group name). |
Length of TO e-mail stream file. The size, in bytes, of the Stream File entry containing the stream file which lists the TOs used for an e-mail. If the stream file name is surrounded by quotes, use all characters within the quotes as the stream file name. For information on the format of an e-mail addresses entry, see Stream File Entry.
Use stream file for TO e-mail address entries should be set to
'1'.
Mail Sender. The user profile from whom the e-mail is being sent.
The following special values can be used for the mail sender:
| *PSFCFG | The mail sender specified on the PSF configuration object will be used for the mail sender. |
Number of attachment e-mail entries. The number of stream files to be attached to the e-mail. This value does not include the spooled file converted to PDF.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Number of BCC e-mail address entries. The number of BCC e-mail addresses to be used for sending an e-mail.
Use stream file for BCC e-mail address entries should be set to
'0'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Number of Body of e-mail entries. The number of stream files to be placed into the body of the e-mail.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Number of CC e-mail address entries. The number of CC e-mail addresses to be used for sending an e-mail.
Use stream file for CC e-mail address entries should be set to
'0'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Number of TO e-mail address entries. The number of TO e-mail addresses to be used for sending an e-mail.
Use stream file for TO e-mail address entries should be set to
'0'.
This field is used only when an SMTP mail server is specified in your PSF configuration object.
Offset to attachment e-mail entries. The offset, in bytes, from the beginning of the PMAP0100 format structure, to a list of attachment entries.
If this value is 0, a list of attachment entries is not specified.Offset to BCC e-mail address entries. The offset, in bytes, from the beginning of the PMAP0100 format structure, to a list of BCC e-mail address entries. This area contains the BCC e-mail addresses to which the PDF file is sent.
If Use stream file for BCC e-mail address entries is set to
'1', then this value will be 0.
Offset to BCC e-mail stream file. The offset, in bytes, from the beginning of the PMAP0100 format structure, to a file name which contains a list of BCC e-mail address entries.
If Use stream file for BCC e-mail address entries is set to
'0', then this value will be 0.
Offset to Body of e-mail entries. The offset, in bytes, from the beginning of the PMAP0100 format structure, to a list of Stream file entries.
If this value is 0, a list of Stream file entries is not specified.Offset to CC e-mail address entries. The offset, in bytes, from the beginning of the PMAP0100 format structure, to a list of CC e-mail address entries. This area contains the CC e-mail addresses to which the PDF file is sent.
If Use stream file for CC e-mail address entries is set to
'1', then this value will be 0.
Offset to CC e-mail stream file. The offset, in bytes, from the beginning of the PMAP0100 format structure, to a file name which contains a list of CC e-mail address entries.
If Use stream file for CC e-mail address entries is set to
'0', then this value will be 0.
Offset to message text. The offset, in bytes, from the beginning of the PMAP0100 format, to the message text which gets placed in to the body of the e-mail.
If this value is 0, message text is not specified.
If you do not want messsage text in the e-mail, specify a value of *NONE at the offset to message text and a value of 5 for the length of the message text.
Offset to subject. The offset, in bytes, to the subject of the e-mail. If this value is 0, a subject is not specified.
Offset to PDF file for e-mail The offset, in bytes, from the beginning of the PMAP0100 format, to the PDF File For E-mail Entry.
Offset to ReplyTo e-mail address. The offset, in bytes, from the beginning of the PMAP0100 format, to the E-mail ddress Entry for a ReplyTo e-mail address. If this value is 0, a ReplyTo e-mail address is not specified.
Offset to TO e-mail address entries. The offset, in bytes, from the beginning of the PMAP0100 format, to to a list of TO e-mail address entries. This area contains the TO e-mail addresses to which the PDF file is sent.
Offset to TO e-mail stream file. The offset, in bytes, from the beginning of the PMAP0100 format, to a file name which contains a list of TO e-mail address entries.
If Use stream file for TO e-mail address entries is set to 0, then this value will be 0.
Owner password. The owner password associated with the PDF file to be created.
This field is applicable for Encryption levels *40RC4 and *128RC4.
The following can be used for the owner password:
| *NONE | No owner password is specified for the PDF file. |
| owner-password | A owner password is specified for the PDF file. The password is encrypted. |
Print PDF file. This field is applicable for Encryption levels *40RC4
and
*128RC4. The definition is different for the type of Encryption level.
For an Encryption level of *40RC4, Print PDF file specifies whether users are allowed to print the PDF file.
When the Encryption level is *40RC4, the following values are used:
|
'0' |
The user is not allowed to print the PDF file. |
|
'1' |
The user is allowed to print the PDF file. |
For an Encryption level of *128RC4, Print PDF file specifies print options for the PDF file.
When the Encryption level is *128RC4, the following values are used:
|
'0' |
The user is not allowed to print the PDF file. |
|
'1' |
The user is not allowed to print the PDF file. |
|
'2' |
The user is only allowed to print at a low resolution (image). This prevents the user from recreating the PDF file with different security settings. Printing may be slower because each page will be printed as a bit-mapped image. |
Use stream file for BCC e-mail address entries. Indicates if a stream file containing BCC e-mail addresses is being used.
The following values are used:
|
'0' |
A stream file for BCC e-mail address entries is not being used. |
|
'1' |
A stream file for BCC e-mail address entries is being used. |
Use stream file for CC e-mail address entries. Indicates if a stream file containing CC e-mail addresses is being used.
The following values are used:
|
'0' |
A stream file for CC e-mail address entries is not being used. |
|
'1' |
A stream file for CC e-mail address entries is being used. |
Use stream file for TO e-mail address entries. Indicates if a stream file containing TO e-mail addresses is being used.
The following values are used:
|
'0' |
A stream file for TO e-mail address entries is not being used. |
|
'1' |
A stream file for TO e-mail address entries is being used. |
User password. The user password associated with the PDF file to be created.
This field is applicable for Encryption levels *40RC4 and *128RC4.
The following can be used for the user password:
| *NONE | No user password is specified for the PDF file. |
| user-password | An user password is specified for the PDF file. The password is encrypted. |
E-mail Address Entry
This table is used for mapping the TO, CC, BCC and ReplyTo e-mail addresses. For more details about the fields that can be used with the following table, see E-mail Address Entry Field Description.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(80) | E-mail address |
E-mail Address Entry Field Description
E-mail address. An e-mail address.
For the TO e-mail address, the following special value can be specified:
| *SPLF | Specifies that the e-mail address is specified as an attribute of the spooled file on the USRDFNDTA parameter in the format USRDFNDTA('MAILTAG(e-mail address)'). You can only specify one e-mail address on the USRDFNDTA parameter. The e-mail address can also be specified in the spooled file with the STRPAGGRP DDS keyword (group name). |
Stream File Entry
This table is used for mapping the stream files that can be used for the Body, Attachment, TO, CC, and BCC stream files. Use one entry for each stream file. If you are specifying a stream file for the Body, the file extension (for example, txt or htm) must be specified in lower case. Otherwise, the file will be sent as an attachment. If necessary, the field is padded with blanks (X'40'). For more details about the fields that can be used with the following table, see Stream File Entry Field Description.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(255) | Stream file name |
Stream File Entry Field Description
Stream file name. A path-qualified stream file name.
File Name Entry
This table is used for specifying a file name that is not path-qualifed. Use this entry for specifying a PDF file for e-mail entry. This will be the name of the attachment for the PDF file (original spooled file) that is included in the e-mail. For more details about the field that can be used with the following table, see File Name Entry Field Description.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(80) | File name |
File Name Entry Field Description
File name. A file name which does not contain path information.
PDF Stream File Information Entry
For more details about the fields in the following table, see PDF Stream File Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to PDF file name |
| 4 | 4 | BINARY(4) | Length of PDF file name |
| 8 | 8 | CHAR(10) | Public Authority |
| 18 | 11 | CHAR(2) | Reserved |
PDF Stream File Information Entry Field Descriptions
Length of PDF file name. The size, in bytes, of the Stream File entry which contains the PDF file name. For information on the format of a Stream File entry, see Stream File Entry.
Offset to PDF file name. The offset, in bytes, from the beginning of the PMAP0100 format, to the Stream File entry for a PDF file.
Public Authority. The public authority for the PDF stream file. The default is *EXCLUDE.
The following special values may be specified:
| *EXCLUDE | Users are excluded from accessing the object. |
| *NONE | Users do not have any of the data authorities to the objects. |
| *RWX | Users are given *RWX authority to perform all operations on the object except those limited to the owner or controlled by object existence, object management, object alter, and object reference authority. Users can change the object and perform basic functions on the object. *RWX authority provides object operational authority and all the data authorities. |
| *RX | The users are given *RX authority to perform basic operations on object, such as run a program or display the contents of a file. The user is prevented from changing the object. *RX authority provides object operational authority and read and execute authorities. |
| *RW | The users are given *RW authority to view the contents of an object and change the contents of an object. *RW authority provides object operational authority and data read, add, update, and delete authorities. |
| *WX | Users are given *WX authority to change the contents of an object and run a program or search a library or directory. *WX authority provides object operational authority and data add, update, delete, and execute authorities. |
| *R | Users are given *R authority to view the contents of an object. *R authority provides object operational authority and data read authority. |
| *W | Users are given *W authority to change the contents of an object. *W authority provides object operational authority and data add, update, and delete authorities. |
| *X | users are given *X authority to run a program or search a library or directory. *X authority provides object operational authority and data execute authority. |
PDF Spooled File Information Entry
These fields are used for mapping the PDF spooled file information. If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the following table, see PDF and AFPDS Spooled File Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Output queue name for output spooled file |
| 10 | A | CHAR(10) | Output queue library name for output spooled file |
| 20 | 14 | CHAR(10) | Spooled file name for output spooled file |
| 30 | 1E | CHAR(10) | User data for output spooled file |
| 40 | 28 | CHAR(10) | Form type for output spooled file |
| 50 | 32 | CHAR(255) | User defined data for output spooled file |
| 305 | 13B | CHAR(3) | Reserved |
AFPDS Spooled File Information Entry
These fields are used for mapping the AFPDS spooled file information. If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the following table, see PDF and AFPDS Spooled File Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Output queue name for output spooled file |
| 10 | A | CHAR(10) | Output queue library name for output spooled file |
| 20 | 14 | CHAR(10) | Spooled file name for output spooled file |
| 30 | 1E | CHAR(10) | User data for output spooled file |
| 40 | 28 | CHAR(10) | Form type for output spooled file |
| 50 | 32 | CHAR(255) | User defined data for output spooled file |
| 305 | 13B | CHAR(3) | Reserved |
PDF and AFPDS Spooled File Information Entry Field Descriptions
Form type for output spooled file. The type of forms that should be loaded on the printer before this spooled file is printed. This is the value which will be used when a file is spooled.
The following special values can be used for the form type for output spooled file:
| *SPLF | The form type of the original spooled file will be used. |
Output queue library name for output spooled file. The name of the library where the output queue for the file which will be spooled resides.
Output queue name for output spooled file. The name of the output queue to which the file to be spooled will be written.
The following special values can be used for the form type for output queue name for output spooled file:
| *PSFCFG | The output queue specified in the PSF configuration object will be used when writing the PDF file to spool. |
Spooled file name for output spooled file. The name which will be used for the file that gets spooled.
The following special values can be used for the spooled file name for output spooled file:
| *SPLF | The name of the original spooled file will be used. |
User data for output spooled file. The user-specified data which will describe the file to be spooled.
The following special values can be used for the user data for output spooled file:
| *SPLF | The user data of the original spooled file will be used. |
User defined data for output spooled file. The user-defined data that will be used for the file to be spooled.
The following special values can be used for the user defined data for output spooled file:
| *SPLF | The user defined data of the original spooled file will be used. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPD0172 D | Parameters passed on CALL do not match those required. |
| CPF5F00 E | Add type &1 is not valid. |
| CPF5F01 E | Length of PDF map entry spooled file attributes is not valid. |
| CPF5F02 E | Length of PDF mapping action is not valid. |
| CPF5F03 E | Value of length, offset, or number in parameter list is not valid. |
| CPF5F04 E | Entry is already in the PDF Map object. |
| CPF5F05 E | No e-mail address specified with mail information. |
| CPF5F06 E | No PDF mapping action was specified for entry. |
| CPF5F07 E | Invalid value &2 specified in PDF map action. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9999 E | Function check. &1 unmonitored by &2 at statement &5, instruction &3. |
API introduced: V5R3
| Top | Print APIs | APIs by category |