Xerox FreeFlow VI eCompose Dispatch SDK User Guide [es]

Version 16.0.3.0 Diciembre de 2020 702P08481

Xerox

FreeFlow

Dispatch SDK

Guía del usuario

VI eCompose

, FreeFlow Output Manager®, FreeFlow Process Manager®, VIPP®y GlossMark®son marcas registradas de Xerox Corporation en los Estados Unidos y/o en otros países. También se reconocen las siguientes marcas comerciales de otras empresas:

Adobe bReady

, el logotipo de Adobe, Acrobat®, el logotipo de Acrobat, Acrobat Reader®, Distiller®, Adobe PDF Jo-

™

, InDesign®, PostScript®, y el logotipo de PostScript son marcas comerciales registradas de Adobe Systems Incorporated en los Estados Unidos y/o otros países. Todas las instancias del nombre PostScript que aparecen en el texto hacen referencia al lenguaje PostScript según lo define Adobe Systems Incorporated, a menos que se indique lo contrario. El nombre PostScript también se usa como marca comercial de producto para la implementación de Adobe Systems del intérprete de lenguaje PostScript y otros productos de Adobe. Copyright 1987 - 2020 Adobe Systems Incorporated y sus licenciatarios. Reservados todos los derechos. Incluye las bibliotecas PDF de Adobe

Intel

, Pentium®, Centrino®y Xeon®son marcas comerciales registradas de Intel Corporation. Intel Core™Duo es

y la tecnología Adobe Normalizer.

una marca comercial de Intel Corporation.

Intelligent Mail

Macintosh

es una marca comercial registrada de United States Postal Service.

, Mac®y Mac OS®son marcas comerciales registradas de Apple, Inc., registradas en los Estados Unidos y en otros países. Los elementos de la Documentación técnica para el usuario de Apple se utilizan con permiso de Apple, Inc.

Novell Oracle

PANTONE

y NetWare®son marcas comerciales registradas de Novell, Inc. en los Estados Unidos y en otros países.

es una marca comercial registrada de Oracle Corporation Redwood City, California.

™

y otras marcas comerciales de Pantone Inc. son propiedad de Pantone Inc. Reservados todos los

derechos.

QR Code

™

es una marca comercial de Denso Wave Incorporated en Japón y/u otros países. TIFF®es una marca comercial registrada de Aldus Corporation.

The Graphics Interchange Format© es propiedad intelectual de CompuServe Incorporated. GIFSM es una marca de servicio de CompuServe Incorporated.

Windows Internet Explorer son marcas comerciales de Microsoft Corporation; Microsoft

, Windows®10, Windows Server®2012, Windows Server®2016, Windows Server®2019, OneDrive®e

y MS-DOS®son marcas comercia-

les registradas de Microsoft Corporation.

Todos los otros nombres de productos y servicios mencionados en esta publicación son marcas comerciales o marcas comerciales registradas de sus respectivas empresas. Se usan en esta publicación en beneficio de esas empresas y no cumplen la función de demostrar respaldo u otro tipo de afiliación con la publicación.

Las empresas, nombres y datos usados en los ejemplos del presente documento son ficticios, a menos que se indique lo contrario.

Si bien este material se ha preparado con gran cuidado, Xerox Corporation no aceptará ningún tipo de responsabilidad como consecuencia de inexactitudes u omisiones.

Este documento se modifica periódicamente. Las modificaciones, inexactitudes técnicas y errores tipográficos se corregirán en ediciones subsiguientes.

Producido en los Estados Unidos de América.

Tabla de contenido

1 Introducción......................................................................................................................... 5

Foro de clientes de VI Suite ............. ..... ........ ..... ............. ..... ............. ............. ..... ............. ... 6

¿Qué es el kit de desarrollo de software de VIeCD? . ............. ..... ........ ..... ............. ..... ........ ... 7

Inicio .. ............. ............. ..... ........ ..... ............. ..... ............. ............. ..... ............. ............. ..... ... 8

Descripción general de la documentación................ ............. ..... ............. ............. ..... ........ .. 9

