manual de interfaz de programación de aplicaciones plantilla de fax de gif faxmaker o outlook. esta...

27
GFI Product Manual Manual de Interfaz de programación de aplicaciones

Upload: doantruc

Post on 12-May-2018

215 views

Category:

Documents


1 download

TRANSCRIPT

GFI Product Manual

Manual de Interfaz de programación de aplicaciones

http://www.gfi.com

[email protected]

La información y contenido de este documento se proporciona sólo para fines informativos y se proporciona "tal cual", sin garantía de ningún tipo, ya sea expresa o implícita, incluyendo pero no limitadas a las garantías implícitas de comercialización, idoneidad para un propósito particular y ausencia de infracción. GFI Software no se hace responsable de ningún daño, incluyendo daños consecuentes, de cualquier naturaleza, que puedan deberse a la utilización de este documento. La información se ha obtenido de fuentes disponibles públicamente. A pesar de los esfuerzos razonables que se han hecho para asegurar la exactitud de los datos facilitados, GFI no reclama, promete o garantiza la integridad, exactitud, actualidad o adecuación de la información y no es responsable de errores tipográficos, fuera de la información actualizada, o errores. GFI no ofrece ninguna garantía, expresa o implícita, y no asume ninguna obligación legal ni responsabilidad por la exactitud o la exhaustividad de la información contenida en este documento.

Si estima que existe algún error objetivo en este documento, póngase en contacto con nosotros y revisaremos sus dudas tan pronto como sea posible.

Todos los nombres de productos y empresas mencionados aquí pueden ser marcas comerciales de sus respectivos titulares.

GFI FaxMaker es propiedad de GFI SOFTWARE Ltd. - 1999-2011 GFI Software Ltd. Reservados todos los derechos.

Versión del documento: FM-API-ES-2.00.00

Última actualización: 08 de agosto de 2011

Índice

1 Interfaces de programación de aplicaciones 1

1.1 Introducción a las interfaces de programación de aplicaciones de GFI FaxMaker .................................................................................... 1

1.2 NetPrintQueue2FAX................................................................. 1

1.3 Text-API .............................................................................. 1

1.4 API XML ............................................................................... 5

1.5 Especificación *.XML ................................................................ 7

1.6 Ejemplo de archivo XMLAPI ...................................................... 15

1.7 Especificación de *.STATUS ..................................................... 17

2 Resolución de problemas 19

2.1 Introducción ....................................................................... 19

2.2 Base de conocimientos ........................................................... 19

2.3 Foro en la red ..................................................................... 19

2.4 Solicitar soporte técnico ......................................................... 19

2.5 Avisos de actualizaciones ........................................................ 19

Índice alfabético 21

Interfaces de programación de aplicaciones GFI FaxMaker | 1

1 Interfaces de programación de aplicaciones

1.1 Introducción a las interfaces de programación de aplicaciones de GFI FaxMaker

GFI FaxMaker le permite enviar faxes automáticamente a la cola de la aplicación por medio de alguno de estos 3 métodos:

1. La característica Netprintqueue2FAX

2. Text-API

3. API XML.

1.2 NetPrintQueue2FAX

La característica Netprintqueue2FAX le permite insertar el número de fax en el documento que se envía. De esta manera, puede imprimir como fax desde casi cualquier aplicación, desde cualquier sitio de la red, sin tener que introducir el número de fax por separado en la plantilla de fax de GIF FaxMaker o Outlook.

Esta característica es especialmente útil para las aplicaciones de contabilidad: simplemente insertando el número de fax en el documento, por ejemplo una factura, se puede enviar un fax. No se requiere ninguna integración ni desarrollo de aplicaciones.

Para obtener más información, consulte el capítulo de NetPrintQueue2FAX en el manual de usuario de GFI FaxMaker.

1.3 Text-API

La Interfaz de programación de aplicaciones (API) de texto le permite enviar archivos de texto automáticamente por medio del envío de un archivo de texto con opciones de fax a un directorio.

Antes de comenzar a utilizar la Text-API, primero debe configurarla en la Configuración del servidor de FAX. Para ello;

1. Vaya a la Configuración de GFI FaxMaker ► Avanzado ► Text-API, haga clic con el botón derecho y seleccione Propiedades. Se abrirá el cuadro de diálogo de propiedades de la Text-API.

2 | GFI FaxMaker Interfaces de programación de aplicaciones

