| This parameter contains 7 elements: |
| Protect PDF File with a Password | Determines whether the document will be protected with a password or not.
Options: | *NO | The PDF file will not be protected with a password and the editing options are not limited. | | *YES | The document will be protected with a password. To open the document at least a user password is required. | | *EXITPGM | The passwords and other security information will be provided when an exit program is run, which creates a CS_PWD01 option structure. | | *RESTRICT | No password is required to open the file, but one or more actions (print, modify, annotate, or copying of text) will be restricted. | | *PWD40BIT | Same as *YES. | | *PWD128BIT | Same as *YES, but uses 128-bit encryption (Adobe Standard Revision 3). | | *RST40BIT | Same as *RESTRICT. | | *RST128BIT | Same as *RESTRICT, but uses 128-bit encryption (Adobe Standard Revision 3). |
|
| User Password | The second element is the user’s password. If *YES is specified for the previous element, a user password must be entered (cannot be left blank). If *RESTRICT is specified for the previous element, a user password may not be entered (as *RESTRICT indicates that the file should have restricted access rights without a password). The password can be any string of characters and numbers. The minimum length is 1 character and the maximum is 32. The password is case-sensitive. |
| Owner Password | The third element is the owner’s password. If no owner password is entered (i.e. it is left blank), the document will not have an owner password. This means that it will not be possible for anyone to perform any restricted actions according to the user rights defined in the following parameters. If *RESTRICT is specified for the first element, an owner password may not be entered (as *RESTRICT indicates that the file should have restricted access rights without a password). The owner password can be any string of characters and numbers. The minimum length is 1 character and the maximum is 32. The password is case-sensitive. Please note that if *EXITPGM is specified with the first element of this parameter, any value typed for the user or owner password in the second and third elements of this parameter are only used if the exit program returns blanks for the corresponding password. | Character Value | Specify the owner’s password. |
|
| Action Description | The remaining four elements of this parameter control the rights granted when the document is opened by entering the user password. These are: | Allow printing? | | Allow modifications? | | Allow copying of text? | | Allow annotation? |
These elements have the following values: | *NO | Not allowed. | | *YES | Allowed. |
|
| |
| SPLIT | The SPLIT parameter can create several stream files from a single spooled file; splitting the spooled file based on criteria specified by i-effect in the SPLITPAGE, SPLITPOS, and/or SPLITKEY parameters.
This option can be useful if a program produces a single spooled file, which has traditionally been split up into separate pages or groups of pages prior to distribution on paper.
i-effect can split the spooled file after a certain number of pages, when a specified key string appears in the spooled file, or when an area of the page changes or meets predefined criteria.
i-effect generates names for the created stream files by appending a sequential number to the part of the stream file name specified in the OUTPFILE parameter preceding any file extension. For example, if
CODE
OUTPFILE(invoice.pdf)
is specified and an option other than SPLIT (*NONE), i-effect will create stream files called invoice1.pdf, invoice2.pdf, invoice3.pdf, etc.
Each stream file can be named more appropriately to its contents (e.g. naming it after the customer to whom it relates); this can be achieved by means of an exit program. The customer number or name should be extracted from the spooled file and passed to the exit program as a parameter. The following options are possible: - Call the exit program before the stream file is created (i.e. at the*STMFSTR exit point) and override the stream file name by generating an option structure of type CS_STM01. OR
- Call the exit program after the stream file has been created (i.e. at the *STMFEND exit point) and rename the stream file by calling a command such as REN.
This parameter contains 3 elements: Split Based On | This element determines the criteria used to split he spooled file. | *NONE | The spooled file will not be split. A single output file is created. | | *PAGE | Splits the spooled file into separate output files every certain number of pages. This option is useful if, for example, to create separate stream files for each customer in the report, and the section of the report relating to a single customer is always on fixed page number. | | *KEY | Splits the spooled file into separate stream files every time a given key string appears in the spooled file. This option can be useful if, for example, to split the report every time a piece of text (e.g. a field label such as Customer number) appears in the report. This method can also be used to identify split points by checking the value of the text at a particular area of the spooled file, where that text is located by means of its of offset position from a specified key string. For example, if the string ‘Customer Number’ precedes the customer number in the spooled file, ‚Customer Number‘ can be used as the key string to locate the customer number on the page, and then changes to the customer number can be used as the trigger for the creation of a new PDF. The exact splitting criteria must be entered in the SPLITKEY parameter. | | *POS | Splits the spooled file into separate stream files based on the text value in the spooled file at a specified position on the page. The position is identified by means of coordinates down the page from top to bottom or line numbers and coordinates across the page from left to right or column numbers. The exact criteria must be entered in the SPLITPOS parameter. | | *POSKEY | A combination of positional and key splitting criteria will be used. The exact splitting criteria must be entered in the SPLITKEY and SPLITPOS parameters. | | *PAGGRP | The spooled file will be split every time a new page group is started. Page groups can be defined in the spooled file by means of the DDS PAGGRP keyword. |
| | Splitting Method | The second element of the SPLIT parameter determines if the split should occur before or after the split point. | *BEFORE | The spooled file is split before the split point. The page, on which the split point occurs, will become the first page of the new output file. This option is typically used where the text, which triggers the creation of a new stream file, occurs in a heading at the start of the new section of the spooled file, i.e. the trigger identifies the start of a new section. | | *AFTER | The spooled file is split after the split point. The page, on which the split point occurs, will be the last page prior to the start of a new output file. This option is typically used where the text, which triggers the creation of a new stream file, occurs in a footing at the end of the previous section of the spooled file, i.e. the trigger identifies the end of the section. Please note: each stream file must consist of at least one complete page. i-effect cannot split single pages into more then one file. |
| | Index Separator Character | The third element of the SPLIT parameter determines the separator character, if any, that is inserted between the body of the file name specified in the OUTPFILE parameter (i.e. the name prior to the extension) and the numerical suffix, which i-effect appends to that name to create a file name for each stream file generated.
Possible Values: | *NONE | No separator will be used. | | *UNDERSCORE | The underscore character will be used. | | Zeichenwert | Specify any other character allowed in the file name. |
|
|
| Split after n Pages (SPLITPAGE) | When SPLIT (*PAGE) is specified to indicate that the spooled file should be split into separate output files every so many pages, this parameter allows the specification of the number of pages, after which i-effect will create a new output file. | 1 | A new output file will be created for each page. | | Number | Determines the number of pages, after which a new output file will be created. |
|
| Split Spooled File at Specific Position (SPLITPOS) | This parameter can locate an area of the spooled file on the page by means of coordinating down the page from top to bottom and across the page from left to right, or by line number and column position. Comparisons can be made of the text value at the position in the spooled file located there and then used to control the splitting of the spooled file.
Special Values: | *NONE | No search criteria are specified. | | Other Values | (Up to 100 repetitions) |
This parameter contains 6 elements: | Line Number or Y-Coordinate | The line number or y-coordinate (from top to bottom) where the page area, which will be checked, is located. It is specified in either column, inches, or millimeters, depending on the value of the measurement method option below. | 0 | The default is 0. | | 0.0-999.999 | Specify the line number of the y-coordinate. |
| | Column Number or X-Coordinate | The column number or x-coordinate (from left to right) where the page area, which will be checked, is located. It is specified in either columns, inches, or millimeters, depending on the value of the measurement method option below. | 0 | The default is 0. | | 0.0-999.999 | Enter the column number of the x-coordinate. |
| | Length | The length of the specified area. The area is either given in columns, inches, or millimeters, depending on the indicated measurement below. | 1 | The default is1. | | 0.001-999.999 | Enter the length of the area. |
| | Measurement Method | The fourth element is the measurement unit, which will be used for the preceding elements. | *ROWCOL | Rows and Columns Use DSPSPLF as a guide. Ensure that TEXT (*CPI) has been defined if CVTSPL is being used. | | *INCH | Inches | | *CM | Centimeters | | *MM | Millimeters |
| | Comparison | A comparison operator. The type of comparison to be performed on the area of the spooled file identified by the preceding parameters can be indicated here. | *NE | Not equal to. | | *EQ | Equal to. | | *GT | Greater than. | | *LT | Less than. | | *GE | Greater than or equal to. | | *LE | Less than or equal to. | | *CT | Contained in, i.e. the string specified appears somewhere in the identified area. | | *NC | Not contained in, i.e. the string specified does not appear somewhere in the area identified. |
| | Character String to be compared | The sixth element is the string, against which the area of the spooled file selected should be compared, as defined with comparison operator in the preceding parameter. Any string may be specified. | *PRV | The default value is the special value *PRV, which denotes the previous value at the same location. | | Character Value | The string, which will be used for comparison. |
|
|
| Split with Key Options (SPLITKEY) | This parameter has two related functions.
The first function specifies a key string, which will trigger the creation of a new stream file every time it appears in the spooled file.
The second function locates an area of the spooled file on the page by means of an offset position from the given key string. Comparisons can performed on the value of the text at the position in the spooled file located there and then used to control the splitting of the spooled file.
Special Values: | *NONE | These criteria will not be defined. | | Other Values | (Up to 100 repetitions) |
This parameter has 8 elements: | Key String used for Splitting | The first element is the key string itself. | Character Value | Specify the desired key string. This is case-sensitive and should be enclosed in single quotes if a lower-case or mixed-case value is required. |
| | Split with Key Method | The way in which the key string is handled. | *ALWAYS | Splitting will occur every time the key string is located on a page. | | *IF | Uses the key string to locate an area of the spooled file and then conditionally split the spool based on performing a comparison of the text at that position. |
The remaining elements only apply if *IF was entered in the second element of the SPLITKEY parameter.
| | Offset | Depending on the value specified for the „Measurement Method“ below, enter either the length of the value to check in characters (*ROWCOL) or in measurement units on the page (*MM, *CM or *INCH). This value can be negative (the area is located left of the character string) or positive (the area is located right of the character string). | 0 | The default offset is 0. | | -999.999 - 999.999 | Enter the offset of the start of the area to check. |
| | Length | Depending on the value specified for the „Measurement Method“ below, enter the offset in either characters (*ROWCOL) or measurement units (*MM, *CM, *INCH) from the start of the key string to the start of the text to be checked for splitting purposes. | 1 | The default is1. | | 0.0-999.999 | Enter the length of the area. |
| | Measurement Method | The units, in which the previous elements are specified. | *ROWCOL | Rows and Columns Use DSPSPLF as a guide. Ensure that TEXT (*CPI) has been defined if CVTSPL is being used. | | *INCH | Inches | | *CM | Centimeters | | *MM | Millimeters |
| | Comparison | A comparison operator. The type of comparison to be performed on the area of the spooled file identified by the preceding parameters can be indicated here. | *NE | Not equal to. | | *EQ | Equal to. | | *GT | Greater than. | | *LT | Less than. | | *GE | Greater than or equal to. | | *LE | Less than or equal to. | | *CT | Contained in, i.e. the string specified appears somewhere in the identified area. | | *NC | Not contained in, i.e. the string specified does not appear somewhere in the area identified. |
| | Character String for Comparison | The string, against which the area of the spooled file selected should be compared, using the comparison operator specified in the preceding parameter. Any string may be specified. | *PRV | The default value is the special value *PRV, which denotes the previous value at the same location. | | Character Value | The string, which will be used for comparison. |
| | Specifies whether blank values should be ignored if * PRV is tested. | *NO | Empty values are not ignored. | | *YES | Empty values are ignored. The comparison is made with the previous non-blank value and only entered values are checked. |
| | Logical connection to the next test | Logical relationship to the next, specified in this parameter examination. | *OR | is an OR operation between the conditions. The separation takes place, if this condition or set of conditions is true OR if the following condition or group of conditions is true. A set of conditions begins with a new * OR condition and consists of one or more
Conditions, between which a * AND operation is. | | *AND | is an AND operation between the conditions. The separation takes place, if this condition or group of conditions is true AND the subsequent condition or set of conditions is true. A set of conditions begins with a new * OR condition and consists of one or more
Conditions, between which a * AND operation is. another. |
|
|
| Exit Program (EXITPGM) | In this parameter up to 100 user-written exit programs can be specified, which i-effect will call at various different predefined exit points within the i-effect processing cycle.
When multiple programs are defined at the same exit point, i-effect will call them in the order in which they are listed on the parameter.
Special Values: | *NONE | No exit programs will be called up. | | *VAR | Specifies that no exit programs, but the EXIT PGM PARM, EXITPGMPOS and / or the EXITPGMKEY parameters to be used to define variables that are to be extracted from the spool file and to the name of the i-effect variables to be referenced. i-effect variables% EXITPGMPOSn:> (where n = 1-99) or <: EXITPGMKEYn:> (won = 1-99). | | Other Values | (Up to 100 possible) |
This parameter contains 3 elements: | Programm | Qualifier 1:
Programm
| | Name | Enter the name of the program, which should be called up. |
| Qualifier 2:
Bibliothek | | *LIBL | Use the library list of the job to locate the program. | | *CURLIB | The exit program exists in the current library of the job. | | Name | Specify the library in which the exit program is located. |
|
| | Parameter format | This element defines the parameters that are passed to the exit program.
These parameters include a standard list parameter (such as the name of the spool and stream file) as well as from the spool file extracted customizable exit program parameters whose values resulting from the settings in the EXITPGMPRM, EXITPGMPOS and EXITPGMKEY parameters.
It is crucial that you choose a value for this element according to the expected from invoked exit program parameter list, otherwise errors occur due to improper parameters between caller and currently activated program. | *TYPE3 | This is the recommended format for future development. | | *TYPE2 | If for reasons of backwards compatibility! For multiple values can be passed to exit Program. | | *TYPE1 | If for reasons of backwards compatibility! Thus a value is passed to exit Program |
| | Exit Point | The processing point at which the program will be selected. These exit points are discussed in detail in Chapter. 13 | *SPLFSTR | Start the spool file. This is the first callable exit point and it is called only once. It is especially suitable for calling initialization. | | *SPLFEND | End of the spool file. This is the last callable exit point and it is called only once. It is especially suitable for calling variables management routines. | | *STMFSTR | Start the stream file. This exit point is called once before the start of production of each stream file. If you divide a single spool file into multiple stream files, this exit point is ever called once for each stream file to be created. This point is especially suitable for overwriting characteristics of the data stream file to be created, such as name and password. | | *STMFEND | The end of the stream file. This exit point is called once after completion of the production of each stream file. If you divide a single spool file into multiple stream files, this exit point is ever called once for each created data stream file. This point is especially suitable for things like renaming, moving or revising the data stream file you just created. | | *PAGECTL | Sideguided (Page control). This is a special exit point, which is provided to give an exit program the opportunity for each side to decide whether this page should appear in the output or not. | | *PAGESTR | Start the page. Called for each page before the page's data to convert. | | *PAGEEND | Bottom of this page. Called for each page after the page's data are converted. |
|
|
| Exit Program Parameters (EXITPGMPRM) | It can be defined in this parameter if i-effect should pass any user-definable parameter strings to the exit program(s) defined on the EXITPGM parameter, and, if so, on what basis.
If EXITPGM(*VAR) is specified, no exit programs will be called but you can use the EXITPGMPOS parameter for the purposes of defining i-effect variables that are to be extracted from the spooled file and referred to through the i-effect variable names %EXITPGMPOSn$ (where n = 1-99) or %EXITPGMKEYn% (where n = 1-99).
Further information about writing and calling exit programs can be found in chapter 13. This parameter contains 2 elements: | Parameter Type | | *NONE | No user-definable parameters are required. | | *POS | The EXITPGMPOS parameter will be used to define one or more areas of the page from which text will be extracted and passed to the exit program(s) as user-definable parameters. | | *KEY | The EXITPGMKEY parameter will be used to define one or more areas of the page from which text will be extracted and passed to the exit program(s) as user-definable parameters. | | *POSKEY | Both the EXITPGMPOS and EXITPGMKEY parameters will be used to define one or more areas of the page from which text will be extracted and passed to the exit program(s) as user-definable parameters. |
| | CCSID of the Parameter Data | Determines the CCSID (Coded Character Set Identifier), which should be used when passing data to exit programs.
Some spooled files (notably those of type *USERASCII) will hold data internally in ASCII. If the data is passed in its original form, it may not be easy to process in an exit program. i-effect can convert this data to a user-friendlier CCSID (e.g. an EBCDIC CCSID) before passing it to the exit program. It must only be specified which CCSID is to be used. | *SPLF | The data is passed in its original form as extracted from the spooled file. | | *JOB | The CCSID of the current job will be used. | | *SYSVAL | The system‘s CCSID (QCCSID system value) will be used. | | *USER | The CCSID of the current user (from the user profile) is used. | | 1-65533 | Specify the CCSID in which the data should be passed. |
|
|
| Exit Progr.Param. String Pos. (EXITPGMPOS) | This parameter is used to define positions in the report from which i-effect will extract items of text and pass them as parameters to the exit program(s) specified in the EXITPGM parameter.
Further information about writing and calling exit programs can be found in chapter 13.
Special Values: | *NONE | No parameters of this kind are required. | | Other Values | (Up to 100 possible) |
This parameter contains 5 elements: | Page Number | The page number from which the text should be extracted.
i-effect will extract the text from the position on the page specified below and will pass it as a parameter to the exit program(s) defined by the EXITPGM parameter, but only for the page specified here.
Note that this is the page number from the output file, not the input file. For example, if i-effect splits a 10-page spooled file into two 5-page stream files, then a page number of 1 on this parameter would refer to the first page in the two stream files, i.e. pages 1 and 6 from the original spooled file.
If *ALL is specified, i-effect will pass the value at the specified location on each page in the output file. If the output file consists of 5 pages, 5 parameters will be passed, one for each page. | 1 | The data will only be extracted from the first page. | | *ALL | The data will be extracted from every page. | | 1-9999999 | Specify the page from which the data will be extracted. |
| | Line Number or Y-Coordinate | Depending on the value specified for the „Measurement Method“ below, enter either the line number on which the parameter text appears in the spooled file (*ROWCOL) or the vertical coordinate on the page at which the start of the text appears (measured in millimeters for *MM, centimeters for *CM or inches for *INCH). | 1 | The default is 1. | | 0.001-999.999 | Specify the line number of the y-coordinate. |
| | Column Number or X-Coordinate | Depending on the value specified for the „Measurement Method“ below, enter either the column number on which the parameter text appears in the spooled file (*ROWCOL) or the horizontal coordinate on the page at which the start of the text appears (measured in millimeters for *MM, centimeters for *CM or inches for *INCH). | 1 | The default is 1. | | 0.001-999.999 | Enter the column number of the x-coordinate. |
| | Length | Depending on the value specified for the „Measurement Method“ below, enter either the number of characters that the parameter text occupies in the spooled file (*ROWCOL) or the horizontal space it occupies on the page (measured in millimeters for *MM, centimeters for *CM or inches for *INCH). | 1 | The default is1. | | 0.001-999.999 | Enter the length of the area. |
| | Measurement Method | The units, in which the previous elements are specified. | *ROWCOL | Rows and Columns Use DSPSPLF as a guide. Ensure that TEXT (*CPI) has been defined if CVTSPL is being used. | | *INCH | Inches | | *CM | Centimeters | | *MM | Millimeters |
| | Variable name | Using this parameter, you can enter the data that has been extracted from the spool file, a name. | *NONE | a user-defined name is assigned to this variable. |
If you with: wish i-effect variable refer to this data element, you must use the following form:
<: EXITPGMPOSn:> (Where n is the ordinal number of the element from EXITPGMPOS parameters (1 element = 1, 2. element = 2, etc.). | var_name | Enter a variable name without the variable marker <: ..:> a,.
You must have a valid OS / 400 enter name. The maximum 20 characters.
You can refer to the data element with: i-effect variable by using the following form: <: var_name:> where var_name is the name specified here. |
|
|
Select Exit Program Parameters Using a Key String
(EXITPGMKEY) | Define key strings with this parameter, which CVTSPLSTMF will use as triggers for extracting text from the report to pass as parameters to the exit program(s), which were specified in the EXITPGM parameter. Special values: | *NONE | There were no such parameters required. | | Ather Values | (Up to 50 repetitions possible) |
Special Values:This parameter contains 6 elements:
| Page Number | i-effect will extract the text from the position on the page specified below and will pass it as a parameter to the exit program(s) defined on the EXITPGM parameter, but only for the page specified here.
Note: this is the page number from the output file, not the input file. For example, if i-effect splits a 10-page spooled file into two 5-page stream files, then a page number of 1 on this parameter would refer to the first page in the two stream files, i.e. pages 1 and 6 from the original spooled file.
If ALL is specified, i-effect will pass the value at the specified location on each page in the output file. If the output file consists of 5 pages, 5 parameters will be passed, one for each page. | 1 | The data will only be extracted from the first page. | | *ALL | The data will be extracted from every page. | | 1-9999999 | Specify the page from which the data will be extracted. |
| | Key String | The key string to check for. | character-value | Geben Sie hier die Schlüsselzeichenkette an, die die Auswahl von Parametertext auslöst. |
| | Occurrence | If the key string appears more than once on each page, the number entered in this element will determine which occurrence of the key string will trigger the selection of parameter text. | 1 | The first occurrence. | | 1-999 | Specify which occurrence of the key string to use. |
| | Offset | Depending on the value specified for the “Measurement Method” below, enter the occurence from the start of the key string to the start of the text to be checked, either in characters (*ROWCOL) or in measurement units on the page (*MM, *CM or *INCH). This value can be negative (the area is located left of the character string) or positive (the area is located right of the character string). | 0 | The default offset is 0. | | -999.999 - 999.999 | Enter the offset of the start of the area to check. |
| | Length | Depending on the value specified for the “Measurement Method” below, enter the length of the parameter text either in characters (*ROWCOL) or in measurement units on the page (*MM, *CM or *INCH). | 1 | The default is1. | | 0.0-999.999 | Enter the length of the area. |
| | Measurement Method | The units, in which the previous elements are specified. | *ROWCOL | Rows and Columns Use DSPSPLF as a guide. Ensure that TEXT (*CPI) has been defined if CVTSPL is being used. | | *INCH | Inches | | *CM | Centimeters | | *MM | Millimeters |
| | Variable name | With this parameter a string can be defined using CVTSPLPDF as a trigger to extract text from the report, which is as a parameter to exit programs that have been specified in the EXITPGM parameters passed.
If EXITPGM (* VAR) has been specified, any exit programs are called the EXITPGMKEY parameters can also be used to * SPOOL to define variables that are to be extracted from the spool file and referenced by the * SPOOL variable name% EXITPGMKEYn% to be (where n = 1-99, refers to the order in which the various parameters are defined in the EXITPGMKEY parameters).
| *NONE | These parameters are not required. |
|
|
| Type of PDF Bookmarks (BOOKMARK) | This parameter determines if PDF bookmarks (outlines) should be created and which type of bookmark should be created.
Bookmarks index a PDF file so that readers can go directly to a particular section of a document. Bookmarks make it quicker and easier for users to navigate around a document in PDF format.
Special Values: | *NONE | No bookmarks will be created. | | *PAGNBR | i-effect creates bookmarks based on page numbers in the document. Note: The text used to generate *PAGNBR bookmarks is held in message CVT0008 in the message file CS_MSGF. By default, it is set to “Page”. The text of this message can be modified, if desired. For example, if the company’s language is Spanish, the name could be changed to “Página”. If this is done, it will need to be changed every time a PTF is applied or an upgrade is made. | | *POSKEY (Nur für SPOOL+) | Defines bookmarks in both the BMARKPOS and BMARKKEY parameters and defines that both positional and key bookmarks will be created. | | *POS | Indicates that bookmarks will be defined in the BMARKPOS parameter and that i-effect should create bookmarks based on the text that appears at a particular position on each page of the report. | | *KEY | Indicates that bookmarks will be defined in the BMARKKEY parameter and that i-effect should create bookmarks based on text associated with a key word or phrase found in the report. | | *PAGIDXTAG | Bookmarks will be generated from page level document index tags, for example those included in the spooled file with the DDS DOCIDXTAG keyword with the tag level equal to PAGE. | | *GRPIDXTAG | Bookmarks will be generated from group level document index tags, for example those included in the spooled file with the DDS DOCIDXTAG keyword with the tag level equal to GROUP. | | *IDXTAG | Bookmarks will be generated from all document index tags, for example those included in the spooled file with the DDS DOCIDXTAG keyword with the tag level equal to GROUP or PAGE. |
|
| Position of the PDF Bookmark Strings (BMARKPOS) | This parameter determines the position, where the book-marked text regularly appears. By specifying BOOKMARK (*POS) and using this BMARKPOS parameter, a set of bookmarks can be created based on a piece of text that appears at a particular position on each page of the report. For example, if an item is of user interest – such as an order number, a customer name, or a product code – appears regularly at position 3 of line 4 on every page and is up to 20 characters long, a bookmark can be generated by specifying:
CODE
CVTSPLPDF FILE(SALES)
BOOKMARK(*POS)
BMARKPOS((4 3 20 *ROWCOL))
This parameter contains 4 elements: | Line Number or Y-Coordinate | Depending on the value specified for the „Measurement Method“ below, enter either the line number on which the parameter text appears in the spooled file (*ROWCOL) or the vertical coordinate on the page at which the start of the text appears (measured in millimeters for *MM, centimeters for *CM or inches for *INCH). | 0.001-999.999 | Enter the line number or vertical coordinate. |
| | Column Number or X-Coordinate | Depending on the value specified for the „Measurement Method“ below, enter either the column number on which the parameter text appears in the spooled file (*ROWCOL) or the horizontal coordinate on the page at which the start of the text appears (measured in millimeters for *MM, centimeters for *CM or inches for *INCH). | 0.001-999.999 | Enter the column number or horizontal coordinate. |
| | Length | Depending on the value specified for the „Measurement Method“ below, enter either the text length in characters (*ROWCOL) or units (measured in millimeters for *MM, centimeters for *CM or inches for *INCH) that the bookmark occupies in the spooled file. | 0.001-999.999 | Enter the length in the unit of measurement defined below. |
| | Measurement Method | The units, in which the previous elements are specified. | *ROWCOL | Rows and Columns
Use DSPSPLF as a guide. Ensure that TEXT (*CPI) has been defined if CVTSPL is being used. | | *INCH | Inches | | *CM | Centimeters | | *MM | Millimeters |
|
|
| PDF Bookmark Key Character Sting (BMARKKEY) | With this parameter it is possible to determine a key character string, which will be used to find a text position in the report, from which bookmarks will be created.
By specifying BOOKMARK (*KEY) with the BMARKKEY parameter, a set of bookmarks can be created based on a piece of text that appears in the report on the same line as another piece of text (i.e. the key string, typically a field label).
For example, if an item of user interest – such as an order number, a customer name, or a product code – appears on the same line as a label such as „Customer Name:“ „Order No:“ or „Product ID“, then, by using these labels as a key string, a bookmark can be generated based on the actual customer name, order number or product identifier.
Example:
CODE
CVTSPLPDF BOOKMARK(*KEY)
BMARKKEY(( Customer name: 1 16 40 *ROWCOL))
This parameter contains 5 elements: | Key String | Specify the key string, which will trigger the selection of bookmark text. | This is case-sensitive and should be enclosed in single quotes if a lower-case or mixed-case value is being defined. |
| | Occurrence | If the key string appears more than once on each page, the number entered in this parameter element will determine which occurrence of the key string will trigger the selection of bookmark text. | *FIRST | The first occurrence. | | *ALL | Every occurrence. | | 1-999 | Specify the occurrence to use. |
| | Offset | Depending on the value specified for the „Measurement Method“ below, enter the offset in either characters (*ROWCOL) or measurement units (*MM, *CM, *INCH) from the start of the key string to the start of the text to be selected as a bookmark.If a positive number is entered, this is interpreted as indicating that the bookmark text is to the right of the key string, whereas a negative number indicates that the bookmark text is to the left of the key string. | -999.999-999.999 | Specify the offset in the units defined below. |
| | Length | Depending on the value specified in „Measurement Method“ below, enter either the length of the bookmark text in characters (*ROWCOL) or in measurement units on the page (*MM, *CM or *INCH). | 0.001-999.999 | Enter the length of the bookmark text. |
| | Measurement Method | The units in which the previous elements are specified. | *ROWCOL | Rows and Columns Use DSPSPLF as a guide. Ensure that TEXT (*CPI) has been defined if CVTSPL is being used. | | *INCH | Inches | | *CM | Centimeters | | *MM | Millimeters |
|
|
| Font | This parameter determines how i-effect handles fonts when creating a stream file from a spooled file.This parameter contains 3 elements: | Font | Possible Special Value: | *MAP | i-effect maps Power Systems fonts to an equivalent PC font from the PDF basic font set (listed below). This option will minimize the size of the PDF file created, but the appearance of the text in the PDF file may not necessarily exactly reproduce the appearance of the text in the spooled file when printed, but will normally be very close to it. | | *EMBED | Where possible, i-effect will embed the font in the PDF file. This guarantees that the font will be available when the PDF file is viewed in Acrobat and will reproduce the appearance of the font on the printed page as closely as possible. However, it may also significantly increase the size of the resultant PDF. Please note that embedding low-resolution Power Systems raster fonts in PDF may yield unsatisfactory results when the resultant PDF file is viewed online. This is simply due to limitations of the raster font technology. When printed, the appearance should be comparable to the quality when the font is used to print documents from Power Systems (this also depends on the printer). |
The following options are in the PDF basic fonts. Adobe Acrobat guarantees the availability of the following fonts: | *COURIER | Only Courier will be used. | | *COURIERB | Only Courier bold will be used. | | *COURIERO | Only Courier oblique will be used. | | *COURIERBO | Only Courier bold oblique will be used. | | *HELVETICA | Only Helvetica will be used. | | *HELVB | Only Helvetica bold will be used. | | *HELVO | Only Helvetica oblique will be used. | | *HELVBO | Only Helvetica bold oblique will be used. | | *TIMES | Only Times New Roman will be used. | | *TIMESB | Only Times New Roman bold will be used. | | *TIMESI | Only Times New Roman italic will be used. | | *TIMESBI | Only Times New Roman bold italic will be used. | | *SYMBOL | Only Symbol will be used. | | *DINGBATS | Only Zapf Dingbats will be used. |
| | Font Size | The following options are possible for font size: | *SCALE | i-effect selects an appropriate font size based on the font, CPI and LPI information in the spooled file. This method is the same as *CALC (see below) except in relation to fonts specified by FGID (font identifier), such as those defined with the DDS FONT keyword. In the case of fonts specified by FGID, when the font is reproduced in PDF by mapping, the font point size is calculated based on the LPI value and then condensed using a horizontal scaling to the appropriate CPI value. This usually reproduces the appearance of the original printed spooled file more closely than *CALC. | | *CALC | i-effect selects an appropriate font size based on the font and CPI information in the spooled file. | | 4-36 | Specify the font size in points. |
| | Embedded Fonts | The third element is only relevant when *EMBED is selected. The IBM Power Systems fonts, which should be embedded in the PDF being created, are specified here.
The following single values are possible: | *NONE | No font types will be embedded. | | *ALL | All font types will be embedded. |
(Up to 10) More options: | *PSTYPE1 | PostScript Type 1 fonts (also called outline fonts on the System i) will be embedded. | | *RASTER | Raster (bitmap) fonts will be embedded. | | *CIDKEYED | CID-keyed fonts (PostScript Type 0 fonts) will be embedded. These are DBCS fonts. | | *FONTID | Fonts specified by a font identifier (e.g. by means of the DDS FONT keyword) are embedded. This is dependent on a suitable font resource object being available for embedding. Please note that Power Systems raster (bitmap) fonts are relatively low in resolution (typically 240 or 300 pels per inch) and are imported into PDF in the form of bitmap images. When displayed on screen in Adobe Acrobat, these bitmaps can appear jagged and un-even and the presentation quality is generally rather poor. This is a feature of the font technology, not a deficiency on the part of i-effect®. When printed, the PDF accurately reproduces the print quality of the Power Systems font on the page. Which is also dependant on the quality of the printer in use. |
|
|
| Font-ID Conversion (CVTFONTID) | This parameter controls how fonts that are identified by a font number (e.g. by means of the DDS FONT keyword or the FONT parameter of the CRTPRTF command) are processed when the spooled file is converted.
For each font identifier or combination of font identifier and font size, the desired predefined font or a font object, which will be embedded, can be specified. Where the specified “from” font ID and font size appears in the spooled file, that font will be mapped to the font typeface and point size specified here, or the font object specified will be used to reproduce that font in PDF.
Single Values: | *NONE | No substitutions are required. | | Other Values | (Up to 100 repetitions) |
This parameter contains 2 elements: | Font ID | The „from“ font identifier and size. Element 1: Font-ID
The “from” Font -ID. | 1-65535 | Enter the font number, which identifies the font in the spooled file. This will usually be a font number defined either on the FONT parameter of the CRTPRTF (Create Printer File) command or on the DDS FONT keyword, e.g. 11 = Courier 10 CPI). | Element 2: Font Size
The “from” font size. | *FONTID | The font point size implied by the font identifier should be assumed. Some IBM font identifiers (e.g. 11 = Courier 10 CPI) imply a specific font size, while others (e.g. 5707 = Times Roman Bold) do not. This is normally implemented on the Power Systems through the use of the printer file DDS keyword FONT with or without the *POINTSIZE option. | | 4-36 | Enter the “from“ Font Size. | Element 3: size unit
The unit type, in the above mentioned font size is measured | *Points | The font size is in point. | | *CPI | The font size is a CPI value (characters per inch). |
| | | | | | |
|
| | Element 1: Font-ID
The “from” Font -ID. | 1-65535 | Enter the font number, which identifies the font in the spooled file. This will usually be a font number defined either on the FONT parameter of the CRTPRTF (Create Printer File) command or on the DDS FONT keyword, e.g. 11 = Courier 10 CPI). | Element 2: Font Size
The “from” font size. | *FONTID | The font point size implied by the font identifier should be assumed. Some IBM font identifiers (e.g. 11 = Courier 10 CPI) imply a specific font size, while others (e.g. 5707 = Times Roman Bold) do not. This is normally implemented on the Power Systems through the use of the printer file DDS keyword FONT with or without the *POINTSIZE option. | | | 4-36 | Enter the “from“ Font Size. |
| | To font | The target font and font size. Element 1: Font
Target font.
Enter the embed-ded font or the font object. | *COURIER *COURIERB *COURIERO *COURIERBO *HELVETICA *HELVB *HELVO *HELVBO *TIMES *TIMESB *TIMESI *TIMESBI *SYMBOL *DINGBATS | Courier Courier Bold Courier oblique Courier Bold oblique Helvetica Helvetica Bold Helvetica oblique Helvetica Bold oblique Times New Roman Times New Roman Bold Times New Roman Italic Times New Roman Bold Italic Symbol Zapf Dingbats | | path-name | Alternatively, specify either a font resource object or a PostScript Type 1 font file. Note: FONT (*EMBED) must be specified if the font is to be embedded in PDF. If FONT (*MAP) is specified, i-effect® will use the font specified in this element of the CVTFONTID parameter to select a suitable standard font to map to, but will still use a mapped standard font not an embedded font! These parameters require an IFS path name. If a font resource object is referenced, the object name must be specified in IFS format, i.e.: /QSYS.LIB/library_name.LIB/object_name.FNTRSC | | | If FONT (*MAP) is specified, i-effect will use the font specified in this element of the CVTFONTID parameter to select a suitable standard font to map to, but will still use a mapped standard font not an embedded font! These parameters require an IFS path name. If a font resource object is referenced, the object name must be specified in IFS format, i.e.: /QSYS.LIB/library_name.LIB/object_name.FNTRSCo | Element 2: Size
The font size can also be entered in points. | *FONTID | The default is *FONTID. This indicates that the size of the font used will be the same as the font size implied or specified by the from-font id or from-font-size part of this parameter. | | 4-36 | Enter the font size in points. |
Example:
CODE
CVTSPLPDF
CVTFONTID(((416) (‚/QSYS.LIB/QFNTCPL.LIB/
C0S0CR10.FNTRSC)))
FONT(*EMBED)
Font ID 416 will be implemented by embedding font resource object C0S0CR10 in library QFNTCPL.Example:
CODE
CVTSPLPDF
CVTFONTID ((416) (‚/QIBM/PRODDATA/OS400/
FONTS/PSFONTS/LATIN/COU.PFB‘)))
FONT(*EMBED)
Font ID 416 should be implemented by embedding the PostScript courier font supplied by IBM at the path given. Please note: Two files are required in order to successfully embed a PostScript font. These are: | A PostScript Type 1 font file. This normally has a file extension of .pfb (e.g. /QIBM/PRODDATA/OS400/FONTS/PSFONTS/LATIN/HEL.PFB) | | A PostScript Type 1 font metrics file. This normally has a file extension of .afm (e.g. /QIBM/PRODDATA/OS400/FONTS/PSFONTS/LATIN/HEL.AFM) |
Specify the name of the font file (.pfb extension) on this parameter. i-effect will attempt to locate the corresponding font metrics file (.afm extension) in the same location. If either file cannot be found, or if either file is not recognized as the appropriate file type, an error will occur. |
|
