Difference between revisions of "CreditLine Command Line"

From Payment Processing Software Library
Jump to: navigation, search
(Format)
(Export Examples)
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{CreditLine Header|Manual}}
 
{{CreditLine Header|Manual}}
=Working Directory=
+
=Important Notes=
 +
==Version Compatibility==
 +
{{Latest Version Reminder}}
 +
 
 +
==Working Directory==
 
Examples below assume that you are running the commands from the command line in the '''911\bin''' directory. Enter the full path as necessary.
 
Examples below assume that you are running the commands from the command line in the '''911\bin''' directory. Enter the full path as necessary.
  
Line 20: Line 24:
  
 
==Format==
 
==Format==
'''CCV_MANAGER ''NetworkName'' MerchantIndex=''N'' Action=''Action_Name'' ''Parameter1''=''Value1'' ''Parameter2''=''Value2'' ...'''
+
'''CCV_MANAGER ''NetworkName'' MerchantIndex=''N'' Action=''Action_Name'' ''Parameter1''=''Value1'' User=''username'' Password=''password'' ''ResultFile''=''file_path'' '''  
  
'''→This starts a separate program and exits when the action is complete'''
+
'''→This starts a separate program and exits when the action is complete'''.
 +
<br>'''&rarr;Note: All parameters except Action are optional, see action descriptions below.'''
  
 
;Network Name
 
;Network Name
 
:Identifies a unique client on the network. The length of '''NetworkName''' has to be 7 characters.  It has to be the first in the command line string.  EVERY INSTANCE has to have a unique name. If you are starting more than one Manager, for  instance with a batch command, make sure to assign it a unique network name.
 
:Identifies a unique client on the network. The length of '''NetworkName''' has to be 7 characters.  It has to be the first in the command line string.  EVERY INSTANCE has to have a unique name. If you are starting more than one Manager, for  instance with a batch command, make sure to assign it a unique network name.
  
=CreditLine Manager Actions=
+
;ResultFile
==Security Parameters==
+
:Path to a text file that will contain '''1''' if command is successful, or '''0''' if it fails. If only the file name is specified, it will be saved to the current directory.
 +
 
 +
===Security Parameters===
 
&rarr; Supported Versions 3.01.09 and up. <br>
 
&rarr; Supported Versions 3.01.09 and up. <br>
 
If the action is protected and requires user name a password use the following parameters
 
If the action is protected and requires user name a password use the following parameters
Line 34: Line 41:
 
;Password=''password'':specifies password
 
;Password=''password'':specifies password
 
''Example''<br>
 
''Example''<br>
;CCV_MANAGER MyName Action=Settle User=test1 Password=test1234
+
;CCV_MANAGER NetworkName Action=Settle User=test1 Password=test1234 ResultFile=result.txt
 +
 
 +
=CreditLine Manager Actions=
 +
 
  
 
==Changing Merchant Index==
 
==Changing Merchant Index==
Line 41: Line 51:
 
<br>The range of merchant index is 0 to 9.  
 
<br>The range of merchant index is 0 to 9.  
 
===Changing Merchant Index Example===
 
===Changing Merchant Index Example===
;CCV_MANAGER MyName MerchantIndex=2 : starts the manager with MerchantIndex 2  
+
;CCV_MANAGER MyName MerchantIndex=2 User=test1 Password=test1234: starts the manager with MerchantIndex 2
  
 
==Settlement==
 
==Settlement==
 
===Simple Settlement Example===
 
===Simple Settlement Example===
;CCV_MANAGER MyName Action=Settle:Close out the current batch and settle it with the processor. Exit when done.
+
;CCV_MANAGER NetworkName Action=Settle ResultFile=result.txt:Close out the current batch and settle it with the processor. Exit when done.
 +
 
 +
;Network Name
 +
:Identifies a unique server on the network. The length of '''NetworkName''' has to be 7 characters.  It has to be the first in the command line string.  EVERY INSTANCE has to have a unique name. If you are starting more than one Manager, for  instance with a batch command, make sure to assign it a unique network name.
 +
 
 +
===Scheduled Batch Example===
 +
Here is an example of scheduled batch parameters:
 +
[[Image:batchScheduleExample1.gif|none|framed|Complete '''Run''' parameter is '''C:\911\BIN\CCV_MANAGER.EXE Term1 Action=Settle ResultFile=result.txt''']]
 +
&rarr; Note: the server must be running for the batch to go through.
  
 
===Controlling Printing===
 
===Controlling Printing===
 
By default '''Action=Settle''' will print a batch report. To control this aspect use the following parameter:
 
By default '''Action=Settle''' will print a batch report. To control this aspect use the following parameter:
;NoPrinting=''N'':do not print the batch if ''N''=1
+
;NoPrinting=''1'':do not print the batch  
 +
