generate
Sintaxis y descripción
El comando generate (forma abreviada gen) genera uno o más archivos de salida (HTML, PDF, RTF y/o DOCX) transformando el archivo XML de entrada utilizando los documentos XSLT contenidos en el archivo PXF de entrada.
stylevisionserver generate | gen --inputxml=NombreArchivo [opciones adicionales] InputPXF |
•La opción --inputxml es obligatoria; proporciona la ruta al archivo XML.
•El argumento InputPXF especifica la ruta al archivo PXF que contiene los documentos XSLT que se utilizarán para generar los documentos de salida. Los archivos PXF se crean con la aplicación Altova StyleVision.
•Cada formato de salida se genera especificando una opción para esa salida (véase la lista Opciones más abajo). El valor de cada opción es una ruta que especifica dónde se generará el resultado.
Nota: StyleVision Server utiliza Apache FOP, el procesador FO del proyecto Apache, para generar archivos PDF a partir de FO. Apache FOP se instala con StyleVision Server en la siguiente ubicación: En sistemas Windows, ProgramData\Altova\SharedBetweenVersions; en sistemas Linux, en una carpeta descendiente de la carpeta StyleVisionServer2026. Tenga en cuenta que Apache FOP requiere que Java Runtime Environment 1.8 o posterior esté instalado en el equipo StyleVision Server. Para StyleVision Server de 32 bits, instale Java de 32 bits; para StyleVision Server de 64 bits, instale Java de 64 bits. Para obtener más información sobre cómo configurar FOP, consulte Requisitos de FOP.
Si va a ejecutar varias transformaciones a PDF, especialmente de documentos grandes, es posible que desee utilizar AltovaFOPServer para realizar el trabajo más rápidamente. El aumento en la velocidad de trabajo se debe a que AltovaFOPServer mantiene cargados los archivos Java VM y FOP jar, lo que ahorra el tiempo necesario para cargar estos archivos en cada transformación. AltovaFOPServer se instalará con el paquete StyleVision. Para utilizarlo en transformaciones, primero debe iniciar AltovaFOPServer a través de la línea de comandos.
Iniciar AltovaFOPServer La sintaxis del comando para iniciar AltovaFOPServer es:
java -cp "{classPath}" {className} --pid "{pidFile} --port {portNumbers}
Ejemplo de comando de la línea de comandos para iniciar AltovaFOPServer:
java -cp "C:\Archivos de programa\Altova\Common2024\jar\gson\gson.jar;C:\Archivos de programa\Altova\Common2024\jar\AltovaFOPServer.jar" com.altova.stylevision.fopserver.Principal --pid "C:\Usuarios\usuario\AppData\Local\Temp\AltovaFopServer.pid" --puerto 9090-9103,9999
El argumento classPath debe contener las rutas de acceso a los archivos gson.jar y AltovaFOPServer.jar. Introduzca las ubicaciones correctas de estos archivos.
Llame a AltovaFOPServer en StyleVision Server Una vez iniciado AltovaFOPServer, puede llamarlo desde StyleVision Server utilizando el comando generate con la opción altova-fopserver-pid-file o altova-fopserver-port (consulte Opciones más abajo).
|
StyleVisionServer en Windows stylevisionserver en Windows y Linux
* Las minúsculas (stylevisionserver) funcionan en todas las plataformas (Windows y Linux), mientras que las mayúsculas (StyleVisionServer) funcionan solamente en Windows. * Use la barra diagonal en Linux y la barra diagonal inversa en Windows.
|
En sistemas Windows: si hay espacios o caracteres especiales (por ejemplo en los nombres de archivos o de carpetas, empresas, personas o productos) debe usar comillas: por ejemplo, "Mi archivo". Sin embargo, debe tener en cuenta que una barra diagonal inversa seguida de comillas dobles (por ejemplo, "C:\Mi Directorio\") es posible que no se lea correctamente. Esto se debe a que la barra diagonal inversa también se usa para empezar secuencias de escape y la secuencia de escape \" también usa las comillas dobles. Para evitar secuencia de caracteres puede añadir otra barra diagonal inversa: \\". En resumen: si necesita escribir una ruta que contenga espacios y una barra diagonal inversa, esta es la mejor forma de hacerlo: "C:\Mi Directorio\\".
|
Ejemplos
Ejemplos del comando generate:
stylevisionserver generate --inputxml=C:\MyFiles\ExpReport.xml --html=Test.html ExpReport.pxf
stylevisionserver generate --inputxml=C:\ExpReport.pxf|zip\ExpReport.xml --html=Test.html ExpReport.pxf
stylevisionserver generate --inputxml=altova://packagedfile/ExpReport.xml --html=Test.html ExpReport.pxf
stylevisionserver generate --inputxml=ExternalXML.xml --html=Test.html Test.pxf
•Los comandos anteriores contienen la opción obligatoria --inputxml, el argumento InputPXF (Test.pxf) y al menos una opción de creación de resultados (--html en todos los ejemplos anteriores).
•El archivo XML de entrada que se va a utilizar puede encontrarse dentro del archivo PXF (ver segundo y tercer ejemplo más arriba) o puede ser un archivo XML externo (situado fuera del archivo PXF; ver primer y cuarto ejemplo más arriba).
•El conmutador --inputxml se ignora si la fuente del esquema principal es BD o BD-XML, pero debe estar presente por motivos sintácticos, y debe utilizar algo como --inputxml=database.
•Si la opción de creación de resultados --html toma una ruta relativa, como en los ejemplos anteriores, la ubicación del archivo de salida será relativa a la carpeta en la que se encuentra el archivo PXF.
Opciones
--xml, --inputxml = RutaDelArchivoXML Esta opción es obligatoria. Especifica la ruta al archivo XML que se va a procesar. El archivo XML puede estar ubicado dentro o fuera del archivo PXF. Para apuntar a archivos XML dentro de un archivo PXF, utilice el localizador |zip (véase la parte resaltada en los ejemplos anteriores). La opción --inputxml se ignora si la fuente del esquema principal del PXF de entrada es una BD o BD-XML.
|
--dbw, --dbwhere = CláusulaWHERE Una cláusula SQL WHERE que determina qué filas de una fuente BD-XML se deben procesar.
|
--p, --param = $NombreParám:ValorParám Asigna un valor a un parámetro definido en el archivo PXF. El conmutador --param debe utilizarse antes de cada parámetro. Utilice comillas si NombreParám o ValorParám contienen un espacio. Ejemplo: --p=$company:"Nanonull Inc"
|
--prohibit-output-outside-target-folder = true|false Los valores son true|false. Si es true, no permite la creación de resultados en ninguna carpeta que no sea aquella en la que se crea el archivo de salida principal (HTML, PDF, RTF, DOCX, FO). Esto proporciona protección para otras carpetas si es necesario. El valor predeterminado es false.
|
--html, --outhtml = RutaArchivo Ruta al archivo HTML que se va a generar.
|
--pdf, --outpdf = RutaArchivo Ruta al archivo PDF que se va a generar.
|
--rtf, --outrtf = RutaArchivo Ruta al archivo RTF que se va a generar.
|
--docx, --outdocx = RutaArchivo Ruta al archivo DOCX que se va a generar.
|
--text, --outtext = RutaArchivo Ruta al archivo de texto que se va a generar.
|
--fo, --outfo = RutaArchivo Ruta al archivo FO que se va a generar.
|
--generate-html-output-as-mime = true|false Los valores son true|false. Si no se especifica la opción, el valor predeterminado es false; si se especifica sin ningún valor, entonces es true. Si es true, el resultado HTML se genera como secuencia mime.
|
--altova-fopserver-pid-file = RutaArchivo La ruta al archivo PID que se utilizará para conectarse a un AltovaFOPServer en ejecución. Puede conectarse a AltovaFOPServer mediante el archivo PID del servidor o un puerto. Esta opción PID es una alternativa a la opción de puerto (véase la siguiente opción). Para obtener más información sobre cómo utilizar AltovaFOPServer, consulte la descripción general del comando generate más arriba.
|
--altova-fopserver-port = Valor Un número de puerto o una lista de números de puerto que se utilizarán para conectarse a un AltovaFOPServer en ejecución. Los números de puerto de una lista se separan con comas. En lugar de un solo número en la lista, puede utilizar un rango. Por lo tanto, puede enviar 9090-9100,9999 como valor de esta opción. Puede conectarse a AltovaFOPServer mediante el archivo PID del AltovaFOPServer o un puerto. Esta opción port es una alternativa a la opción PID (véase la opción anterior). Para obtener más información sobre cómo utilizar AltovaFOPServer, consulte la descripción general del comando generate más arriba.
|
--taxonomy-package = RutaArchivo Ruta a un paquete de taxonomías adicional. Añada la opción varias veces para indicar más de un paquete de taxonomías.
|
--taxonomy-packages-config-file = RutaArchivo Ruta al archivo TaxonomyPackagesConfig.json, que es un archivo común utilizado por los productos Altova XMLSpy, MapForce y StyleVision para configurar taxonomías XBRL para su uso en estos productos.
|
--v, --verbose = true|false Los valores son true|false. Activa o desactiva la visualización de todos los mensajes, respectivamente. El valor predeterminado es false si no se proporciona la opción, true si se proporciona sin un valor.
|
--l, --lang = en|de|es|fr|ja El idioma utilizado para mostrar los mensajes.
|
Use la opción --h, --help para mostrar información sobre el comando.
Las opciones se enumeran en versión corta (si existe) y larga. Puede usar una o dos barras tanto para la versión corta como para la larga. Las opciones pueden tomar un valor o no hacerlo. Si lo hacen, se escribe así: --option=value. Los valores se pueden indicar sin comillas, salvo en dos casos: (i) cuando la cadena del valor contiene espacios o (ii) cuando se indica de forma explícita en la descripción de la opción que las comillas son necesarias. Si una opción toma un valor booleano y no se especifica ningún valor, entonces el valor predeterminado de la opción es TRUE. Use la opción --h, --help para mostrar información sobre el comando.
Catálogos
Si usa el mecanismo de catalogación de Altova encontrará los archivos relevantes en la carpeta etc de la carpera de la aplicación StyleVision Server. Para leer información más detallada consulte la sección Catálogos del manual de Altova StyleVision.
Puede crear el archivo CustomCatalog.xml a partir del archivo de plantilla CustomCatalog_template.xml. Asegúrese de que cambia el nombre del archivo de plantilla a CustomCatalog.xml, ya que es este el que se usa en el mecanismo de catalogación (y no la plantilla).
Tenga en cuenta que:
•Durante una instalación nueva de la misma versión principal (misma u otra subversión), el archivo de plantilla se sustituye por uno nuevo, pero CustomCatalog.xml no cambia.
•Sin embargo, si instala una versión principal nueva sobre una versión principal anterior, la carpeta de la instalación anterior se borra junto con su archivo CustomCatalog.xml. Por tanto, si quiere seguir usando el CustomCatalog.xml de la versión anterior debe guardarlo en una ubicación segura. Después de instalar la versión principal nueva puede copiar el archivo CustomCatalog.xml guardado en la carpeta etc de la versión principal nueva y editarlo allí como necesite.