Captura de pantalla 1: Las propiedades de la Text-API

2. Ahora habilite “Buscar en la carpeta archivos de texto” e introduzca el nombre de la carpeta donde se guardarán todos los archivos (que se envían por fax).

3. Ahora especifique una carátula sobre la cual se deberá formatear el texto en el archivo de texto, seleccionando una carátula apropiada del cuadro de lista.

Para enviar un archivo de texto automáticamente:

1. Cree un archivo de texto con el texto de su mensaje.

2. Agregue una línea al principio del texto. Comience con dos puntos dobles (::) y especifique el nombre del destinatario, la empresa, el apellido, el departamento, la dirección de correo electrónico (todos opcionales) y el número de fax.

Por ejemplo, para enviar un fax a Joe Johnson del departamento de ventas de la empresa ABC cuya dirección de correo electrónico es [email protected] y cuyo número de fax es 12345678, la entrada será la siguiente:

::Joe, ABC, Johnson, Ventas, [email protected], 12345678

El número de fax se puede ubicar en cualquier lugar de la sintaxis. También puede especificar el número de fax por sí mismo. Por ejemplo:

:: 12345678

La sintaxis completa para esta línea es la siguiente:

::<nombre>, <empresa>, <apellido>, <departamento>, <dirección de correo electrónico>, <número de fax>

3. Puede agregar opciones de envío adicionales añadiendo una segunda línea, precedida por dos puntos dobles, especificando opciones de fax válidas tal como se describe en el siguiente párrafo “Opciones de fax”.

4. Guarde el archivo de texto en el directorio. Asegúrese que el archivo se guarde con la extensión .txt.

5. Ahora, el servidor de fax comenzará a procesar el archivo y cambiará su extensión por .tmp.

Interfaces de programación de aplicaciones GFI FaxMaker | 3

6. Si el fax se transmite correctamente, la extensión del nombre de archivo de fax cambiará a *.ok. Si el fax falla, la extensión cambiará a *.err. Los archivos *.OK y *.ERR se pueden visualizar con un editor de texto normal. Si especifica el remitente del fax (ver a continuación), también se enviará un informe de transmisión al usuario.

NOTA: No se utilizan las extensiones *.OK y *.ERR si especifica el remitente del mensaje como se describe en la sección “Para especificar el remitente del mensaje” más adelante en el manual.

La carátula de la Text-API

Los archivos de texto se formatean utilizando un archivo HTML como plantilla. De esta manera, puede agregar el logotipo de su empresa y detalles de dirección, etc., al archivo de texto. Por defecto, la plantilla de texto utiliza la carátula global predeterminada que está configurada en la configuración del servidor de fax, ficha de carátula. Sin embargo, puede cambiar la carátula que desea utilizar especificando un archivo de carátula diferente, como se muestra a continuación en las opciones de fax.

Opciones de fax

Cuando envía un fax utilizando la Text-API, puede especificar opciones de “envío” como resolución alta o normal y programación de la hora de envío de fax. Estas opciones se deben especificar en la segunda línea del archivo del texto precedida por dos puntos dobles ::. (Los destinatarios del fax no podrán ver estas especificaciones en el texto recibido). Se pueden utilizar las siguientes opciones: Para especificar una carátula

::C=nombre de carátula o ::Coverpage=nombre de carátula.

Por ejemplo: ::C=carátula1

“Nombre de carátula” corresponde al nombre de su carátula. Si no desea enviar una carátula, pero se agrega una carátula por defecto, puede anular esta opción temporalmente especificando “none” en lugar del nombre de una carátula. Esto hará que GFI FaxMaker no agregue una carátula.

NOTA: Recuerde que la carátula se debe almacenar y configurar primero en el servidor.

Para especificar una carátula frontal

::F=nombre de carátula frontal o ::frontcover=nombre de carátula

Por ejemplo: ::F=carátulafrontal2

“Nombre de carátula frontal” corresponde al nombre de su carátula frontal.

NOTA: Recuerde que la carátula se debe almacenar y configurar primero en el servidor.

Para especificar una cabecera de fax

::fh=cabecera o :: faxheader=cabecera

Por ejemplo: ::fh=John Doe o ::faxheader=John Doe

Con esta opción, puede definir una cabecera personal personalizada, la cual se agregará a la cabecera de fax predeterminada al principio del fax.

Para especificar resolución alta o normal

::H o ::high, o ::N o ::normal

