Data Loading...
ACHGenerator1500 Flipbook PDF
ACHGenerator1500
122 Views
32 Downloads
FLIP PDF 403.63KB
ACH Generator
Version 15
C OPYRIGHT Information in this document is subject to change without notice. The OnBase® Information Management System software (the "Software") described in this document is furnished only under a separate license agreement and may be used or copied only according to the terms of such agreement. It is against the law to copy the Software except as specifically allowed in the license agreement. This document or accompanying materials contains certain information which is confidential information of Hyland Software, Inc. and which is subject to the confidentiality provisions agreed to by you. All data, names, and formats used in this document’s examples are fictitious unless noted otherwise. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright law, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Hyland Software, Inc. ©
2015 Hyland Software, Inc. All rights reserved. Depending on the modules licensed, the OnBase® Information Management System software may include software developed and copyrighted by third parties, including but not limited to the following: A2iA CheckReader™ by A2iA Corp; Adobe® PDF Library™ by Adobe Systems Incorporated; dtSearch® Text Retrieval Engine by dtSearch Corp.; software or other content adapted from Smart Client – Composite UI Application Block by Microsoft Corporation © 2005 Microsoft Corporation; software or other content adapted from Microsoft patterns & practices ObjectBuilder © 2006 Microsoft Corporation; Nuance™ OCR © 1994-2012 Nuance Communications; portions of imaging code owned and copyrighted by Pegasus Imaging Corporation, Tampa, FL; Imaging Technology copyrighted by Snowbound Software Corporation, Snowbound.com; CD-R technology by Sonic Solutions, Inc.; full-text indexing technology by Autonomy; IDSMail © 2005 by Intuitive Data Solutions; jLex Copyright 1996-2003 by Elliot Joel Berk and C. Scott Ananian; Rumba by NetManage; AutoVue by Oracle America, Inc. All rights reserved. Further information regarding third-party software included in the OnBase Information Management System software can be found in the About box within the Software. Hyland Software®, OnBase®, Application Enabler, and Where Your Information Finds You are registered or unregistered trademarks of Hyland Software, Inc. A2iA CheckReader™ is a trademark of A2iA Corporation. Adobe® PDF Library™ is a trademark of Adobe Systems Incorporated. All other trademarks, service marks, trade names and products of other companies are the property of their respective owners.
Document Name ............................................................................. ACH Generator Department/Group .......................................................................... Documentation Revision Number ............................................................................................. 15
©
2015 Hyland Software, Inc. ii
©2015
Hyland Software, Inc. iii
© 2015
Hyland Software, Inc. iv
USING THIS MODULE REFERENCE GUIDE (PDF) In the following module reference guide (MRG), we provide a great deal of information. If you are unfamiliar with our MRGs, take a few moments to review the content below so you can more quickly and efficiently locate the information you need. Note: The content in this MRG is considered module-specific. Therefore, you may be
referred to another MRG if a referenced function is not specific to this module.
What is in the MRG? The MRG is a PDF document containing all available instructions for a module. It includes the following chapters, which contain task-oriented sections: • Exposure - Provides introductory information and license requirements. • Usage - Provides instructions on user-facing functionality. • Configuration - Provides instructions on administrative tasks and functions. • Installation - Provides instructions on installation procedures and information on system requirements. Tip: It is considered a best practice to read through an entire stepped process before
attempting to complete any of its steps. Pay close attention to notes, tips, and cautions, which can help you better understand the entire process and discover any prerequisites you may not have completed.
How to Navigate the MRG When using the MRG, consider the following: • You can jump to any chapter or section contained in the MRG by clicking its entry in the Table of Contents. • The title bars of dialog boxes and the names of options in the software are displayed as bold text in the documentation. If you are searching for information on a named option or dialog box, search for that text in the documentation. The following search instructions pertain to viewing an MRG in Adobe Reader or Adobe Acrobat. Some of the information may not apply to other PDF readers. Basic search: Press Ctrl + F. Enter the word or phrase you are looking for in the search box and press Enter to locate each instance. Advanced search: Press Ctrl + Shift + F. From the Search dialog box, enter the word or
phrase you are looking for and select one of the following options:
• In the current document - Searches the document you are viewing. • All PDF Documents in - Searches a selected folder or directory. If you are unsure of which MRG to search, try searching the folder your MRGs are located in to display all results for the word or phrase.
©2015
Hyland Software, Inc. v
Advanced search results are displayed in a list, along with some context (e.g., page numbers and some of the text surrounding each instance). Cross-references: Cross-references are links to related information or additional instructions you may need to complete a task. Though they appear the same as normal text, they jump to referenced sections when clicked. A page or step number typically indicates a crossreference.
Example of a cross-reference: What is in the MRG? on page v. Tip: To return to the page you were viewing before following a cross-reference, press Alt + Left Arrow until the desired page is displayed.
© 2015
Hyland Software, Inc. vi
ACH Generator
Table of Contents
USING THIS MODULE REFERENCE GUIDE (PDF) What is in the MRG?......................................................................................... v How to Navigate the MRG ................................................................................ v
EXPOSURE Overview .........................................................................................................1 Commonly Used Terminology ..........................................................................1 How ACH Works ....................................................................................................... 2
Applications .....................................................................................................2 Licensing .........................................................................................................3
USAGE Usage ..............................................................................................................5 Register the Workstation ........................................................................................... 5 Clearing Excess Registrations ............................................................................... 7 Workstation Cleanup ................................................................................................. 8 View Current Users ................................................................................................... 8 Clean Up ........................................................................................................... 9
Administration .................................................................................................9 Maintenance ....................................................................................................9
CONFIGURATION Configuration Overview .................................................................................11 Configuring the ACH Generator Server....................................................................... Mandatory Configuration Information .................................................................. Optional Configuration Information ...................................................................... Configuring Non-Business Days .......................................................................... Configuring WorkView ............................................................................................. Configuring Unity Scripts ......................................................................................... Configuring a Workflow Life Cycle .............................................................................
11 11 13 15 16 17 17
INSTALLATION Requirements ................................................................................................19 Client Module Supported Operating Systems .............................................................. Operating System Requirements ......................................................................... Databases Supported .............................................................................................. Microsoft SQL Server ......................................................................................... Oracle ............................................................................................................. Sybase SQL Anywhere ....................................................................................... Database Client / Server Version Compatibility ...........................................................
©
2015 Hyland Software, Inc. vii
19 19 20 20 20 21 21
Table of Contents
ACH Generator
Database/File Servers ....................................................................................... Processing Workstation Minimum Hardware Requirements............................................ Third-Party Software Support ................................................................................... About Virtual Environments...................................................................................... 64-Bit Support Statement ........................................................................................ Windows User Account Control Statement .................................................................. Data Execution Prevention (DEP) .............................................................................. Determining DEP Settings .................................................................................. Configuring Exceptions to DEP Settings ................................................................ Licensing ...............................................................................................................
22 22 22 23 23 23 24 24 25 26
Pre-Installation .............................................................................................26 Creating Directories for ACH Logs ............................................................................. 27 OnBase Products .................................................................................................... 27
Installation ....................................................................................................27 Installing the ACH Files............................................................................................ 27 Setting Up a New ACH Server................................................................................... 28
Command Line Switches and .ini Settings......................................................28 Backup / Recovery ........................................................................................28 Troubleshooting ............................................................................................29 Contacting Support ........................................................................................29
©
2015 Hyland Software, Inc. viii
EXPOSURE Overview The Automated Clearing House (ACH) is a nationwide network of financial institutions utilizing batch-oriented electronic funds transfer. The ACH network provides clearing of electronic payments, such as Direct Deposit, for participating financial institutions. Depository institutions participating in the ACH network are governed by National Automated Clearing House Association (NACHA) Operating Rules, which enforce standards of accurate and efficient payment processing. Payments are cleared in batches through ACH Operators, such as the Federal Reserve, which act as central clearing facilities for thousands of financial institutions. The OnBase ACH Generator can create an ACH file that conforms to the NACHA format for Electronic Funds Transfer (EFT). OnBase can create pre-notification files, in an amount of zero dollars, to test the information prior to funds transfer. The check consolidation feature will combine multiple payments to the same account into a single transaction in the ACH file to further reduce fees.
Commonly Used Terminology This section gives an overview of financial terms commonly used when describing the ACH process. 1 ACH : The Automated Clearing House is a network of participating financial institu-
tions which utilizes Electronic Funds Transfer (EFT) to exchange monies.
ACH Operator : An ACH Operator is the central clearing house for ACH payments, operated by the Federal Reserve or a private institution. ACH payments are transmitted to and from these Operators by participating financial organizations. Direct Deposit : The most common form of ACH transaction. Direct Deposit disburses funds directly into consumer accounts. Direct Payment : Withdraws funds directly from an account, under proper authorization. Effective/Settlement Date: These are actually two separate dates. The Effective
Date is the date entered by the Originator as the day the transaction should post. The Settlement Date is the actual date the transaction is settled by the ACH Operator. These dates will differ by the time the transaction takes to process through the ACH Operator.
NACHA: The National Automated Clearing House Association sets standards and rules for responsible and effective clearing of electronic payments through the ACH Network.
1. This terminology is intended as a general overview. It is not included as a comprehensive guide to NACHA standards. Please refer to the current edition of NACHA’s ACH Rules for additional information or confirmation.
©
2015 Hyland Software, Inc. 1
ACH Generator
OnBase 15
Originating Depository Financial Institution (ODFI) : The financial institution that originates the ACH transaction. The ODFI deposits ACH files into the ACH Network, on behalf of the Originator. Originator : The Originator is the company (or individual) that begins the ACH transaction, by requesting a transfer of funds. Pre-Notifications : An ACH transaction in the amount of zero dollars sent to both
Exposure
test the connection to the Receiving Depository Financial Institution as well as notify them of future payments. This is optional.
Receiver: The Receiver is the company (or individual) who has authorized an Originator to request an ACH transfer of funds. Receiving Depository Financial Institution (RDFI) : The RDFI is the Receiver’s financial institution. Money transferred from the ODFI will end up in the Receiver’s bank account at the RDFI.
How ACH Works Note: The following is an example of a typical ACH transaction. Refer to Commonly Used
Terminology on page 1 for further explanation of the terminology used in this example.
When you bought your car, you received financing through your car dealership. Your car payments are due on the 15th of each month. In order to avoid any possibility of late payments, you authorize your financial institution to withdraw 400 dollars each month for automatic transfer into your lender’s account. This authorization takes the form of a written payment agreement. Each month, when you check your bank account to make sure the payment is being transferred correctly, you see the 400 dollars still in your account with the description “Pending ACH Debit.” On the 15th of each month, you notice the money is withdrawn from your account. The Receiver in this case is the lender; the individual/institution that will eventually receive the money. The Receiver authorizes the institution which handles their accounts, the Originator, to initiate a request for funds into the ACH Network. Having this authorization, the Originator sends a request to the Originating Depository Financial Institution (ODFI). The ODFI is the bank at which your account is kept. The Originator makes this request by forwarding transaction data to the ODFI. The ODFI then sorts this data, sends it to the ACH Operator, and deducts the amount of the car payment (400 dollars) from your account. This amount is, for the time being, still in your account, but marked as a “Pending ACH Debit,” or a “Pending ACH Transaction.” This is what you see when you check your account before the 15th of each month. Essentially, these funds have a freeze placed on them.
©
2015 Hyland Software, Inc. 2
OnBase 15
ACH Generator
Applications Applications for ACH payments include: • Direct Deposit payments, such as Social Security, payroll, and tax refunds • Government tax payments • Electronic bill payments Many forms of internet payment, such as members-only web sites, also utilize ACH to facilitate funds transfer.
Licensing The ACH Generator requires a valid Client license. Check your current licensing status by selecting Utils | Product Licenses from the Configuration module.
©
2015 Hyland Software, Inc. 3
Exposure
When the ODFI transmits ACH batch payment files to the ACH Operator (which happens at least once per day, and generally up to four times), the ACH Operator notes the transaction digitally. So far, this entire transaction has been hypothetical. Think of what the ACH Operator does as marking the transaction in a ledger; the only difference is that the marks are electronic, not on paper. The ACH Operator sends the noted file on to the RDFI, or Receiving Depository Financial Institution. This would be the lender’s bank. The amount of the car payment is added to the lender’s account, but again, this is noted as “Pending ACH Transaction.” When the RDFI receives the information from the ACH Operator and all accounts are verified to have adequate funds, the payment is transferred from your account to your lender’s. At this point all “Pending” notes are removed and the transaction is settled.
OnBase 15
Exposure
ACH Generator
©
2015 Hyland Software, Inc. 4
USAGE Usage The OnBase ACH Generator is completely automated once configured. No user interaction is required to generate ACH files, although solution-specific scripting and/or third-party applications may need to be in place to correctly process or send the ACH files. The workstation that will be generating ACH files does need to be registered for the ACH Generator.
Register the Workstation To register the workstation: 1. From the OnBase Client, click Admin | User Management | Workstation Registration . The Products Registered for Workstation dialog box is displayed.
The right side displays all products registered on the selected workstation. The left side of the screen displays a list of the workstations that have, at any time, been logged on to OnBase. The current workstation is shown at the top of the list and marked with an asterisk (*). The columns are as follows:
©
2015 Hyland Software, Inc. 5
Usage
ACH Generator
OnBase 15
Column Name
Description
License(s)
Displays the symbols of the products registered for that workstation. The legend for the symbols is located below the list of workstations.
Registered
Displays the name of each workstation that has ever been logged in to OnBase.
Last Logon
Displays the date that the workstation was last logged on.
Description
Displays a short description of the individual workstation.
2. Make sure that the current workstation, denoted by an asterisk (*), is selected. Select the proper Workstation License from the Products Registered drop-down list. If you are properly licensed for the Workstation License and it is not available from the drop-down list, it may be registered on another workstation. Select each workstation that is marked with a + (which indicates that the workstation is registered for the Workstation License or another product) until the Workstation License is found. To revoke registration from the workstation, select the Workstation license on the right side and click the Revoke button. Then, select the current workstation and register it. If the Workstation License is not displayed in the drop-down and it is not registered to any other workstation, it is possible that the module may not be licensed. Tip: It is considered a best practice to register a processing workstation as a Named Client rather than a Concurrent Client. This ensures that the processing workstation always has access to the processing module; a workstation registered as a Concurrent Client cannot access the processing module if another workstation is currently registered for it. Note: If a registered workstation needs to be re-registered, the old workstation can be deleted by selecting it in the workstation list and clicking Delete . All product rights held by the workstation will be returned to the list of available licenses found in the Products Registered drop-down. This forces the user logging on from that workstation to register
the workstation the next time they attempt to log on.
3. When you have finished registering the workstation, click Exit.
©
2015 Hyland Software, Inc. 6
OnBase 15
ACH Generator
4. Verify registration —Select Window | System Status from the menu bar to display the System Status dialog box. At the bottom of the window is a list of all products registered on the workstation and a status message for each.
Usage
©
2015 Hyland Software, Inc. 7
ACH Generator
OnBase 15
Clearing Excess Registrations
Usage
The number of workstations you can register for a given module is dependent upon the number of licenses you have purchased for that module. If you attempt to register a specific module on more workstations than you have licenses for, the excess workstations will be unable to use the module. When a user logs on to a workstation with one or more excess product registrations, a warning will be displayed to inform them what modules will not work on that workstation. You can remove excess product registrations the same way you would remove a functional product registration. From the Workstation Registration dialog box, select the workstation that has excess product registrations. Any products that are registered in excess of the licensing limit will contain the [Excess Registration] string. Select the necessary products and click Revoke to remove the
excess registration from the workstation.
Workstation Cleanup At some point, it may be necessary to delete workstations from the list in the Products Registered for Workstation dialog box. This may be necessary if there are many
workstations on the list that are no longer accessing OnBase. One method of cleanup is to delete all of them and allow the list to regenerate as workstations are logged back on to OnBase. Alternatively, you can select the desired workstations and delete them in groups. If workstations are deleted inadvertently, they will be added back when the workstation is logged onto OnBase. If the current workstation is selected, an error message is displayed and it is not removed from the list. To delete a workstation from the Products Registered for Workstation: 1. From the OnBase Client, click Admin | User Management | Workstation Registration . The Products Registered for Workstation dialog box is displayed. 2. The left side of the dialog box contains four sortable columns. The Last Logon column allows the user to delete all workstations that have not been logged on to OnBase during a specified period of time. 3. Select the desired workstations and click the Delete button. 4. Select Exit when finished.
View Current Users View Current Users allows a user to view information about other OnBase users, including
the time a user logged onto the system and the type of license being consumed by that user’s workstation.
©
2015 Hyland Software, Inc. 8
OnBase 15
ACH Generator
To view current user information, select Admin | User Management | View Current Users. The Users Currently Logged In dialog box is displayed.
Usage
Clean Up User entries can be removed, or cleaned up, from the Users Currently Logged In dialog box provided that the user is not trying to remove his or her own session and the session being cleaned up is not displaying an Active status.
Administration The ACH Generator will create a report in the SYS ACH Report Document Type under the System Documents Document Type Group. This report should be reviewed on a regular basis to make sure there were no processing issues and the total items and total amounts processed matched.
Maintenance There is no system maintenance necessary for the ACH Generator.
©
2015 Hyland Software, Inc. 9
OnBase 15
Usage
ACH Generator
©
2015 Hyland Software, Inc. 10
CONFIGURATION Configuration Overview The following step is required for configuring the ACH Generator: • Enter all configuration information in the ACH Generator Configuration (see Configuring the ACH Generator Server on page 11). If you wish to generate ACH files using Unity scripts, the following configuration steps are also required: 1. Configure WorkView to connect to your Web Server and Application Server (see Configuring WorkView on page 16). Note: This step is only required if WorkView is licensed in your database.
2. Configure an appropriate Unity script to generate ACH files (see Configuring Unity Scripts on page 17). 3. Configure a Workflow Life Cycle to run the Unity script (see Configuring a Workflow Life Cycle on page 17).
Configuring the ACH Generator Server To configure the ACH Generator Server: 1. Open the ACH Server executable. 2. Click Tools | Settings to open the ACH Settings Configuration dialog box. Note: Depending on which version of the ACH Generator you are using, the ACH Settings Configuration dialog box may be displayed automatically when you open the executable.
When configuring the ACH Settings, some information is mandatory. Use the tables below as a guide to which information must be entered to adhere to NACHA standards for generated ACH files.
Mandatory Configuration Information Setting
Description
Destination Path for Output Files Log File
The path for this setting must be C:\ACH\Log\. This directory is where the log files for each generation of ACH files will be placed.
ACH File(s)
The path for this setting must be C:\ACH\Output\. This directory is where the generated ACH files will be placed.
Company Information
©
2015 Hyland Software, Inc. 11
ACH Generator
OnBase 15
Setting
Description
Name
The name of the company or institution that will be used in the batch header records of the generated ACH files. Note: The Name can be up to 16 characters long.
Configuration
ID
The company ID that will be used in the batch header and batch control records of the generated ACH files. Note: The ID can be up to 10 characters long.
Entry Description
The entry description that will be used in the batch header records of the generated ACH files. Note: The Entry Description can be up to 10 characters long.
Originating DFI ID
The routing number of the ODFI that will be used in the batch header and batch control records of the generated ACH files. For a definition of ODFI, see Commonly Used Terminology on page 1. Note: The Originating DFI ID must be 8 numeric characters long in the form of TTTTAAAA.
Transfer Information Destination Routing Number
The immediate destination routing number that will be used in the file header records of the generated ACH files. Note: The Destination Routing Number must be 10 numeric characters long in the form of bTTTTAAAAC, where b is blank, and C is the check digit.
Origin Routing Number
The immediate origin routing number that will be used in the file header records of the generated ACH files. Note: The Origin Routing Number must be 10 numeric characters long in the form of nTTTTAAAAC, where N is 0-9, and C is the check digit.
Account Information Receiving DFI ID
The routing number of the RDFI that will be used in the deposit/ payment records of the generated ACH files. Note: The Receiving DFI ID must be 8 numeric characters in the form of TTTTAAAA.
©
2015 Hyland Software, Inc. 12
OnBase 15
ACH Generator
Setting
Description
Check Digit
The check digit for the Receiving DFI ID that will be used in the deposit/payment records of the generated ACH files. Note: The Check Digit must be 1 numeric character.
DFI Account #
Note: The DFI Account # can be up to 17 characters long. Name
The individual name that will be used in the deposit/payment records of the generated ACH files. Note: The Name can be up to 22 characters long.
Account Type
Indicates the type of bank account. Select Checking or Savings.
Batch Type CCD or PPD
Indicates the type of entries which will be used in each batch of generated ACH files.
Optional Configuration Information Setting
Description
Destination Path for Output Files Archive ACH Files to OnBase
Select to archive ACH log files into OnBase.
Company Information Discretionary Data
The company-specific data that will be used in the batch header records of the generated ACH files. Note: The Discretionary Data can be up to 20 characters long.
Authentication Code
The message authentication code that will be used in the batch control records of the generated ACH files. Note: The Authentication Code can be up to 8 characters long.
Override Dates
The batch header effective entry date and description are normally auto-generated as the next business day. Override Dates allows the user to enter specific dates to be used in the batch headers of the generated ACH files.
©
2015 Hyland Software, Inc. 13
Configuration
The DFI account number that will be used in the payment/deposit records of the generated ACH files.
ACH Generator
OnBase 15
Setting
Description
Descriptive Date
The company descriptive date that will be used in the batch header records of the generated ACH files.
Configuration
Note: This setting is only used if Override Dates is selected. It is optional. Note: The Descriptive Date can be up to 6 characters long. Effective Date
The effective date that will be used in the batch header records of the generated ACH files. See Commonly Used Terminology on page 1 for more information about the Effective Date. Note: This setting is mandatory if Override Dates is selected. Note: The Effective Date must be 6 numeric characters long in the form of YYMMDD.
Transfer Information Destination Name
The ACH or receiving point for which the file is destined, used in the file header records of the generated ACH files. Note: The Destination Name can be up to 23 characters long.
Origin Name
The name of the ACH Operator or sending point that is sending the file, used in the file header records of the generated ACH files. Note: The Origin Name can be up to 23 characters long.
Account Information Individual ID #
The individual number ID that will be used in the deposit/payment records of the generated ACH files. This is the account number by which the Receiver is known to the Originator. See page 1 for more information about the Receiver and Originator. Note: The Individual ID # can be up to 15 characters long.
Discretionary Data
The discretionary data that will be used in the deposit/payment records of the generated ACH files. Note: The Discretionary Data can be up to 2 characters long.
©
2015 Hyland Software, Inc. 14
OnBase 15
ACH Generator
Setting
Description
Payment Info
The payment-related information used in the addenda records of the generated ACH files. Note: The Payment Info can be up to 80 characters long.
Miscellaneous The content of this field will be inserted at the top of the generated ACH file, prior to the file header record. Note: Use of this field will result in non-standard ACH files.
Configuring Non-Business Days The ACH Generator creates ACH files every day unless non-business days are configured. Any day flagged as non-business will not have ACH files generated for it. Non-business days may be configured by week, month, year, or by full calendar. Note: Depending on which version of the ACH Generator you are using, the Non-Business Days dialog box detailed below might not be available. If it is not available, you must manually configure non-business days in the ACHServerConfig.xml file. For more
information, contact your first line of support.
©
2015 Hyland Software, Inc. 15
Configuration
Additional Info
ACH Generator
OnBase 15
To configure non-business days: 1. From the ACH Generator menu bar, select Tools | Calendar. 2. The Non-Business Days dialog box is displayed.
Configuration
Note: The default display for the calendar is Weekly.
3. If desired, right-click the calendar heading (in the example above, Weekly ) and select one of the following options to display a different calendar for configuration: • Weekly--configure non-business days by the week • Monthly--configure non-business days by the month • Monthly (day-relative)--configure non-business days by selecting the desired recurring day of the month • Annual--configure non-business days throughout an entire calendar year • Full Calendar--configure non-business days throughout the current calendar year 4. Double-click a dot to select the day as a non-business day. 5. If desired, enter a description for the day in the Description field. 6. Click OK to save settings and close the dialog box. Click Cancel to close the dialog box without saving changes.
Configuring WorkView If WorkView is licensed in your database, you must configure the connection settings for your Web Server and Application Server. For more information, see the Web Server Connection Setup section of the WorkView | Case Manager module reference guide.
©
2015 Hyland Software, Inc. 16
OnBase 15
ACH Generator
Configuring Unity Scripts If you wish to generate ACH files using Unity scripts, you must configure appropriate Unity scripts in the Unity Configuration tool within the OnBase Configuration module. For more information on configuring Unity scripts, contact your first line of support.
Configuring a Workflow Life Cycle
For more information on configuring Workflow Life Cycles, see the Workflow module reference guide.
©
2015 Hyland Software, Inc. 17
Configuration
If you wish to generate ACH files using Unity scripts, you must configure a Workflow Life Cycle in OnBase Studio with a Run Unity Script Action.
OnBase 15
Configuration
ACH Generator
©
2015 Hyland Software, Inc. 18
INSTALLATION Requirements Client Module Supported Operating Systems • Windows Vista SP2 or later service pack • Windows Server 2008 SP2 or later service pack • Windows Server 2008 R2 SP1 or later service pack • Windows 7 SP1 or later service pack • Windows 8 • Windows 8.1 • Windows Server 2012 • Windows Server 2012 R2 Note: As of OnBase 14, the Windows XP and Windows Server 2003 operating systems are
no longer supported. These operating systems do not support Microsoft .NET Framework 4.5.1, which is a requirement as of OnBase 14. If you are using either the Windows XP or Windows Server 2003 operating system, you should not upgrade to OnBase 14 until you have upgraded to a Windows operating system supported by OnBase. For a complete list of operating systems that are no longer supported, see the table below.
Operating System
No Longer Supported As Of:
Windows NT 4.0
OnBase 7.2
Windows 98
OnBase 7.2
Windows 2000
OnBase 10.0.0
Windows XP
OnBase 14
Windows Server 2003
OnBase 14
Operating System Requirements The above Client module supported operating systems require both: • Microsoft .NET Framework 4.5.1 • Microsoft Visual C++ 2013 Redistributable Package (x86) Note: The Microsoft Visual C++ 2013 Redistributable Package (x86) is installed using the vcredist_x86.exe delivered with OnBase.
©
2015 Hyland Software, Inc. 19
ACH Generator
OnBase 15
Databases Supported The following tables list the databases supported.
Installation
Microsoft SQL Server Microsoft SQL Server
Additional Information
Microsoft SQL Server ™ 2005 (SP2 or later recommended)
Microsoft SQL Server 2005 must be running in compatibility mode 7 or greater. Running in compatibility mode 6.5 or lower will result in errors during the upgrade process.
Microsoft SQL Server 2008 (RTM, SP1, SP2; SP2 recommended)
SQL Server 2005 drivers must be upgraded to the Feature Pack for Microsoft SQL Server 2005 - December 2008 or a later feature pack.
Microsoft SQL Server 2008 R2 (RTM, SP1; SP1 recommended)
Note: On January 11, 2011, Microsoft discontinued technical support for Microsoft SQL Server 7.0. As of release 11.0.0, Hyland Software no longer supports SQL Server 7.0.
Microsoft SQL Server 2012 Microsoft SQL Server 2014
Note: On April 9, 2013, Microsoft discontinued technical support for Microsoft SQL Server 2000. As of release 13, Hyland Software no longer supports SQL Server 2000. Note: You must ensure that your SQL Server database client software version matches or exceeds the database server version. For example, if your database server is SQL Server 2008, verify that the database client is SQL Server 2008 (or later). Running a previous client version, such as SQL Server 2005, will result in system instability and memory issues. For instructions on determining your server and client versions, see Database Client / Server Version Compatibility on page 21.
Oracle Note: If you are using an Oracle database, it is strongly recommended that you have a
certified Oracle Database Administrator on staff.
Oracle
Additional Information
Oracle v 8.0.5.0 or later
Oracle version 8.0.5.0 can be used, but it is not recommended due to potential memory leaks. If Oracle 8.0.5.0 is used, a third-party ODBC driver is recommended.
Oracle 8i: 8.1.7.7 or later
ODBC drivers should be 8.1.7 or later. 8.1.6.x drivers have known issues and are not supported.
©
2015 Hyland Software, Inc. 20
OnBase 15
ACH Generator
Oracle
Additional Information
Oracle 9i: Release 1 and Release 2 (9.2)
Oracle driver version 10.2.0.3 is recommended.
Oracle 10g: Release 1 and Release 2
To ensure that Unicode characters retrieved from a CLOB data type are not truncated, the Oracle 10g R2 ODBC drivers (which are backward compatible) should be installed, as well as the latest patchset (version 10.2.0.3) for these drivers. Oracle 11g: Release 1 and Release 2
All Oracle 11g drivers can be used.
Oracle 12c
All Oracle 12c drivers can be used.
Sybase SQL Anywhere Sybase SQL Anywhere
Additional Information
Sybase SQL
As of OnBase 14, Sybase SQL Anywhere™ versions 11.x and lower are no longer supported. Sybase’s engineering support for SQL Anywhere versions 11.x and lower has been retired (Sybase End of Life Page).
Anywhere
™
12
SAP Sybase SQL Anywhere 16
Database Client / Server Version Compatibility Due to critical issues that have been reported to Hyland Software, Hyland Software strongly recommends that: • your database client software version matches or exceeds the database server version and • you are running the most recent version of the database client. This will help to reduce compatibility issues and minimize troubleshooting time when issues do occur. Your database administrator can determine the database server version and identify the most-recent version of the database client software. The ODBC driver number indicates which version of the database client software you are using. For example, if your database server software is Oracle 10 Release 2, verify that the Oracle Client software is Oracle 10 Release 2 (or later). The same is true of SQL databases. For example, if your database server is SQL Server 2005, verify that the database client is SQL Server 2005 (or later).
©
2015 Hyland Software, Inc. 21
Installation
An issue has been observed with the Oracle ODBC drivers where Unicode characters (e.g., Japanese characters) retrieved from a CLOB data type will be truncated, and could potentially cause errors in OnBase. The data remains intact in the database; however the results when retrieving the data will be truncated. This has specifically been observed in two areas of OnBase that use the CLOB data type to store large amounts of data: VBScripts and License Certificates. This behavior may apply to other areas of the software that use this data type as well.
ACH Generator
OnBase 15
To check your database client version, perform the following steps from the workstation or server where the ODBC connection is configured: 1. Open your ODBC Data Source Administrator, and click on the Drivers tab. 2. Select the driver you are using to connect to your OnBase database.
Installation
• If your database server software is Oracle 10 Release 2, the version number should appear as 10.2.[#.#.#] (or later), where 10.2 is the version number and [#.#.#] represents the service pack. • If your database server software is any version of Microsoft SQL Server, select Microsoft ODBC Driver 11. The above descriptions are examples of two commonly used database version schemes. Ensure that the supported database you use adheres to the database client/server recommendation. In general, Hyland Software recommends that you use the most current drivers that correspond to your system.
Database/File Servers Server requirements are site-specific. Database/file servers should be dedicated purpose servers; i.e., not used as a domain controller, email server, print server, proxy server, etc. Network and disk I/O hardware should be optimized for performance and redundancy. Multiple network interface cards on servers are often required to minimize network bottlenecks.
Processing Workstation Minimum Hardware Requirements Hardware
Minimum Requirement
Memory (RAM)
A typical processing station can run on as little as 64 MB in addition to the amount of memory required to run the operating system. OS requirements vary greatly.
Free Hard Disk Space
200 MB (system files and OnBase software)
Screen Resolution
1024 x 768 (1280 x 800) Note: Using a lower resolution may result in a loss of functionality.
Third-Party Software Support OnBase is used in conjunction with a variety of third-party software products. The specific versions of third-party software that are supported are documented in the requirements sections of this manual, which reflect the versions that were required at the time this manual was published. For up-to-date information, click on the following link: https://www.onbase.com/ community/technical_communities/third_party_software_updates/default.aspx.
©
2015 Hyland Software, Inc. 22
OnBase 15
ACH Generator
About Virtual Environments Hyland Software develops, tests, and supports the OnBase suite of products on specific Operating Systems, not specific hardware configurations. When OnBase is operated in a virtual environment (such as Citrix, VMware, Hyper-V, or Windows Remote Desktop) there may be limitations or subtle differences imposed by the environment. The customer and the virtual environment vendor are responsible for any interactions or issues that arise at the Hardware or Operating System layer as a result of their use of a virtual environment.
Each OnBase site is unique. Hyland Software depends on the customers who deploy OnBase in virtual environments to do so only after careful design and adequate planning (that takes into account the workloads of your organization), and in accordance with recommendations provided by the virtual environment’s vendor. As with any implementation, Hyland Software strongly recommends that any customer deploying the OnBase solution in a virtual environment thoroughly test the solution before putting it into production. For information about using OnBase in a Citrix and Microsoft Windows Remote Desktop environment, please see the Citrix and Microsoft Windows Remote Desktop Environment Deployment Guide , available from your solution provider.
64-Bit Support Statement The OnBase suite of products is tested on 64-bit systems and is capable of being deployed on 64-bit systems using the Windows 32-bit on Windows 64-bit Emulator (WOW64) layer. However, OnBase modules that integrate with third-party applications may not be able to be used with the 64-bit versions of these applications. For these modules, only the 32-bit versions of these third-party applications are currently supported by the OnBase integrations. Consult the module-specific requirements section in each module reference guide for complete requirements details. Supported database versions that are deployed on a 64-bit database server are also supported. For more information, contact your solution provider.
Windows User Account Control Statement Hyland Software is dedicated to ensuring that OnBase is compatible with Windows User Account Control (UAC). UAC is a feature of Windows operating systems that was introduced with Windows Vista. It limits the ability of standard users to make global system changes to a workstation and prevents malicious software from making unauthorized changes to protected areas. For details on UAC, refer to your Microsoft support information or see http:// technet.microsoft.com/en-us/library/cc709691(WS.10).aspx. You may encounter UAC in OnBase when: • Installing or uninstalling OnBase, OnBase modules, or OnBase ActiveX controls.
©
2015 Hyland Software, Inc. 23
Installation
When it appears that a performance-related issue in OnBase is either caused by (or is unique to) the virtual environment, organizations may be asked to validate that the issue occurs in a non-virtual environment. Hyland Software will make this request if there is reason to believe that the virtual environment is a contributing factor to the issue.
ACH Generator
OnBase 15
• Copying, moving, or saving files to the Program Files directory, Windows directory, or another protected location. • Modifying system-wide settings, such as the registry. If Windows UAC is enabled, the above operations may prompt for administrator privileges or credentials, even if an administrator is currently logged on.
Installation
Data Execution Prevention (DEP) Data Execution Prevention, or DEP, is a Windows feature that prevents execution of code from places where it should not be executed. Two kinds of DEP may be present on any system running any modern Windows client (i.e., Windows Vista or later) or server (i.e., Windows Server 2008 or later) operating system: DEP software and hardware-based DEP. Each type of DEP prevents a different type of undesired code execution. By default, DEP software is contained in all modern Windows client and server operating systems. Hardware-based DEP, or computer-hardware enforced protection, requires a processor that will support hardware-based DEP. Processors that support hardware-based DEP do so through a set of instructions on the processor that implement the hardware protection. Hardware-based DEP is only used in Windows when such a processor is present. If there is an issue with OnBase as a result of DEP, make sure an exception for OnBase has been created in your DEP settings.
Determining DEP Settings The following instructions will help you determine whether DEP settings need to be adjusted on your system: 1. 2. 3. 4.
Log on to your operating system with administrator rights. Click the Start button. Right-click on Computer and select Properties. Click Advanced system settings in the Tasks pane. The System Properties dialog box is displayed. 5. Select the Advanced tab. 6. Select the Settings button in the Performance section. The Performance Options dialog box is displayed. 7. Select the Data Execution Prevention tab. When configuring DEP, two options are present to choose from: Turn on DEP for essential Windows programs and services only and Turn on DEP for all programs and services except those I select . The first option is selected by default for Windows client operating systems (i.e., Windows Vista and later). The second option is selected by default for Windows server operating systems (i.e., Windows Server 2008 and later). When DEP is only turned on for essential Windows programs and services, OnBase will perform normally. However, when Turn on DEP for all programs and services except those I select has been chosen, and hardware-based DEP is enabled, exceptions need to be configured to exempt OnBase from DEP.
Note: Text at the bottom of the Data Execution Prevention tab will indicate whether
hardware-based DEP is supported on your system.
©
2015 Hyland Software, Inc. 24
OnBase 15
ACH Generator
Configuring Exceptions to DEP Settings To configure exceptions to DEP settings: 1. In the Data Execution Prevention tab, the Turn on DEP for all programs and services except those I select option should be already selected. Caution: Do NOT select this option if it is not already selected. Selecting this option enables
2. Click Add... 3. Browse out to the location of your OnBase Configuration and/or Client executable files. Click Open . Note: The location of the executables must be full paths.
©
2015 Hyland Software, Inc. 25
Installation
a higher DEP security level, which could potentially cause issues with other applications on your system.
ACH Generator
OnBase 15
Installation
4. Selected applications will display in the exceptions list.
If you continue to experience problems, consult your service provider.
Licensing See Licensing on page 3 for licensing requirements.
Pre-Installation Prior to any installation, approval to install is required from Hyland Software. Workflow discovery time may also be required in order to ensure the process meets the required needs. The ACH Generator is a stand-alone application that will function independently of OnBase. Keeping log files of the ACH files requires a connection to the OnBase database.
©
2015 Hyland Software, Inc. 26
OnBase 15
ACH Generator
Creating Directories for ACH Logs Prior to installation, directories must be manually created if you wish to keep logs of the ACH files. If you do not wish to log the generated ACH files, these steps may be omitted. Caution: These paths must be configured exactly as described, or logging will not function.
The folder names are case sensitive.
To create directories for ACH logs:
• Log • Output The paths to these folders should read C:\ACH\Log and C:\ACH\Output.
OnBase Products If you wish to use Unity scripts to generate ACH files, the following OnBase products must be installed and configured prior to installing and configuring the ACH Generator. For specific installation and configuration procedures, see these products’ respective module reference guides. • The OnBase Web Server • The OnBase Application Server • The Unity Client • OnBase Studio Note: If WorkView is licensed in your database, it must also be installed and configured.
Installation Installing the ACH Files To install the necessary ACH files: 1. Obtain the following files from your solution provider: • ACHServerConfig.exe • ACHProcessor.dll • ACHServerConfig.xml 2. Copy the ACHServerConfig.exe executable to your desktop. 3. Copy the ACHProcessor.dll file to the Application Server’s bin folder (e.g., C:\Inetpub\ wwwroot\AppServer\bin ).
©
2015 Hyland Software, Inc. 27
Installation
1. Open your C: drive. 2. At the root of your C: drive, create a new folder and name it ACH . 3. In the ACH folder, create two new folders:
ACH Generator
OnBase 15
4. Register the ACHProcessor.dll file with the Global Assembly Cache by opening a command prompt and running the following command: gacutil /I C:\Program Files\Hyland\ACHProcessor.dll 5. Copy the ACHServerConfig.xml file to the C:\ProgramData\Hyland Software folder.
Setting Up a New ACH Server Installation
To set up a new ACH Server: 1. Create an ODBC source to the OnBase database called OBServer. Note: When creating the ODBC source, the server name must be the name of the server running the ACH Generator. Do not specify the server name as [local].
2. Create a user (user name: ACH SERVER , password: password) and assign it to a User Group. Note: The user name and password must be entered exactly as shown.
3. Create and/or assign the following keywords: • A Currency Keyword Type named Amount . • A Numeric Keyword Type named Number Of Entries . • An Alphanumeric Keyword Type named File Modifier. 4. Create two Document Types • SYS ACH Report • SYS ACH File Note: These Document Types must be entered exactly as shown.
5. 6. 7. 8.
Assign the User Group to each Document Type. Assign the keywords from step 3. Set up cross-references between the two Document Types (optional). Register the ACHServer.exe , obClnt32.exe, and mzAPI.dll files.
Command Line Switches and .ini Settings There are no command line switches or .ini settings for this module.
Backup / Recovery A copy of every ACH Generated file is saved under the SYS ACH File Document Type. If necessary, you can use that file to send information regarding transferring electronic funds. In order to run ACH Generator, you must register ACHServer.exe , obClnt32.exe , and mzAPI.dll . If you move these files from one directory to another, you must re-register these files.
©
2015 Hyland Software, Inc. 28
OnBase 15
ACH Generator
Troubleshooting If you are having problems running the ACH Generator, make sure that ACHServer.exe , obClnt32.exe , and mzAPI.dll are registered. If you move these files from one directory to another, you must re-register the files. Other problems may be caused if the computer temporary directory is out of space.
Contacting Support • The OnBase module where the issue was encountered. • The OnBase version and build (Example: 15.0.0.10). • The type and version of the connected database, such as Microsoft SQL Server 2008 or Oracle 11g, and any Service Packs that have been installed. • The operating system that the workstation is running on, such as Windows 7 or Windows Server 2008, and any Service Packs that have been installed. Check the supported operating systems for this module to ensure that the operating system is supported. • The name and version of any application related to the issue. • The version of Internet Explorer, and any Service Packs that have been installed, if applicable. • A complete description of the problem, including actions leading up to the issue. • Screenshots of any error messages. Supplied with the above information, your solution provider can better assist you in correcting the issue.
©
2015 Hyland Software, Inc. 29
Installation
When contacting your solution provider, please provide the following information:
OnBase 15
Installation
ACH Generator
©
2015 Hyland Software, Inc. 30