This document is a guide to installing, configuring and using the JetTrac Archive™ Custom Agent. This document includes detailed instructions for installation and configuration in the Central Job Management Database.
JetTrac Archive™ creates metadata files using information from Central. This data comes in three ways: The JetTrac Archive ini file, the incoming field-nominated file (FNF) from Central, and from the JetTrac Archive command line.
The metadata files created by JetTrac Archive are usually used by an Electronic Document Management System (EDMS) to provide information about other files (possibly PDF) that are going to be archived into the EDMS. These archival documents would also be created by Central.
JetTrac Archive™ is written in Java so it will run on any platform that supports Java, including, Windows and most flavors of UNIX.
If you need assistance in installing and configuring JetTrac Archive™, call Pro Technology Automation, Inc. at 805-527-1248 or email us at firstname.lastname@example.org. Please note that the JetTrac Archive™ license fee does not cover configuration services and technical support so there may be an additional charge. Please ensure you read these instructions carefully before calling for technical support.
Though this document says “Central” throughout, it applies the same to all versions of JetForm Central, Accelio Present Central and Adobe Central Output Server.
Refer to the document JetTrac Java and Licensing Considerations for installing the Java Runtime Environment (Java or Java Runtime Environment or JRE) and generating a site code for your site. It is available on the web at www.protechinc.com on the JetTrac page. If installing on a Windows platform, we highly recommend you use at least version 1.3.0 of the JRE (1.4 and 1.5 should work fine), though in some cases, other versions will work. Contact us for further questions.
After the JRE is installed, you are ready to proceed to the JetTrac Archive files themselves. The files you need are:
JTArchive.jar JetTrac Archive executable program file (java)
JTArchive.ini JetTrac Archive INI file
Run JTArchive.bat Sample DOS batch file to test JTArchive
archiv.lic JetTrac Archive license key file (only obtained from Pro Technology)
JetTracArchiveUserGuide.pdf this document
There are two main steps to complete the configuration of JetTrac Archive. The first is to set up the JetTracArchive.ini file. The second is to set up a task and job step in the Job Management Database in Central Control to call JetTrac Archive™ at the correct time.
To set up the INI file, open JetTracArchive.ini. A sample looks like this:
“^job printthrough inv”#AMOUNT#”dept”#DEPTNAME#”dsep “#CMDLINE#
Line 1 Delimiter that is desired between fields
Line 2 File name formula
Line 3 Meta-data formula (must terminate with the delimiter character
Line 4 pass spaces in filename (Y = keep spaces in meta-data file, N = convert spaces to underscores).
The first four lines are values that JetTrac Archive reads. The rest of the lines are internal documentation to prompt you for what goes on each line. The double-tilde (~~) serves to separate the code lines from the explanations.
Line 1 is the delimit character that you want to use in the next two lines of this file. The filename and the contents of the file can be made up of a mix of static and dynamic elements. This delimiter character will be used to separate the elements.
Line 2 The formula to be used to generate the metadata filenames. These files can be written anywhere you desire. You can mix static values with values found in any field in the document. This is done in this format:
1. All elements end in the delimit character.
2. The delimit character must not occur in your static elements.
3. All static elements have quotes around the string inside the delimiter. If you need quotes in your data, you must put two quotes together. The exterior pair of quotes will be used by JetTrac Archive and the interior pair will be left in the output.
4. The field value elements will be filtered for invalid filename characters. Invalid characters will be converted to underscores. You have the option to convert spaces or not on Line 4.
5. To have a value from the command line used, use CMDLINE as the field name. See the example above.
Line 3 The formula used to create the metadata content of the files. All of the same rules apply as for the formula in Line 2.
Line 4 The switch to decide whether or not to convert spaces on Line 2 or convert them to _ (underscores). The metadata contents inside the file (Line 3) are never filtered.
JetTrac Archive is a Java program and must be run from withing the Java Runtime Environment. Refer to section 2.1 for more information on acquiring and installing Java. Assuming that you already have Java installed on your system, the format of the command line is:
java –jar [path to java.jar file] [input fnf] [ini file] [log file] [command line input]
A sample is:
java –jar c:\jfsrvr\JTArchive.jar test.fnf JTArchive.ini jfserver.log AP_Printer
Section 2.7 will instruct you how to implement this command line for use with Central.
As with all JetTrac products, JetTrac Archive is protected from piracy by the JetTrac License Manager system. This system locks JetTrac Archive for use exclusively to one server or system in your organization. It works in this manner:
1. You run JetTrac SiteCode on your computer and generate a unique site code file for your system.
2. You send that site code file to Pro Technology Automation.
3. Pro Technology uses your site code file to generate a product license key file.
4. Pro Technology sends the product license key file back to you.
5. When JetTrac Archive runs, it scans the system and compares the tokens it finds with the tokens found in the license key file, and if they match, it runs normally.
Refer to the document JetTrac Java and Licensing Considerations for further information.
To add the JetTrac Archive custom agent in Central Control for Windows platforms:
1. Start Central Control by clicking Start, Programs, Adobe, Central Control (may be slightly different for your installation). You will get the following screen:
2. Add a new Task by clicking on File, Job Management Database, Tasks. You will get the following screen:
3. Create a new task by clicking New Task. Set up the Task Definition with the following information:
Task ID: JTArchive
Program name: java –jar c:\jfsrvr\CustomAgents\JTArchive\JTArchive.jar
Program options: @InFile @MDFName @LogFileName
Comment: JetTrac Archive Custom Agent by Pro Technology
Optionally, you may elect to use a command-line input to JetTrac Archive. If so, you would add that value to the end of the program options line after a space. Often, you would add @OtherJobTokens if that is how you are passing the variable information. Contact Pro Technology for help on this.
4. Click OK to save the Task Definition. Close out of the Task Definition window.
5. Now you must create a job step that calls the JetTrac Archive task. This would be one of the job steps in the complete job you are setting up.
If, for instance there is a job that runs a JFTrans step and then a JFMerge, then we will need to split the job into at least two jobs. JetTrac Archive would run after the JFTrans step. The JFMerge step will then be put into a new job.
The job will be named according to what we give the name of the job in the ini file, explained in section 2.3 above. This would allow each of the output files created by JetTrac Archive to be individually picked up and processed one-by-one by Central. The resulting output would be grouped according to the key field. There are myriad other options that can be done with JetTrac Archive by varying how the job cards are built and building multiple secondary jobs to handle all of the output options desired.
6. From the main screen of Central Control, click File, Job Management Database, Jobs. You will get a list of all jobs you have set up in Central. We will assume that you already have a job set up and you are adding a Routing step. Click on the Job that you want to sort, then click “New Step”. The New Job Step screen will appear. Following are the fields that you need to fill in:
Task ID – from the drop down list, select JTArchive
Input File – the value that goes here would be a single letter which is the output from the previous job step. If your current job had two steps, JFTRANS and JFMERGE, then the output from JFTRANS was “A”. If you now want to sort this file, then the Input file for JetTrac Archive would be A. If you have questions about how this works, contact your Central support person.
Output file – leave this as *
On Error – Select S to Stop the Job if there is an error in JetTrac Archive
Form File – this field would contain the fully qualified INI filename that you have set up for JetTrac Archive, e.g. c:\jfsrvr\CustomAgents\JTArchive\JTArchive.ini
Preamble file – This should be * Delete whatever else might appear here.
Printer Name – leave it as *
Macro Number – leave it at 1
Load Flag – leave it at T
Comments – type in a description like “Creates Metadata”
7. Close all windows, get back to the main Central Control screen and update the Job Management Database by clicking on Control, Reload Job Management DB. When asked if you want to save changes to the Job Management Database, click Yes.
To submit a transaction file to Central, you place a data file into the Collector Directory. There are a number of ways to do this depending on the platform that you are running Central. You can FTP the file, use the JetForm Print Processor, use Named Pipes or simply copy the file.
As JetTrac Archive is set up as one of the steps of a job, whenever a job is triggered that needs to use JetTrac Archive, the processing happens automatically.
JetTrac Archive™ conforms to all requirements as a Custom Agent. It writes a status to the log file and creates the JETFORM.RSP. Here is a sample entry in the log file for a successful run of JetTrac Archive:
19991014121616 JetTrac Archive : processing completed
991014 12:16:16 C:\JFSRVR\jfsrvr.exe: –> returned  JetTrac Archive : processing completed.