Difference between revisions of "CreditLine Installation"
(→Files) |
(→Minimum Windows Version) |
||
(105 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{CreditLine Header|Installation}} |
− | + | ||
− | + | =Pre-Installation Checks= | |
+ | ==Minimum Windows Version== | ||
+ | Industry requires TLS 1.2 for all payment processing applications. See below for Windows Version Support Matrix: | ||
+ | [[image:TLSOSREQ.jpg|framed|none|See '''[https://blogs.msdn.microsoft.com/kaushal/2011/10/02/support-for-ssltls-protocols-on-windows/ Microsoft TLS Article]''' for more info.]] | ||
− | == | + | ==Anti-Virus Warning== |
− | + | We have had some complaints that on certain installations anti-virus software would try to interfere with the operation of CreditLine. Once the software started acting up, disabling the anti-virus did not help, only the uninstallation has solved the problem. Trend-Micro was particularly troublesome. | |
+ | <br>→ <br> | ||
+ | 1) Make sure to set Anti-Virus to ignore the entire 911 folder and the Data messaging directory, if used.<br> | ||
+ | 2) Set our software as trusted in the Anti-Virus.<br> | ||
− | + | ==Windows Server 2008 Installation== | |
+ | '''Note:''' If installing on '''Windows Server 2008''', save the setup file to the desktop, right click on the file, select '''Properties''', click on '''Compatibility''', Check '''Run this program in compatibility mode for''', Select '''Windows Server 2008''', Check '''Privilege Level''' '''Run this program as an administrator''' | ||
− | + | =CreditLine Client and Server Installation= | |
+ | *If the client and server will reside on different networked machines, please follow [[CreditLine Networked Client-Server Installation]] | ||
+ | *If the client and server will reside on the same machine, please follow [[CreditLine Local Client-Server Installation]] | ||
− | + | =Installation Notes and Options= | |
+ | ==Server Monitor Service== | ||
+ | A server monitor service CreditServerMonitor will be installed. In case the server or the service is not running, the server or the service will be started automatically, depending on whether the CreditLine service is installed. | ||
− | + | To disable this feature, open windows Services list and disable CreditServerMonitor. | |
− | + | ||
− | + | ==Silent Install== | |
+ | ''Advanced Option''. Starting from version 3.03.18, a silent install can be performed by downloading the '''ZIP version''' of the installation, unzipping to a local folder and running '''SilentSetup.bat''' from the command line. | ||
− | == | + | ==Security Setup== |
− | + | Please follow this '''[[CreditLine Security Setup|Security Setup Guide]]''' to setup your security | |
− | + | ==Default Login Credentials== | |
+ | {{CreditLine Default Login}} | ||
− | == | + | ==Disabling Automatic Server Restart== |
− | + | By default the CreditLIne server or CreditLineService (if installed) will be restarted if down within a minute of discovery. This feature can eliminate many support calls due to a down server. | |
− | + | You can '''disable''' this feature either by disabling '''CreditServerMonitor''' Service in Windows Services <br>or setting the following to NO in '''911\data\911_CCV.ini''': | |
− | + | <code> | |
− | + | <br>;If set to YES, the server service will automatically restart when no server service available, whether in service mode or in application mode. | |
− | + | <br>;The server service won't restart automatically if set to NO. | |
− | + | <br>;Default: YES | |
− | + | <br>EnableServerAutorestart=NO | |
− | + | </code> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | === | + | ==Setting Up Multiple Merchant Accounts== |
− | + | If you are planning to use multiple merchant accounts on the same server, read the [[CreditLine Multiple Merchant Account Setup]] article. | |
− | + | ||
− | + | ==Multiple Terminal Setup== | |
− | + | You can run as many terminals on as many network machines as desirable by connecting to the same [[CreditLine Server]] through the network. | |
− | + | Create a shortcut to '''Manager''' executable and make '''Start In''' (working) directory point to the Server's '''\911\bin''' directory. For instance, if the Server resides on '''\\brain\CDRIVE\911''', then map Z: to '''\\brain\CDRIVE''' | |
− | + | and set the '''Start In''' working directory for the shortcut to the Manager to '''Z:\911\bin'''. | |
− | + | ||
− | + | For detailed information on how to setup and program remote terminals and managers see [[CreditLine_Integration#Multiple_Terminal_Setup|Multiple Terminal Setup in the Programming Guide]]. | |
− | + | ||
− | + | ==Running Multiple Servers On The Same Machine== | |
− | | | + | Although a ''CreditLine Server'' can handle [[CreditLine Multiple Merchant Account Setup|multiple merchant accounts]], there can only be one processor setup per ''CreditLine Server''. In rare instance, that you need to handle more than one processor on the same machine, follow this procedure: |
− | + | # In [[CreditLine Advanced Setup]] file uncomment (remove ''';''' in front of) and set this line: '''MultipleInstance=YES'''. | |
− | + | # Install the software into two separate directories '''c:\server1''' and '''c:\server2''' (or more directories as needed) | |
− | + | Now you can setup one processor per directory. | |
− | + | ||
− | + | ||
− | + | ==Advanced Setup Options== | |
− | [[Category:CreditLine Installation]] | + | {{CreditLine Advanced Setup}} |
+ | {{Template:CreditLine Directory Structure}} | ||
+ | |||
+ | ==Also See== | ||
+ | [[CreditLine Licensing]] | ||
+ | |||
+ | [[Category:CreditLine Installation|Installation]] |
Latest revision as of 21:37, 18 April 2017
This article is part of the Payment Processing Software Library |
|
Get it... | |
Install it... | |
Installation | |
Connect to it... | |
Set it up... | |
Learn to use it... | |
→ Manual & User Guide | |
Fix it... | |
→ Errors & Troubleshooting | |
Get Help... | |
More Info ... | |
See also... | |
CreditLine Payment Processing Software Installation. This site can also be reached at http://docs.911software.com
→ Looking for better rates? Get a Free Credit Card Processing Cost Comparison!
Contents
- 1 Pre-Installation Checks
- 2 CreditLine Client and Server Installation
- 3 Installation Notes and Options
- 3.1 Server Monitor Service
- 3.2 Silent Install
- 3.3 Security Setup
- 3.4 Default Login Credentials
- 3.5 Disabling Automatic Server Restart
- 3.6 Setting Up Multiple Merchant Accounts
- 3.7 Multiple Terminal Setup
- 3.8 Running Multiple Servers On The Same Machine
- 3.9 Advanced Setup Options
- 3.10 Directory Structure
- 3.11 Important Files
- 3.12 Encryption Keys
- 3.13 BIN Ranges
- 3.14 Terminal Registration File
- 3.15 Backups
- 3.16 Also See
Pre-Installation Checks
Minimum Windows Version
Industry requires TLS 1.2 for all payment processing applications. See below for Windows Version Support Matrix:
Anti-Virus Warning
We have had some complaints that on certain installations anti-virus software would try to interfere with the operation of CreditLine. Once the software started acting up, disabling the anti-virus did not help, only the uninstallation has solved the problem. Trend-Micro was particularly troublesome.
→
1) Make sure to set Anti-Virus to ignore the entire 911 folder and the Data messaging directory, if used.
2) Set our software as trusted in the Anti-Virus.
Windows Server 2008 Installation
Note: If installing on Windows Server 2008, save the setup file to the desktop, right click on the file, select Properties, click on Compatibility, Check Run this program in compatibility mode for, Select Windows Server 2008, Check Privilege Level Run this program as an administrator
CreditLine Client and Server Installation
- If the client and server will reside on different networked machines, please follow CreditLine Networked Client-Server Installation
- If the client and server will reside on the same machine, please follow CreditLine Local Client-Server Installation
Installation Notes and Options
Server Monitor Service
A server monitor service CreditServerMonitor will be installed. In case the server or the service is not running, the server or the service will be started automatically, depending on whether the CreditLine service is installed.
To disable this feature, open windows Services list and disable CreditServerMonitor.
Silent Install
Advanced Option. Starting from version 3.03.18, a silent install can be performed by downloading the ZIP version of the installation, unzipping to a local folder and running SilentSetup.bat from the command line.
Security Setup
Please follow this Security Setup Guide to setup your security
Default Login Credentials
- User Name
- admin
- Password
- creditline1
Disabling Automatic Server Restart
By default the CreditLIne server or CreditLineService (if installed) will be restarted if down within a minute of discovery. This feature can eliminate many support calls due to a down server.
You can disable this feature either by disabling CreditServerMonitor Service in Windows Services
or setting the following to NO in 911\data\911_CCV.ini:
;If set to YES, the server service will automatically restart when no server service available, whether in service mode or in application mode.
;The server service won't restart automatically if set to NO.
;Default: YES
EnableServerAutorestart=NO
Setting Up Multiple Merchant Accounts
If you are planning to use multiple merchant accounts on the same server, read the CreditLine Multiple Merchant Account Setup article.
Multiple Terminal Setup
You can run as many terminals on as many network machines as desirable by connecting to the same CreditLine Server through the network. Create a shortcut to Manager executable and make Start In (working) directory point to the Server's \911\bin directory. For instance, if the Server resides on \\brain\CDRIVE\911, then map Z: to \\brain\CDRIVE and set the Start In working directory for the shortcut to the Manager to Z:\911\bin.
For detailed information on how to setup and program remote terminals and managers see Multiple Terminal Setup in the Programming Guide.
Running Multiple Servers On The Same Machine
Although a CreditLine Server can handle multiple merchant accounts, there can only be one processor setup per CreditLine Server. In rare instance, that you need to handle more than one processor on the same machine, follow this procedure:
- In CreditLine Advanced Setup file uncomment (remove ; in front of) and set this line: MultipleInstance=YES.
- Install the software into two separate directories c:\server1 and c:\server2 (or more directories as needed)
Now you can setup one processor per directory.
Advanced Setup Options
CreditLine behavior can be fine tuned to match your operational requirements.
Please see the 911/data/911_CCV.INI and 911/DATA/CLCAPI.INI (for advanced API behavior) files for more information.
→ Upgrades do not overwrite the ini files because they may contain custom settings.
→ IMPORTANT! Make sure to browse through the CUSTOM POS SETTINGS section at the end of the 911/data/911_CCV.INI file for any settings that may be necessary for your specific POS installation.
- Note: for the key to take effect, do not forget to remove ';' in front of a key to uncomment it.
Directory Structure
NOTE: in version 3.01.07 and older the software ALWAYS looks for \911\bin from the root of the drive regardless of the installation path or working directory set. The working directory only points out the root drive.
Directory Name | Contains |
---|---|
C:\911\BIN | Executables |
C:\911\DATA | Data |
C:\911\JOR | Historical Journal, automaticly created. For multiple merchant setups it is JOR? where ? is the merchant index. |
C:\911\LOG | Historical Log, automaticly created. For multiple merchant setups it is LOG? where ? is the merchant index. |
C:\911\MESSAGES | Text-Based Communication Files |
Important Files
Encryption Keys
The following two files must always accompany the #Transaction Journal: 911\data\DataEncryptingKey.ini and \911\data\KeyEncryptingKey.ini
Transaction Journal
The journal of all transactions is under the 911\data directory in ccv_jor.dat (or ccv_jor?.dat where ? is merchant index if you are using a multiple merchant setup. Make sure that the encryption keys 911\data\DataEncryptingKey.ini and \911\data\KeyEncryptingKey.ini always follow any moves of the data to and from the system or permanent corruption of the Transaction Journal File may result.
→Deleting this file will remove all unbatched transactions.
Setup
The merchant and other setup is under the 911\data directory in ccv_info.dat file(or ccv_info?.dat where ? is merchant index if you are using a multiple merchant setup.
BIN Ranges
The card number BIN ranges are the starting 6 digits of the card numbers that help us to identify the card types. \911\data\ccv_range.ini contains the defined BIN ranges for the setup
Terminal Registration File
The following file is used to register Terminals/Lanes manually, when required by processor compliance (e.g. Elavon 5/3rd Bank): 911\data\POSREGISTRATION.ini
Log
- Server Activity Log
- The log is stored under the 911\data directory in ccv_log.dat file (or ccv_log?.dat where ? is merchant index if you are using a multiple merchant setup. The log can be viewed in CreditLine Manager by using CreditLine View Log Dialog. Older logs can be viewed by using the CreditLine Log Archive List Dialog.
- Error Statistic File
- The error statistic file can be used for reliability testing and is stored under the 911\data directory in ccv_error.csv. The header for the file describes the fields, separated by '|', e.g. "DATE|TIME|MERCHANT NAME|ERROR DESCRIPTION|ERROR TYPE|TRANS TYPE|PROCESSOR NAME|COMM TYPE|COMM PARAMETER"
Advanced Configuration
The advanced configuration is under the 911\data directory in 911_ccv.ini. See CreditLine Advanced Setup for more info.
Connection Configuration
The connection settings for various processors and modems is under the 911\data directory in ccv_link.ini.
Important File Summary
File Name | Function |
---|---|
C:\911\BIN\CCV_MANAGER.EXE | Manager Program |
C:\911\BIN\CCV_SERVER.EXE | Server Program |
C:\911\DATA\CCV_INFO.DAT | Site Configuration - this file contains all the merchant specific information → multiple merchant setups use multiple files of format C:\911\DATA\CCV_INFO?.DAT where ? is the merchant index. |
C:\911\DATA\CCV_JOR.DAT | Current Day Journal - deleting this file will remove all authorized transactions → multiple merchant setups use multiple files of format C:\911\DATA\CCV_JOR?.DAT where ? is the merchant index. |
C:\911\DATA\CCV_LOG.TXT | Current Day Log |
C:\911\DATA\911_CCV.INI | Program Configuration |
C:\911\DATA\CCV_LINK.INI | Connection Configuration |
Backups
Batches (Journals)
You can view and manipulate the Journal Backups in the CreditLine Batch Archive Dialog
→In some extreme cases the transactions that you are looking for can only be found by clicking the Radio Buttons "Before Batch" and "Daily Backup" in the CreditLine Batch Archive Dialog
The number of days that the journals are backed up is specified in CreditLine Business Configuration Dialog. To restore the journal/batch you can rename the desired journal backup file to ccv_jor.dat and move it to 911\DATA directory. Don't forget to reload the configuration to apply the changes.
→ For multiple merchant setups replace JOR below with JOR? where ? is the merchant index.
File Name | Function |
---|---|
C:\911\JOR\b<time_stamp>.?? | "BEFORE" BACKUP. Backup of the journal before the batch was run |
C:\911\JOR\j<time_stamp>.?? | "BATCH" BACKUP. Backup of the journal that was batched |
C:\911\JOR\d<time_stamp>.?? | "DAY" BACKUP. Incremental Backup of the journal for a business day appended at the time of the batch |
C:\911\JOR\u<time_stamp>.?? | "UN-BATCHED" BACKUP. Backup of un-batched transactions that were carried over to the next batch (for instance un-finalized Auths) |
Logs
You can view the Log Backups in the CreditLine Log Archive List Dialog
The number of days that the logs are backed up is specified in CreditLine Business Configuration Dialog.
→ For multiple merchant setups replace LOG below with LOG? where ? is the merchant index.
File Name | Function |
---|---|
C:\911\LOG\l<time_stamp>.?? | Backup of the logs |
Setup Files
To restore the setup file you can rename the desired setup backup file to ccv_info.dat and move it to 911\DATA directory. Don't forget to reload the configuration to apply the changes.
→ For multiple merchant setups replace JOR below with JOR? where ? is the merchant index.
File Name | Function |
---|---|
C:\911\JOR\n<time_stamp>.?? | Backup of CreditLine Setup File - generated after every batch |
C:\911\JOR\i<time_stamp>.?? | Backup of CreditLine Setup File - generated before every batch |
Encryption Keys
The encryption keys are backed up in the 911\Backup directory.
There are two keys: DataEncryptingKey.ini (backup file starting with d), KeyEncryptingKey.ini (backup file starting with k)
To restore the keys:
- Batch out any outstanding accessible transactions
- Backup current DataEncryptingKey.ini and KeyEncryptingKey.ini in 911\Data directory, by renaming them to DataEncryptingKey.ini.bad and KeyEncryptingKey.ini.bad
- Enter 911\Backup directory and sort by Date Modified';
- Pick the desired pair of keys, copy them to 911\Data directory and rename to DataEncryptingKey.ini and KeyEncryptingKey.ini respectively.
- Restart the CreditLine server/service and CreditLine Manager
- Attempt to view the journal
- If unsuccessful, try the next pair in the list.