QAD Enterprise Applications Enterprise Edition Administration Guide QAD System Administration Introduction to System Administration Domain Constants System Interface Printers Batch Processing and Daemons System Control CIM Interface Database Management Reports and Utilities Customizing Business Logic Customizing Specific Business Components UI Customization Installing Electronic Bank File Formats 70-3184-2015EE QAD Enterprise Applications 2015 Enterprise Edition March 2015 This document contains proprietary information that is protected by copyright and other intellectual property laws. No part of this document may be reproduced, translated, or modified without the prior written consent of QAD Inc. The information contained in this document is subject to change without notice. QAD Inc. provides this material as is and makes no warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. QAD Inc. shall not be liable for errors contained herein or for incidental or consequential damages (including lost profits) in connection with the furnishing, performance, or use of this material whether based on warranty, contract, or other legal theory. QAD and MFG/PRO are registered trademarks of QAD Inc. The QAD logo is a trademark of QAD Inc. Designations used by other companies to distinguish their products are often claimed as trademarks. In this document, the product names appear in initial capital or all capital letters. Contact the appropriate companies for more information regarding trademarks and registration. Copyright © 2015 by QAD Inc. SysAdmin_AG_v2015.pdf/ymg/ofs QAD Inc. 100 Innovation Place Santa Barbara, California 93108 Phone (805) 566-6000 http://www.qad.com Contents System Administration  Change Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Chapter 1 Introduction to System Administration. . . . . . . . . . . . . . .1 System Administration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Types of Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Domain Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 System Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Batch Processing and Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 System Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 CIM Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 Database Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 Reports and Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 Customizing Component-Based Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Chapter 2 Domain Constants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Overview of Domain Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Maintaining Holiday and Shop Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Calendar Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Holiday Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Using Generalized Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Field Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Generalized Codes Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Using Reason Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 Managing Number Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 NRM Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Sequence Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 NRM Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 Setting Up Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 Setting Sequence Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Defining Sequences for Sales Orders . . . . . . . . . . . . . . . . . . . . . . . . . .26 Viewing Sequence Number History . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Deleting and Archiving Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Tracking Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 iv QAD System Administration User Guide Change Tracking Implementation Overview . . . . . . . . . . . . . . . . . . . . .27 Defining Change Tracking Reason Codes . . . . . . . . . . . . . . . . . . . . . . .28 Activating Change Tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28 Specifying Fields to Track . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28 Chapter 3 System Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31 Overview of User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33 Using Multiple Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 Multiple Languages and Unicode . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 Setting Up Multiple Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 Language Detail Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 Report Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Customizing Menu Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Executing Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Menu Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 Menus and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 Menu System Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Setting Up Menu Substitutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 Defining Program Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 Viewing Business Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 Modifying Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Creating and Managing Browses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Maintaining Drill Downs and Lookups . . . . . . . . . . . . . . . . . . . . . . . . .48 Creating Access to Other Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Managing Stored Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 Defining Browse URL Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 Creating Browses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 Creating Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62 Defining User Menu and Function Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 User Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Executing Programs in Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66 User Function Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66 Using Field and Program Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66 Adding User Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Printing Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Setting User Telnet Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Configuring Telnet Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Define the Login Sequence Script Lines . . . . . . . . . . . . . . . . . . . . . . . .68 Configure Telnet Connection Settings . . . . . . . . . . . . . . . . . . . . . . . . . .70 Verify the Login Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 Modifying Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 Building an E-Mail System Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72 Setting Up E-Mail System Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . .72 Contents v Using Text E-Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72 E-Mailing Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72 E-Mail Definition Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73 E-Mail Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Customizing Appearance of HTML E-Mail . . . . . . . . . . . . . . . . . . . . .74 Configuring E-Mail Notification for Components . . . . . . . . . . . . . . . .74 Using Advanced Reporting Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75 QAD-Provided Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 Custom Reports and Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 Monitoring User Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 Chapter 4 Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79 Introduction to Printer Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80 Defining Printer Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80 Setting Up Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82 Defining a Printer for Use with QAD .NET UI . . . . . . . . . . . . . . . . . . .84 Setting Default Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84 Defining Document Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84 Chapter 5 Batch Processing and Daemons . . . . . . . . . . . . . . . . . . .87 Introduction to Batch Processes and Daemons . . . . . . . . . . . . . . . . . . . . . . . . . .88 Batch Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 Define Batch IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 Review Batch Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89 Process Batch Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89 Invoke Batch Processing from CIM . . . . . . . . . . . . . . . . . . . . . . . . . . .90 Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91 Overview of Daemon Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92 Daemon User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93 Types of Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93 Daemon Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98 Daemon Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98 Event Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109 Report Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112 XML Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115 Queue View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117 Queue Correct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 Queue Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119 Running Daemons on the Command Line . . . . . . . . . . . . . . . . . . . . . .120 Integrating XML Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120 Planning the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120 Identifying Business Components . . . . . . . . . . . . . . . . . . . . . . . . . . . .121 vi QAD System Administration User Guide Business Component Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122 Tables and Mandatory Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123 Component Schema and Sample Files . . . . . . . . . . . . . . . . . . . . . . . . .125 Creating the XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126 Integrating Multiple Records in an XML Document . . . . . . . . . . . . . .130 Processing the XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130 Bulk Data Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131 Chapter 6 System Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 System Control Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138 Database Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138 System Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 Maintain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 Synchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142 View System Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143 System Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 Set Debug Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145 View CT Logfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147 server.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148 Configuring System and User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148 System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148 User Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152 Making UI Caching Configurable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152 Configuring Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153 Managing Draft Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153 Chapter 7 CIM Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155 Introduction to CIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156 Using the CIM Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156 CIM Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158 Input File Formatting Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158 Input Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159 Determining Data for the Input File . . . . . . . . . . . . . . . . . . . . . . . . . . .159 CIM Data Input File Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160 Creating a CIM Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160 Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162 Deleting Records through CIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162 Creating Input Files to Delete Records . . . . . . . . . . . . . . . . . . . . . . . .163 Example of CIM Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163 Running Multiple CIM Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163 Killing CIM Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163 Contents vii Chapter 8 Database Management . . . . . . . . . . . . . . . . . . . . . . . . . .165 Managing Database Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Determining Disk Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Freeing Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Dumping and Loading Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167 Dump/Load Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167 Deleting and Archiving Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168 Audit Detail Delete/Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169 Restoring Archive Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169 Integrity Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170 Registering Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171 Licensing Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171 License Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174 License Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176 Managing Database Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180 Initializing Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181 Maintaining Sequences Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . .182 Maintaining Sequences Using CIM . . . . . . . . . . . . . . . . . . . . . . . . . . .183 Maintaining Audit Trails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184 Maintaining Sequences in Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . .184 Component Record Numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185 Setting Up Multiple Time Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186 Multiple Time Zones Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . .186 Multiple Time Zone Load Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . .188 Setting a Default Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189 Domain Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189 UTC and Transactions Outside Domains . . . . . . . . . . . . . . . . . . . . . .190 Chapter 9 Reports and Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . .193 Generating Auditing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194 Other Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194 Using System Cross-References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194 Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195 Table, Field, and Menu Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195 Using Program Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196 Updating the Cross-Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198 Setting Up Application Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198 Progress AppServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198 Defining the AppServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199 Example: Using an AppServer to Run MRP . . . . . . . . . . . . . . . . . . . .200 Using Operating System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204 Using Delete/Archive Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204 viii QAD System Administration User Guide Audit Detail Delete/Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204 GL Transaction Delete/Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204 Statutory-Currency Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205 Choosing the Best Time to Run the Utility . . . . . . . . . . . . . . . . . . . . .205 Running the Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206 Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207 Command Line Application Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207 Chapter 10 Customizing Business Logic. . . . . . . . . . . . . . . . . . . . .211 Introduction to Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212 Customization Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212 Supporting Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213 Elements of Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213 Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214 Accessing Generalized Codes and Master Comments . . . . . . . . . . . . . . . . . . .216 Generalized Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216 Master Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217 Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217 Database Access and Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217 Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218 Identifying Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218 Sample Code for Non-Intrusive Customization . . . . . . . . . . . . . . . . . .222 Creating Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223 Writing Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224 Compiling Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224 Updating Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224 Running Other Business Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . .225 Examples of Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225 Chapter 11 Customizing Specific Business Components . . . . . . .227 Customizing Process Incoming Bank Files . . . . . . . . . . . . . . . . . . . . . . . . . . .228 Customer Payments in Bank File Import Lines . . . . . . . . . . . . . . . . . .228 Setting Up Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237 Enabling and Disabling the Customizable Matching Logic . . . . . . . .237 Customizing the Validation of Tax IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237 Validation Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238 Errors and Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239 Customization Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239 Chapter 12 UI Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 Contents ix Design Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 Settings that Affect Design Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . .242 Starting Design Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244 Working in Design Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249 Customize Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252 Delete Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255 Exporting Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .256 Importing Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257 User-Defined Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257 Create a User-Defined Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258 UDFs and Design Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .260 Modifying UDFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .261 Adding Fields to Financials QRF Reports . . . . . . . . . . . . . . . . . . . . . .261 User-Defined Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .264 Elements of User-Defined Component Implementation . . . . . . . . . . .265 User-Defined Components Maintain . . . . . . . . . . . . . . . . . . . . . . . . . .266 Example of User-Defined Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267 Non-Intrusive Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267 Creating a New Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267 Financial Text Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .281 Chapter 13 Installing Electronic Bank File Formats . . . . . . . . . . . .283 Introduction to Electronic Banking Format Installation . . . . . . . . . . . . . . . . . .284 Setting up EDI eCommerce to Use Imported Bank Formats . . . . . . . . . . . . . .284 Using Bank File Format Import to Install the Format . . . . . . . . . . . . . . . . . . .287 Default Directory Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289 Product Information Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291 Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .293 x QAD System Administration User Guide