To work with the I3D Report you need:
Currently, supported browsers are:
Please note that third-party browser extensions (such as Ad Blockers) may interfere with Report Viewer and hinder its performance or introduce unexpected errors. If you face any problems viewing reports, first try disabling or uninstalling all third-party browser extensions one-by-one. |
The I3D Report Viewer is installed automatically as the component of the HP Oxygen.
After successful installation, you may continue to use I3D Report straight away with no additional configuration efforts. The following info is for technical reference purposes. |
The latest version of Report Viewer will be installed along with other report templates to the following folder:
%ProgramData%\OctoNus Software\I3D Report Viewer.
A dedicated folder for Report Data will be created in the user's Documents folder:
%MyDocuments%\OctoNus Software\I3D Reports.
Purpose | Synonym | Default Path |
---|---|---|
Report Viewer | %VIEWER% | %ProgramData%\OctoNus Software\I3D Report Viewer |
Report Data | %DATA% | %MyDocuments%\OctoNus Software\I3D Reports |
Please note that if you had previously installed and configured an earlier version of Oxygen HPReflect with I3D Reports, your path settings will be preserved. This means that you'll have to manually update Report Viewer version in your dedicated folder of choice. If you wish to use the default folders, simply update I3D Report path settings according to the values specified above. |
The Interactive 3D Reports Client is installed separately. To obtain the installation file, refer to OctoNus support.
You may want to configure I3D Reports to work in specialized local folders (e.g. on a dedicated disk drive, in a Dropbox folder) or over a LAN folder within your organization's intranet (shared disk drive).
You can have the Viewer and/or Data folders re-located to customized folders.
To do so, proceed with the following steps:
|
To configure folders using Report GUI:
Use the [...]
buttons near the path controls to browse to your new Data and Viewer folders.
Now you're ready to use your custom report folders.
You can use this way of configuration only if specific conditions are met. |
To configure folders using Internal Configuration dialog:
When you launch the Interactive 3D Reports Client, you may see error messages indicating that report settings have not been configured properly:
The application will also check configuration on every start-up and when you modify its settings, and will inform you of any issues.
To configure the application:
In the settings dialog, you can also specify additional settings.
Setting | Description |
---|---|
Automatically Open Report - Timeout | Set between 500 and 50000 milliseconds. This option means the timeout to automatically find/open reports. It starts when you input a new character. The option lets you quickly update the search status of reports. |
Intercept new line in Stone ID | The option means whether or not a new line is intercepted in the Stone ID Field. It's necessary to scan Stone ID barcodes with the new line symbol. If the option is checked, the new line symbol will be intercepted, and a barcode is read as a single string. If the option is unchecked, the new line symbol won't be intercepted, and only the part of barcode before the new line symbol is read. |
This information is not required for I3D Report configuration, but it is intended for your better understanding of the internal data structures.
Sometimes you might want to transfer a specific report or a set of reports for specific stone to you business partners or clients. Understanding the internal Report Data folder structure will allow you to determine which files and folders you need to transfer in such a scenario.
Each version of the viewer should be located in a subfolder of the %VIEWER% folder named in the format of the corresponding viewer version, e.g. "1.0", "1.4.6", "2.1.0" et cetera:
\ %VIEWER%
\ 1.0
index.html
...
\ 1.4.6
index.html
...
\ 2.1.0
index.html
...
To update I3D Viewer version in a custom %VIEWER% folder, simply extract provided Report Viewer archive into the folder and make sure that the resulting folder tree matches described above (considering available Report Viewer versions).
This folder will be automatically populated by Oxygen HP Reflect on Interactive report generation and will store report data.
The following description is for your information only, no manual changes are required.
Its basic structure is as follows:
\ %DATA%
\ ID-567 <- Folder containing all reports for the stone with specified ID
\ 0001- ID-567 <- First report for the stone
report.js
metadata.xml
\ 0002-ID-567 <- Second report for the stone
\ Images <- Sub-folder with Report Images
0-1.jpg
0-2.jpg
...
report.js
metadata.xml
\ ID-24536
\ 0001-ID-24536 <- First report for the stone
\ Images
0-1.jpg
0-2.jpg
...
report.js
metadata.xml
\ 0002-ID-24536 <- Second report for the stone
\ Images
0-1.jpg
0-2.jpg
...
report.js
metadata.xml
\ 0003-ID-24536 <- Third report for the stone
report.js
metadata.xml