Por ejemplo: ::H

“H” corresponde a resolución alta (200 * 200 ppp) y “N” a resolución normal (200 * 100 ppp).

Para programar un fax

::YYYY-MM-DD-hh:mm:ss

Por ejemplo: ::2010-04-21-16:05:00

4 | GFI FaxMaker Interfaces de programación de aplicaciones

Especifique el año con 4 dígitos para “YYYY” y 2 dígitos para el resto. “MM” corresponde a mes, “DD” a día, “hh” a hora, “mm” a minutos y “ss” a segundos. Cuando especifique un valor de un solo dígito (por ejemplo, de 0 a 9) para valores de 2 dígitos, asegúrese de agregar un “0” como prefijo de manera que “3” sea “03”.

Puede usar alternativamente el siguiente método equivalente:

::hh:mm

Por ejemplo: ::23:15

“hh” equivale a horas y “mm” equivale a minutos. Si desea enviar un fax a una hora determinada, puede usar esta opción.

Para especificar un código de facturación

::B=nnnn o ::billingcode=nnnn

Por ejemplo: ::B=5

“nnnn” se puede reemplazar por cualquier cadena. Este número se agregará al archivo de registro y luego se puede usar para dividir los costes.

Para especificar el asunto

::S=asunto o ::subject=asunto

Por ejemplo: ::s=listadeprecios

Reemplace “asunto” por el asunto que especificará GFI FaxMaker en el campo <asunto> de la carátula.

Para especificar prioridad

::p=low/high/l/h o priority= low/high/l/h

Por ejemplo: ::p=low

“P” corresponde a prioridad. Puede especificar low, high o l o h. Esta opción es útil cuando ha enviado un fax grande y desea que se envíe inmediatamente.

Para solicitar qué línea de fax usar

::line=númerodelínea, o l=númerodelínea

Por ejemplo: ::line=1

GFI FaxMaker intentará enviar el fax por la línea especificada. Sin embargo, si la línea está ocupada o no está disponible, lo enviará por otra línea.

Para especificar la línea de fax que se usará

::dl=númerodelínea

Por ejemplo: ::dl=1

GFI FaxMaker enviará el fax sólo por la línea especificada. Si la línea está ocupada, no se enviará el fax hasta que la línea esté disponible.

Puede usar alternativamente el siguiente método:

::line=númerodelínea, demandline o l=númerodelínea, dl

Por ejemplo: ::line=1,dl

Para especificar el remitente del mensaje

::fr=nombre o ::from=nombre

Por ejemplo: ::from=John Smith

Reemplace “nombre” por el nombre del remitente. Esto sólo es necesario cuando se usa la Text-API, ya que en este caso GFI FaxMaker no tendrá ninguna información sobre el remitente. Si se usa esta opción, GFI FaxMaker incluirá el nombre del remitente en la carátula y devolverá un informe de transmisión al remitente.

Interfaces de programación de aplicaciones GFI FaxMaker | 5

Para adjuntar un archivo al fax

::A=nombre de archivo

Por ejemplo: ::A=folleto.fax o ::A=renuncia.txt

“Nombre de archivo” corresponde al nombre del archivo adjunto del fax. Se pueden agregar varios archivos adjuntos al fax; para ello, especifique los comandos de archivos adjuntos múltiples tal como se muestra en el ejemplo.

NOTA: GFI FaxMaker busca el archivo adjunto primero en el directorio de “carátula” en el servidor de fax y luego en el directorio de la Text-API.

Opciones múltiples

Cuando utilice opciones múltiples en un mensaje, debe escribirlas en la misma línea, separadas por una coma.

Por ejemplo:

::c=carátula1,23:15,B=5

En este ejemplo se envía un fax con “carátula1” como carátula, programado para las 23.15 horas, y se cobra con el código de facturación 5.

Captura de pantalla 2: Envío de un fax usando opciones múltiples

NOTA 1: Recuerde que, antes de usar opciones de fax, debe asegurarse de haber almacenado los archivos adjuntos y carátulas que está utilizando.

NOTA 2: GFI FaxMaker no distingue entre mayúsculas y minúsculas. Esto significa que no importa si escribe su texto en mayúsculas o no.

1.4 API XML

