Breadcrumbs

HTML Export

The HTML Export command is sent to the analyzer to exercise the HTML Export menu option for existing frames. This command does not require capture hardware to be connected. The command format is:

“HTML Export;summary=<summary>;databytes=<bytes>;decode=<decode>;[frames=<frames>;] [frame range upper=<frame number>;][frame range lower=<frame number>;][layers=<layer1>,<layer2>,...,<layerK>,...<layerN>;]file=<export path>"

“summary” values are:

  • 0 – Do not include (default)

  • 1 – Include

“bytes” values are:

  • 0 – Do not include

  • 1 – Include (default)

“decode” values are:

  • 0 – Do not include

  • 1 – Include (default if “bytes” is “include”)

“frames” valid values are:

  • “all” – Export all frames, all other frame parameters ignored (default)

  • “selected” – Export selected frames

“frame number” values are:

  • Valid values are 0 to the highest frame.

  • if “frames” is set to “all”. “frame range upper” and “frame range lower” are ignored

  • If “frames” is set to “selected”, “frame range upper” defaults to highest frame and “frame range lower” defaults to 0.

Valid values for “layers” are the layer names comma separated and without quotes or extra spaces. For example:

layers=LE BB,LE BIS

will export only data in the layers “LE BB” and “LE BIS”. For a list of layers see the layer table for the export command.

There is no space before or after the command in the list of layer names unless the layer name ends in a space.

If the export path represents just a file name the configured log directory will be prepended.

Response: “HTML EXPORT;<status>[;Reason=<reason>]” where a reason will only be supplied for FAILED status.

Examples:

“HTML Export;summary=1;databytes=0;decode=0;file=f:\MyExport.htm”

“HTML Export;summary=1;databytes=0;decode=0;file=f:\MyExport.htm”;frame range upper=48”

“HTML Export;frames=selected;frame range lower=10;frame range upper=20;layers=LE BB,LE BIS;file=f:\MyExport.htm”

There are several important ideas to remember about HTML Export.

  • BE AWARE THAT THIS CAN CAUSE THE ANALYZER TO SPEND CONSIDERABLE TIME GENERATING THE HTML FILE.

  • If no html file is specified, a default one will be generated and saved in the log file directory created during installation of the analyzer application.

  • If an html file is specified, then this file is created and saved in the log file directory created during installation of the analyzer application.

  • All layers for each frame will be exported unless the layers field is used to specify the layers to export.

  • If the capture file is empty, no html will be generated, and an error will be reported.

  • If the range selected is outside the current range of processed frames, no html will be generated, and the last process frame will be included in the reason.

  • If all frames need to be exported, then select some unknown large number for the upper range or set “frames” to “all” or repeatedly send Is Processing Complete command until frame compilation is done prior to sending HTML Export command.