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 [additional options] 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, ProgramData\Altova\SharedBetweenVersions; en sistemas Linux y macOS, en una carpeta bajo la carpeta StyleVisionServer2023. Para poder usar Apache FO necesita tener instalado Java Runtime Environment 1.8 o posterior 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). Para más información sobre cómo configurar FOP consulte el apartado Requisitos para FOP. |
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
•Los comandos anteriores contienen la opción obligatoria --inputxml, el argumento --inputxml (Test.pxf) y al menos una opción de creación de resultado (--html en todos los ejemplos anteriores).
•El archivo XML que se debe usar se encuentra dentro del archivo PXF (véanse el segundo y el tercer ejemplo) o puede ser un archivo XML externo (ubicado fuera del archivo PXF; véanse los ejemplos primero y cuarto).
•El conmutador --inputxml se ignora si la fuente principal del esquema es BD o XML-DB, pero sigue teniendo que estar presente por razones de sintaxis; debe usar algo parecido a: --inputxml=database.
•Si la opción de creación de resultado --html toma una ruta relativa, como en los ejemplos anteriores, entonces la ubicación del archivo de salida será relativa a la carpeta en la que se encuentra el archivo PXF.
Opciones
--xml, --inputxml = PathToXMLFile Esta opción es obligatoria e 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 se ignora si la fuente principal del esquema del archivo PXF de entrada es una DB o DB-XML. |
--dbw, --dbwhere = WHEREClause Una cláusula SQL WHERE que determina qué filas de una fuente DB-XML de 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. Use comillas si ParamName o ParamValue contienen algún espacio. Ejemplo: --p=\$company:"Nanonull Inc"
|
--prohibit-output-outside-target-folder = true|false Usa los valores true|false. Con true no permite crear resultados en ninguna carpeta que no sea aquella en la que se crea el archivo principal de salida (HTML, PDF, RTF, DOCX). De esta forma se pueden proteger otras carpetas si hace falta. El valor predeterminado es false.
|
--html, --outhtml = FilePath La ruta de acceso del archivo HTML.
|
--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 Usa los valores 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 es true, entonces los resultados HTML se generan como una secuencia mime.
|
--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 Usa los valores true|false. Activa o desactiva todos los mensajes que aparecen. El valor predeterminado es false si no se indica esta opción y true si se indica pero no se se asigna ningún valor.
|
--l, --lang = en|de|es|fr|ja El idioma que se usa para mostrar 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 está usando el método de catalogación de Altova, puede encontrar los archivos de catálogo relevantes en la carpeta etc de la carpeta de la aplicación StyleVision Server. Para más información consulte la sección Catálogos del manual de Altova StyleVision.