La API XML se utiliza para establecer explícitamente todos los datos que necesita el Servidor de fax GFI FaxMaker o el Agente de transferencia de mensajes GFI FaxMaker para enviar faxes y/o mensajes SMS, respectivamente. Como lo especifica su nombre, la API XML se basa en XML. Se envía al servidor de fax un archivo que contiene todos los datos necesarios para el fax y/o la transmisión SMS en formato de archivo XML estándar.

6 | GFI FaxMaker Interfaces de programación de aplicaciones

Uso de la API XML:

Figura 1: Envío de un fax/SMS por medio de la API XML

El envío de un fax a GFI FaxMaker se realiza depositando un archivo XML en una carpeta. La ubicación de la carpeta se configura en el registro del ordenador donde está instalado GFI FaxMaker, bajo “XMLAPI”, situado en la clave de registro “HKLM\Software\GFI FAX & VOICE\FaxMaker\Config”. Archivos FaxMaker *.xml consultan periódicamente esta carpeta, la cual elige cualquier archivo xml para transmisión ya sea como fax o SMS.

La aplicación de terceros genera un archivo XML que contiene toda la información necesaria para el fax/SMS.

El archivo XML se deposita en la carpeta designada.

GFI FaxMaker consulta la carpeta designada preconfigurada y recupera la información del archivo XML para procesarla.

GFI FaxMaker procesa la información XML y envía FAX/SMS.

Figura 2: Recepción de respuestas de FaxMaker a través de la API XML

Interfaces de programación de aplicaciones GFI FaxMaker | 7

GFI FaxMaker genera una respuesta.

El archivo XML se deposita en la carpeta designada.

La aplicación de terceros consulta la carpeta designada preconfigurada y recupera la información del archivo XML para procesarla.

La aplicación de terceros debe buscar en la carpeta archivos de respuesta. GFI FaxMaker los limpia automáticamente en 10 minutos desde la última operación de escritura que tiene lugar dentro del archivo de respuesta.

El tiempo de intervalo es configurable por medio del valor de registro “XMLAPIExpiry” que se encuentra en la clave de registro HKLM\Software\GFI FAX & VOICE\Faxmaker\Config. El valor de este campo se expresa en minutos.

Los mensajes de respuesta se guardan con la extensión “.status”.

NOTA: Los nombres de archivo (tanto *.xml como *.status) están limitados a 16 caracteres y pasado este límite se truncarán.

1.5 Especificación *.XML

Campos de mensaje

Ruta XML \faxmakerdata\fields

Tipo Nodo

Disposición Opcional [x1]

Detalles Bloque que contiene los datos del fax o mensaje SMS.

NOTA: Especifique este bloque sólo una vez en un archivo XMLAPI.

Ejemplo <?xml version=“1.0”

encoding=“utf-8”?>

<faxmakerdata>

<fields>

<subject>this is the subject</subject>

<schedule>2004-10-10-08:15:00</schedule>

<priority>high</priority>

<billingcode>25</billingcode>

<resolution>high</resolution>

<coverpage>corporate</coverpage>

<frontcovernote>letterhead</frontcovernote>

<faxline demandline=“true”>3</faxline>

<faxheader>J. L. Smith</faxheader>

<bodyfile type=“text/plain”>c:\temp\bodyfile.txt</bodyfile>

<attachment>c:\temp\document.doc</attachment>

<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>

</fields>

</faxmakerdata>

Ruta XML \faxmakerdata\fields\subject

Tipo Cadena

Disposición Opcional

Detalles Establece el asunto del mensaje

8 | GFI FaxMaker Interfaces de programación de aplicaciones

Ruta XML \faxmakerdata\fields\schedule

Tipo Cadena

Disposición Opcional

Detalles Establece la hora de envío del mensaje. La cadena de fecha se tiene que especificar en el formato fijo: YYYY-MM-DD-HH:mm:ss

Ruta XML \faxmakerdata\fields\priority

Tipo Cadena

Disposición Opcional

Detalles Establece la prioridad del mensaje. Los valores válidos son “low”, “normal”, “high”, “veryhigh”.

Ruta XML \faxmakerdata\fields\billingcode

Tipo Cadena

Disposición Opcional

Detalles Establece el código de facturación del remitente del mensaje.

Ruta XML \faxmakerdata\fields\resolution

Tipo Cadena

Disposición Opcional

Detalles Establece la resolución del fax. Los valores válidos son “normal”, “high”.

Ruta XML \faxmakerdata\fields\coverpage

Tipo Cadena

Disposición Opcional

