What is Oxygen Microscope and who benefits from it
What is new ?
Release Notes and Documentation
Versions history
The Gallery

Test CPU performance of the Pacor, Helium Rough and Oxygen Software
 
Oxygen Microscope Server download
 
Oxygen Microscope Documentation (PDF)
FAQ
Customizing Oxygen Customer Reports
Customizing Oxygen / DiamCalc Polish reports

Creating and customizing appraisers (PDF)
Creating and customizing pricelists (PDF)
Appendixes
 
DiamCalc
DiBox
DiBox 2.0
GemAdviser Free Version
Helium IG
Helium Polish
Helium Rough
Helium Tender
M-Box 2.0
M-Box 1.5
M-Box
Oxygen DZ
Oxygen HIG
Oxygen Immersion
Oxygen Inclusion
Oxygen Microscope Server
Oxygen Viewer Free Version
Oxygen XRay Server
Pacor
Pacor Client
Stereo Viewer Free Version
ViBox

PACOR - Advanced Computer technologies for Processing of Rough diamonds
Laser Mapping of Concavities
Scanning major and minor symmetry features
Technology patent "A method and apparatus for locating inclusions in a diamond stone"
Immersion Glass
 
Oxygen / DiamCalc reports
Customizing Oxygen / DiamCalc Polish reports

Oxygen Polish reports are available in Oxygen since version 3.0 (19 March, 2010).

Oxygen software allows creating reports based on templates in the MS Word rich-text format RTF and HTML formats. Report templates are placed in the PolishReportTemplates folder. The general path is:

[Application Data]\OctoNus Software\PolishReportTemplates\

For example in default Windows XP installation the path is:

C:\Documents and Settings\All Users\Application Data\OctoNus Software\PolishReportTemplates\

To open folder PolishReportTemplates press button in Print polish report dialog window.

OctoNus Software offer an utility for installing set of templates:

http://www.octonus.com/download/reports/OctoNusReportTemplateSetup.exe

There are both templates for Customer reports and Polish reports. Download and run the utility, then follow its instructions to install default set of templates.

Oxygen users can take these templates and customize them for their needs or create new templates.

It is possible to convert the old type report templates with .ini files from previous DiamCalc and Helium programs for use with new programs. Polish Reports Format Converter utility converts these old templates into the new format and save them to template folder.
Download Polish Reports Format Converter utility

Customization of Oxygen Polish reports is not the same like it was in the Helium Polish. It is easy. INI files not need any more.

Using RTF report templates

RTF file defines appearance of the generated report. The main idea is that the RTF file is a template for the report. During report creation Oxygen software searches the RTF file for specific bookmarks and replaces them with parameter values. All known bookmarks will be replaced with the corresponding parameter values. All unknown bookmarks will be left intact. If some parameter value is not available, the corresponding bookmark will be left intact. If you don't want to see some parameter's value in the report, just remove the corresponding bookmark. For example, the text in the file marked with the bookmark TOTAL_DEPTH_MM will be replaced with the total height of the diamond in millimeters. Make sure that all bookmark names are written in capital letters. If it is necessary to put the same parameter's value several times in the report, you may use the following technique. RTF file can not contain two bookmarks with the same names. so add a _COPY_N suffix to the primary bookmark's name, for example, TOTAL_DEPTH_MM_COPY_1. Thus, both bookmarks TOTAL_DEPTH_MM and TOTAL_DEPTH_MM_COPY_1 will be replaced with the value of the same parameter the total height of the diamond in millimeters.

To see the list of all available bookmarks in a file, to add and delete them you may use MS Word. Open RTF file in it and choose menu Insert/Bookmark.. Write bookmark name and click button Add. The bookmark will be added to the list.

For polish report templates, all the service bookmarks can be divided into four groups:

Group 1. General properties for the whole document
Avery report should contain one special bookmark named GENERAL_PROPERTIES, where properties are included: name of the template, cutting type, etc. After report generation this bookmark with its contents is deleted. This bookmark only helps to generate report. Its format is described in section (i). Bookmark should contain text in described format.
Group 2. Parameters Bookmarks for computable values, such as girdle diameter, in mm or %. Bookmark may contain any text, it will be replaced with calculated value during report generation.
Group 3. Pictures Bookmarks for pictures, such as symmetry plot. Bookmark may contain any text, it will be replaced with a proper picture during report generation.
Group 4. Customizable pictures Bookmarks for customizable pictures. There are 4 types of view for customizable pictures:
  • POLISH_MODEL_REPORT
  • POLISH_ANGLES_REPORT
  • POLISH_SIDES_REPORT
  • PROFILE_VIEW_REPORT
Bookmarks of customizable pictures can contain options. Its format is described in section (ii).

i) General properties for the whole document