2 Antecedentes .....................................................................................................................11

Flujo de datos de VIeCD... ............. ............. ..... ........ ..... ............. ..... ........ ..... ............. ..... ... 13

Filtros IncomingFolders de VIeCD....... ..... ........ ..... ............. ............. ..... ........ ..... ............. ... 14

Elegibilidad: CommandTemplates, RuleVars y DispatchRule FieldName... .................. ........ 15

Archivo de índice ........... .................. ............. ..... ............. ............. ..... ........ ..... ............. 15

RuleVars...... ..... ............. ............. ..... ............. ............. ..... ........ ..... ..... ........ ..... ............. 16

Nombre del campo del archivo de índice reservado . ............. ..... ........ ..... ............. ....... 16

Filtros AutoRun .... ............. ..... ........ ..... ............. ..... ........ ..... ............. ..... ............. ............. .. 17

Procesamiento ...... .................. ..... ........ ..... ............. ............. ..... ........ ..... ............. ..... ......... 18

Ciclo de vida de los trabajos VIeCD ...... ............. ..... ........ ..... ............. ............. ..... ............. . 19

Inelegible....... ..... ............. ............. ..... ............. ..... ........ ..... ............. ..... ........ ..... .......... 20

Conflicto de reglas .................. ............. ..... ........ ..... ............. ..... ........ ..... ............. ........ 20

Elegible . ............. ..... ............. ............. ..... ............. ............. ..... ........ ..... ............. ..... ...... 20

Pendiente... ..... ............. ............. ..... ........ ..... ............. ............. ..... ............. ..... ............. . 20

Actual ... ..... ........ ..... ............. .................. ............. ..... ............. ............. ..... ........ ..... ...... 21

Retenido ...... ..... ........ ..... ............. .................. ............. ..... ............. ............. ..... ........ .... 21

Completado . ............. ............. ..... ........ ..... ............. ..... ............. ..... ........ ..... ............. .... 21

3 Ejemplos, bibliotecas y utilidades ..................................................................................23

Ejemplos ........ ..... ........ ..... ............. ............. ..... ........ ..... ............. ..... ............. ..... ........ ..... ... 24

Forward....... ..... ............. ............. ..... ............. ..... ............. ............. ..... ........ ..... ............. 24

Client ..... ..... ........ ..... ............. ..... ........ ..... ............. ............. ..... ............. ..... ............. ..... 25

Server... ..... ............. ..... ............. ............. ..... ............. ............. ..... ........ ..... ............. ..... .. 25

Server2........ ..... ............. ............. ..... ............. .................. ............. ..... ........ ..... ............. 25

Olsend........ ..... ............. ............. ..... ........ ..... ............. .................. ............. ..... ............. . 26

Olsession.. ..... ........ ..... ............. .................. ............. ..... ........ ..... ............. ..... ........ ..... ... 26

Wrap. ..... ........ ..... ............. .................. ............. ..... ........ ..... ............. ..... ........ ..... .......... 26

Bibliotecas ....... ............. ..... ............. ..... ........ ..... ............. ............. ..... ............. ............. ..... . 27

vtpdwrap............. ..... ............. ..... ........ ..... ............. ............. ..... ........ ..... .................. ..... 27

vtpdsession ........ ............. ..... ........ ..... ............. ..... ........ ..... ............. .................. ........... 27

Utilidades..... ........ ..... ............. .................. ............. ..... ........ ..... ............. ..... ........ ..... .......... 28

4 VIeC Dispatch In-Circuit Emulator ................................................................................29

Uso de VIeCDICE ... ............. ............. ..... ............. .................. ............. ..... ........ ..... ............. 30

Caso 1............... ............. ..... ........ ..... ............. ............. ..... ............. ............. ..... ............ 30

Caso 2............... ............. ..... ........ ..... ............. ............. ..... ............. ............. ..... ............ 31

Caso 3............... ............. ..... ........ ..... ............. ............. ..... ............. ............. ..... ............ 31

Xerox®FreeFlow®VI eCompose Dispatch SDK

