PegaDISTRIBUTION MANAGER (IOS) for PegaRULES Process Commander. Installation and Configuration Guide

Transcription

1 PegaDISTRIBUTION MANAGER (IOS) for PegaRULES Process Commander Installation and Configuration Guide Version August 2006

2 Copyright 2006 Pegasystems Inc., Cambridge, MA All rights reserved. This document describes products and services of Pegasystems Inc. It may contain trade secrets and proprietary information. The document and product are protected by copyright and distributed under licenses restricting their use, copying distribution, or transmittal in any form without prior written authorization of Pegasystems Inc. This document is current as of the date of publication only. Changes in the document may be made from time to time at the discretion of Pegasystems. This document remains the property of Pegasystems and must be returned to it upon request. This document does not imply any commitment to offer or deliver the products or services described. This document may include references to Pegasystems product features that have not been licensed by your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems service consultant. For Pegasystems trademarks and registered trademarks, all rights reserved. Other brand or product names are trademarks of their respective holders. Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors. This document or Help System could contain technical inaccuracies or typographical errors. Changes are periodically added to the information herein. Pegasystems Inc. may make improvements and/or changes in the information described herein at any time. This document is the property of: Pegasystems Inc. 101 Main Street Cambridge, MA Phone: (617) Fax: (617) PegaDISTRIBUTION MANAGER (IOS) for PegaRULES Process Commander Document: Installation and Operations Guide Software Version Updated: August 8, 2006

3 Contents Installation and Configuration... 1 Hardware and Software Requirements... 3 Installation... 5 Installing the IOS Software... 5 Verifying the Spooler Database... 9 Configuring Process Commander to Work with IOS...12 Creating the Database Name Object...12 Creating the Database Table Object...14 Creating the COS Server Object...15 Creating the COS Printer Objects...17 Enabling the Agent Activity...18 Set IOS Runtime Options...20 General Configuration Options...20 Spooler Database Configuration Options...21 Print Channel Configuration Options...22 FAX Configuration Options Configuration Options...25 Unzip Configuration Options...25 Applying Configuration Options...26 The IOS Spooler Database Schema...27 Field Values...29 Tag Data...30 Appendix A: Contacting Pegasystems...31 Customer Support...32 Education Services...32 Pegasystems Certified Professional Program...32 Pega Developer Network (PDN)...32 Documentation Feedback...33 Office Locations...33

4 Installation and Configuration The PegaDISTRIBUTION MANAGER can print Microsoft Word correspondence generated by requestors (people or systems) or convert DOC files to PDF documents. PegaDISTRIBUTION MANAGER works with Process Commander, but it is independent of Process Commander and can receive and process requests from more than one Process Commander system simultaneously. Note: PegaDISTRIBUTION MANAGER is the name of Pegasystems correspondence product. The name of the server program is IOS. As a matter of convenience, this document treats IOS and PegaDISTRIBUTION MANAGER as synonyms. It uses the acronym IOS more often because it is shorter. IOS is also referred to as COS (Correspondence Output Server) in the Process Commander environment. Therefore, Process Commander rules for IOS have COS in their names. IOS connects to a small spooler database through ODBC. The spooler database is the database that receives the print jobs sent from Process Commander. IOS uses Microsoft Access 2003, Microsoft SQL Server 2003, or Oracle or later for the spooler database. IOS creates and uses as many as 20 Windows process threads for printing. This optional multithreading allows high volume printing on a production system. IOS also allows you to set the number of simultaneous database records read per thread to balance the load across multiple threads.

5 2 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide IOS is also involved in the creation of PDF files. The DOC file is passed to IOS in the spooler print request record. (The type and size of the field is dependent upon your database.) When Process Commander receives a request to create a PDF file it sends the PDF file to IOS. IOS then sends this file to a third party printer driver (from Amyuni Technologies) that creates the PDF. IOS then overwrites the DOC file with the new PDF file and updates the status of the database record. A Pega-ProCom agent activity continually monitors the database, so when the PDF conversion takes place, Process Commander obtains the PDF file, attaches it to the appropriate work object, and continues with its own processing. Note: To use IOS you must have a new spooler database because the format of the spooler database has changed.