A special bookmark GENERAL_PROPERTIES is necessary to generate RTF report. In this bookmark, main properties of template are numbered, such as template name, cutting type, and some others (they will be described below). The bookmark can be placed anywhere in document; we recommend to place it at the end of the document in order user can see document formatting not paying much attention on this service thing. Properties of bookmark are listed one by one without spaces, delimited with semicolon.

An example of GENERAL_PROPERTIES bookmark contents:

[ReportType=PolishRTF;VisibleName=Standart report for Brilliant;CuttingType=Brilliant;ColorReport=0;Pictures=POLISH_MODEL_REPORT_PAV_VIEW, POLISH_MODEL_REPORT_CRN_VIEW/]

ReportType

This option is mandatory. It is a mark which shows that this document is a template. For polish reports, its value should be PolishRTF. Other possible value is PolishHTML for HTML reports.

VisibleName

This option is mandatory. It specifies the name, which is shown in a list of templates in Polish report dialog in Oxygen.

CuttingType

This option is mandatory. It specifies cutting type, for which the template is available. It identifies the cutting for which this report template is made. Different cuttings may have different set of parameters and different meaning of the same parameters. That is why it may be necessary to make report templates for each type of the cutting. CuttingType value can be one of the following:

  • BRILLIANT - brilliant
  • FANCYROUND - oval, marquise, pear
  • FANCYPRINCE - princess
  • FANCYSTEPCUT - emerald, stepcuts
  • CUSHION - cushion
  • RADIANT - radiant
  • SQUARERADIANT - square radiant
  • ALL - any type of cutting

ColorReport

This option is optional. It specifies the type of report. ColorReport value can be 1 - for color reports or 0 - for black-and-white reports.

However, in Polish reports dialog in Oxygen possible to create color report, black-and-white report or use report color information from template. See bootom of section Report templates in the dialog window Print polish report:

Picture

This option is optional. It is used for listing of bookmarks for pictures that require additional attributes - customizable pictures. Bookmarks names should be listened one by one without spaces and delimited by comma. Attributes themselves should be written in corresponding bookmark. In the above example, it is shown that at bookmarks POLISH_MODEL_REPORT_PAV_VIEW and POLISH_MODEL_REPORT_CRN_VIEW additional attributes of pictures are placed.

ii) Customizable pictures

Picture bookmarks with additional attributes should contain text with attributes in format Name=Value, listed one by one without spaces, delimited with semicolon. For example:

[PictureID=POLISH_MODEL_REPORT;X=0;Y=0;Z=180;InvisibleEdges=1;VisibleSidesInColor=0; VisibleEdgesColorR=0;VisibleEdgesColorG=0;VisibleEdgesColorB=0;InvisibleEdgesColorR=192; InvisibleEdgesColorG=192;InvisibleEdgesColorB=192]

Attributes names are fixed and values are specified by user.

PictureID

This attribute is mandatory. It can have on of the followed values written in capital letters:

  • POLISH_MODEL_REPORT
  • POLISH_ANGLES_REPORT
  • POLISH_SIDES_REPORT
  • PROFILE_VIEW_REPORT

Picture with the POLISH_MODEL_REPORT value contains a simple model of the polished diamond without inscriptions above it. Picture attributes allow to specify whether to draw invisible edges or not, orientation of the model, color and aspect ration of the picture.

Picture with the POLISH_ANGLES_REPORT value contains a model of the polished diamond with facet angles inscribed above the model. Picture attributes allow to specify the orientation of the model, what angles to write, font size, aspect ratio and color of the picture.

Picture with the POLISH_SIDES_REPORT value contains a model of the semi-polished diamond with information about all facets inscribed above the model. Picture attributes allow to specify the orientation of the model, what information to write (angles/heights), precision, font size, aspect ratio and color of the picture.

Picture with the PROFILE_VIEW_REPORT value contains a side view of the model of the polished diamond with the values of basic parameters inscribed above the model. Picture attributes allow to specify the font size, aspect ratio and color of the picture.

X, Y, Z

These attributes are optional. If such key is not specified it is assumed to be zero. It is the angle of rotation of the 3D model around X, Y, Z axis in degrees before making the final image. This attribute allows to create various views of the same model.

InvisibleEdges

This attribute is optional. It specifies the way of drawing invisible edges of the 3D model. Possible values are:

0 invisible edges are not drawn
1 invisible edges are drawn without refraction
2 invisible edges are drawn taking refraction of the light into consideration

If this key is not specified it is assumed to be equal to 1.

VisibleSidesInColor

This attribute is optional. It specifies the way of coloring of visible edges. Possible values are:

0 black and white scheme. For example, extra facets will be drawn in gray color
1 color scheme (for example, extra facets will be drawn in blue color).

If this key is not specified it is assumed to be equal to 0.

VisibleEdgesColorR, VisibleEdgesColorG, VisibleEdgesColorB

