{"id":1913,"date":"2017-07-25T08:55:58","date_gmt":"2017-07-25T07:55:58","guid":{"rendered":"https:\/\/www.threesl.com\/blog\/?p=1913"},"modified":"2022-08-23T15:32:01","modified_gmt":"2022-08-23T14:32:01","slug":"exporting-using-c_io-exe-in-a-batch-file","status":"publish","type":"post","link":"https:\/\/www.threesl.com\/blog\/exporting-using-c_io-exe-in-a-batch-file\/","title":{"rendered":"Exporting using c_io.exe in a Batch File"},"content":{"rendered":"

All Exporting Options for c_io.exe<\/h2>\n

Exporting either a whole project or just a query can take a long time if the database is huge. The quickest and easiest way to do this is use c_io.exe<\/em> in a batch file during down time e.g. night<\/p>\n

The options available are:<\/p>\n

\"Export
Export Options for c_io.exe<\/figcaption><\/figure>\n

Required Export Options<\/h2>\n

So the first option is, of course, the export<\/em> option that needs the user to specify a location and a name for the exporting file:<\/p>\n

-export<\/strong> \u201cC:\\Temp\\export1.exp\u201d<\/p>\n

The Type Options<\/h3>\n

The -type<\/strong> option is required for the export option and allows users to define the type of export they require:<\/p>\n

params<\/strong> will export only this projects parameters (Project Schema)
\n all<\/strong> will export all items and definition files the user has access to
\npdb<\/strong> will export all items the user has access to but not definition files
\n query<\/strong> export items matching a named query.<\/p>\n

\n

Options used with query<\/h4>\n

-query<\/strong> will specify the query to be used. This is required if the type is set to query
\n-qloc<\/strong> will specify the location of the query. This is required if the -query<\/strong> option is used.<\/p>\n<\/div>\n

expformat<\/strong> is for exporting all files set in a saved format.<\/p>\n

\n

Options used with expformat<\/h4>\n

-expname<\/strong> is the Export Formats name.
\n-exploc<\/strong> is used in conjunction with -expname<\/strong> to state the location of the export format
\n-identity<\/strong> can be used with -expname <\/strong>and will override the Identity set in a query.<\/p>\n<\/div>\n

\"Export
Export UI Identity<\/figcaption><\/figure>\n
\"Query
Query UI Identity<\/figcaption><\/figure>\n

basesum<\/strong> requires the user to use -basename<\/em> with the Baseline Name and -sumformat<\/em> which allows the user to specify how the data is output either as CSV or standard (Note: the user must have the PROJECT_RO <\/strong>privilege for this option)<\/p>\n

\n

Options used with basesum<\/h4>\n

-basename<\/strong> needs to have a Baseline name currently either open or closed.
\n– sumformat<\/strong> allows the user to state they format -basesum<\/strong> is output as CSV or standard.<\/p>\n

The standard output is <BASEHIST><\/a> records in the normal format:
\n<\/strong><\/p>\n

<BASEHIST>\r\n <BH_BNAME> = BASE1\r\n <BH_DOMID> =\r\n <BH_NMSPC> = NMSPACE_START\r\n MH_IGNOREMODEL\r\n NMSPACE_END\r\n <BH_INFTP> = INFO_REQUIREMENT\r\n <BH_INFST> = NULL_INFOSUB\r\n <BH_STERT> =\r\n <BH_TTYPE> =\r\n <BH_INFRF> = REQ-1\r\n <BH_VERSN> = 01\r\n <BH_STATU> = B<\/pre>\n
\"<BASEHIST>
The CSV output will set the fields from left to right and output the items below this line:<\/figcaption><\/figure>\n<\/div>\n
Elective Export Options<\/strong><\/h2>\n
Other export options are not required but can be used with –type<\/strong> all and -type<\/strong> pdb:
\n– since<\/strong> can be used to state a date or date and time since which items were created or modified. The format for this is yyyymmdd or yyyymmddThhmmss so 20170119 (19\/01\/2017). For example 20170119T183030 (19\/01\/2017 18:30:30)<\/p>\n
-until<\/strong> will only export items that have been modified up to a certain date or date and time or a time after the -since<\/strong> was set. The format for this is the same as -since<\/strong>.<\/p>\n
-delete_state<\/strong> allows the user to specify if they want the items being exported to be (Same as in the Export UI):<\/p>\n
normal<\/strong> – Not marked as delete
\nrecoverable<\/strong> – Items marked as deleted but can be recovered
\nall<\/strong> – All items not matter what they are marked as will be exported<\/p>\n
\"Delete
The Delete state in the Export UI in WorkBench.<\/figcaption><\/figure>\n<\/div>\n
-scope<\/strong> controls how an item is output either on its own or with all the items cross referencs. Using item<\/strong> will make sure only the item on its own is output. Using item_xref<\/strong> will output the item and any items cross referenced to it.<\/p>\n
-binarytodir<\/strong> sets a folder for the binary data. So a user would use -binary \u201cC:\\Temp\\binary\u201d<\/em> and all binary data would be output to unique files and the path to this file would be output in the export file next to the binary frame:<\/p>\n
<FR_FNAME> = PICTURE\r\n <FR_VERSN> = 0\r\n <FR_FTEXT> = C:\\Temp\\binary\\binary_frame0.dat<\/pre>\n
-sanitise<\/strong> will output items but without any binary frames. It will also change all text including item names, comments descriptions, text frames, change history, diagram symbols, discussions and user defined cross reference attributes.<\/p>\n
c_io.exe Batch File Exporting Examples<\/h2>\n
Exporting Project Schema using -type params<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\params1.exp\" -type params<\/pre>\n
Using -type all<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\all1.exp\" -type all<\/pre>\n
Using -type all and -since<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\all2.exp\" -type all -since 20150724 -until 20150818<\/pre>\n
Using -type all with sanitising<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\all3.exp\" -type all -sanitise<\/pre>\n
Using -type pdb<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\pdb1.exp\" -type pdb<\/pre>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\pdb2.exp\" -type pdb -scope item<\/pre>\n
Using -type query<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\query1.exp\" -type query -query \"Accepted Items\" -qloc project<\/pre>\n
Using -type expformat<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login manager,MANAGER,demo -export \"C:\\Temp\\exportformats1.exp\" -type expformat -expname all_since_until -exploc project -identity REQ-20<\/pre>\n
Using -type basename<\/h3>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\baseline1.exp\" -type basesum -basename alpha -sumformat standard<\/pre>\n
Helpful other c_io options<\/h2>\n
There are several helpful options especially when using in a batch file.<\/p>\n
-log<\/strong> allows a user to specify a name for a log. This is the log that will have the details of the actions performed during the\u00a0 import.<\/p>\n
-noldap<\/strong> allows users to bypass using LDAP when running a command line or batch file.
\n-errorstack<\/strong> option is for logging any issues with the import<\/p>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\all3.exp\" -type all -noldap -errorstack -log \"C:\\Temp\\all4_log.log\"<\/pre>\n
\"%CRADLEHOME%\\bin\\exe\\windows\\c_io.exe\" -login admin,ADMIN,demo -export \"C:\\Temp\\pdb3.exp\" -type pdb -noldap -errorstack -log \"C:\\Temp\\pdb3_log.log\"<\/pre>\n
Options not used within a batch file<\/h2>\n
A few of the options not used in a batch file but are in a command prompt. These are pop ups with information on them which why they are not in a batch file.<\/p>\n
-verbose<\/strong> lets the user know that c_io.exe has finished
\n-ver<\/strong> lets the user see what the version number, date and time of the build they are using.
\n-help<\/strong> is used to see all the command line options.<\/p>\n
Related Posts<\/h6>\n
Read Publishing a Formal Document Using a Batch File<\/a> article for information of formal documentation.<\/p>\n
Importing<\/a> using c_io,\u00a0 and exporting a single frame<\/a> is also possible.<\/p>\n
 <\/p>\n
 <\/p>\n