Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Soporte e Integracin
Librera TfhkaNet
Manual de Integracin
SOPORTE E INTEGRACIN
Manual de Integracin
Revision 1.0
Historial de Revisiones
Revisin
Fecha
1.o
02/05/14
Paginas
Afectadas
Todas
Comentario
Versin inicial
ndice
Capitulo 1 .......................................................................................................... 1
Introduccin .............................................................................................................. 1
Resumen .................................................................................................................... 1
Requerimientos de Hardware ................................................................................. 2
Requerimientos de Software ................................................................................... 2
Capitulo 2 .......................................................................................................... 3
Instalacin ................................................................................................................. 3
Instalacin .................................................................................................... 3
Alcance de la librera ................................................................................................ 6
Capitulo 3 .......................................................................................................... 7
Importacin y Declaraciones .................................................................................. 7
Mtodos de la clase Tfhka ....................................................................................... 9
OpenFpctrl .................................................................................................. 9
CloseFpctrl................................................................................................... 9
CheckFprinter ............................................................................................. 9
CheckDrawer............................................................................................. 10
ReadFpStatus ............................................................................................. 10
SendCmd .................................................................................................... 10
SendFileCmd ............................................................................................. 11
UploadReportCmd ................................................................................... 11
UploadStatusCmd ..................................................................................... 11
Atributos pblicos orientados a objetos de la Clase Tfhka .............................. 13
StatusErrorPrinter tipo PrinterStatus..................................................... 13
GetZReport tipo ReportData ................................................................. 13
GetS1PrinterData tipo S1PrinterData ................................................... 14
GetS2PrinterData tipo S2PrinterData ................................................... 14
GetS3PrinterData tipo S3PrinterData ................................................... 14
GetS4PrinterData tipo S4PrinterData ................................................... 15
GetS5PrinterData tipo S5PrinterData ................................................... 15
GetS6PrinterData tipo S6PrinterData ................................................... 15
GetS7PrinterData tipo S7PrinterData ................................................... 15
GetS8EPrinterData tipo S8PrinterData ................................................ 15
GetS8PPrinterData tipo S8PrinterData................................................. 16
PrinterException ....................................................................................... 16
Mtodos pblicos orientados a objetos de la Clase Tfhka de Objetos........... 17
GetPrinterStatus........................................................................................ 17
GetXReport ............................................................................................... 17
GetX2Report ............................................................................................. 17
GetX4Report ............................................................................................. 18
GetX5Report ............................................................................................. 18
GetX7Report ............................................................................................. 18
GetZReport ............................................................................................... 19
PrintZReport ............................................................................................. 20
PrintXReport ............................................................................................. 21
GetS1PrinterData ..................................................................................... 21
GetS2PrinterData ..................................................................................... 21
GetS2EPrinterData .................................................................................. 21
GetS21PrinterData ................................................................................... 22
GetS22PrinterData ................................................................................... 22
GetS23PrinterData ................................................................................... 22
GetS24PrinterData ................................................................................... 23
GetS25PrinterData ................................................................................... 23
GetS3PrinterData ..................................................................................... 23
GetS4PrinterData ..................................................................................... 24
GetS5PrinterData ..................................................................................... 24
GetX4Report ............................................................................................. 24
GetX5Report ............................................................................................. 25
Anexos ..................................................................................................................... 26
ANEXO 1: Lista de cdigos de Status .................................................. 26
ANEXO 2: Lista de cdigos de Error ................................................... 27
ANEXO 3: Ejemplo bsico de emisin de Factura para Consumidor
Final ............................................................................................................ 28
T H E
F A C T O R Y
Captulo
H K A
Introduccin
La librera TfhkaNet permite la integracin con sistemas
administrativos desarrollados bajo la tecnologa de .NET; como lo
son C#, J#, VB.NET y ASP
Resumen
T H E
F A C T O R Y
H K A
Requerimientos de Hardware
Espacio
Puerto
libre
en
Serial
Disco
fsico
Duro
o
de
50MB
USB
2.0
en
.NET
Requerimientos de Software
un
desarrollo
T H E
F A C T O R Y
H K A
Captulo
Instalacin
En el SDK descargado, usted se encontrar con las tres herramientas bsicas para
realizar la integracin del sistema administrativo con nuestra impresora fiscal; la librera
de integracin (TfhkaNet.dll), el manual de dicha librera y un demo funcional de
cdigo abierto en donde se ejemplifica el uso de la librera de forma prctica.
Instalacin
Antes de comenzar a hacer uso de la librera en el desarrollo, lo primero que se debe
hacer es incluir y referenciar la librera en nuestro proyecto. Esto se consigue siguiendo
los siguientes pasos:
1. Creamos un nuevo Proyecto.
T H E
F A C T O R Y
H K A
T H E
F A C T O R Y
H K A
Acto seguido, nos encontramos listos para empezar a utilizar los mtodos y
funciones que contiene la clase Tfhka.
T H E
F A C T O R Y
H K A
Alcance de la librera
La librera TfhkaNet es compatible con cualquier desarrollo cuya base sea la tecnologa
.NET.
T H E
F A C T O R Y
H K A
Captulo
Importacin y Declaraciones
Una vez agregada la referencia de la clase TfhkaNet a la Solucin e importado el
espacio de nombre respectivo se puede empezar a trabajar con la clase Tfhka, con sus
atributos y mtodos pblicos.
using TfhkaNet.IF;
using TfhkaNet.IF.VE;
1.
Ejemplos:
private Tfhka Impresora;
public Tfhka Impresora;
2.
La clase Tfhka tiene dos constructores, uno por defecto y otro que recibe
como parmetro un String o cadena de carcter con el nombre del puerto serial o
terminal serial.
Constructor 1:
<Nombre del Objeto> = new Tfhka();
Este solo inicializar las propiedades del objeto fiscal.
Constructor 2:
<Nombre del Objeto> = new Tfhka(<Nombre del Puerto serial>);
Este adems de inicializar las propiedades del objeto fiscal, abre puerto y
verifica comunicacin.
Ejemplos:
Impresora = new Tfhka ( COM1 );
T H E
F A C T O R Y
H K A
T H E
F A C T O R Y
H K A
T H E
F A C T O R Y
H K A
CheckDrawer
BOOLEAN CheckDrawer()
Permite verificar si la gaveta de dinero est conectada al PC.
Retorno:
True: Gaveta conectada.
False: Gaveta no detectada.
ReadFpStatus
BOOLEAN ReadFpStatus()
Permite leer las variables de estado y error de la impresora. Al ejecutar
este mtodo se establece el valor de la variable tipo String Estado. (Ver
Anexos 1 y 2)
Retorno:
True: Mtodo ejecutado exitosamente
False: Error en ejecucin del mtodo
Nota: En la librera .NET esta funcin esta obsoleta y no se recomienda su uso, ser
eliminada en futuras versiones de la librera, use la funcin GetPrinterStatus().
SendCmd
BOOL SendCmd(String Cmd)
Permite realizar el envo de comandos hacia la impresora, en forma de
tramas de caracteres ASCII, tal como es descrito en los manuales de
integracin de las respectivas impresoras, y en el manual general de
protocolos y comandos del protocolo TFHKA.
Parmetros:
10
T H E
F A C T O R Y
H K A
String cmd: tipo de reporte a solicitar. Los reportes que pueden ser
U0X
U0Z
U1Z
U1X
11
T H E
F A C T O R Y
H K A
String cmd: tipo de Status a solicitar. Los Status que pueden ser
solicitados
-
son
S1
S2
S3
los
S4
S5
S8E
siguientes:
S8P
12
T H E
F A C T O R Y
H K A
13
T H E
F A C T O R Y
H K A
14
T H E
F A C T O R Y
H K A
15
T H E
F A C T O R Y
H K A
PrinterException
Representa un tipo de excepcin que arrojan algunos mtodos de
creacin de objetos de las estructuras anteriormente definidas cuando
ocurre un error en la transaccin con la impresora fiscal. Est
compuesto por los siguientes elementos:
PrinterStatus StatusError(): retorna un objeto que contiene
informacin del Status y el Error al momento de generarse la
excepcin.
Message(): Contiene la descripcin de la excepcin arrojada.
16
T H E
F A C T O R Y
H K A
17
T H E
F A C T O R Y
H K A
Excepcin:
Arroja la excepcin PrinterException
GetX4Report
ReportData GetX4Report() throws PrinterException
Sube al PC un reporte X4 por medio del comando U0X4
actualizando sus valores de data.
Retorno:
Un objeto de tipo ReportData en la variable global ReportePC con
toda la informacin para la carga de un reporte X4 actual.
Excepcin:
Arroja la excepcin PrinterException
GetX5Report
ReportData GetX5Report() throws PrinterException
Sube al PC un reporte X5 por medio del comando U0X5
actualizando sus valores de data.
Retorno:
Un objeto de tipo ReportData en la variable global ReportePC con
toda la informacin para la carga de un reporte X5 actual.
Excepcin:
Arroja la excepcin PrinterException
GetX7Report
ReportData GetX7Report() throws PrinterException
Sube al PC un reporte X7 por medio del comando U0X7
actualizando sus valores de data.
Retorno:
Un objeto de tipo ReportData en la variable global ReportePC con
toda la informacin para la carga de un reporte X7 actual.
18
T H E
F A C T O R Y
H K A
Excepcin:
Arroja la excepcin PrinterException
GetZReport
ReportData GetZReport() throws PrinterException
Sube al PC un reporte Z por medio del comando U0Z actualizando
sus valores de data.
Retorno
Un objeto de tipo ReportData en la variable global ReportePC con
toda la informacin del ltimo reporte Z emitido.
Excepcin
Arroja la excepcin PrinterException.
ReportData[] GetZReport(string StartDate, string EndDate) throws
PrinterException
Realiza una lectura de memoria fiscal por rango de fecha.
Parmetros:
19
int
T H E
F A C T O R Y
H K A
StartDate,
Date
EndDate)
20
throws
T H E
F A C T O R Y
H K A
Excepcin
Arroja la excepcin PrinterException
PrintXReport
VOID PrintXReport() throws PrinterException
Imprime el Reporte Diario X
Excepcin
Arroja la excepcin PrinterException
GetS1PrinterData
S1PrinterData GetS1PrinterData() throws PrinterException
Sube el estado S1 de la Impresora fiscal al PC y Sube el estado S1 de la
Impresora fiscal al PC y actualiza sus valores de data.
Retorno:
Un objeto de tipo S1PrinterData en la variable global S1Estado.
Excepcin:
Arroja la excepcin PrinterException.
GetS2PrinterData
S2PrinterData GetS2PrinterData() throws PrinterException
Sube el estado S2 de la Impresora fiscal al PC y actualiza sus valores de
data.
Retorno
Un objeto de tipo S2PrinterData en la variable global S2Estado.
Excepcin
Arroja la excepcin PrinterException.
GetS2EPrinterData
S2PrinterData GetS2EPrinterData() throws PrinterException
21
T H E
F A C T O R Y
H K A
22
T H E
F A C T O R Y
H K A
Retorno
Un objeto de tipo S2PrinterData en la variable global S2Estado.
Excepcin
Arroja la excepcin PrinterException.
GetS24PrinterData
S2PrinterData GetS24PrinterData() throws PrinterException
Sube el estado S2 correspondiente a los montos Tasa4 de la
transaccin actual y actualiza sus valores de data.
Retorno
Un objeto de tipo S2PrinterData en la variable global S2Estado.
Excepcin
Arroja la excepcin PrinterException.
GetS25PrinterData
S2PrinterData GetS25PrinterData() throws PrinterException
Sube el estado S2 correspondiente a los montos Tasa5 de la
transaccin actual y actualiza sus valores de data.
Retorno
Un objeto de tipo S2PrinterData en la variable global S2Estado.
Excepcin
Arroja la excepcin PrinterException.
GetS3PrinterData
S3PrinterData GetS3PrinterData() throws PrinterException
Sube el estado S3 de la Impresora fiscal al PC y actualiza sus valores de
data.
Retorno
Un objeto de tipo S3PrinterData en la variable global S3Estado. Es
importante mencionar que el objeto del tipo S3PrinterData contiene
23
T H E
F A C T O R Y
H K A
24
T H E
F A C T O R Y
H K A
Retorno
Un objeto de tipo AcumuladosX en la variable global ReporteAcumX.
Excepcin
Arroja la excepcin PrinterException.
GetX5Report
AcumuladosX GetX5Report() throws PrinterException
Sube el reporte de acumulados de Notas de Crdito con Crdito Fiscal
y actualiza sus valores de data.
Retorno
Un objeto de tipo AcumuladosX en la variable global ReporteAcumX.
Excepcin
Arroja la excepcin PrinterException.
25
T H E
F A C T O R Y
H K A
Anexos
ANEXO 1: Lista de cdigos de Status
STATUS
Retorno
(Hex)
Retorno
(Decimal)
Estado desconocido.
0A
10
0B
11
0C
12
Comentario
26
T H E
F A C T O R Y
H K A
Retorno
(Decimal)
00
No hay error.
01
02
03
50
80
54
84
Tasa invalida.
58
88
5C
92
Comando invalido.
60
96
Error fiscal.
64
100
6C
108
70
112
80
128
Error en la comunicacin.
89
137
No hay respuesta.
90
144
Error LRC.
91
145
99
153
Comentario
27
T H E
F A C T O R Y
H K A
package ejemplomanual;
import tfhka.ve.*;
import tfhka.*;
public class EjemploManual {
private static Tfhka tf; //declaracin de la clase
public static void main(String[] args) {
try {
imprimir_factura();
} catch (PrinterException ex) {
System.out.println("Ha
ocurrido
ex.getMessage()); // Manejo de error
}
una
excepcin:
"
}
public static void imprimir_factura() throws PrinterException{
tf = new tfhka.ve.Tfhka("COM1"); //inicializacin de la clase
if(tf!=null){
tf.SendCmd(" 000000010000000100Papas"); //Agregar Item
tf.SendCmd("101"); //Pago Total en Efectivo
}
}
}
28