These attributes are optional. If such key is not specified it is assumed to be zero. They specify the RGB color for drawing visible edges of the 3D model.

InvisibleEdgesColorR,InvisibleEdgesColorG,InvisibleEdgesColorB

These attributes are optional. If such key is not specified it is assumed to be zero. They specify the RGB color for drawing invisible edges of the 3D model. 6

AspectRatioX, AspectRatioY

These attributes are optional. If such key is not specified it is assumed to be zero. They specify the desired proportions of the generated picture. If the actual proportions of the picture differ from the specified, blank margins are added.

PavilionView

This attribute specifies orientation of the model. Possible values are:

0 Crown view
1 Pavilion view

If this key is not specified it is assumed to be equal to 1.

PictureType

This attribute specifies the way of drawing the picture. If PictureID=POLISH_ANGLES_REPORT then possible values for parameter PictureType are:

0 invisible edges are drawn taking refraction into account, slope angles of main facets are written near facets;
1 invisible edges are not drawn, slope angles of all facets are written;
2 - invisible edges are not drawn, azimuth angles of all facets are written;
3 - invisible edges are not drawn, deviation of slope angles from the average are written;
4 - invisible edges are not drawn, deviation of azimuth angles from ideal are written;
5 - invisible edges are not drawn, slope angles of main facets are written near facets together with the maximum inscribed circle and section of the model with the plane in which the circle lies;
6 - invisible edges are not drawn, slope angles of main facets are written above facets together with the maximum inscribed circle and section of the model with the plane in which the circle lies.

If PictureID=POLISH_SIDES_REPORT then possible values for parameter PictureType are:

0 slope angles of all facets are drawn;
1 - azimuth angles of all facets are drawn;
2 heights in % of all facets are drawn;
3 - heights in mm of all facets are drawn.

Colored

This attribute is optional. Default value: 0. The program generates black and white pictures if it is 0 and colored otherwise.

FontSize

This attribute is optional. Default value: 100. This parameter adjusts the font height on the picture. It specifies the ratio between desired and default font size. For example, if FontSize=200, all text on the picture will be twice higher than default.

Precision

This attribute is optional. Default value: 2. This parameter is applicable to pictures with PictureID=POLISH_SIDES_REPORT. It specifies the number of decimal digits used when writing facet angles or heights.

TitleLengthGirdleFacet, TitleDepthGirdleFacet

These attributes are optional. They specify the text that will be written on the picture above the corresponding parameter values. When the font size is large the default text may appear too big to fit the picture and you may want to change it.

Using HTML report templates

The HTML file defines the appearance of the generated report. During report creation Oxygen software searches the HTML file for specific bookmarks and replaces them with parameter values. In HTML file, bookmark is <a> tag with name attribute specifying bookmark name.

The bookmarks descriptions are similar as in RTF report templates. As in RTF polish report templates, all the service bookmarks can be divided into four groups:

Group 1. General properties for the whole document
Avery report should contain one special bookmark named GENERAL_PROPERTIES, where properties are included: name of the template, cutting type, etc. After report generation this bookmark with its contents will be deleted. This bookmark only helps to generate report. Its format will be described in section (i). Bookmark should contain text in this format. This bookmark can be placed anywhere in document, for example before closing </body> tag.
Group 2. Parameters
Bookmarks for computable values, such as girdle diameter, in mm or %. Bookmark may contain any text, it will be replaced with calculated value during report generation.
Group 3. Pictures
Bookmarks for pictures, such as symmetry plot. Bookmark will be replaced with a proper picture during report generation. Bookmark should contain picture generation options, such as size and file name. Its format will be described in section (iii).
Group 4. Customizable pictures
Bookmarks for customizable pictures. There are 4 types of customizable pictures:
  • POLISH_MODEL_REPORT
  • POLISH_ANGLES_REPORT
  • POLISH_SIDES_REPORT
  • PROFILE_VIEW_REPORT
Bookmarks of customizable pictures can contain options. Its format is described in section (ii).

i) General properties of the whole document

A special bookmark GENERAL_PROPERTIES is necessary to generate HTML report. In this bookmark, main properties of template are numbered, such as template name, cutting type, and some others..

ReportType

This option is mandatory. It is a mark which shows that this document is a template. For polish reports, its value should be PolishHTML. Other possible value is PolishRTF for RTF reports.

VisibleName

This option is mandatory. It specifies the name, which is shown in a list of templates in Polish report dialog in Oxygen.

CuttingType

This option is mandatory. It specifies cutting type, for which the template is available. It identifies the cutting for which this report template is made. Different cuttings may have different set of parameters and different meaning of the same parameters. That is why it may be necessary to make report templates for each type of the cutting. CuttingType value can be one of the following:

  • BRILLIANT - brilliant
  • FANCYROUND - oval, marquise, pear
  • FANCYPRINCE - princess
  • FANCYSTEPCUT - emerald, stepcuts
  • CUSHION - cushion
  • RADIANT - radiant
  • SQUARERADIANT - square radiant
  • ALL - any type of cutting

