Retail:AXISC3 Payment Provider
Contents |
Introduction
Web POS payment provider for AXIS C3 by Ingenico. This documents describes the configuration in the Openbravo side. For the configuration of all Ingenico AXIS C3 artifacts please refer to the Ingenico documentation.
Installation
Openbravo for Retail modules
 | Note: The Web POS AXIS C3 Payment Provider modules are available since 3.0RR20Q3 |
The Openbravo AXIS C3 Payment Integration module is required to be installed: Ingenico Axis C3 Payment Provider.
How to install modules is described in detail in the document Modules Management.
AXISC3 Hardware Manager plugin
The AXIS C3 plugin installed is required to be installed as a Hardware Manager plugin.
How to install Hardware manager plugins is described in the document Retail:Hardware and Peripherals Installation.
It is required also to create the AXISC3 logging configuration file named jc3api-log4j.properties in the bin folder of the Hardware Manager.
In case the logs should be displayed in the console, the file must have the following content:
# log4j properties file
status = warn
# Name of the configuration
name = ConsoleLogConfigDemo
# Console appender configuration
appender.console.type = Console
appender.console.name = consoleLogger
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
# Root logger level
rootLogger.level = debug
# Root logger referring to console appender
rootLogger.appenderRef.stdout.ref = consoleLogger
In case the logs should be stored in a file, the configuration file must have the following content:
status = warn
name= RollingFileLogConfigDemo
# Log files location
property.basePath = .
# RollingFileAppender name, pattern, path and rollover policy
appender.rolling.type = RollingFile
appender.rolling.name = fileLogger
appender.rolling.fileName= ${basePath}/c3.log
appender.rolling.filePattern= ${basePath}/c3_%d{yyyyMMdd}.log.gz
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = %d{yyyy-MM-dd HH:mm:ss.SSS} %level [%t] [%l] - %msg%n
appender.rolling.policies.type = Policies
# RollingFileAppender rotation policy
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
appender.rolling.policies.size.size = 10MB
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 1
appender.rolling.policies.time.modulate = true
appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.delete.type = Delete
appender.rolling.strategy.delete.basePath = ${basePath}
appender.rolling.strategy.delete.maxDepth = 10
appender.rolling.strategy.delete.ifLastModified.type = IfLastModified
# Delete all files older than 30 days
appender.rolling.strategy.delete.ifLastModified.age = 30d
# Configure root logger
rootLogger.level = debug
rootLogger.appenderRef.rolling.ref = fileLogger
The log level of the AXISC3 libraries can be configured modifying the property rootLogger.level in this file.
The log file name of the AXISC3 libraries can be configured modifying the property appender.rolling.fileName in this file.
Configuration
Once it is installed it needs to be configured. Login in Openbravo as administrator.
In the window Channel- Touchpoint, select the terminal to configure and edit the field Hardware URL. This value indicates the address of the Hardware Manager connected to the Touchpoint. This is the same address used for the receipt printer, customer display, ...
Scroll down and go to the section AXISC3 Terminal Configuration. Here fill in the following fields:
- Host: Hostname or IP Ingenico AXIS C3 driver is located using the Hardware Manager host as origin. (usually localhost).
- Port: Listening port of Ingenico AXIS C3 (usually 9518).
- Terminal: Terminal identifier defined by the Ingenico configuration.
- Initialization: Defines the number of hours a valid initialization is kept. When loggin in if the number of hours the last initialization was executed is greater thant this value, a new initialization process is executed.
- Prints Info: Defines the moment where the payment receipts must be printed. If checked, payment receipts will be printed just after the payment transaction has been processed. If false payment receipts will be printed when closing the receipt. In this case, templates for receipts and refunds that includes in the payment details must include the code to print the payment transaction details.
- Interface: Defines the Ingenico AXIS C3 interface used.
- Network: when the device is connected to the network.
- USB: when the device is connected with a usb cable. USB connection is only supported in Windows 11 or greater operating system.
- Simulation: MUST NOT BE USED IN PRODUCTION ENVIRONMENTS, only in test or development environments.
To configure the default receipt templates, go to the window Organization, go to the section Web POS Formats and select the templates created for your store.
To configure the Provider Group for AXIS C3 and Payment Methods, follow the guide Retail:Payment Methods grouping by Provider User Guide to configure it. The Provider available to use in the Provider Group window is AXISC3 Card Provider.
Transaction approvals
Some transactions processed by AXIS C3 like general refunds to cards, request a manager approval. Transactions approvals are managed with the preference Site Manager Approval for payments.
Web POS operations
The AXIS C3 Payment integration for Web POS support card payments, and card refunds. During POS login the AXIS C3 initializes the payment device and downloads a new firmware version if available. And during logout it uploads all offline transactions pending if any.
Transactions can be aborted from the Web POS terminal. During the transaction the dialog that appears has a button Abort Transaction. If pressed by the cashier, an abort request will be sent to AXIS C3.
After the transaction has been properly processed. A receipt for the customer will be printed.
The following menu options are available in the POS for the cashier for management purposes.
AXISC3 Last Transaction
Prints the receipt of the last transaction. This option is useful for example if it is needed to reprint the receipt in case the printer runs out of paper.
AXISC3 Autotest
Verifies the connectivity with AXIS C3. It generates different messages between AXIS C3 and the POS to verify everything is properly managed.
AXISC3 Version
Prints a receipt with the information of the AXIS C3 software installed. Here there is a sample receipt printed with this option.