Detalles Establece la carátula que se usa para enviar el fax. Esta puede ser cualquier nombre de carátula especificado en la configuración de carátulas de FaxMaker, o un nombre de archivo en la carpeta FaxMaker\Coverpge.

Ruta XML \faxmakerdata\fields\frontcovernote

Tipo Cadena

Disposición Opcional

Detalles Establece la nota de carátula frontal que se usa para enviar el fax. Esta puede ser cualquier nombre de nota de carátula frontal especificado en la configuración de notas de carátula frontal de FaxMaker, o un nombre de archivo en la carpeta FaxMaker\Coverpge.

Ruta XML \faxmakerdata\fields\faxline

Tipo Número

Interfaces de programación de aplicaciones GFI FaxMaker | 9

Disposición Opcional

Detalles Establece el número de línea preferido que se usa cuando se envía el fax.

Atributos demandline=“true” Especifique este atributo cuando desee enviar el fax usando obligatoriamente la línea especificada.

Ruta XML \faxmakerdata\fields\faxheader

Tipo Cadena

Disposición Opcional

Detalles Establece la información de la cabecera personal de fax que se usa en el fax. Adopta el texto de la cabecera/pie de página del fax si se selecciona el campo de cabecera/pie de página correcto.

Ruta XML \faxmakerdata\fields\bodyfile

Tipo Cadena

Disposición Opcional

Detalles Establece el archivo que se usa como cuerpo del mensaje. Se puede pasar el archivo como una ruta completa o sólo un nombre de archivo, en cuyo caso se busca el archivo en la misma carpeta o en la carpeta FaxMaker\coverpge.

NOTA: Si se pasa el archivo como ruta completa, se elimina con el mismo archivo XML cuando se procesa.

Atributos type=“text/html” Especifique este atributo cuando desee especificar que el texto del cuerpo del mensaje se encuentra en formato HTML.

type=“text/rtf” Especifique este atributo cuando desee especificar que el texto del cuerpo del mensaje se encuentra en formato RTF.

type=“text/plain” Especifique este atributo cuando desee especificar que el texto del cuerpo del mensaje se encuentra en formato de texto sencillo.

NOTA: Dado que este es el valor predeterminado, no es necesario especificar este atributo si sabe que el archivo del cuerpo de su mensaje se encuentra en formato de texto sencillo.

Ruta XML \faxmakerdata\fields\attachment

Tipo Cadena

Disposición Opcional [Múltiple x60 Máx.]

Detalles Adjunta al mensaje el archivo especificado. Se puede pasar el archivo como una ruta completa o sólo un nombre de archivo, en cuyo caso se busca el archivo en la misma carpeta o en la carpeta FaxMaker\coverpge.

NOTA 1: Si se pasa el archivo como ruta completa, se elimina con el mismo archivo XML cuando se procesa. Esto también sucede si el archivo se pasa como nombre de archivo y el archivo existe en la misma carpeta.

NOTA 2: Puede especificar 60 archivos adjuntos como máximo.

10 | GFI FaxMaker Interfaces de programación de aplicaciones

NOTA: se requiere \faxmakerdata\fields\attachment o \faxmakerdata\fields\bodyfile

Ruta XML \faxmakerdata\fields\uid

Tipo Cadena [Máx. 255 caracteres]

Disposición Opcional

Detalles Especifique un identificador que se usa para marcar el mensaje. El carácter único de este identificador depende del creador del mensaje. El número máximo de caracteres es 255.

Ruta XML \faxmakerdata\fields\textapi

Tipo Cadena

Disposición Opcional [Múltiple]

Detalles Se usa para especificar una sola línea de comandos de Text-API. (incluyendo el prefijo “::”). Este campo se puede especificar varias veces.

Campos de remitente

Ruta XML \faxmakerdata\sender

Tipo Nodo

Disposición Obligatorio [x1]

Detalles Bloque que contiene los detalles personales del remitente. No especifica el remitente real.

NOTA: Especifique este bloque sólo una vez en un archivo XMLAPI.

Ejemplo <?xml version=“1.0”

encoding=“utf-8”?>

<faxmakerdata>

<sender>

<firstname>John</firstname>

<lastname>Smith</lastname>

<company>J.S. Holdings</company>

<department>Sales</department>

<faxnumber>+123 (456) 7890</faxnumber>

<voicenumber>+123 (456) 0987</voicenumber>

<emailaddress>[email protected]</emailaddress>

