PluginMgr command

PluginMgr can run both the EditAFP and IndexAFP commands and write the output to an AFP file. Or, PluginMgr can run only the command that you specify.

It is more efficient to use PluginMgr to run the EditAFP and IndexAFP commands at the same time than to run them separately. However, if you want IndexAFP to create a resource group file, you must run the IndexAFP command.

Format

PluginMgr  -c  controlfile [ -docIdx indexfile ] [-edit [:options;]]
[-fontMapDir fontmapdirectory] [-formDef formdefinition]
-i inputfile [ -index [: options; ] ] -o outputfile[-pluginDir plugindirectory ] [ -resDir resourcedirectories ] [-trace tracefile] [ -trclvl level ] [ -version ]
Note: Brackets indicate that the option is not required. Do not type any brackets when you enter the command.

Options

-ccontrolfile
The full path name of the AFP Visual Environment control file that contains the page group and index tag definitions. This option is required.
-docIdxindexfile
The full path name of the document index file that you want AFP Visual Environment to create. Any existing data in the file is overwritten. This option is not required. If it is not specified, the document index file is not created.
-edit[:options;]
Indicates that PluginMgr is to run the EditAFP command, and specifies EditAFP options. Valid EditAFP options are:

-snfserialfile[:barcodedefinition];...
The name of the Intelligent Mail bar code (IMB) serial number file and the name of the bar code definition in the control file that the serial number file applies to. If -snf is not specified, EditAFP uses the serial number file that was specified in the bar code definition when the control file was created. If you specify more than one serial number file and bar code definition name, separate them with a semicolon as shown in Examples.

serialfile
The full path name of the serial number file.
barcodedefinition
The name of the bar code definition. If no bar code definition name is specified, the serial number file is used for all IMBs in the AFP file. If the bar code definition name contains blanks or other special characters, enclose the name in double quotation marks.

-ue
The user exit class name.
If you specify EditAFP options, type a colon before the options and a semi-colon after the options, as shown in Examples. If you do not specify any EditAFP options, do not type the colon and semi-colon.
Note: The -edit and -index options interract in this way:
  • If neither -edit nor -index is specified, PluginMgr can run both IndexAFP and EditAFP, depending on which definitions are in the control file. If the control file contains definitions that AFP Indexer created, PluginMgr runs AFPIndex first because definitions that AFP Editor created might depend on page groups and index tags that AFP Indexer created.
  • If -edit is specified but not -index, PluginMgr runs only EditAFP.
  • If -index is specified but not -edit, PluginMgr runs only IndexAFP.

Examples:

-edit
-edit:-snf /directory/serialfile;
-edit:-snf /directory/tofile:"to IMB";/directory/replyfile:"reply IMB";

-fontMapDirfontmapdirectory
The full path name of the directory that contains customized font-mapping files, which override the default font-mapping files. This option is not required. If it is not specified, only the default font-mapping files are used.
-formDefformdefinition
The full path name of the form definition that contains the active medium map for the first page in each page group. PluginMgr writes the name of the active medium map in the document index file and includes the form definition in the resource group file.

This option is not required. If this option is not specified, PluginMgr uses the medium map name in the first inline form definition or, if no inline form definitions exist, in the first Invoke Medium Map (IMM) structured field. If no inline form definitions or IMM structured fields exist, PluginMgr uses a null name to indicate that the first medium map in the form definition is the active medium map for the first page.

Example:-formDef F1USER10

-iinputfile
The full path name of the input AFP file that you want to process. The input file must contain MO:DCA-P data with no line data. This option is required.

To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with //. When you specify a fully qualified name, two sets of quotation marks are required. For example, "//'USERID.PDS(MYDOC)'" or "//'USERID.SEQDS'". When you specify a partially qualified name, you only need one set of quotation marks. For example, "//PDS(MYDOC)" or "//SEQDS".

-index[:options;]
Indicates that PluginMgr is to run the IndexAFP command, and specifies IndexAFP options. Valid IndexAFP options are:

-te
The trigger exit class name.
-ue
The user exit class name.

If you specify IndexAFP options, type a colon before the options and a semi-colon after the options, as shown in Examples. If you do not specify any IndexAFP options, do not type the colon and semi-colon.

Note: The -edit and -index options interract in this way:
  • If neither -edit nor -index is specified, PluginMgr can run both IndexAFP and EditAFP, depending on the definitions in the control file. If the control file contains definitions that AFP Indexer created, PluginMgr runs AFPIndex first because definitions that AFP Editor created might depend on page groups and index tags that AFP Indexer created.
  • If -edit is specified but not -index, PluginMgr runs only EditAFP.
  • If -index is specified but not -edit, PluginMgr runs only IndexAFP.

Examples:

-index
-index:-ue /directory/userexit;
-index:-ue /directory/userexit; -edit

-ooutputfile
The full path name of the file where the output AFP file is written. Any existing data in the file is overwritten. This option is required.

To specify an MVS data set, such as a sequential or partitioned data set, precede the data set name with //. When you specify a fully qualified name, two sets of quotation marks are required. For example, "//'USERID.PDS(MYDOC)'" or "//'USERID.SEQDS'". When you specify a partially qualified name, you only need one set of quotation marks. For example, "//PDS(MYDOC)" or "//SEQDS".

If you specify an MVS data set, allocate and catalog the data set before you run PluginMgr. Allocate the output data set with these characteristics:
  • Record format: VBM
  • Record length: 8K (8192) bytes or larger

-pluginDirplugindirectory
The full path name of the directory that contains the IndexAFP and EditAFP directories. Specify this option only if you moved the IndexAFP and EditAFP directories to a different directory after installation. This option is not required. If it is not specified, the default directory is ./plugins.
-resDirresourcedirectory;...
The full path names of one or more AFP resource directories that contain AFP resources. PluginMgr looks for AFP resources in these resource directories before the resource directories identified to AFP Visual Environment when the control file was created. This option is not required.

Specify this option if AFP resources are not inline and are not in the same directories that you identified to AFP Visual Environment when the control file was created.

Separate multiple directories with a semicolon. If a resource directory path name contains a blank, enclose the path name in double quotation marks.

-tracetracefile
The full path name of the file where PluginMgr writes trace information. If the file already exists, PluginMgr appends to it. Otherwise, PluginMgr creates the file. Use this option for diagnostic purposes only.
-trclvllevel
The level of tracing. This option is not required.

Values for level are:

debug
Trace at a higher level.
normal
Trace at a lower level (default).

-version
Displays the version number of PluginMgr. This option is not required.

Examples–PluginMgr

AIX: This example applies all the definitions in the infile.ctl control file and writes the output to file outfile.afp: 

java -jar /install_directory/PluginMgr.jar 
-i /directory/infile.afp -o /directory/outfile.afp 
-c /directory/infile.ctl

Windows: This example applies all the definitions in the infile.ctl control file and writes the output to file outfile.afp: 

java -jar \install_directory\PluginMgr.jar 
-i \directory\infile.afp -o \directory\outfile.afp 
-c \directory\infile.ctl

z/OS: This example applies all the definitions in the infile.ctl control file and writes the output to file outfile.afp. Enter this command on the z/OS UNIX command line: 

java -jar /install_directory/PluginMgr.jar 
-i /directory/infile.afp -o /directory/outfile.afp 
-c /directory/infile.ctl

For install_directory, use the directory where you installed AFP Visual Environment.

For directory, use the directory where the file is located.

Exit codes

0
PluginMgr was successful.
<0
PluginMgr was not successful. No output file was created, or the output file is incomplete. Error messages are written to stderr.
Parent topic: AFP Visual Environment commands