{"id":1798,"date":"2017-06-12T10:23:46","date_gmt":"2017-06-12T09:23:46","guid":{"rendered":"https:\/\/www.threesl.com\/blog\/?p=1798"},"modified":"2022-12-07T13:23:37","modified_gmt":"2022-12-07T13:23:37","slug":"publish-formal-document-using-batch-file","status":"publish","type":"post","link":"https:\/\/www.threesl.com\/blog\/publish-formal-document-using-batch-file\/","title":{"rendered":"Publish a Formal Document Using a Batch File"},"content":{"rendered":"

Running Document Publisher in the Background<\/h2>\n

Publishing a Draft<\/em> or Formal Document<\/em> can take time. If you need to use Microsoft\u00ae Word<\/em> for other work, is a nuisance when having to wait.<\/p>\n

Users can run a batch file to create the documents either as a Draft<\/em> and\/or as a Formal document<\/em>. The batch file can be used in a task<\/em> <\/a>while the user is not using their computer; for example at night or a weekend if many documents are being generated.<\/p>\n

The command line needs to have all the options set the same as they would\u00a0 be through the UI (User Interface):<\/p>\n

\"Publish
Publish Formal Document User Interface<\/figcaption><\/figure>\n

Formal Document Command line Options<\/h2>\n

The normal batch file command line options for just a draft document are:<\/p>\n

\"Draft
Command Line Draft Options<\/figcaption><\/figure>\n

Each of the following shows what the command line options for each Formal option in the User Interface:<\/p>\n

\"Formal
Formal Options needed in a batch file<\/figcaption><\/figure>\n

All the above -fdoc<\/samp> options are requirements within the command line except -newversion<\/samp>. Only use the -newversion<\/samp> option, if a new version of the document is required.<\/p>\n

The final command line to generate the DEMO Template will look like this: (NOTE: Options with more than a single word are required to be in quotes e.g. -fdoccomment<\/samp> “Published DEMO Template Using Batch File”)<\/em><\/em><\/em><\/p>\n

\"%CRADLEHOME%\\bin\\exe\\windows\\DocPub.exe\" -login MANAGER,MANAGER,demo -file \"DEMO Template\" -location PROJECT -type DOCX -output \"C:\\Temp\\DEMO Template.doc\" -formal -fdocname \"DEMO Template\" -fdoctype REQUIREMENTS -fdoctitle \"DEMO Template\" -fdocissue 1 -fdocdate Jun -fdocref DEMO1 -fdocclass UNCLASSIFIED -fdoccomment \"Published DEMO Template Using Batch File\" \u2013log<\/pre>\n
Any template that generates through Document Publisher can generate through a batch file.<\/p>\n
As you can see in the command window below, 3 templates are being generated, a doc<\/em>, a docx<\/em> and a docm<\/em>.<\/p>\n
\"Command
Command Window showing 3 types of document being generated<\/figcaption><\/figure>\n
Once the documents are generated, they can be seen in WorkBench<\/em> in the Project sidebar<\/em> under the Formal Document<\/em> sections:<\/p>\n
\"Project
Project sidebar – Formal Documents sections showing the 3 generated documents<\/figcaption><\/figure>\n
Using parameters within a batch file<\/h2>\n
The great thing about using a command line batch file is that parameters<\/a> can be set, as long as the template has parameters setup. This means you can run the same document many times but use different parameters for each run with a different document output name. For example if you used ?reqID<\/samp> within the Key<\/em> or Identity<\/em> you could output different Requirement Documents<\/em>.<\/p>\n