Exporting a Single Item Frame using ‘getframe’ with c_io

Exporting

A user can export a single item’s text or binary frame and place it in a file using getframe. A batch file is great for this as a user can use copy and paste the same command line numerous times,  replacing the identity for each line. Then when run, all the frames will be quickly exported.

The start of this command line is the same as for all main options, using the path and login details.

The -getframe options are as follows:

Options for getframe in c_io.exe
The options for getframe in c_io.exe

-getframe option sets the frame name to be output for the first item that matches the query or identity (if used).

-file sets the name and location of the file to be output

-query option sets the query to be used

-qloc sets the location of the -query option

-identity over rides any set within the used query

c_io.exe Batch File GetFrame Examples

"%CRADLEHOME%\bin\exe\windows\c_io.exe" -login admin,ADMIN,demo -getframe NOTES -file "C:\Temp\notes.txt" -query "Req - All" -qloc automatic

Using -identity

"%CRADLEHOME%\bin\exe\windows\c_io.exe" -login admin,ADMIN,demo -getframe TEXT -file "C:\Temp\REQ-2_TEXT.txt" -query "Req - All" -qloc automatic  -identity "REQ-2"

"%CRADLEHOME%\bin\exe\windows\c_io.exe" -login admin,ADMIN,demo -getframe PICTURE -file "C:\Temp\REQ-9_PIC.jpg" -query "Req - All" -qloc automatic  -identity "REQ-9"

Helpful other c_io options

There are several helpful options especially when using in a batch file.

-log 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  import.

-noldap allows users to bypass using LDAP when running a command line or batch file.
-errorstack option is for logging any issues with the import

"%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"

"%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" -verbose

Options not used within a batch file

There are a couple of options that are not used in a batch file. The reason is that they are only useful in a command line, in a command prompt as they show pop ups with information on them.

-ver lets the user see what the version number, date and time of the build they are using.
-help option allows a user to see the command line options.

Links to Other Batch File Options

Read Publishing a Formal Document Using a Batch File article for information of formal documentation.

Details of importing can be read in Importing Using c_io in a Batch File

See the how to use c_io ‘automatically’

How to Use c_io.exe in a Batch File

 

Printing Diagrams using printdiag with c_io.exe

Printing many individual diagrams through WorkBench can be slow and time consuming. Using the option -printdiag in c_io.exe, a user can then print many diagrams at once. Once the first command line has been set up, it can be copied, pasted. The file name and the identity can be altered for each diagram that the user requires printing.

The options to do this are:

printdiag options in c_io.exe
The printdiag options in c_io.exe

Required Options

-printdiag allows a user to set the type of output for the diagram. The types currently used for this are:

  • hpgl – Hewlett-Packard Graphics Language
  • ps – PostScript
  • rtf – Rich Text Format
  • svg – Scalable Vector Graphics

Elective Options

-onlydiag will output the diagram without a surrounding frame and the details which the frame contains.

-catcode will print the category value in the diagrams border.

-portrait will cause the diagrams to be output into a portrait orientation rather than the default of landscape. This option is only used in conjunction with -printdiag, it will not work with any other c_io.exe options.

-file sets the name and location of the file to be output.

-query set the query to being used and as before -qloc sets the location

-identity overrides any identity set within the used query

-printdiag Batch File Examples

"%CRADLEHOME%\bin\exe\windows\c_io.exe" -login admin,ADMIN,demo -printdiag svg -file "C:\Temp\DFD_C.svg" -query "Diagram - Ess DFD" -qloc project  -identity "C"

"%CRADLEHOME%\bin\exe\windows\c_io.exe" -login admin,ADMIN,demo -printdiag rtf -file "C:\Temp\eFFBD_133.rtf" -query "Diagram - Ess eFFBD" -qloc project -portrait -identity "1.3.3" -onlydiag

Helpful other c_io options

There are several helpful options especially when using in a batch file.

-log 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 import.

-noldap allows users to bypass using LDAP when running a command line or batch file.
-errorstack option is for logging any issues with the import

"%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"
"%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"

Options not used within a batch file

There are a couple of options that are not used in a batch file. The reason is that they are only useful in a command line, in a command prompt as they show pop ups with information on them.

-ver lets the user see what the version number, date and time of the build they are using.
-help option allows a user to see the command line options.

Related Posts

Read Exporting using c_io in a batch file article for information on how to create data transfer files from Cradle.
See the how to use c_io ‘automatically’

How to Use c_io.exe in a Batch File

Create a Document Output

Produce Documents From Your Cradle Data

Produce documents from your Cradle data, launched straight from WorkBench.

Document Publisher is an automated document output tool that interacts with Microsoft® Word. It is used to produce professional high-quality reports from the information held in a Cradle project database (PDB).

Document Publisher works by combining a user-defined template with information held in your project to generate dynamic content including, hierarchical headings, paragraphs of body text, tables, diagrams, figures and embedded data.

Full control is provided for paragraph styles, section numbering and captions.

Powerful data filters and parametrics can be defined to supplement database querying. Conditions under which particular attributes are to appear in the output can also be specified.

Document Publisher can be launched directly from start menu, or from within Cradle WorkBench.

Whist the video above shows a draft document being produced, formal document versions can be produced as described in How to publish formal project documents.