Guía del usuario

Tabla de contenido

Caso 4............... ............. ..... ........ ..... ............. ............. ..... ............. .................. ............ 32

Uso de VIeCDICE en modo por lotes ....... ..... ............. ............. ..... ........ ..... ............. ........... 34

Xerox®FreeFlow®VI eCompose Dispatch SDK Guía del usuario

Introducción

Este capítulo incluye:

• Foro de clientes de VI Suite ........... ..... ............. ............. ..... ........ ..... ............. .................. ......... 6

• ¿Qué es el kit de desarrollo de software de VIeCD? ........ ..... ............. .................. ............. ..... ... 7

• Inicio........ ..... ........ ..... ............. ............. ..... ............. .................. ............. ..... ........ ..... ............. .. 8

• Descripción general de la documentación. ........ ..... ............. .................. ............. ..... ............. ... 9

Esta guía se ha diseñado para desarrolladores de software que usan el Software Development Kit (SDK) de FreeFlow miento con el software VI eCompose (VIeC). Para usar el software VI eCompose, se recomienda que se familiarice con el software o plataformas siguientes:

• Lenguaje VIPP

• Software VIeC Dispatch

• Lenguaje de programación C, C++, o aplicaciones de la plataforma

Se recomienda que los usuarios tengan experiencia con el software VIeC Dispatch. Consulte el ejemplo en la Guía del usuario de FreeFlow

Este documento incluye información general de VIeC, como una descripción de los estados y los flujos de datos de VIeCD. La información complementa el material de referencia y la aplicación de ejemplo de VIeCD en la Guía del usuario de FreeFlow

Nota: Todos los nombres de productos de los módulos del software FreeFlow®VI Suite cam-

biaron a partir de la versión 10.0 de FreeFlow VI Suite.

Nombre de producto de legado Nombre de producto nuevo

FreeFlow VI Interpreter FreeFlow VI Compose

FreeFlow VI Interpreter Open Edition FreeFlow VI Compose Open Edition

FreeFlow VI Designer FreeFlow VI Design Pro

VI eCompose Dispatch (VIeCD) para integrar aplicaciones de postprocesa-

VI eCompose y en el Taller de VI eCompose.

VI eCompose.

FreeFlow VI PDF Originator FreeFlow VI eCompose

FreeFlow VIPP

Todos los demás productos que no se mencionan en la lista conservan el mismo nombre de la versión anterior de FreeFlow VI Suite.

Las referencias al lenguaje, comandos y formato de información variable de VIPP necen sin cambio.

Pro Publisher FreeFlow VI Design Express

Xerox®FreeFlow®VI eCompose Dispatch SDK

perma-

Guía del usuario

Introducción

Foro de clientes de VI Suite

Xerox proporciona un foro de asistencia técnica a la comunidad. El foro de clientes de VI Suite ahora es parte de un foro de asistencia más grande, que le permite publicar y revisar información acerca de los productos y servicios de Xerox desde una sola ubicación. Tómese un minuto para iniciar sesión en la comunidad del foro de clientes: http://vippsupport.xerox.com.

Xerox®FreeFlow®VI eCompose Dispatch SDK Guía del usuario

Introducción

¿Qué es el kit de desarrollo de software de VIeCD?

VIeCD SDK consiste en una recopilación de ejemplos y puntos de inicio como código fuente, utilidades y bibliotecas, que pueden usarse para integrar a VIeCD con otros flujos de trabajos. La mayoría del código proporcionado se ha escrito en C (con la excepción del ejemplo olsession, que se ha escrito en C++). Una API (interfaz del programador de la aplicación), la biblioteca de encapsulación de la regla de distribución (vtpdwrap), se presenta en la definición de la clase en el archivo vtpdwrap.h.

También se proporciona la documentación de referencia en formato HTML y Adobe PDF. Los documentos en formato HTML fueron extraídos del código de origen VIeCD SDK y, a continuación, fueron cruzados e indexados, y se pueden encontrar en el directorio /vipodsdk/docs del soporte de distribución de VIeCD SDK. Además del archivo PDF que está leyendo, los documentos readme (léame) PDF se pueden encontrar en los subdirectorios /vipodsdk/apps. Estos proporcionan instrucciones para el uso de las aplicaciones de ejemplo.