</sender>

</faxmakerdata>

Ruta XML \faxmakerdata\sender\firstname

Tipo Cadena

Disposición Opcional

Detalles Establece el nombre del remitente.

Ruta XML \faxmakerdata\sender\lastname

Tipo Cadena

Interfaces de programación de aplicaciones GFI FaxMaker | 11

Disposición Opcional

Detalles Establece el apellido del remitente.

Ruta XML \faxmakerdata\sender\company

Tipo Cadena

Disposición Opcional

Detalles Establece la empresa del remitente.

Ruta XML \faxmakerdata\sender\department

Tipo Cadena

Disposición Opcional

Detalles Establece el departamento del remitente.

Ruta XML \faxmakerdata\sender\faxnumber

Tipo Cadena

Disposición Opcional

Detalles Establece el número de fax del remitente.

Ruta XML \faxmakerdata\sender\voicenumber

Tipo Cadena

Disposición Opcional

Detalles Establece el número de voz (teléfono) del remitente.

Ruta XML \faxmakerdata\sender\emailaddress

Tipo Cadena

Disposición Obligatorio

Detalles Establece la dirección de correo electrónico en Internet del remitente.

Destinatarios de fax

Ruta XML \faxmakerdata\recipients\fax

Tipo Nodo

Disposición Opcional [x1]

Detalles Bloque que contiene los destinatarios a los que enviar faxes.

NOTA: Especifique este bloque sólo una vez en un archivo XMLAPI.

12 | GFI FaxMaker Interfaces de programación de aplicaciones

Ejemplo <?xml version=“1.0”

encoding=“utf-8”?>

<faxmakerdata>

<recipients>

<fax>

<recipient>

<firstname>Joe</firstname>

<lastname>Bloggs</lastname>

<company>J.B. Ltd.</company>

<department>Marketing</department>

<faxnumber>+1 800 6565</faxnumber>

<voicenumber>+1 800 6564</voicenumber>

<emailaddress>[email protected]</emailaddress>

</recipient>

</fax>

</recipients>

</faxmakerdata>

Ruta XML \faxmakerdata\recipients\fax\recipient

Tipo Nodo

Disposición Obligatorio [Múltiple]

Detalles Bloque que contiene los detalles personales de un único destinatario de fax.

Ruta XML \faxmakerdata\recipients\fax\recipient\firstname

Tipo Cadena

Disposición Opcional

Detalles Establece el nombre del destinatario.

Ruta XML \faxmakerdata\recipients\fax\recipient\lastname

Tipo Cadena

Disposición Opcional

Detalles Establece el apellido del destinatario.

Ruta XML \faxmakerdata\recipients\fax\recipient\company

Tipo Cadena

Disposición Opcional

Detalles Establece el nombre de la empresa del destinatario.

Ruta XML \faxmakerdata\recipients\fax\recipient\department

Tipo Cadena

Disposición Opcional

Detalles Establece el departamento del destinatario.

Interfaces de programación de aplicaciones GFI FaxMaker | 13

Ruta XML \faxmakerdata\recipients\fax\recipient\faxnumber

Tipo Cadena

Disposición Obligatorio

Detalles Establece el número de fax del destinatario.

Ruta XML \faxmakerdata\recipients\fax\recipient\voicenumber

Tipo Cadena

Disposición Opcional

Detalles Establece el número de voz (teléfono) del destinatario.

Ruta XML \faxmakerdata\recipients\fax\recipient\emailaddress

Tipo Cadena

Disposición Opcional

Detalles Establece la dirección de correo electrónico en Internet del destinatario.

Destinatarios de SMS

Ruta XML \faxmakerdata\recipients\sms

Tipo Nodo

Disposición Opcional [x1]

Detalles

Bloque que contiene los destinatarios a los que se envían mensajes SMS.

NOTA: Especifique este bloque sólo una vez en un archivo XMLAPI.

Ejemplo <?xml version=“1.0”

encoding=“utf-8”?>

<faxmakerdata>

<recipients>

<sms>

<recipient>

<firstname>Joe</firstname>

<lastname>Bloggs</lastname>

<company>J.B. Ltd.</company>

<department>Marketing</department>

<smsnumber>+1 65656565</smsnumber>

<voicenumber>+1 800 6564</voicenumber>

<emailaddress>[email protected]</emailaddress>

</recipient>

</sms>

</recipients>

</faxmakerdata>

