13.5 Description of commonly used structures by SurpriseServer

The description of used notation is contained in section Used notation.

Element {resources}

{resources} = <RESOURCES> [ {disk} ... ] [ {parameter} ... ] [ {filesystem} ... ] </RESOURCES>

This structure desribes all the hard drives and their partitioning in the computer. It also includes description of general conversion parameters.

Element {final}

{final} = <FINAL> <IMPORT> [ {disk} ... ] <EXPORT> [ {disk} ... ] [ {parameter} ... ] </FINAL>

This structure describes the original (IMPORT) and the suggested (EXPORT) partitioning of the drives in the computer. It also includes description of general conversion parameters.

Element {error}

{error} = <ERROR> description of error (free form text) </ERROR>

This structure describes an error.

Element {disk}

{disk} = <DISK [NAME={string}] [MODEL={string}] BLOCKS={number} ALIGN_START={number} ALIGN_END={number} RESERVED={number} [HEADS={number}] [SECTORS={number}] [CYLINDERS={number}] > [ {parameter} ... ] [ {partition} ... ] </DISK>

This structure describes hard drive physical parameters, partitions on that drive and parameters of it (partition table type etc.).

Element {partition}

{partition} = <PARTITION START={number} LENGTH={number} TYPE={string} NUMBER={number} > [ {entry} ] [ {parameter} ... ] [ {directory} ... ] </PARTITION>

This structure describes partition position, its filesystem and its data.

Element {entry}

{entry} = <ENTRY> <BOOT={number}> <STARTHEAD={number}> <STARTSECTOR={number}> <STARTCYLINDER={number}> <SYSTEM={number}> <ENDHEAD={number}> <ENDSECTOR={number}> <ENDCYLINDER={number}> <FIRSTSECTOR={number}> <SIZESECTOR={number}> </ENTRY>

This structure describes the entry of the partition in the partition table.

Element {filesystem} = <FILESYSTEM NAME={string}

{filesystem} = <FILESYSTEM NAME={string}> [ {parameter} ... ] </FILESYSTEM>

This strcuture describes filesystem supported by Surprise Library.

Element {directory}

{directory} = <DIRECTORY [ NAME={string} ] SIZE={number} ID={number} >

This structure describes directory containing some data.

Element {parameter}

{parameter} = {parameter1} | {parameter2} | {parameter3} | {parameter4} | {parameter5}

This structure describes a general parameter; it can be one of five types - interval, string, boolean, discrete number or discrete string.

Element {parameter1}

{parameter1} = <PARAMETER ID={number} NAME={string} TYPE="INTERVAL" [IMPORT] [EXPORT] [DETECTED] [DETERMINED] > {number} <INTERVAL MIN={number} MAX={number}> </PARAMETER>

This structure describes number parameter.

Element {parameter2}

{parameter2} = <PARAMETER ID={number} NAME={string} TYPE="BOOLEAN" [IMPORT] [EXPORT] [DETECTED] [DETERMINED] > TRUE | FALSE </PARAMETER>

This structure describes boolean parameter.

Element {parameter3}

{parameter3} = <PARAMETER ID={number} NAME={string} TYPE="STRING" [IMPORT] [EXPORT] [DETECTED] [DETERMINED] > {string} <MAXLENGTH= {number} | UNLIMITED> [<REGEX={string}>] </PARAMETER>

This structure describes string parameter.

Element {parameter4}

{parameter4} = <PARAMETER ID={number} NAME={string} TYPE="DSTRING" [IMPORT] [EXPORT] [DETECTED] [DETERMINED] > <INDEX={number}> <CHOICES COUNT={number}> {string} ... </CHOICES> </PARAMETER>

This structure describes string parameter which can have only limited number of values.

Element {parameter5}

{parameter5} = <PARAMETER ID={number} NAME={string} TYPE="DNUMBER" [IMPORT] [EXPORT] [DETECTED] [DETERMINED] > <INDEX={number}> <CHOICES COUNT={number}> {number} ... </CHOICES> </PARAMETER>

This structure describes number parameter which can have only limited number of values.