Xerox

FreeFlow®VI eCompose Dispatch SDK

Guía del usuario

Introducción

Inicio

Para usar VIeCD SDK, vaya a /vipodsdk/docs/index.html. Este archivo proporciona la información básica necesaria como:

• Una breve introducción a SDK

• Información de licencia

• Dónde obtener información de asistencia y de plataformas compatibles con VIeCD SDK

• Creación del SDK

• Suposiciones acerca de las ubicaciones de los archivos y el entorno

• Antecedentes sobre las decisiones de diseño de VIeCD SDK

• Implementación de VIeCD SDK

• Descripciones de los documentos y los archivos que deben ser revisados para comenzar

• Una breve descripción del contenido de VIeCD SDK, como:

– Utilidades

– Bibliotecas

– Código de ejemplo

– Aplicaciones de ejemplo de VIPP

– Diseño del archivo de Win32

Además, la página principal, /vipodsdk/docs/index.html, contiene los enlaces siguientes:

Estructuras de datos Una página que contiene una lista de las estructuras de datos proporciona-

das y una breve descripción de las mismas. Para ver las descripciones completas de cada estructura, haga clic en el hipertexto de esta página.

Lista de archivos Una página que contiene una lista de todos los archivos documentados con

una breve descripción de los mismos. Para ver las descripciones completas de cada archivo, haga clic en el hipertexto de esta página.

Campos de datos Una página indexada con una lista de todas las estructuras documentadas y

los campos de unión y enlaces a las estructuras y a las uniones a las que pertenecen.

Elementos globales Una lista de todas las definiciones de tipos, enumeraciones, definiciones, va-

riables y funciones documentadas con enlaces a la documentación relacionada.

Ejemplos Una lista de los ejemplos proporcionados con el SDK y enlaces al código fuen-

te para estos.

Después de revisar los archivos, use el documento para obtener información y explicaciones sobre los archivos y las utilidades que componen el VIeCD SDK.

Xerox®FreeFlow®VI eCompose Dispatch SDK Guía del usuario

Introducción

Descripción general de la documentación

Esta guía proporciona información sobre VIeCD SDK y VIeCD In-Circuit Emulator (VIeCDICE). La guía se organiza como se indica a continuación:

Antecedentes Proporciona información general sobre VIeCD y VIeCD SDK. Este

capítulo complementa la información de la Guía del usuario de FreeFlow VI eCompose e incorpora información específica sobre VIeCD SDK. Este capítulo proporciona una descripción general de VIeCD y los temas siguientes:

Flujo de datos de VIeCD

Filtros de IncomingFolders de VIeCD

Elegibilidad: El nombre de campo DispatchRule, CommandTemplates y RuleVars

Ciclo de vida de los trabajos VIeCD

Ejemplos, bibliotecas y utilidades Proporciona descripciones de los archivos y las utilidades proporcio-

nados con el VIeCD SDK, y ejemplos de cómo utilizarlos.

VIeC Dispatch In-Circuit Emulator Proporciona una descripción ampliada de la utilidad VIeCDICE, e in-

cluye las siguientes secciones:

Uso de VIeCDICE

Uso de VIeCDICE en modo por lotes

Para obtener más información acerca del lenguaje VIPP®, VI Compose y los módulos relacionados, consulte la documentación de FreeFlow

Variable Information Suite. La documentación incluye

las guías siguientes:

• Guía del usuario de FreeFlow

prender y usar VIPP

y sus aplicaciones. La guía describe los archivos y las utilidades proporcionadas con el software, los recursos necesarios para generar trabajos VIPP básica para la impresión mediante VIPP

• Manual de referencia de lenguaje VIPP

gerencias de programación y mensajes de error de VIPP

• Guía del usuario de FreeFlow

VI Compose: Proporciona la información necesaria para com-