6 Hardware and Software Requirements 3 Hardware and Software Requirements The IOS server requires the following hardware and software. Windows 2003 Professional or Server or Windows XP Microsoft Word. The platform of choice is Windows 2003 with Word 2003, but IOS works with any version of Microsoft Word, whether it is Word 97, 2000, or XP (2002). At least 256 MB RAM At least 4 GB free space on the hard drive Local-area network access to PegaRULES version 3 or higher FACSys Fax Messaging Gateway (version 4.9.1) for Windows for faxing JDBC driver for the database on your PegaRULES Process Commander system ODBC driver for the spooling database Regardless of DBMS used, you must have the ODBC driver for the spooling database installed on the Windows 2003 or XP computer on which you plan to run IOS and you must have a database server running the desired DBMS. (The ODBC driver must work on XP and connect to the DBMS in use. The installation procedure does not install the ODBC driver for any DBMS. You must install that system s ODBC driver on the computer that runs IOS prior to configuring IOS.) As IOS uses ODBC to communicate with its spooler database, neither the spooler database nor the complete DBMS needs to be installed on the computer that runs IOS. However, Pegasystems recommends that you install the database and the complete DBMS on the same computer that runs IOS. You must configure an ODBC data source on the Windows 2003 or XP computer running IOS to access the desired database server. If you do not wish to use Oracle or the SQL Server, you can use the Microsoft Access database. IOS uses ODBC and will install the ODBC driver that it needs to read and write to that database. However, you cannot compact the database, nor can you view the contents and/or schema without writing an ODBC application unless you have either Microsoft Access 2003 or XP installed. Therefore, if you want to use the Access database, you must have Access installed. Note: Microsoft Access restricts the size of the Microsoft Word documents that can be converted. The limit is 64kb which applies to the Word document when it is encoded to base64.