Ruta XML \faxmakerdata\recipients\sms\recipient

14 | GFI FaxMaker Interfaces de programación de aplicaciones

Tipo Nodo

Disposición Obligatorio [Múltiple]

Detalles Bloque que contiene los detalles personales de un único destinatario de SMS.

Ruta XML \faxmakerdata\recipients\sms\recipient\firstname

Tipo Cadena

Disposición Opcional

Detalles Establece el nombre del destinatario.

Ruta XML \faxmakerdata\recipients\sms\recipient\lastname

Tipo Cadena

Disposición Opcional

Detalles Establece el apellido del destinatario.

Ruta XML \faxmakerdata\recipients\sms\recipient\company

Tipo Cadena

Disposición Opcional

Detalles Establece el nombre de la empresa del destinatario.

Ruta XML \faxmakerdata\recipients\sms\recipient\department

Tipo Cadena

Disposición Opcional

Detalles Establece el departamento del destinatario.

Ruta XML \faxmakerdata\recipients\sms\recipient\smsnumber

Tipo Cadena

Disposición Obligatorio

Detalles Establece el número de SMS del destinatario.

Ruta XML \faxmakerdata\recipients\sms\recipient\voicenumber

Tipo Cadena

Disposición Opcional

Detalles Establece el número de voz (teléfono) del destinatario.

Ruta XML \faxmakerdata\recipients\sms\recipient\emailaddress

Interfaces de programación de aplicaciones GFI FaxMaker | 15

Tipo Cadena

Disposición Opcional

Detalles Establece la dirección de correo electrónico en Internet del destinatario.

1.6 Ejemplo de archivo XMLAPI

Ejemplo <?xml version=“1.0”

encoding=“utf-8”?>

<faxmakerdata>

<fields>

<subject>this is the subject</subject>

<schedule>2004-10-10-08:15:00</schedule>

<priority>high</priority>

<billingcode>25</billingcode>

<resolution>high</resolution>

<coverpage>corporate</coverpage>

<frontcovernote>letterhead</frontcovernote>

<faxline demandline=“true”>3</faxline>

<faxheader>J. L. Smith</faxheader>

<bodyfile type=“text/plain”>c:\temp\bodyfile.txt</bodyfile>

<attachment>c:\temp\document.doc</attachment>

<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>

</fields>

<sender>

<firstname>John</firstname>

<lastname>Smith</lastname>

<company>J.S. Holdings</company>

<department>Sales</department>

<faxnumber>+123 (456) 7890</faxnumber>

<voicenumber>+123 (456) 0987</voicenumber>

<emailaddress>[email protected]</emailaddress>

</sender>

<recipients>

<fax>

<recipient>

<firstname>Joe</firstname>

<lastname>Bloggs</lastname>

<company>J.B. Ltd.</company>

<department>Marketing</department>

<faxnumber>+1 800 6565</faxnumber>

<voicenumber>+1 800 6564</voicenumber>

<emailaddress>[email protected]</emailaddress>

</recipient>

</fax>

<sms>

<recipient>

<smsnumber>+1 65656565</smsnumber>

</recipient>

</sms>

</recipients>

</faxmakerdata>

Interfaces de programación de aplicaciones GFI FaxMaker | 17

1.7 Especificación de *.STATUS

Campos de mensaje

Ejemplo <?xml version=“1.0”

encoding=“utf-8”?>

<faxmakerdata>

<fax>

<errorcode>3</errorcode>

<description>Cannot find attachment</description>

<uid>123132</uid>

<faxfile>c:\folder\image1.fax</faxfile>

<recipient>+356 21225544</recipient>

</fax>

<fax>

<errorcode>0</errorcode>

<description>Success</description>

<uid>123132</uid>

<faxfile>c:\folder\image2.fax</faxfile>

<recipient>+356 21889922</recipient>

</fax>

</faxmakerstatus>

NOTA: Existe un nodo para cada fax transmitido. Si el archivo de entrada ha especificado un único destinatario, entonces sólo hay un nodo de fax en el archivo .status resultante. Sin embargo, si se especifican varios destinatarios, solo habrá un nodo de fax por destinatario.

Campo Código de error

Tipo Numérico

Disposición Obligatorio

Detalles Si la transmisión se ha realizado correctamente contiene cero. Si no, un código de error. Use este campo en combinación con el campo de descripción para determinar la causa del problema.