: Documenta los comandos de VIPP®, proporciona su-

VI eCompose: Contiene información sobre el uso del software

y la información

VI eCompose para crear y enviar documentos de Adobe PDF, y para administrar de forma remota servidores web de VIeC.

• Guía del usuario de FreeFlow

• Guía del usuario de VIPP

• Guía del usuario de FreeFlow

• Glosario y referencia rápida de la documentación de FreeFlow

Para obtener más información acerca de la formación de VIPP

VI Design Pro

Manage

VI Explorer

Variable Information Suite

, póngase en contacto con un re-

presentante de Xerox.

Xerox

FreeFlow®VI eCompose Dispatch SDK

Guía del usuario

Introducción

Xerox®FreeFlow®VI eCompose Dispatch SDK Guía del usuario

Antecedentes

Este capítulo incluye:

• Flujo de datos de VIeCD......... ..... ............. .................. ............. ..... ........ ..... ............. ..... ........ . 13

• Filtros IncomingFolders de VIeCD ..... ............. ..... ........ ..... ............. ..... ............. ............. ..... .... 14

• Elegibilidad: CommandTemplates, RuleVars y DispatchRule FieldName. ............. ..... ............. . 15

• Filtros AutoRun.......... .................. ..... ........ ..... ............. ............. ..... ........ ..... ............. ..... ......... 17

• Procesamiento ............ .................. ............. ..... ........ ..... ............. ............. ..... ............. ............ 18

• Ciclo de vida de los trabajos VIeCD ....... .................. ............. ..... ............. ............. ..... ........ .... 19

El software VIeC Dispatch proporciona un mecanismo de envío genérico que inicia y supervisa el postprocesamiento de trabajos VIeC por parte de procesos de servidor especificados por el cliente, como procesos de correo electrónico, fax o depósito de documentos. En este rol, el software VIeC Dispatch se puede considerar middleware, ya que media entre los trabajos VIeC completados y el software de postprocesamiento de servidor especificado.

En los parámetros incrustados y en el resto de datos del postprocesamiento incorporados al trabajo VIeC, utilice el comando BOOKMARK de VIPP

• Los parámetros y el resto de datos se extraen de los nombres de campo y los valores de archivos de índice generados por VIeC.

• El software VIeC Dispatch transfiere los parámetros y el resto de datos al software de servidor especificado.

• Los archivos de índice de dada trabajo se identifican mediante la extensión .csv.

VIeCD es compatible con los flujos de trabajo que requieren la intervención del usuario, o con los flujos de trabajo automáticos, mediante el uso de la función AutoRun y de los filtros de usuario. Por ejemplo:

• Servidores que interactúan con sistemas de adquisición de correo electrónico y que requieren:

– Comprobación o verificación personal de la salida de VIeC antes del envío

– Limitaciones de los usuarios que pueden iniciar el envío de dichos trabajos

• Servidores que interactúan con depósitos de documentos que requieren flujos de trabajo automáticos. El proceso VIeC a VIeCD se ejecuta sin intervención del usuario.

Cuando VIeCD invoca a un programa de servidor, los parámetros se extraen de un archivo de índice del trabajo VIeC sobre una base de línea por línea. El proceso crea una nueva instancia del programa de servidor como un nuevo subproceso de cada invocación. VIeCD no permite ninguna interacción directa con el programa de servidor a través del subproceso en stdin/stdout durante la invocación. Es posible que la limitante de la invocación no sea adecuada para interactuar con todos los tipos de programas de servidor. Las posibles incompatibilidades entre el postprocesamiento de VIeC y VIeCD incluyen:

• Programas que requieren algún tipo de interacción del usuario o interacción programática en el modo normal de funcionamiento, por ejemplo, la respuesta Sí o No para la sobreescritura de archivos.

• Programas que requieren algún tipo de estado de sesión en un conjunto de transacciones, como el registro en el servidor de Microsoft Exchange para realizar transmisiones de correo electrónico.

Xerox®FreeFlow®VI eCompose Dispatch SDK

Guía del usuario

+ 25 hidden pages