generate
Sintaxis y descripción
El comando generate (gen en versión abreviada) genera uno o más archivos de salida (HTML, PDF, RTF y/o DOCX) al transformar el archivo XML de entrada con los documentos XSLT que contiene el archivo PXF de entrada.
stylevisionserver generate | gen --inputxml=Filename [opciones adicionales] InputPXF |
•La opción --inputxml es obligatoria y da la ruta de acceso del archivo XML.
•El argumento InputPXF indica la ruta de acceso al archivo PXF que contiene los documentos XSLT que se usan para generar los documentos de salida. Los archivos PXF se crean con la aplicación de Altova StyleVision.
•Cada formato de salida se genera indicando la opción correspondiente para ese resultado (véase la lista Opciones más abajo). El valor de cada una de las opciones es una ruta que indica dónde se debe generar el resultado.
| Nota: | StyleVision Server usa Apache FOP, el procesador FO del proyecto Apache, para generar archivos PDF a partir de FO. Apache FOP se instala automáticamente con StyleVision Server en estas ubicaciones: en sistemas Windows, en ProgramData\Altova\SharedBetweenVersions; en sistemas Linux y macOS, en una subcarpeta de StyleVisionServer2024. Recuerde que para poder usar Apache FOP es necesario tener instalado Java Runtime Environment 1.8 o superior en el equipo de StyleVision Server. Debe instalar la versión de Java que corresponda a su versión de StyleVision Server (32 o 64 bits, respectivamente). Para más información sobre cómo configurar FOP consulte el apartado Requisitos para FOP. |
Si quiere ejecutar múltiples transformaciones a PDF, especialmente de documentos de gran tamaño, puede que desee usar AltovaFOPServer para realizar el trabajo más rápidamente. La mayor velocidad se debe a que AltovaFOPServer mantiene cargados los archivos Java VM y FOP jar después de la primera transformación, ahorrando así el tiempo para cargar estos archivos de nuevo cada vez. AltovaFOPServer se instalará junto con su paquete StyleVision. Para poder utilizarlo para 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}
Un comando de la línea de comandos para iniciar AltovaFOPServer podría tener este aspecto:
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 la ubicación correcta para encontrar estos archivos.
Llamar a AltovaFOPServer en StyleVision Server Una vez haya iniciado AltovaFOPServer, puede llamarlo desde StyleVision Server usando el comando generate o con la opción altova-fopserver-pid-file o altova-fopserver-port (ver Opciones más abajo).
|
StyleVisionServer en Windows stylevisionserver en Windows y Unix (Linux, Mac)
* Las minúsculas (stylevisionserver) funcionan en todas las plataformas (Windows, Linux y Mac), mientras que las mayúsculas (StyleVisionServer) funcionan solamente en Windows y Mac. * Use la barra diagonal en Linux y Mac 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
•Estos ejemplos utilizan la opción obligatoria --inputxml, el argumento PXFEntrada (Test.pxf) y un mínimo de una opción de formato de salida (--html en todos los ejemplos mencionados).
•El archivo XML de entrada que se debe usar puede encontrarse dentro del archivo PXF (ver el segundo y tercer ejemplo más arriba) o puede ser un archivo XML externo (ubicado fuera del archivo PXF, como en el primer y cuarto ejemplo).
•El modificador --inputxml se ignora si el esquema fuente principal es de BD o BD-XML, pero debe estar presente por motivos sintácticos y será necesario algo como --inputxml=baseDedatos.
•Si la opción de formato de salida --html toma una ruta de acceso relativa, como en los ejemplos más arriba, entonces la ubicación del archivo de salida será relativa a la carpeta donde está guardado el archivo PXF.
Opciones
--xml, --inputxml = PathToXMLFile Esta opción es obligatoria. Indica la ruta de acceso del archivo XML que se quiere procesar. El archivo XML se puede encontrar dentro o fuera del archivo PXF. Para indicar archivos XML que estén dentro de un archivo PXF debe usar el localizador |zip (véase la parte resaltada en los ejemplos anteriores). La opción --inputxml se omite si la fuente principal del esquema del archivo PXF de entrada es una BD o BD-XML.
|
--dbw, --dbwhere = WHEREClause Una cláusula SQL WHERE que determina qué filas de una fuente BD-XML se deben procesar.
|
--p, --param = $ParamName:ParamValue Asigna un valor a un parámetro definido en el archivo PXF. El conmutador --param se debe usar antes de cada parámetro. Si NombreParám o ValorParám contiene un espacio, utilice comillas. Ejemplo: --p=$company:"Nanonull Inc"
|
--prohibit-output-outside-target-folder = true|false Los valores son true|false. Si su valor es true, no permite crear documentos de salida en ninguna otra carpeta que no sea la carpeta donde se crea el archivo de salida principal (HTML, PDF, RTF, DOCX, FO). De esta forma se pueden proteger otras carpetas si hace falta. El valor predeterminado es false.
|
--html, --outhtml = FilePath La ruta de acceso al archivo HTML que se quiere generar.
|
--pdf, --outpdf = FilePath La ruta de acceso al archivo PDF que se quiere generar.
|
--rtf, --outrtf = FilePath La ruta de acceso al archivo RTF que se quiere generar.
|
--docx, --outdocx = FilePath La ruta de acceso al archivo DOCX que se quiere generar.
|
--text, --outtext = FilePath La ruta de acceso al archivo de texto que se quiere generar.
|
--fo, --outfo = FilePath La ruta de acceso al archivo FO que se quiere generar.
|
--generate-html-output-as-mime = true|false Los valores son true|false. Si no se indica esta opción, el valor predeterminado es false. Si se indica pero no se le asigna ningún valor, entonces se lee como true. Si su valor es true, entonces el resultado HTML se genera como una cadena de texto tipo MIME.
|
--altova-fopserver-pid-file = PathToFile La ruta de acceso al archivo PID que se usa para conectarse a un AltovaFOPServer en ejecución. Puede conectarse a un AltovaFOPDServer a través del archivo PID del servidor o de un puerto. Es decir que puede usar esta opción de PID como alternativa a usar un puerto (véase la siguiente opción). Para obtener más información sobre cómo usar AltovaFOPServer, consulte la descripción general del comando generate más arriba.
|
--altova-fopserver-port = Value Un número de puerto o una lista de números de puerto que se usan para conectarse a un AltovaFOPServer en ejecución. Los números de puerto de una lista se separan por comas. En lugar de un único número en la lista, también puede utilizar un rango de números. Por tanto, puede introducir 9090-9100,9999 como valor de esta opción. Recuerde que puede conectarse a un AltovaFOPDServer a través del archivo PID del servidor AltovaFOPServer o de un puerto. Es decir que puede usar esta opción de puerto como alternativa a usar un archivo PID (véase la opción anterior). Para obtener más información sobre cómo usar AltovaFOPServer, consulte la descripción general del comando generate más arriba.
|
--taxonomy-package = FilePath La ruta de acceso a otro paquete de taxonomía. Agregue esta opción varias veces para indicar más de un paquete de taxonomía.
|
--taxonomy-packages-config-file = FilePath La ruta de acceso al archivo TaxonomyPackagesConfig.json, que es un archivo común que usan los productos de Altova XMLSpy, MapForce y StyleVision para configurar taxonomías XBRL que se usan en todos estos productos.
|
--v, --verbose = true|false Los valores son true|false. Activa o desactiva todos los mensajes que aparecen. Si no incluye esta opción, el valor predeterminado es false. Si incluye la opción pero no indica ningún valor, entonces se usa true.
|
--l, --lang = en|de|es|fr|ja El idioma utilizado para la presentación de 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.