HELP CONVERT — MicroVMS 4.6
Copies the records of one file to another file, changing the organization and format of the input file, if necessary, to conform to that of the output file; can be invoked interactively. Does not translate carriage control information. You can also use CONVERT to reformat a relative or indexed file by specifying the input and output files as the same file. Note that when reformatting a relative or indexed file, CONVERT establishes new record's file addresses (RFAs), and eliminates deleted records and empty record cells. Format CONVERT input-file-spec[,...] output-file-spec Requires the Program Development Tools Option.
Additional information available:
/SPREADSHEET/STATISTICS/RECLAIM
Parameters
input-file-spec Specification of the file(s)to be converted. You may specify up to 10 input files; wildcard characters are not allowed. Multiple input files are concatenated into a single output file. output-file-spec Specification of the file to which the converted records are to be written. The output file can be an existing file; if it already contains records, the converted records can be added to the end sequentially, or the records can be merged into their proper sequential order in an indexed file. The file type of the output file defaults to that of the first input file. Wildcard characters are not allowed.
Qualifiers
Additional information available:
/APPEND/CREATE/EXCEPTIONS_FILE/EXIT/FAST_LOAD
/FDL/FILL_BUCKETS/FIXED_CONTROL/KEY/MERGE
/PAD/PROLOG/READ_CHECK/SHARE/SORT
/APPEND
/NOAPPEND (default) Appends the output records to an existing sequential file. This qualifier is ignored if the output file's organization is relative or indexed. /APPEND overrides /CREATE.
/CREATE (default)
/NOCREATE Creates an output file. If the output file is to have different characteristics from those of the input file, specify the /FDL qualifier.
/EXCEPTIONS_FILE[=file-spec]
/NOEXCEPTIONS_FILE (default) Generates a sequential file that contains a copy of any input records that cause exceptions and are, therefore, not written to the output file. File type defaults to EXC. If no file is specified, the exception records are written to SYS$OUTPUT.
/EXIT
/NOEXIT (default) Terminates the conversion if an exception record is encountered.
/FAST_LOAD (default)
/NOFAST_LOAD Uses a fast-loading algorithm for index files. /FAST_LOAD sorts both the primary and the secondary keys and, therefore, requires a larger amount of space for work files. /NOFAST_LOAD sorts only the primary keys.
/FDL=file-spec
Specifies the FDL (File Definition Language) file to be used in creating the output file. The default file type for the FDL file is FDL; the output file's specification overrides the FDL file specification.
/FILL_BUCKETS
/NOFILL_BUCKETS (default) Overrides the bucket fill percentage parameter associated with the output file, filling the buckets with as many records as possible. This qualifier is only valid for indexed output files.
/FIXED_CONTROL
/NOFIXED_CONTROL (default)
Controls the behavior of CONVERT in conversions between VFC (VARIABLE
with FIXED CONTROL) records and other type records (FIXED or VARIABLE).
Not applicable to indexed files.
o If you specify /FIXED_CONTROL for VFC input records, the fixed
control portion of the record will be written as the first part
of the output record.
o If you specify /NOFIXED_CONTROL with VFC input records, the
fixed portion of the record is not copied to the output record.
o If you specify /FIXED_CONTROL for VFC output records, the fixed
control portion of the output record is taken from the first
part of the input record.
o If you specify /NOFIXED_CONTROL for VFC output records, the
fixed portion of the output record is set to 0.
Note that you must account for the size of the fixed control area
when calculating the maximum size of the output record.
/KEY[=n]
Specifies the key of reference by which records are accessed from an indexed file; valid only for indexed input files. If you specify an indexed output file, you must also specify /NOFAST and /NOSORT. The default is /KEY=0 (the primary key).
/MERGE
Specifies that records are to be inserted into their proper positions in an existing indexed file; valid only for existing indexed output files. /MERGE overrides /CREATE. Omit /MERGE when loading records into an empty indexed file or when creating a new indexed file.
/PAD[=[radix]character]
/NOPAD (default) Pads records that do not contain as many bytes as the record length for fixed-length record format with the specified character; valid only for fixed-length record formats. The character can be any ASCII character A through Z, a through z, or 0 through 9; the default is null. To specify a nonprintable ASCII character, you must specify a radix (%D for decimal, %O for octal, %X for hexadecimal) and a numeric character; do not specify a radix with a printable ASCII character. The default, /NOPAD, causes an exception when a short record is encountered.
/PROLOG=n
Specifies the prolog version number of the indexed output file. If you specify a value of 2, the output file will be either a prolog 1 or prolog 2 file. If you specify 3, CONVERT will attempt to create a Prolog 3 file for output. If the output file cannot fit the criteria for Prolog 3, you will receive a fatal error and the conversion will not occur. If you do not specify /PROLOG, CONVERT uses the VAX/VMS RMS default; specify the SHOW RMS_DEFAULT command to display the default. /PROLOG overrides the value specified as the FDL attribute KEY PROLOG.
/READ_CHECK
/NOREAD_CHECK (default) Reads each input record a second time and compares it to the original.
/SHARE
/NOSHARE (default) Opens the input file for sharing with other processes. (Because other processes can alter the records while CONVERT is operating, the consistency of the output data file cannot be guaranteed.)
/SORT
/NOSORT Sorts the input file before loading it into an indexed file; valid only with an indexed output file. The sort is performed on the primary key of the output file. The default is /SORT, unless you specified the same file for both input and output, in which case it is /NOSORT.
/SPREADSHEET
/SPREADSHEET
Invokes Xway, a program which translates data and models among many
popular spreadsheet programs. Xway also handles generic ASCII data
stored in tabular or field format, providing compatibility with
application programs and databases.
Xway is available as an interactive, menu-driven package with
extensive on-line, context-dependent help. Experienced users of the
interactive version can streamline operations with type-ahead. Xway
can be invoked on a DCL command line and also has a callable
interface.
This optional software product is available under separate license.
Format:
CONVERT/SPREADSHEET [input-file-spec] [output-file-spec]
For more information, invoke Xway and use the <HELP> key to see
Xway's on-line help, or refer to:
o VAX Xway User's Guide -- for information about running
Xway interactively.
o VAX Xway Programmer's Guide -- for information about
Xway's callable interface.
Additional information available:
FormatsCommand qualifiersParameter qualifiersOutput options
Release Notes
Formats
Xway exchanges information to and from the following formats:
DECalc command files
DECalc grids (binary)
Lotus 1-2-3 WKS (binary)
Lotus 1-2-3 WK1 (binary)
Lotus Symphony WRK (binary)
Multiplan SYLK
DIF (Data Interchange Format)
Generic ASCII tabular files
Generic ASCII field files
Model context information can be translated for model-to-model
exchanges.
Command qualifiers
Command qualifiers are used at DCL level and can appear anywhere on
the command line. Command qualifiers are optional.
Format:
$ CONVERT/SPREADSHEET [command_qualifiers]-
[input_filename] [parameter_qualifiers]-
[output_filename][parameter_qualifiers]
For more information, see the VAX Xway User's Guide.
/DEFINITION
/DEFINITION=filename
/NODEFINITION (default)
Allows you to restore a definition file containing Xway
parameters. This file can contain all information needed to
specify an exchange. Xway performs the exchange using the
information in the specified file instead of using information
entered at the terminal.
/INTERACTIVE
/INTERACTIVE (default)
/NOINTERACTIVE
Controls whether Xway invokes the menu interface. When in
INTERACTIVE mode, a Main Menu is displayed after you invoke Xway.
The /NOINTERACTIVE qualifier lets you use Xway without using the
menu interface; there is no user interaction. This qualifier is
useful when using Xway in a batch procedure or if you want to
suppress the menus.
When in /NOINTERACTIVE mode, you must supply all necessary
information on the command line for Xway to successfully perform
the exchange. You can specify a definition file which should
contain all the information Xway requires for the exchange.
/LOG
/LOG[=filename] (default)
/NOLOG
Indicates whether Xway displays status and error messages. You
can specify a file in which Xway records the log information. If
you do not specify a file with the /LOG qualifier, Xway displays
status and error messages on the terminal screen.
Additional information available:
Examples
1. $ CONVERT/SPREADSHEET/DEFINITION=WEEKLY_SPREADSHEET/NOINTERACTIVE
In this example, Xway uses the file, WEEKLY_SPREADSHEET.XWAY, as
the definition file. The definition file contains all the
information needed to perform the exchange. The /NOINTERACTIVE
qualifier suppresses the Xway menus and prompts.
2. $ CONVERT/SPREADSHEET/LOG=FOOBAR.LOG
In this example, all Xway status and error messages are recorded
in the file, FOOBAR.LOG.
Parameter qualifiers
Parameter qualifiers are used at DCL level and provide additional
information regarding the file immediately proceeding the qualifier.
Parameter qualifiers are optional.
Format:
$ CONVERT/SPREADSHEET [command_qualifiers]-
[input_filename] [parameter_qualifiers]-
[output_filename][parameter_qualifiers]
/DATE_EDIT_STRING
/DATE_EDIT_STRING="date edit string"
Specifies the format for the date in input or output files. Valid
characters for the date edit string are:
D represents a digit of the day of the month, 1 through 31
M represents a letter in the name of the month
N represents a digit in the number of the month, 1 through 12
Y represents a digit in the year
J represents a digit of the day in a year, 1 through 365
W represents a letter in the day of the week
B represents a blank (a space)
/ represents a slash
- represents a hyphen
. represents a period
(n) repeats the previous date edit string character 'n' times.
The 'n' must be a positive integer and cannot appear at the
beginning of the date edit string. If the value of 'n' is
zero (0), the previous character in the string is ignored.
/DISCARD
/DISCARD
/NODISCARD (default)
Specifies whether Xway should keep model context information (for
example, formatting and formulas). Using the /DISCARD qualifier
causes Xway to discard model formats and to produce a file
containing only data.
Since Xway translates information that cannot be exchanged
(formulas for which no equivalent exists in the target
spreadsheet) as labels, you may want to use the /DISCARD qualifier
to translate calculated data as constants during an exchange,
rather than labels.
/FORMAT
/FORMAT=type
Specifies the type of file Xway is processing. Input and output
filenames require a format specification. The format can be the
same for both files.
The types are as follows:
DECALC[=(option,...)]
LOTUS[=option]
DIF Data Interchange Format file
SYLK SYmbolic LinK file
FIELD ASCII field file
TABULAR ASCII tabular file
Use one of the following options for DECalc type files:
V22 DECalc V2.2 files
V30 DECalc V3.0 files [default]
COMMAND DECalc command files [default]
GRID DECalc grid files
Use one of the following options for LOTUS type files:
WKS LOTUS 1-2-3 V1.A binary worksheets
WK1 LOTUS 1-2-3 V2.0 binary worksheets
WRK LOTUS Symphony V1.0 binary worksheets
/RELOCATE
/RELOCATE[=(option[,option])]
/NORELOCATE (default)
Allows you to move an entire spreadsheet to the right or left and
up or down. The maximum number of rows or columns by which a
spreadsheet can be located is 65,535 in each direction.
You can use one or both of the following options.
ROW:n Moves the spreadsheet a specified number of rows.
COLUMN:n Moves the spreadsheet a specified number of columns.
Integers specified in an option can be positive or negative.
Negative integers move the grid up or to the left, omitting data
in the upper rows and right-hand columns of the grid. Positive
integers move the spreadsheet down or to the right, adding blank
rows and/or columns to the spreadsheet.
You should specify one option when using the /RELOCATE qualifier.
You are limited to specifying two options. Options should be
enclosed in parentheses; if using more than one option, separate
the options with a comma.
/SEPARATOR
/SEPARATOR="quoted string"
where:
"quoted string" is a string using up to 80 alphanumeric
characters. Some examples of valid separators
used in a "quoted string" are:
"*" asterisk
" " <space> character
" " <tab> character
"," comma (this is the default)
"" white space (this is only valid
for input files)
Defines the separator for an input or output tabular format file.
If used as a qualifier for an input file, Xway searches for the
specified separator when reading the file. If used for an output
file, Xway inserts the separator between data cells.
The separator is only used for tabular format files.
/TRAILING_SEPARATOR_COUNT
/TRAILING_SEPARATOR_COUNT=n
Indicates the number of separators appearing at the end of each
line in an output tabular format file. Use a positive integer
with this qualifier. The default value is zero (0).
SUPERCOMP-TWENTY requires two separators.
/TRANSPOSE
/TRANSPOSE
/NOTRANSPOSE (default)
Reverses the position of the rows and columns in a grid. Rows
become columns in a transposed grid (as if the grid is rotated
around a diagonal axis, from upper left to lower right corner).
The first row becomes the first column, and the left-to-right
sequence becomes a top-to-bottom sequence.
Additional information available:
Examples
1. CONVERT/SPREADSHEET BUDGET/FORMAT=FIELD -
/DATE_EDIT_STRING="DD/MMM/YYYY"
In this example, the input file, BUDGET.FLD uses DD/MMM/YYYY as
the format for dates where:
DD = the first two digits of the day in the month, 01 through 31
MMM = the first three letters of the month
YYYY = the four digits in the year
2. CONVERT/SPREADSHEET PAYROLL/FORMAT=(LOTUS:WKS) -
SALARY/FORMAT=(DECALC:V22COMMAND)
In this example, a Lotus 1-2-3 file, PAYROLL.WKS, is being
translated to a DECalc dump file, SALARY.DMP . All other
information required for the exchange would be entered by using
the Xway menus.
3. CONVERT/SPREADSHEET PAYROLL.WKS NEWPAYROLL.WKS/RELOCATE=(ROW:10,COL:10)
In this example, the file, PAYROLL.WKS, is relocated down ten
rows and moved ten rows to the right; blank rows and columns are
added to the model.
4. CONVERT/SPREADHSEET SALES/FORMAT=TABULAR/SEPARATOR="*" -
COST/FORMAT=(DECALC:V22COMMAND)
In this example, a tabular input file. SALES.TAB is being
translated to a DECalc dump file, COST.DMP. The separator used
in the tabular file is "*" .
5. CONVERT/SPREADSHEET STAFF/FORMAT=TABULAR -
/SEPARATOR="*"/TRAILING_SEPARATOR_COUNT=2
In this example, the input file, STAFF.TAB is a SUPERCOMP-TWENTY
file; therefore, the TRAILING_SEPARATOR_COUNT qualifier is used
to indicate that two separators appear at the end of every line
in the input file.
Output options
You can rearrange and manipulate output files with Xway options.
For more information, see the VAX Xway User's Guide.
The valid output options are:
RELOCATE Moves an entire grid (or file) up or down a number
of rows, and right or left a number of columns.
TRANSPOSE Reverses the row/column orientation. The columns
become rows and the rows become columns.
DISCARD Removes the model formatting information (such as
windows, titles, formulas, and cell formats).
Release Notes
A copy of the Xway release notes is contained in the file:
SYS$HELP:XWAY011.RELEASE_NOTES
The release notes include information regarding enhancements,
restrictions, and general notes. You can type or print this file to
read the release note information.
Additional information available:
Guidelines
DECalc output uses algebraic math mode.
Xway automatically sets the math mode to "algebraic" for DECalc
format output.
DECalc comments are omitted.
Any comments you have entered during a DECalc session are stripped
out of DECalc input files.
DECalc only reads dates in the format DD-MMM-YYYY.
Xway can output DECalc files containing dates that have been
formatted according to different date edit strings, but DECalc
does not read them. This restriction applies to DECalc version
2.2 and earlier.
No recursion checking is performed for DECalc exchanges.
Xway does not check whether the model you are translating into a
DECalc output format contains recursive references. DECalc does
not handle recursive references.
Xway does not handle the DECalc continuation character from table
files.
Long lines from tabular files (which are split into smaller
logical lines with the DECalc continuation character) are
exchanged as two or more separate lines by Xway.
Xway handles larger and smaller numbers (numbers with a greater
precision) than can DECalc.
Xway reports an overflow or underflow condition when it processes
a number that is too large or too small for the precision DECalc
can handle. Numbers that overflow or underflow are translated
into labels. DECalc's largest signed number is: + or -1.7E+38
and its smallest signed number is: + or -.29E-38.
Xway does not handle redundant cell referencing for SYLK input
files.
Xway does not parse "non-concise" (redundant) cell references from
Multiplan SYLK, such as: (R3:4 C1:61 C R3). Use only one "R" or
"C" per reference. For example,
SUM(R3:4 C1:61 C) should be written as SUM(R3:4 C)
ABS(R3:4 C[-1] R3) should be written as ABS(R3 C[-1])
Xway skips cells containing redundant cell references, and reports
an "invalid cell" message to the log.
You cannot specify a lowercase separator for tabular files when you
use the interactive, menu-driven version of Xway.
If you want a lowercase separator, specify it on the DCL command
line or edit the Definition file.
Lotus 1-2-3 version 1.0 does not allow cells to reference other
cells containing text.
1-2-3 changes to zero any cells that reference other cells
containing text. In the example below, cell B1 will contain zero.
A B C
1 "text" A1
Since Multiplan and DECalc do allow cells to reference other cells
containing text, models translated with Xway and read into Lotus
1-2-3 Version 1.0 may differ from the original.
/STATISTICS
/NOSTATISTICS (default) Displays conversion statistics.
Additional information available:
/TRUNCATE/WORK_FILES/WRITE_CHECK
/TRUNCATE
/NOTRUNCATE (default) Truncates records that exceed the maximum record length of the file or the record length for fixed record format. /NOTRUNCATE prevents long records from being written to the output file; /EXCEPTION_FILE writes the untruncated record to the exception file.
/WORK_FILES=n
Specifies the number of temporary work files to be used during the sort process. The value of n can be 0 or any value between 2 and 10. The default for n is 2, and a value of 0 means that no work files are necessary because of sufficient physical memory. Valid only with the /SORT or /FAST_LOAD qualifiers.
/WRITE_CHECK
/NOWRITE_CHECK (default) Reads each output record and compares it to the original.
/RECLAIM
Makes empty buckets in Prolog 3 indexed files available so that new records can be written in them. If all the records in a bucket have been deleted, that bucket is locked until CONVERT/RECLAIM makes it available. Unlike CONVERT, CONVERT/RECLAIM maintains record's file addresses (RFAs). Format CONVERT/RECLAIM file-spec Requires the Program Development Tools Option.
Additional information available:
Parameter
file-spec Specification of the Prolog 3 indexed file in which you want to reclaim buckets. (This file cannot be opened for shared access during bucket reclamation.)
Qualifiers
Additional information available:
/STATISTICS
/NOSTATISTICS (default) Displays conversion statistics.