Campo Descripción

Tipo Cadena

Disposición Obligatorio

Detalles Contiene un informe de transmisión para transmisiones realizadas con éxito o que han generado error.

Campo uid

Tipo Cadena

Disposición Opcional

Detalles Si el archivo de entrada XMLAPI original contenía el campo “uid”, aquí se proporciona su valor. Para obtener más información sobre el campo “uid”, consulte [1].

18 | GFI FaxMaker Interfaces de programación de aplicaciones

Campo Archivo de fax

Tipo Cadena

Disposición Opcional

Detalles Contiene la ruta completa al archivo de imagen del fax.

Campo Destinatario

Tipo Cadena

Disposición Opcional

Detalles Contiene el número de fax al que se ha enviado el fax.

Resolución de problemas GFI FaxMaker | 19

2 Resolución de problemas

2.1 Introducción

En el capítulo de resolución de problemas se explica lo que debe hacer para resolver los problemas de software con los que se pueda encontrar. Las principales fuentes de información a disposición de los usuarios son:

El manual, la mayoría de los problemas se pueden resolver leyendo este manual

Artículos de la Base de conocimientos de GFI

Foro en la red

Poniéndose en contacto con el Centro de soporte de GFI

2.2 Base de conocimientos

GFI mantiene su Base de conocimientos, que incluye respuestas a los problemas más comunes. Si tiene un problema, consulte primero la Base de conocimientos. La Base de conocimientos tiene siempre la lista más actualizada de preguntas y revisiones de soporte técnico. Para acceder a la Base de conocimientos, visite http://kbase.gfi.com/ (en inglés).

2.3 Foro en la red

El soporte técnico de usuario a usuario está disponible a través del foro en la red. Puede encontrar el foro en: http://forums.gfi.com/.

2.4 Solicitar soporte técnico

Si consultó este manual y nuestros artículos de la Base de conocimientos y aún así no puede resolver problemas con el software, póngase en contacto con el equipo del Centro de soporte de GFI completando un formulario de solicitud de soporte en línea o mediante comunicación telefónica.

» En línea: rellene el formulario de solicitud de soporte en: http://support.gfi.com/supportrequestform.asp. Siga las instrucciones tal y como se indican en esta página para enviar su solicitud de soporte.

» Teléfono: para obtener el número telefónico correcto del Centro de soporte para su región, visite: http://www.gfi.com/company/contact.htm.

NOTA: Antes de ponerse en contacto con nuestro equipo del Centro de soporte, tenga a mano su identificación de cliente. Su identificación de cliente es el número de cuenta en línea que se le asigna cuando registra por primera vez las claves de su licencia en nuestra área del cliente en: http://customers.gfi.com.

Le responderemos en 24 horas o antes, según su huso horario.

2.5 Avisos de actualizaciones

Le recomendamos firmemente que se suscriba a nuestra lista de avisos de actualizaciones. De este modo, recibirá notificaciones inmediatas sobre nuevas actualizaciones del producto. Para suscribirse a nuestros avisos de actualizaciones, visite: http://www.gfi.com/pages/productmailing.htm.

GFI FaxMaker Índice alfabético | 21

Índice alfabético

A

API, 1, 4, 5

API de texto, 1, 5

D

Destinatarios de Fax, 11

Destinatarios de SMS, 13

E

Ejemplo de archive XMLAPI, 15

Especificación *.STATUS, 17

especificación *.XML, 7

P

Portada Frontal, 3

R

Resolución de problemas, 19

USA, CANADA, CENTRAL AND SOUTH AMERICA

15300 Weston Parkway, Suite 104, Cary, NC 27513, USA

Telephone: +1 (888) 243-4329

Fax: +1 (919) 379-3402

Email: [email protected]

UK AND REPUBLIC OF IRELAND

Magna House, 18-32 London Road, Staines, Middlesex, TW18 4BP, UK

Telephone: +44 (0) 870 770 5370

Fax: +44 (0) 870 770 5377

Email: [email protected]

EUROPE, MIDDLE EAST AND AFRICA

GFI House, San Andrea Street, San Gwann, SGN 1612, Malta

Telephone: +356 2205 2000

Fax: +356 2138 2419

Email: [email protected]

AUSTRALIA AND NEW ZEALAND

83 King William Road, Unley 5061, South Australia

Telephone: +61 8 8273 3000

Fax: +61 8 8273 3099

Email: [email protected]