generate
Syntaxe et description
La commande generate (la forme abrégée est gen) génère un ou plusieurs fichiers de sortie (HTML, PDF, RTF, et/ou DOCX) en transformant le fichier d'entrée XML à l'aide du document XSLT contenu dans le fichier d'entrée PXF
stylevisionserver generate | gen --inputxml=Filename [additional options] InputPXF |
•L'option --inputxml est obligatoire ; elle indique le chemin vers le fichier XML.
•L'argument InputPXF spécifie le chemin vers le fichier PXF qui contient le document XSLT qui sera utilisé pour générer les documents de sortie. Les fichiers PXF sont créés avec l'application Altova StyleVision.
•Chaque format de sortie est généré en spécifiant une option pour cette sortie (voir la liste d'Options ci-dessous). La valeur de chaque option est un chemin qui spécifie l'endroit où la sortie sera générée.
| Note : | StyleVision Server utilise Apache FOP, le processeur FO du Projet Apache, pour générer des fichiers PDF depuis FO. Apache FOP est installé avec StyleVision Server à l'emplacement suivant : sur les systèmes Windows, ProgramData\Altova\SharedBetweenVersions; sur les systèmes Linux et macOS, dans un fichier descendant du dossier StyleVisionServer2024. Veuillez noter que Apache FOP nécessite Java Runtime Environment 1.6 ou plus à installer sur l'appareil StyleVision Server. En ce qui concerne StyleVision Server 32-bit, installer Java 32-bit ; pour StyleVision Server 64-bit, installer Java 64-bit. Pour plus d'information sur la configuration de FOP, voir le chapitre Exigences FOP. |
Si vous allez exécuter de multiples transformations au PDF, en particulier des documents volumineux, vous allez vouloir utiliser le AltovaFOPServer pour exécuter des tâches plus rapidement. L'accéleration des tâches apparaît car AltovaFOPServer maintient les fichiers Java VM et FOP chargés, économise donc du temps pour charger ces fichiers pour chaque transformation. AltovaFOPServer sera installé avec votre pack de StyleVision. Afin de pouvoir l'utiliser pour des transformations, vous devez d'abord démarrer AltovaFOPServer via la ligne de commande.
Start AltovaFOPServer La syntaxe de la commande pour démarrer AltovaFOPServer est :
java -cp "{classPath}" {className} --pid "{pidFile} --port {portNumbers}
Un exemple de commande CLI pour démarrer AltovaFOPServer :
java -cp "C:\Program Files\Altova\Common2024\jar\gson\gson.jar;C:\Program Files\Altova\Common2024\jar\AltovaFOPServer.jar" com.altova.stylevision.fopserver.Main --pid "C:\Users\user\AppData\Local\Temp\AltovaFopServer.pid" --port 9090-9103,9999
L'argument classPath doit contenir des chemins dans les fichiers gson.jar et AltovaFOPServer.jar files. Saisissez les emplacements corrects de ces fichiers.
Appel AltovaFOPServer dans StyleVision Server Une fois que AltovaFOPServer a été démarré, vous pouvez l'appeler depuis StyleVision Server en utilisant la commande generate avec soit l'option altova-fopserver-pid-file ou altova-fopserver-port (voir Options ci-dessous).
|
StyleVisionServer sur Windows stylevisionserver sur Windows et Unix (Linux, Mac)
* Veuillez noter que la casse minuscule (stylevisionserver) fonctionne sur toutes les plate-formes (Windows, Linux et Mac), alors que la casse majuscule (StyleVisionServer) fonctionne uniquement sur Windows et Mac. * Utiliser des barres obliques basculée vers l'avant sur Linux et Mac, des barres obliques basculées vers l'arrière sur Windows.
|
Dans les systèmes Windows : lorsque des espaces se produisent (par exemple, dans les noms de fichier ou de dossier, ou les noms d'entreprise, de personne ou de produit), utiliser des guillemets : par exemple, "My File". Veuillez noter, néanmoins qu'une barre oblique inversée suivie par un double guillemet (par exemple, "C:\My directory\") peut ne pas être lue correctement. Cela est dû au fait que le caractère de barre oblique inversée est également utilisé pour indiquer le début d'une séquence d'échappement, et la séquence d'échappement \" représente le caractère de marque de double guillemet. Si vous souhaitez échapper cette séquence des caractères, utiliser une barre oblique inversée précédente comme ceci : \\". Pour résumer : Si vous souhaitez écrire un chemin de fichier qui contient des espaces et des barre oblique inversée de fin, l'écrire comme ceci : "C:\My Directory\\".
|
Exemples
Des exemples de la commande 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
•La commande ci-dessus contient l'option --inputxml obligatoire, l'argument InputPXF (Test.pxf) et un minimum d'une option output-creation (--html dans tous les exemples ci-dessus).
•Le fichier XML d'entrée à utiliser peut être situé dans le fichier PXF (voir le deuxième et troisième exemple ci-dessus) ou il peut être un fichier XML externe (situé en-dehors du fichier PXF ; voir le troisième et quatrième exemple ci-dessus).
•L'interrupteur --inputxml reste ignoré si la source de schéma principale est BD ou BD-XML, mais il doit y figurer pour des raisons de syntaxe et vous devriez utiliser quelque chose du genre --inputxml=database.
•Si l'option output-creation --html prend un chemin relatif, comme illustré dans l'exemple ci-dessus, l'emplacement du fichier de sortie sera relatif par rapport au dossier dans lequel le fichier PXF se trouve.
Options
--xml, --inputxml = PathToXMLFile Cette option est obligatoire. Elle spécifie le chemin vers le fichier XML à traiter. Le fichier XML peut être situé à l'intérieur ou à l'extérieur du fichier PXF. Pour cibler des fichiers XML dans un fichier PXF, utiliser le |zip locator (voir les parties marquées dans les exemples ci-dessous). L'option --inputxml est ignorée si la source de schéma principale est DB ou DB-XML.
|
--dbw, --dbwhere = WHEREClause Une clause WHERE qui détermine quelles lignes d'une source DB-XML doivent être traitées.
|
--p, --param = $ParamName:ParamValue Attribue une valeur au paramètre défini dans le fichier PXF. L'interrupteur --param doit être utilisé avant chaque paramètre. Utiliser des guillemets si ParamName ou ParamValue contient un espace. Par exemple : --p=$company:"Nanonull Inc"
|
--prohibit-output-outside-target-folder = true|false Les valeurs sont true|false. Si true, ne permet pas la création d'une sortie dans un autre fichier que celui dans lequel le fichier de sortie principal (HTML, PDF, RTF, DOCX, FO) est créé. Cela permet de protéger les autres dossiers, le cas échéant. Le réglage par défaut est false.
|
--html, --outhtml = FilePath Le chemin vers le fichier HTML à générer.
|
--pdf, --outpdf = FilePath Le chemin vers le fichier PDF à générer.
|
--rtf, --outrtf = FilePath Le chemin vers le fichier RTF à générer.
|
--docx, --outdocx = FilePath Le chemin vers le fichier DOCX à générer.
|
--text, --outtext = FilePath Chemin vers le fichier texte à générer.
|
--fo, --outfo = FilePath Le chemin vers le fichier FO à générer.
|
--generate-html-output-as-mime = true|false Les valeurs sont true|false. Si l'option n'est pas spécifiée, le réglage par défaut est false. Si l'option est spécifiée sans valeur, le réglage par défaut est true. Si true, la sortie HTML est générée en tant que mime stream.
|
--altova-fopserver-pid-file = PathToFile Le chemin vers le fichier PID à utiliser pour se connecter à un AltovaFOPServer. Vous pouvez vous connecter à AltovaFOPServer soit apr le biais du fichier PID du serveur, soit par un port. L'option PID est une alternative au port de l'option (voir prochaine option). Pour plus d'information comment utiliser AltovaFOPServer, voir la desciption générale de la commande generate ci-dessus.
|
--altova-fopserver-port = Value Un numéro de port est une liste de numéros de ports à utiliser pour se connecter au AltovaFOPServer exécuté. Le numéro de port dans une liste est séparée par des virgules. À la place d'un seul numéro dans la liste, vous pouvez en utiliser une variété. Donc vous pouvez soumettre 9090-9100,9999 comme valeur de cette option. Notez que vous pouvez vous connecter au AltovaFOPServer soit par le biais du fichier PID du AltovaFOPServer, soit d'un port. L'option du port est une alternative à l'option PID (voir l'option précédente). Pour plus d'information comment utiliser AltovaFOPServer, voir la description générale de la commande generate ci-dessus.
|
--taxonomy-package = FilePath Le chemin vers un pack de taxonomie supplémentaire. Ajouter l'option de multiples fois pour spécifier plus d'un pack de taxonomie.
|
--taxonomy-packages-config-file = FilePath Le chemin vers le fichier TaxonomyPackagesConfig.json, qui est un fichier commun utilisé par les produits d'Altova XMLSpy, MapForce et StyleVision pour configurer les taxonomies XBRL à utiliser parmi ces produits.
|
--v, --verbose = true|false Les valeurs sont true|false. L'affichage de tous les messages peut être allumé ou éteint, respectivement. Le réglage par défaut est false si l'option n'est pas fournie ou true si l'option est fournie sans valeur.
|
--l, --lang = en|de|es|fr|ja La langue utilisée pour afficher les messages .
|
Utiliser l'option --h, --help pour afficher des informations à propos de la commande.
Les options sont recensées dans la forme abrégée (si disponible) et dans la forme longue. Vous pouvez utiliser un ou deux tirets pour les formes abrégées et longues. Une option peut ou ne peut pas prendre une valeur. Si elle prend une valeur, elle est écrite comme ceci : --option=value. Des valeurs peuvent être spécifiées sans guillemets sauf dans deux cas : (i) si le string valeur contient des espace, ou (ii) s'il est explicitement indiqué dans la description que des guillemets sont exigés. Si une option prend une valeur booléenne et qu'aucune valeur n'est spécifiée, alors la valeur par défaut de l'option est TRUE. Utiliser l'option --h, --help pour afficher des informations à propos de la commande.
Catalogs
Si vous utilisez le mécanisme de catalogue d’Altova, vous pouvez trouver les fichiers de catalogue pertinents dans le dossier etc du dossier d’application StyleVision Server. Pour des informations détaillées, voir la section Catalogues du manuel de StyleVision d’Altova.
Vous pouvez créer CustomCatalog.xml depuis le fichier modèle CustomCatalog_template.xml. Assurez-vous de renommer le modèle de fichier en CustomCatalog.xml étant donné que ce dernier fichier sera le fichier utilisé dans le mécanisme de catalogue (pas le modèle de fichier).
Veuillez noter les points suivants :
•Lors d’une nouvelle installation de la même version majeure (mêmes versions ou différentes versions mineures), le modèle de fichier sera remplacé par un nouveau modèle de fichier, mais CustomCatalog.xml ne sera pas touché.
•Toutefois, si vous installez une nouvelle version majeure au-dessus de la version majeure précédente, alors le dossier de la version majeure précédente sera supprimé - ensemble avec son CustomCatalog.xml. Donc, si vous voulez continuer à utiliser CustomCatalog.xml, assurez-vous d’enregistrer CustomCatalog.xml depuis le dossier de la version majeure à un endroit sûr. Une fois que la nouvelle version majeure a été installée, vous pouvez copier CustomCatalog.xml que vous avez enregistré dans le dossier etc de la nouvelle version majeure et l’éditer là tel que requis.