ColorReport

This option is optional. It specifies the type of report. ColorReport value can be 1 - for color reports or 0 - for black-and-white reports.

However, in Polish reports dialog in Oxygen possible to create color report, black-and-white report or use report color information from template. See bootom of section Report templates in the dialog window Print polish report:

Picture

Picture option is optional. It is used for listing of bookmarks for pictures that require additional attributes - customizable pictures. Bookmarks names should be listened one by one without spaces and delimited by comma.

Executable

Executable option is optional. In this option an external program can be specified, which opens HTML files. After generation, report will be opened with this program. If no program is stated or the option is absent, the default HTML browser is used.

AutoResultPathParam, AutoResultPathPrefix, AutoResultPathSuffix

AutoResultPathParam, AutoResultPathPrefix, AutoResultPathSuffix   options are optional. After report generation, it will be saved in a folder name <AutoResultPathPrefix >_< AutoResultPathParam >_< AutoResultPathSuffix > where <AutoResultPathParam> means value of bookmark, which is stated in this option, and <AutoResultPathPrefix> and <AutoResultPathSuffix> mean their values.

For example,

AutoResultPathParam=STONE_ID;AutoResultPathPrefix=html; AutoResultPathSuffix=report

will generate report for stone with STONE_ID = 3_CARAT_BRILLIANT in folder html_3_CARAT_BRILLIANT_report.

ResultPath

ResultPath option is optional. If no one of the above options AutoResultPathParam, AutoResultPathPrefix, AutoResult are stated, the path which is in this option is used.

StaticFiles

StaticFiles option is optional. In HTML template <img> tags can be used. If such files are local, i.e. they are places in the same folder with template file, they will be copied to result folder. In this option such files names are listed one by one without spaces, delimited with comma.

For example, GENERAL_PROPERTIES bookmark:

<a name=GENERAL_PROPERTIES>

[ReportType=PolishHtml; VisibleName=Standard report for brilliant; CuttingType=Brilliant;Executable=; ResultPath=Html_Polish_Brilliant;AutoResultPathParam=STONE_ID; AutoResultPathPrefix=html_;AutoResultPathSuffix=; StaticFiles=imageGirdle.gif, imageCulet.gif,imageTable.gif,imageMIC.gif,link.gif, ga.gif; Pictures=POLISH_ANGLES_REPORT_PAV_ANGLES, POLISH_ANGLES_REPORT_CRN_ANGLES]

</a>

It is similar to the same in section Using RTF report template.

ii) Customizable pictures

Picture bookmarks with additional attributes should contain text with attributes in format Name=Value, listed one by one without spaces, delimited with semicolon. The list of attributes and their names is the same as in RTF format, plus three attributes which can be used with all types of report pictures:

FileNameEMF, FileNameBMP, FileNamePNG or FileNameGIF

These keys are optional. It should have the file name for the picture in the Windows Bitmap Format (BMP) or Portable Network Graphics Format (PNG) or Graphics Interchange Format (GIF). The Oxygen  software creates uncompressed true-color BMP images, compressed true-color PNG images and compressed 8-bit color GIF images. If this key is not specified, the corresponding file will not be created or updated. If this key is specified, two more keys should be specified also: Width, Height.

Width, Height

These keys should be specified if the FileNameBMP, FileNamePNG or FileNameGIF key is present. They specify the maximum width and height of the raster image with the report picture in pixels. The actual picture will fit into the given dimensions preserving the aspect ratio.

iii) Other pictures

The following three attributes should be used with common report pictures, they are similar to the same values of customizable pictures options:

FileNameEMF, FileNameBMP, FileNamePNG or FileNameGIF

These keys are optional. It should have the file name for the picture in the Windows Bitmap Format (BMP) or Portable Network Graphics Format (PNG) or Graphics Interchange Format (GIF). The Helium  software creates uncompressed true-color BMP images, compressed true-color PNG images and compressed 8-bit color GIF images. If this key is not specified, the corresponding file will not be created or updated. If this key is specified, two more keys should be specified also: Width, Height.

Width, Height

These keys should be specified if the FileNameBMP or FileNamePNG or FileNameGIF key is present. They specify the maximum width and height of the raster image with the report picture in pixels. The actual picture will fit into the given dimensions preserving the aspect ratio. For example, a bookmark for picture PLOT_GIRDLE_SYMMETRY may look:

<a name="PLOT_GIRDLE_SYMMETRY">

[FileNamePNG=PLOT_GIRDLE_SYMMETRY.png;Width=250;Height=500]

</a>