7 4 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Word 2003 and Access 2003 are included with Microsoft Office 2003 Professional Edition. FACSys Fax Messaging Gateway is a fax server product from emfast Inc. ( IOS uses the Active Fax Messaging SDK from emfast to send faxes to and receive statuses from the FACSys Gateway.

8 Installation 5 Installation The following descriptions show the screens as they appear for a new installation of IOS. Important: If you are upgrading from a version prior to IOS , you must uninstall that version before installing IOS You must also create a new spooler database and configure a new data source for that database. Note: You cannot install IOS on Windows NT, 95, 98, or ME. Installing the IOS Software 1. Log in to Windows as an administrator. 2. Insert PegaDISTRIBUTION MANAGER (IOS) CD into the CD-ROM drive on the IOS server. A window appears, indicating that InstallShield is preparing the Windows installer. Tip: As you install IOS, write down the names of the directories and database files. You will need this information later during the configuration process. 3. Click Next. The ReadMe window appears (Figure 1). Figure 1. Read Me Window

9 6 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Note: The ReadMe file contains information pertaining to the installation process, the contents of the CD, and any last minute updates that are not in the product documentation. The ReadMe file also describes changes that have been applied since the last major release of IOS and are not in the documentation. 4. Click Next. The Installation Directory Prompt appears for you to select the directory where IOS should be installed. 5. To accept the default directory, click Next. Or, to change the default location, click the Browser button and navigate to an existing folder on the drive of your choice, or specify a new path, and click Next. Tip: Write down the path information you will need it later. 6. Click Next. A confirmation screen appears displaying the settings you choose (Figure 2). Figure 2. Setup Confirmation Prompt

10 Installation 7 7. Click Next. The Setup Status screen appears with a progress bar showing the components being installed (Figure 3). Figure 3. Installation Progress Bar 8. When done, the Finish prompt appears indicating the installation is complete (Figure 4). Figure 4. Finish Prompt Window 9. Click Finish.

11 8 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide 10. You may see a pop up message asking whether you want to update the IOS HTML help file. Click Yes to update the help file (Figure 5). Figure 5. HTML Help Update 11. A pop up message confirms that the HTML help is updated. Click OK.

12 Verifying the Spooler Database 9 Verifying the Spooler Database Now choose the database you want to use for the spooler. You can use an Oracle 8i, Microsoft Access, or Microsoft SQL Server database. You must create the spooler database using the database MANAGER of your choice. IOS uses a Microsoft Access database as a default data source. To create and verify this or a different data source: 1. Launch Microsoft Access, Microsoft SQL Server Enterprise Manager, or Oracle Enterprise Manager, and create a blank database called IOS. You may want to save the database in the IOS folder you created. Write down the path to this folder. 2. Close your database software. 3. Run the IOS Spooler tool to create a data source and configure it for IOS. Activate the IOS Spooler Setup Tool from the Start menu, select Start > Programs > Pegasystems > PegaDISTRIBUTION MANAGER > Spooler DB Setup Tool The Spooler Database Setup Utility window (Figure 6) appears, prompting you to create a new data source. Figure 6. Prompt to Create a New Data Source The selection list shows all ODBC data sources defined on your system. If the data source is listed, select it and go to step 5. Otherwise, go to step 4.

13 10 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide 4. Select one of the following procedures to create your new data source. To create a new data source from the Start menu, select: Start > Setting > Control Pane l> Administrative Tools > Data Sources (ODBC) To create a new data source using the IOS spooler tool, click the Create New Data Source button on the Spooler Database Setup Utility. Doing this takes you to the standard ODBC dialogs for creating ODBC data sources. Follow the on-screen prompts and when complete, click the X in the dialog box to close the window. Then reopen the IOS Spooler tool and go to step 5. Note: When you create an ODBC data source, be sure to create it as a system data source. For example, use the System DSN tab in the ODBC dialog, not the Use DSN or File DSN tabs. If you are creating a Microsoft Access data source, do not use a driver location for any country other than the United States. Important: If you create the data source, you must close the Spooler Database Setup Tool and activate it again from the Start menu as mentioned in Step 3. Your new data source now appears in the selection list in Figure Select the desired data source from the selection box and click Continue. The Data Source Verification window appears (Figure 7). Figure 7. Data Source Verification Window

14 Verifying the Spooler Database 11 The scrollable text box displays messages from the setup utility. The setup utility then attempts to connect to the data source. If the connection is successful, it determines whether the correct table definitions are in the database. If the correct table definitions are not in the database, the setup utility creates them. If your verification window displays the messages ( Table appears to be ok. And Verification Complete. ), your IOS installation on the IOS server is complete. 6. Click Done.

15 12 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Configuring Process Commander to Work with IOS To configure Process Commander to use the IOS server to print correspondence or convert Word files to PDF files, you create the following items in Process Commander: A database name object that represents the IOS database and that holds the information Process Commander needs to connect to it. A database table object that maps the Process Commander class named Data-COS-Server-Default to the Results table in the IOS database. A COS server object that represents the server hosting IOS and that specifies a directory on that server where files should be stored. One or more COS printer objects that represent(s) the printer(s) available to the PegaDISTRIBUTION MANAGER software running on the server identified in the COS server object. If you plan to configure IOS to print Word documents and to convert Word documents to PDF files, you need to create two printer objects. When using PegaDISTRIBUTION MANAGER to convert DOC files to PDF files, there is one more configuration step: you must also enable the GetConvertedPDFsFromPDM agent activity in the Pega-ProCom agent. Creating the Database Name Object The database servers used by your Process Commander system are represented as database name objects (Data-Admin-DB-Name). A database name object provides connection information that Process Commander uses to communicate with the database the object represents. If IOS uses the same database as Process Commander, skip this procedure and go to Creating the Database Table in page 14.. Before you begin, complete the following tasks: In the external database, create or identity a database user account for Process Commander access. Make the appropriate JDBC driver available to the application server running Process Commander. Then create a JDBC data source for the database in the application server and write down the JNDI name of the data source. If you need help with this task, consult the documentation for your application server software.

16 Configuring Process Commander to Work with IOS 13 To create a database name object, complete the following steps: 1. In the Rules by Type explorer, choose SysAdmin > Database. A list of databases appears. 2. Click New. 3. Name the database and click Create. 4. On the Database tab, click in the How to Connect field and choose Use JDBC Connection Pool from the list. 5. In the JDBC Datasource Settings field, enter the JNDI name of the data source (Figure 8). Figure 8. Database Name Form 6. On the History tab, enter descriptions in the Full Description and the Usage fields. 7. Save the database definition. 8. Click Test Connection to verify that the data source and database name object are configured correctly.

17 14 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Creating the Database Table Object A database table object (Data-Admin-Table) associates an existing Process Commander class with an existing relational database table or view in either the PegaRULES database or an external database. Complete the following steps: 1. In the Rules by Type explorer, choose SysAdmin > Database Table. A list of table mappings appears. 2. Click New. 3. Choose the class named Data-COS-Server-Default and click Create. 4. On the Database tab, choose the database that holds the Requests table. 5. Click in the Table Name field and enter Requests (Figure 9). Figure 9. Database Tab for DataAdminDBTable Form 6. On the History tab, enter descriptions in the Full Description and the Usage fields. 7. Save the table mapping. 8. Click Test Connectivity to verify that Process Commander can connect to the table.

18 Configuring Process Commander to Work with IOS 15 Creating the COS Server Object The COS server object represents the server on which IOS is running and specifies the directory where files are to be stored. To create the COS server object, complete the following steps: 1. From the Rules By Type explorer, select SysAdmin > COS Server. 2. Click New. 3. In the New form, enter the name of the computer on which you installed - IOS and click Create. The COS Server form appears (Figure 10). Figure 10. Properties Tab on the COS Server Form 4. On the Properties tab enter the following values for each section: COS Server Section: COS Host Name: Enter the network path name of the computer and directory for the Windows 2003 server on which IOS is running. Process Commander places the output files into that directory. Remember the IOS and Process Commander servers must be in the same domain and must both have access to the directory specified in this field. Tip. The format of the path that you enter in the COS Host Name field must be one that both the IOS server and the Process Commander server can understand. Directory configuration on the IOS computer if Process Commander is also running on a Windows 2000 or XP computer: Find the work directory of the IOS server using windows explorer, usually it s C:\Program Files\Pegasystems\IOS\work, right click on it, select sharing, and check Share this folder and keep the default share name work.

19 16 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Directory configuration on the Process Commander computer if it s running Windows 2000 or XP: Double-click on My Network Places, navigate to the computer that is running IOS, find the shared directory work usually its C:\Program Files\Pegasystems\IOS\Work, right-click on it, select Map Network Drive, and click Finish. Directory configuration on IOS computer if the Process Commander computer is running UNIX: Install Network File System (NFS) on the IOS computer. Export the drive on which IOS is installed. For example, using NFS Maestro server from HummingBird, open the Exports Editor and add the following entry: /C rw,access= machine name running Process Commander Directory configuration on the Process Commander computer if it is running UNIX: On the UNIX computer create a directory and name it as follows: computer name of the IOS server + root (for example, if IOS is running on a computer named ios2k, than the directory name would be ios2kroot. Mount the drive you just exported from Step 3 using the appropriate UNIX mount command to the directory you just created. (For example, on SUN use: mount ios2k:/c /ios2kroot). On the root directory, create a directory and name it with the computer name running IOS (ios2k), and then create a link to it as follows: ln -s (source) (target), where source equals the path from the mounted directory down to the Work directory as shown below: /ios2kroot/c/program Files/Pegasystems/IOS/Work target equals the directory named with the name of the computer that is running IOS (ios2k). Class Name: Mapped to the database name used by the IOS server; select Data-COS-Servers-Default (See Creating the Database Table, Step 2 on page 14.) Active: Check this box to indicate that this COS Server is available to receive requests and is running. Clear the box to prevent the system from sending additional requests to this COS Server. Database Section: Enable Purging: By default this box is checked to allow Process Commander to delete old requests. If desired uncheck it. Delete Requests older than (days): Enter a number of days after which requests can be purged, whether completed or not. 5. On the History tab, enter descriptions in the Full Description and the Usage fields and then save the COS server object.

20 Configuring Process Commander to Work with IOS 17 Creating the COS Printer Objects You create COS printer objects to represent a printer that prints out Word documents and/or to represent the Amyuni printer driver that converts Word files to PDF documents, but the steps are slightly different. Configuring a Printer Object that Represents a Physical Printer Follow the steps below to configure the printer object that represents the printer that IOS uses to print correspondence: 1. From the Rules by Type explorer, select SysAdmin > COS Printer. 2. Click New. 3. In the New form, enter a name for the printer and click Create. The COS Printer form appears (Figure 11). Figure 11. COS Printer Form for a Printer 4. On the Properties tab, enter the following information: Printer ID the name of the printer on the network; for example, \\MYPRINTSERVER\DEV5-01 (server name followed by the printer s network ID) COS Server Name the name of the COS server object that you created to represent the IOS server running PegaDISTRIBUTION MANAGER. 5. On the History tab, enter descriptions in the Full Description and the Usage fields. 6. Save the COS printer object. Tip: Be sure that the IOS server and the client computers have network access to this printer. You can add printers by creating new instance using the same IOS server.

21 18 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Configuring a Printer Object the Represents the Amyuni Printer Driver Follow the steps below to configure the printer object that represents the Amyuni printer driver on the IOS server: 1. From the Rules by Type explorer, select SysAdmin > COS Printer. 2. Click New. 3. In the New form, enter AmyuniDocumentConverter as the name and click Create. The COS Printer form appears (Figure 12). Figure 12. COS Printer Form for the Amyuni Printer Driver 4. On the Properties tab, enter the following information: Printer ID enter the string Amyuni Document Converter. COS Server Name the name of the COS server object that you created to represent the IOS server. 5. On the History tab, enter descriptions in the Full Description and the Usage fields. 6. Save the COS printer object. Enabling the Agent Activity The standard Process Commander agent rule Pega-ProCom is in locked Process Commander RuleSet. To enable the GetConvertedPDFsFromPDM activity, you use the generated agent schedule instances, not the agent queue rule. To enable the agent activity, complete the following steps: 1. In the Rules by Type explorer, choose SysAdmin > Agent Schedule. (Do not choose Agent Queue.) A list of agent schedules appears. 2. Select the first Pega-ProCom agent schedule in the list and open it.

22 Configuring Process Commander to Work with IOS On the Schedule tab, select the GetConvertedPDFsFromPDM activity (Figure 13). By default, the activity is set to run once every three minutes (180 seconds). Modify the interval as necessary. Figure 13. Agent Schedule for the Pega-ProCom Agent 4. Click Save and close the form. 5. If your Process Commander system uses more than one node, there will be more than one Pega-ProCom agent schedule in the list. Repeat steps 2 through 4 for each one.

23 20 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Set IOS Runtime Options To configure the IOS runtime options, start IOS from the Start menu: Start > Programs > Pegasystems > PegaDISTRIBUTION MANAGER > IOS. The Server Connection Window appears (Figure 14). Important: Do not click Start now. You still need to configure the connection options which are described below. Figure 14. Server Connection Window General Configuration Options 1. From the Server Connection Window (Figure 14) select Tools > Options. The Options window appears (Figure 15). Figure 15. Options Window General Tab

24 Set IOS Runtime Options On the General tab, accept the default connection name (INET_SERVER). 3. (Optional) To have IOS start whenever the server starts, select the Connect on startup option. Otherwise, you have to start IOS manually when you start the host computer. 4. Leave the Protocol box blank. It is not used with PegaRULES. 5. In the Logs section, click in the Folder field and specify the directory in which you want to place the logs. Use the [ ] button to browse to the desired directory. 6. To have IOS write detailed information to the log files, select the Verbose output. Do not select any of the other options in the logs section. 7. (Optional) In the Purge section, select the Delete Requests After option and specify the number of days. Spooler Database Configuration Options 1. From the Options window, select the Spooler tab (Figure 16). Figure 16. Options Window Spooler Tab 2. Select the correct ODBC data source from the Current Data Source selection box. Note: Although you can create a new data source by clicking the Create New Data Source button, you will still need to run the Spooler Setup Tool to verify or create the required data structure.

25 22 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Print Channel Configuration Options 1. From the Options window, select the Print tab (Figure 17). Figure 17. Options Window Print Tab IOS can drive multiple instances of Microsoft Word to print Word, text, and HTML files. IOS dedicates a thread for each running instance of Microsoft Word that it uses. Use the Print tab of the Options window to balance the load across different instances of Word. 2. Select the Enabled option. This activates the Print channel and enables the remaining options on the form. 3. The Wakeup interval value specifies how often each thread waits before it reads the spooler database. Tip: Under heavy loads, set a shorter interval and more threads. 4. The value specified in the Number of threads box determines how many instances of Microsoft Word IOS will start and use. Choose a value between 1 and 20. Each running instance of Word requires approximately 25 MB of RAM. 5. The Number of DB requests per thread specifies the maximum number of requests that IOS passes to each running instance of Microsoft Word each time IOS reads the database. The range of allowed values is between 10 and 100. Set your values assuming a peak load. For example, suppose you anticipate 100 requests per minute. If you distribute your load among four instances of Word, you should then allocate 25 DB requests per thread.

26 Set IOS Runtime Options Click the Image Options button to display the Image Options selection window shown in (Figure 18). Figure 18. Image Options Selection Window 7. In the Folder field, enter the directory where images are to be saved when printing files with images or click the [ ] button to select the desired directory. 8. If you want IOS to ignore missing images, separate images with page breaks, or both, check the appropriate boxes. 9. Click OK to apply the image options and return to the Options window. Limitations on PDF Conversion PegaDISTRIBUTION MANAGER has a limit when processing large files. If you receive the error Printer not activated error code -30 PegaDISTRIBUTION MANAGER may be overloaded and your file might not convert. This occurs occasionally when converting files greater than 1 MB while PegaDISTRIBUTION MANAGER is overloaded. Solution Make the following changes to the Print tab on the Options dialog box (Figure 17). 1. Set the Number of Threads to Set the Wakeup Interval (in seconds) to 1. Note: These changes will enable you to convert large files into PDF, but the system becomes slower. Therefore, do not keep this setting as your default setting.

27 24 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide FAX Configuration Options 1. From the Options window, select the Fax tab (Figure 19). Figure 19. Options Window FAX Tab 2. In the Spooler area, check the Enabled box to activate the fax thread. Use the Wakeup interval to specify how long the thread is to remain idle before checking for more requests. The wakeup interval value specified here applies only to the fax thread. 3. In the Interface area, enter the name of the fax server, user account, and password to be used by the fax server.

28 Set IOS Runtime Options 25 Configuration Options Process Commander does not use IOS for correspondence. Use this tab to configure IOS for use with other Pegasystems products. To ensure that the IOS options are disabled, follow these steps: 1. From the Options window, select the tab (Figure 20). Figure 20. Options Window Tab 2. Make sure the Enabled box is unchecked. Unzip Configuration Options 1. From the Options window, select the Unzip tab (Figure 21). Figure 21. Options Window Unzip Tab 2. Check Enabled. This lets IOS unzip the Zip files.

29 26 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Applying Configuration Options 1. After you complete the information on all the tabs, click the OK button to apply your settings. The options you set take effect the next time you start IOS. Note: If you want to exit without any modifications taking effect, click Cancel. 2. The system returns to the main IOS window. Click the X in the upper-right hand corner to close the main window. 3. Start IOS again. Select Start > Programs > Pegasystems > PegaDISTRIBUTION MANAGER > IOS.

30 The IOS Spooler Database Schema 27 The IOS Spooler Database Schema The IOS spooler database has one table named Requests. Figure 22 displays the schema for Microsoft Access, SQL Server, and Oracle. Information for the footnoted items is located below (Figure 22). Microsoft Access SQL Server Oracle FieldName 1 Data Type Size Data Type Size Data Type Size ID 2 Auto Number - DECIMAL 3 27 NUMBER 4 27 Request_Date Date/Time - DATETIME - DATE - Pegasystem_ID Text 20 VARCHAR 20 VARCHAR2 20 ZPRSpool_Key Text 255 VARCHAR 255 VARCHAR2 255 Output_Type Text 10 VARCHAR 10 VARCHAR2 10 External_Data_File Text 255 VARCHAR 255 VARCHAR2 255 External Data Type Text 5 VARCHAR 5 VARCHAR2 5 Tag_Data 5 Memo - TEXT - BLOB - Group_ID Text 50 VARCHAR 50 VARCHAR2 50 Group_Sort_Order Long - INT - NUMBER 27 Group_Total Long - INT - NUMBER 27 Fax_ID Long - INT - NUMBER 27 Status Text 10 VARCHAR 10 VARCHAR2 10 Error_Buffer Text 255 VARCHAR 255 VARCHAR2 255 Figure 22. Schema for the Requests Table Footnotes: 1. Field Name The Field Names are different from those in IOS 3.1. Underscores replace embedded blanks. In Oracle, you must capitalize all field names. 2. ID The ID is the primary key. Its values are created automatically and uniqueness is guaranteed. The Auto Number data type provides this for Microsoft Access. In SQL Server, the column definition has the IDENTITY clause, and Oracle associates a sequence object for this purpose. If not specified, precision is assumed to be 0.

31 28 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide 3. DECIMAL The size of DECIMAL fields in SQL Server is expressed by the ordered pair (scale, precision). Scale represents the total number of decimal digits irrespective of decimal point placement, and precision is the number of digits to the right of the decimal place. 4. NUMBER The NUMERIC data type in Oracle is similar to DECIMAL in SQL Server, except Oracle also allows negative precision, in which case the number is padded with trailing zeroes. 5. Tag_Data The protocol from Process Commander to IOS limits this to 32 KB, Memo fields in Microsoft Access can contain up to 64,000 bytes. TEXT fields in SQL Server and LONG fields in Oracle can contain up to bytes.

32 Field Values 29 Field Values Figure 23 displays the values of the fields in the IOS Spooler database table named Requests. FieldName Values Notes ID Request Date Automatically generated Date of request PegaSYSTEM ID PegaRULES server name Used for error checking ZPRSpool Key Unique reference ID or NOERRPROCESS Used for error checking Output Type External Data File PRINT FAX UNZIP PDF File to be processed External Data Type T R D T = text, R = Rich Text Format, D Doc File Tag Data See the Tag Data table on page 30 Group ID PRINTING or FAXING Only for Zip files (UNZIP output type) Group Sort Order 0 Not used with PegaRULES Group Total Any integer Number of files within a Zip file to be printed or faxed Fax ID 0 Not used with PegaRULES Status NEW INPROC ERROR DONE GRPNEW GRPREADY NOTIFIED SVCWAIT Error Buffer Error description Holds error Figure 23. Field Values for the Requests Table

33 30 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Tag Data The Tag Data field is a string in which the first character is a delimiter (=). Tags and their associated values then occur serially and are separated by the delimiter character. Tags and their associated values (Figure 24) vary by the type of request. UNZIP requests have tags for both processing the Zip file and the eventual output of the individual files encapsulated in the Zip file. Request Type Tag Values PRINT TEMPDIR Path for temporary directory. Used in request generated by UNZIP. PRINTER Network path to printer COPIES Number of times to print file DEBUG n FAX FAXTONUMBERx Fax number, suffixed by single digit index value. Digits, not delimited. FAXTONAMEx Fax recipient, suffixed by single digit index value. Corresponding names and numbers have the same index. FAXFROMNAME Sender's name UNZIP OUTPUT_TYPE PRINT FAX TEMPDIR Directory to place files in Filenames separated by delimiters (for example, filex.doc=filea.doc) This forces individual files to print in specified order. Used in Group sort order on the generated requests. If not specified, the order in which individual files print is the order in which they were extracted from the Zip file. PDF pzinskey Work object to link the new PDF to in Process Commander. pycategory Attachment category to use when saving the new PDF in Process Commander. pymemo Memo to use when saving the new PDF in Process Commander. pxattachname New name of the converted PDF. pyuseridentifier User ID of the Word to PDF requestor. DEBUG 1 to enable debugging PRINTER Always set to Amyuni Document Converter. Figure 24. Tag Data

34 Appendix A Contacting Pegasystems This appendix describes how to contact Pegasystems for the following: Customer support Education services Documentation feedback Office locations For more information about our company and products, visit our Web site at

35 32 PegaDISTRIBUTION MANAGER (IOS) Installation and Configuration Guide Customer Support Pegasystems Global Services has a dedicated team of support engineers and product specialists ready to respond with support and consulting services. Pegasystems offers a choice of customer support programs to meet your business requirements. Global Services is committed to working in partnership with our customers to deliver world-class support and service. To contact Pegasystems, go to Education Services Pegasystems Education department offers a wide range of courses for our customers. For course descriptions and contact information, go to Courses can be presented at customer sites. Courses are given at these locations: Headquarters in Cambridge, Massachusetts Chicago, Illinois San Francisco, California Reading, United Kingdom Sydney, Australia Pegasystems Certified Professional Program The Pegasystems Certified Professional Program is an important part of Education Services. The program provides certification examinations for System Architects on the aspects of PegaRULES Process Commander essential to implementing successful applications. For more information, go to Pega Developer Network (PDN) The Pega Developer Network (PDN), located at is the primary technical resource area for the Process Commander developer community. The PDN contains a broad range of technical articles including troubleshooting and How-To information and a comprehensive and searchable knowledgebase to help developers speed their application development. The PDN also links directly to the customer support section of pega.com where customers can submit trouble reports and product enhancement requests.

36 Documentation Feedback 33 Documentation Feedback Pegasystems strives to produce high-quality documentation. If you have comments or suggestions, please send us a fax or with the following information: Document name, version number, and order number (located on the copyright page) Page number Brief description of the problem for example, what instructions are inaccurate, or what information requires clarification Send faxes to: , attention Technical Communications. Send to: docteam@pega.com. Note: This address is only for documentation feedback. For a product or technical question, contact Pegasystems Global Services department. Office Locations Pegasystems maintains offices in these locations: Cambridge, Massachusetts (Headquarters) Alpharetta, Georgia Chicago, Illinois Concord, New Hampshire New York, New York Irving, Texas Toronto, Ontario, Canada Melbourne, Australia Sydney, Australia Paris, France Reading, United Kingdom For more information, contact your Pegasystems Sales Representative or go to