;NoPrinting=''0'':force print the batch, even if user is expired (otherwise the report won't print)
 
''Example''<br>
 
''Example''<br>
;CCV_MANAGER MyName Action=Settle NoPrinting=1:runs the batch and exits; no report is printed
+
;CCV_MANAGER MyName Action=Settle NoPrinting=1 ResultFile=result.txt:runs the batch and exits; no report is printed
  
 
===Multiple Merchants===
 
===Multiple Merchants===
 
For Multiple Merchant Setup you can enter the Merchant Index like so:<br>  
 
For Multiple Merchant Setup you can enter the Merchant Index like so:<br>  
;CCV_MANAGER.EXE MyName MerchantIndex=1 Action=Settle:runs the batch for merchant index 1 and exits; no report is printed
+
;CCV_MANAGER.EXE MyName MerchantIndex=1 Action=Settle ResultFile=result.txt:runs the batch for merchant index 1 and exits; no report is printed
  
 
&rarr; Use one task per Merchant Index.
 
&rarr; Use one task per Merchant Index.
Line 65: Line 84:
 
;CardDetailReport:Print the card detail report  
 
;CardDetailReport:Print the card detail report  
 
;IrregularityReport:Print the irregularity report
 
;IrregularityReport:Print the irregularity report
 +
===Saving Report To A File===
 +
See [[#Export|Export]]
 
===Report Example===
 
===Report Example===
 
;CCV_MANAGER MyName Action=BatchReport:Print batch report. Exit when done.
 
;CCV_MANAGER MyName Action=BatchReport:Print batch report. Exit when done.
Line 70: Line 91:
 
==Export==
 
==Export==
 
;Export:Export the journal (batch contents). Exit when done.
 
;Export:Export the journal (batch contents). Exit when done.
 +
;BatchReportExport:Save Batch Report to a file. Exit when done.
 +
 
===Export Parameter Format===
 
===Export Parameter Format===
'''Action=Export BusinessDate=''date'' OutputFile=''file_path'''''
+
;'''Action=Export BusinessDate=''date'' OutputFile=''file_path'' User=''username'' Password=''password'' ResultFile=''res_file_path''''':export batch data
 +
;'''Action=BatchReportExport OutputFile=''file_path'' User=''username'' Password=''password'' ResultFile=''res_file_path''''':save batch report to a file
 +
 
 +
'''Parameter Description'''
 
;''date''
 
;''date''
 
:;yyyymmdd (e.g. 20050109):exports the journal for specified business date
 
:;yyyymmdd (e.g. 20050109):exports the journal for specified business date
Line 78: Line 104:
  
 
===Export Examples===
 
===Export Examples===
'''CCV_MANAGER CCVMGR1 Action=Export BusinessDate=20050109 OutputFile=\ExpHistory.txt'''<br>
+
'''CCV_MANAGER CCVMGR1 Action=Export BusinessDate=20050109 OutputFile=\ExpHistory.txt User=test1 Password=test1234 '''<br>
'''CCV_MANAGER CCVMGR1 Action=Export BusinessDate=Current OutputFile=\ExpCurrent.txt'''<br>
+
'''CCV_MANAGER CCVMGR1 Action=Export BusinessDate=Current OutputFile=\ExpCurrent.txt   User=test1 Password=test1234 '''<br>
 +
'''CCV_MANAGER CCVMGR1 Action=BatchReportExport OutputFile=\ExpBatchReport.txt  User=test1 Password=test1234 '''<br>
 +
 
 +
===See Also===
 +
[[CreditLine Import/Export]]
 +
 
 +
==Import==
 +
;Import:Import the journal (batch contents). Exit when done.
 +
 
 +
===Import Parameter Format===
 +
'''Action=Import InputFile=''file_path'' User=''username'' Password=''password'' 
 +
;''file_path'':specifies the file to import the journal from.
 +
 
 +
===See Also===
 +
[[CreditLine Import/Export]]
  
 
[[Category:CreditLine Manual|Command Line]]
 
[[Category:CreditLine Manual|Command Line]]

Latest revision as of 19:35, 30 October 2013

This article is part of the
Payment Processing Software Library

Categories

Get it...

Credit Card Software
Download

Install it...

Installation
Upgrade & Migration

Connect to it...

Point Of Sale Integration

Set it up...

Quick Start Guide
Setup
Processor Setup

Licensing

Learn to use it...

Manual & User Guide
Knowledge Base
Frequently Asked Questions
Compliance Guide
Merchant Account Rates
User Interface Guides

Fix it...

Errors & Troubleshooting
Knowledge Base
Corrupted Install Repair

Get Help...

Contact
Processor Support Contacts

More Info ...

Glossary
Articles

See also...

911 Software
Help

CreditLine Payment Processing Software Manual. This site can also be reached at http://docs.911software.com

Looking for better rates?   Get a Free Credit Card Processing Cost Comparison!

Important Notes

Version Compatibility

This article describes the functionality present in the latest version. For more information, please see [Release Notes]. Make sure to [download and upgrade to the latest version] to be able to take advantage of the latest features.

Working Directory

Examples below assume that you are running the commands from the command line in the 911\bin directory. Enter the full path as necessary.

CreditLine Server Commands

Format

CCV_SERVER NetworkName

Network Name
Identifies a unique server on the network. The length of NetworkName has to be 7 characters. It has to be the first in the command line string. EVERY INSTANCE has to have a unique name. If you are starting more than one Manager, for instance with a batch command, make sure to assign it a unique network name.


CreditLine Manager Commands

Scheduling Command Line Functions

Command Line Functions can be scheduled to run automatically through Windows Scheduled Tasks Service. Click here for more details. Make sure to add the Start In (working) path to the examples below as necessary.


Format

CCV_MANAGER NetworkName MerchantIndex=N Action=Action_Name Parameter1=Value1 User=username Password=password ResultFile=file_path

→This starts a separate program and exits when the action is complete.
→Note: All parameters except Action are optional, see action descriptions below.

Network Name
Identifies a unique client on the network. The length of NetworkName has to be 7 characters. It has to be the first in the command line string. EVERY INSTANCE has to have a unique name. If you are starting more than one Manager, for instance with a batch command, make sure to assign it a unique network name.
ResultFile
Path to a text file that will contain 1 if command is successful, or 0 if it fails. If only the file name is specified, it will be saved to the current directory.

Security Parameters

→ Supported Versions 3.01.09 and up.
If the action is protected and requires user name a password use the following parameters

User=username
specifies user name
Password=password
specifies password

Example

CCV_MANAGER NetworkName Action=Settle User=test1 Password=test1234 ResultFile=result.txt

CreditLine Manager Actions

Changing Merchant Index

→This applies to multiple merchant account setups only. This directive is optional
Changes manager merchant index
The range of merchant index is 0 to 9.

Changing Merchant Index Example

CCV_MANAGER MyName MerchantIndex=2 User=test1 Password=test1234
starts the manager with MerchantIndex 2

Settlement

Simple Settlement Example

CCV_MANAGER NetworkName Action=Settle ResultFile=result.txt
Close out the current batch and settle it with the processor. Exit when done.
Network Name
Identifies a unique server on the network. The length of NetworkName has to be 7 characters. It has to be the first in the command line string. EVERY INSTANCE has to have a unique name. If you are starting more than one Manager, for instance with a batch command, make sure to assign it a unique network name.

Scheduled Batch Example

Here is an example of scheduled batch parameters:

Complete Run parameter is C:\911\BIN\CCV_MANAGER.EXE Term1 Action=Settle ResultFile=result.txt

→ Note: the server must be running for the batch to go through.

Controlling Printing

By default Action=Settle will print a batch report. To control this aspect use the following parameter:

NoPrinting=1
do not print the batch
NoPrinting=0
force print the batch, even if user is expired (otherwise the report won't print)

Example

CCV_MANAGER MyName Action=Settle NoPrinting=1 ResultFile=result.txt
runs the batch and exits; no report is printed

Multiple Merchants

For Multiple Merchant Setup you can enter the Merchant Index like so:

CCV_MANAGER.EXE MyName MerchantIndex=1 Action=Settle ResultFile=result.txt
runs the batch for merchant index 1 and exits; no report is printed

→ Use one task per Merchant Index.

See Changing Merchant Index for more details.

Reports

BatchReport
Print the batch report
CardDetailReport
Print the card detail report
IrregularityReport
Print the irregularity report

Saving Report To A File

See Export

Report Example

CCV_MANAGER MyName Action=BatchReport
Print batch report. Exit when done.

Export

Export
Export the journal (batch contents). Exit when done.
BatchReportExport
Save Batch Report to a file. Exit when done.

Export Parameter Format

Action=Export BusinessDate=date OutputFile=file_path User=username Password=password ResultFile=res_file_path
export batch data
Action=BatchReportExport OutputFile=file_path User=username Password=password ResultFile=res_file_path
save batch report to a file

Parameter Description

date
yyyymmdd (e.g. 20050109)
exports the journal for specified business date
current
exports the journal for current business date
file_path
specifies the file to export the journal to.

Export Examples

CCV_MANAGER CCVMGR1 Action=Export BusinessDate=20050109 OutputFile=\ExpHistory.txt User=test1 Password=test1234
CCV_MANAGER CCVMGR1 Action=Export BusinessDate=Current OutputFile=\ExpCurrent.txt User=test1 Password=test1234
CCV_MANAGER CCVMGR1 Action=BatchReportExport OutputFile=\ExpBatchReport.txt User=test1 Password=test1234

See Also

CreditLine Import/Export

Import

Import
Import the journal (batch contents). Exit when done.

Import Parameter Format

Action=Import InputFile=file_path User=username Password=password

file_path
specifies the file to import the journal from.

See Also

CreditLine Import/Export