Bruker MSWS Reporting User Manual
Bruker MSWS Reporting User Manual
Version 8
MS Excel Reports
© Bruker 2011
All other trademarks are the sole property of their respective owners.
All Rights Reserved
Reproduction, adaptation, or translation without prior written permission is prohibited, except as
allowed under the copyright laws.
Warranty
The information contained in this document is subject to change without notice. Bruker makes no
warranty of any kind with regard to this material, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose. Bruker is not liable for errors contained herein or
for incidental or consequential damages in connection with the furnishing, performance or use of this
material. Bruker assumes no responsibility for the use or reliability of its software on equipment that is
not furnished by Bruker.
Use of Trademarks
The names of actual companies and products mentioned herein may be the trademarks of their
respective owners.
2
Contents
Chapter 1 Hardware and software requirements ................................................................................. 7
Chapter 2 Bruker reporting tool components ....................................................................................... 8
Chapter 3 Secure Login ..................................................................................................................... 10
3.1 User login – First time login................................................................................................... 10
3.2 Changing the password ........................................................................................................ 11
3.3 Recover password ................................................................................................................ 13
Chapter 4 Create Template ................................................................................................................ 14
4.1 Open Blank Template page .................................................................................................. 14
4.2 Toolbox window .................................................................................................................... 15
4.2.1 Available Super Objects panel .......................................................................................... 15
4.2.2 Existing Templates ............................................................................................................ 19
4.3 Report configuration window ................................................................................................. 20
4.3.1 Selected Super Objects panel ........................................................................................... 20
4.4 Creating a new Template ...................................................................................................... 22
4.4.1 Create a template with Header, Tabular and Chart elements: ......................................... 22
4.4.2 Create a template with Header, Repeater-Tabular and Repeater-Chart elements: ......... 36
Chapter 5 Modify Template and Delete Template ............................................................................. 40
5.1 Modify an Existing Template ................................................................................................. 40
5.2 Delete an Existing Template ................................................................................................. 41
Chapter 6 Generate Report................................................................................................................ 42
6.1 Invoke MS Excel reporting from MS Data Review ................................................................ 42
6.2 Interactive reporting in MS Excel .......................................................................................... 43
6.3 Automatic report generation (Make report for the template specified in the method)........... 47
6.3.1 Workflow for automatic report generation ......................................................................... 47
6.3.2 Protection of report generated in MS Excel format. .......................................................... 53
Chapter 7 Import-Export utility ........................................................................................................... 55
7.1 How to use Import Export Utility ............................................................................................ 57
7.1.1 Import templates................................................................................................................ 57
7.1.2 Export templates ............................................................................................................... 59
7.2 Delete functionality supported in Import Export Utility .......................................................... 63
7.2.1 Delete templates in Backup folder .................................................................................... 63
7.2.2 Delete templates in User Templates folder ....................................................................... 65
Chapter 8 Factory templates available with the tool .......................................................................... 68
Chapter 9 Trouble Shooting ............................................................................................................... 71
Chapter 10 Limitations and specifications for MS Access and MS Excel ........................................ 73
10.1 MS Excel specifications and limits ........................................................................................ 73
10.1.1 Worksheet and workbook specifications and limits....................................................... 73
10.1.2 Calculation specifications and limits.............................................................................. 74
10.1.3 Charting specifications and limits .................................................................................. 75
10.2 MS Access Database specifications and limits ..................................................................... 76
3
10.2.1 General .......................................................................................................................... 76
10.2.2 Table ............................................................................................................................. 76
10.2.3 Query ............................................................................................................................. 77
4
Overview
MS Excel Reports is a flexible reporting package implemented to use
Microsoft Excel 2010 as the front end and Microsoft Access 2010 as the
database.
Help
For standard MS Excel features, the Microsoft help is available.
Help with respect to template categories, is provided along with the add in
Help with respect to super object and its individual property, is provided along
with the add in
5
MS Excel Report Components
MS Excel reporting software has following major components:
6
Chapter 1 Hardware and software requirements
Following are the hardware and software requirements for MS Excel reporting.
Hardware Configuration
Manufacturer Dell
Software Configuration
MS Excel 2010
7
Chapter 2 Bruker reporting tool components
Following components will be available to the user:
1. Login
2. Create/Modify Template
3. Button to invoke toolbox window
4. Button to invoke Report configuration window
1. Login
Login button will be available to the user in MS Excel ribbon bar after installation of the add-in.
This button will ensure secure login to the tool. The user will be able create or modify the template
only after logging in to the tool.
2. Create/Modify Template
Create/Modify Template button will be available to the user in MS Excel ribbon bar after
successful login to the add-in.
This option will enable the user to create his own customized report template or to modify the
already created template. Here the user is also given the privilege to delete a template.
Note: The user will not be able to modify or delete the factory templates available with the tool.
Toolbox contains the vital elements required while creating/modifying/deleting a template. The
button to invoke the Toolbox window will be available to the user on successful login to the add-in.
8
This window consists of the following:
• Available super objects panel
• Existing templates dropdown
• Option to delete the selected template
• Option to modify the selected template
• Template properties
• Help text
9
Chapter 3 Secure Login
6. On successful login, the button “Login” will be disabled and the option to Create/Modify a
report will be enabled to the user. On login, by default the following windows will be displayed:
a. Tool box window
b. Report configuration window
c. Blank template
10
Fig.: After successful login, the Login button is disabled and template designer would be
displayed.
11
Fig.: Required parameters for changing the password
12
3.3 Recover password
This functionality is used to recover the password. To recover the password, the user should be
aware of the security question and its answer that has been set during changing the password.
2. Select the appropriate security question and enter the answer and click on Recover
13
Chapter 4 Create Template
14
4.2 Toolbox window
This window will be displayed by default on the left hand side of the blank template. The user can
move, resize or close the toolbox window. If closed, the window can be invoked by clicking on the
toolbox icon in ribbon bar for Bruker add-in.
This is a part of Toolbox window and is displayed when the user clicks on Create/Modify
Template button in MS Excel ribbon bar.
It contains nodes and sub-nodes, which in turn contain the super objects that can be used to drag
and drop in the template area while creating or modifying a template. Every super object when
dropped in the template canvas will display a caption and its value. The caption can be modified
to user requirement.
15
Fig: Short description of the super object in the form of a tool tip
2. Following are the set of rules for adding the header elements to the template:
a. The object cannot be placed in column ‘A’. This is because, when a header super
object is placed in the template, its corresponding name is placed in the left
adjacent cell. Hence the header super object can be placed in a cell which has a
left adjacent cell.
b. If the user tries to add a header element in column ‘A’, following message is
displayed to the user
c. If two header elements are dropped in adjacent cells, then the value of the first
header element would be over written with the caption of the second header
element. As a result the generated report will not display the value of the first
header element.
3. Tabular: This contains sub-nodes which list the super objects belonging to the sub-node.
These super objects are used to create the Tables in a report. A tool tip will be displayed
to the user when the mouse is hovered over the super object. This is a short description
about the super object. Following are the set of rules for adding the tabular elements to
the template:
a. The object cannot be placed in row ‘1’. This is because, when a tabular super
object is placed in the template, its corresponding name is placed in the above
adjacent cell. Hence the tabular super object can only be placed in a cell which
has an above adjacent cell.
b. If the user tries to add a header element in row 1, following message is displayed
to the user
16
Fig.: Information displayed to the user
c. If two tabular elements are dropped one below the other, then the value of the
first tabular element would be over written with the caption of the second tabular
element. As a result the generated report will not display the value of the first
tabular element.
4. Charts: This section contains the various charts that can be added to the template.
These charts if added, will be displayed only once in the generated report. A tool tip will
be displayed to the user when the mouse is hovered over the chart. The charts available
are:
17
Once the chart is dropped in the template, it can be configured to modify the annotation
and other properties.
Following are the set of rules for adding the charts to the template:
a. In case different charts should be placed adjacent to each other, they should be
placed in such a way that they do not fall in the same column. If they do, the
generated report will display overlapped charts
b. The chart size is user configurable. There is no recommended size of chart for
optimum display
c. The chart can be resized to any dimension. While resizing, the aspect ratio as per
monitor screen resolution should be maintained for optimum display
The elements can be added in Levels. A maximum of 3 levels of repeater elements are
allowed in any template.
Repeater contains two nodes:
a. Tabular: This set contains the sub-nodes and the super objects clubbed in the
sub-nodes. They are similar to the Tabular super objects in the non-repeater
section. The rules mentioned in 3.2.1 Available Super Objects panelAvailable Formatted: Font: (Default) Arial, 10
Super Objects panel – Bullet 2 should be considered during adding the Repeater- pt
tabular elements to template:
b. Charts: Charts as mentioned in 3.2.1 Available Super Objects panelAvailable Formatted: Font: (Default) Arial, 10
Super Objects panel – Bullet 4 are also available in Repeater. These charts if
added to the template are repeated for the data set that they are meant for.
Following are the set of rules during adding the charts to template:
i. In repeaters, charts can be added from level 2 onwards. Charts if added
to level 1 will not be displayed in the generated report.
ii. If charts are to be placed adjacent to each other, then they have to be
placed in such a way that they fall in different columns of Excel. If they
18
fall in the same column, then the generated report will display overlapped
charts.
4.2.2 Existing Templates
Note: a. The user will not be able to delete a template that is open for modification.
b. The user will not be allowed to delete factory templates.
b. Modify - Selecting a template from the list and clicking this button, enables it for
modification
Note: The user will not be able to modify factory templates available with the tool.
6. Once a template is selected, its properties are displayed in Template Properties section
and Help text for the selected property is displayed below it.
19
Fig.: Template properties and Help text
4.3 Report configuration window
This window will be displayed by default on the right hand side of the blank template. The user can
move, resize or close the toolbox window. If closed, the window can be invoked by clicking on the
toolbox icon in ribbon bar for Bruker add-in.
1. This is a part of Report configuration window and is displayed when the user clicks on
Create/Modify Template button in MS Excel ribbon bar.
2. Initially only the nodes will be displayed. When the user drops a super object in the template
canvas, the super object would be displayed in the ‘Selected super objects’ panel.
3. If the user clicks on any of the super object in this panel, its corresponding properties and
help text for selected property is displayed.
20
Fig.: Super objects property and help text.
4. If a super object from the template canvas is to be deleted, right click the object in Selected
Super Objects, an option ‘Delete’ is displayed. Clicking on Delete, will delete the object from
the template.
21
4.4 Creating a new Template
A template can contain Header elements along with Tabular elements or Repeater elements or a
combination of both. The template can also contain Free Form text in the report or Report title, Report
Header and Footer.
E.g.: Below figure shows adding of Header super objects to the blank template
22
Fig.: Drag-drop Header super objects to a blank template
4. Once the super objects are placed in the template, they are also appropriately listed in
Selected Super Objects panel and their properties are displayed in Properties section.
5. Similar to Header super objects, Tabular super objects and Charts can be added
23
Fig.: Charts placed in a blank template
6. The default settings for various elements (Date/Time/Decimal etc.) will be as per the table
below:
24
Element Format Example
Left/Right = 0.7
Top/Bottom = 0.87
Page margins
Header/Footer = 0.3
Center on page = Horizontally
7. If users need to design template where a single plot is repeated for each compound, such as
ISTD_ByCompoundGroup, then user will have to size the plot (single one) to a size such that
the number of charts in rows is what he wants to be.
E.g.: Assuming the width of template is 100, to have 3 charts in a row, user should adjust the
width of the chart to a value like 30. Further, to achieve this, the chart from the Repeater
section needs to be selected and its Level property – Chart Wrap value should be True.
8. Select the catergory of the template to which it belongs. This selection can be done in the
Tool box panel > Template properties > Category
The category mentioned for template would be used for logical grouping of templates
9. Default value for a template category is ‘Single’. The available options in the dropdown are:
a. Single: This category pertains to the template being used for reporting the data for a
single data file.
b. Multiple: This category pertains to the template being used for reporting the data for
a recalc file with multiple datafiles.
c. Single_Compound: This category pertains to the template being used for reporting
the data for selected compound for the selected datafile.
d. Multiple_Compound: This category pertains to the template being used for reporting
the data for selected compound for all the datafiles of a recalc list.
25
Fig.: Saving the newly created template
12. Once the template is saved, it will appear in Existing Templates list below ‘Your Templates’.
13. Upon saving, the template properties at the lower most section of the Tool box panel will be
updated with the following details:
a. Category
b. Created date
c. Description
d. Modified date
e. Template Name
f. Template Path
14. Once all the required elements are placed in the template, there are some
settings/configurations to be done to get appropriate reports. The list of such
settings/configurations is given below.
Note: The Help text for each property and its options is available as the last section in Report
Configuration window. The section can be extended to read the text if long.
26
3.4.1.1 Settings/Configurations to be done for Tabular and Chart element properties prior to
generating the report:
Property
# Default value Description
name
1 Advanced False True/False depending upon the report requirement
Formatting This is ‘True’ if the column header formatting should
For Header override the default formatting.
2 DB Element Appropriate string is String that represents database relation of the
displayed element. This is set when the element is dropped in
the template canvas
3 Display Appropriate string is Name that is displayed
Name displayed
4 Filter By Enter appropriate Filtering property is applicable to each element in
value. tabular data (repeater and non-repeater data)
a. Filtering property is included into each element
property panel
b. The user needs to enter the value for the filtering
purpose
c. If filter is applied, then the report generated will
display data that pass the filter.
d. The charts will also be displayed for the data that
pass the filter.
e. For a given table with multiple columns, filter
property can be applied to any/all columns of the
table
5 NumericData Select the This property will enable to hide the negative values
Treatment appropriate option and/or zeros in the generated report
from the dropdown
6 Order By Asc Asc/Desc depending upon the report requirement
27
7 Order Priority None Select the appropriate option from the dropdown
The above two properties are used for
sorting of data in the report.
a. Sorting is applicable to tabular data (repeater
and non-repeater data)
b. Both ascending and descending type of sorting
is supported
c. Maximum of 3 levels of sorting are supported by
the add-in.
i. Primary
ii. Secondary
iii. Tertiary
d. The default value is ‘None’.
e. At a given instance, a value can be assigned to
only one of the element. This means, if Primary
sort is applied to ‘A’ element, the same sort
order cannot be assigned to element ‘B’
f. When sorting option is opted in the template, the
charts displayed in the report will also be
according to the sort option opted
8 Override False True/False depending upon the report requirement.
Default This property is set to ‘True’ if the template
Formatting formatting is to be overridden by Excel formatting
done by the user
9 Position Excel position of the cell
10 XPosition Numeric value corresponding to the Excel column
holding the data element
11 YPosition Numeric value corresponding to the Excel row
holding the data element.
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
TIC properties:
28
Default Description
# Node Property name
value
1 Advanced TIC Annotation True True/False depending upon the
Configuration filtering_Acquisition report requirement
segments
Annotation True True/False depending upon the
filtering_Integration report requirement
Events_Baselines
Background color White Select the appropriate color from
the palette
Number of plots 1 Select from the dropdown
Overlap window 1 Select from the dropdown
Peak Annotation True True/False depending upon the
filtering_Compound report requirement.
Name
Peak Annotation False True/False depending upon the
filtering_Compound report requirement.
Number
Default Description
# Node Property name
value
Peak Annotation True True/False depending upon the
filtering_Retention report requirement.
Time
Peak Annotation False True/False depending upon the
filtering_Scan Number report requirement.
2 Annotation Font Color Black Select the appropriate color from
Font Selection the palette
3 Basic TIC Peak Type Annotation False True/False depending upon the
Configurations filtering_Duplicates report requirement.
Peak Type Annotation True True/False depending upon the
filtering_Failed report requirement
Peak Type Annotation True True/False depending upon the
filtering_Identified report requirement
Peak Type Annotation True True/False depending upon the
filtering_Missing report requirement
Peak Type Annotation False True/False depending upon the
filtering_TIC’s report requirement
Peak Type Annotation False True/False depending upon the
filtering_Unknown report requirement
4 Graph Line Graph Line color Black Select the appropriate color from
the palette
5 Main Property Display Name Blank This is not editable by the user.
Last Row at Chart False True /False depending upon the
report requirement. This value can
be edited by the user.
29
Name This displays the name of the chart.
This is not editable by the user
Position This is not editable by the user
Preferred Height Vertical size of the window in
inches. This is not editable by the
user
Preferred Width Horizontal size of the window in
inches. This is not editable by the
user
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
30
XIC properties:
All or a few of the following properties will be present for all types of XIC’s, i.e.:
a. XIC
b. XIC Overlay
c. XIC IS
d. XIC IS Overlay
e. XIC Qualifier
f. XIC Qualifier IS
Default Description
# Node Property name
value
1 Advanced XIC Background color White Select the appropriate color from
Configuration the palette
Show Additional False True/False depending upon the
Details report requirement
2 Annotation Direction 0 Select from the dropdown
Font Selection
Effects: None
31
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
Calibration Curve:
Default Description
# Node Property name
value
1 Advanced Color Background White Select the appropriate color from
Calibration the palette
Curve
Color File markers Dark Select the appropriate color from
Blue the palette
Color outliers Red Select the appropriate color from
the palette
Color plot Dark Select the appropriate color from
Blue the palette
Color Replicates Navy Select the appropriate color from
the palette
Color Test Black Select the appropriate color from
the palette
Exec RSD Test False True/False depending upon the
report requirement
2 Main Property Last Row at Chart False True/False depending upon the
report requirement. This value can
be edited by the user.
Name This displays the name of the chart.
This is not editable by the user
Position This is not editable by the user
Preferred Height Vertical size of the window in
inches. This is not editable by the
user
Preferred Width Horizontal size of the window in
inches. This is not editable by the
user
32
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
Control Chart:
Default Description
# Node Property name
value
1 Advanced Background Color White Select the appropriate color from
Control Chart the palette
Configuration
2 Main Property Last Row at Chart False True/False depending upon the
report requirement. This value can
be edited by the user.
Name This displays the name of the chart.
This is not editable by the user
Position This is not editable by the user
Preferred Height Vertical size of the window in
inches. This is not editable by the
user
Preferred Width Horizontal size of the window in
inches. This is not editable by the
user
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
Spectrum:
All or a few of the following properties will be present for all types of Spectra, i.e.:
a. Spectrum
b. Spectrum Overlay.
c. Spectrum IS Overlay
d. Spectrum Diff
e. Spectrum Raw Sample
f. Spectrum Ref
33
Fig.: Spectrum properties
Default Description
# Node Property name
value
1 Advanced Font Color Black Select the appropriate color from
Font Selection the palette
2 Advance Background Color White Select the appropriate color from
Spectrum the palette
Configuration
Horizontal Axis Major Outside Select from the dropdown
Ticks Style
Horizontal Axis Minor 4 Select from the dropdown
Ticks Count
Horizontal Axis Minor Outside Select from the dropdown
Ticks Style
Peak Label Threshold 25 Select from the dropdown
4 Main Property Last Row at Chart False True/False depending upon the
report requirement. This value can
be edited by the user.
Name This displays the name of the chart.
This is not editable by the user
Position This is not editable by the user
34
Preferred Height Vertical size of the window in
inches. This is not editable by the
user
Preferred Width Horizontal size of the window in
inches. This is not editable by the
user
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
Note: The template configuration is saved in MS Access database. If user replaces the database with
blank database then, user defined templates will be lost
35
4.4.2 Create a template with Header, Repeater-Tabular and Repeater-Chart
elements:
Note:
1. A maximum of 3 levels can be achieved using Repeater super objects.
2. Do not add any Charts in Level 1. If added, they would not be displayed in the generated
report.
8. Once all the required elements are placed in the template, there are some
settings/configurations to be done to get appropriate reports. The list of such
settings/configurations is given below.
9. Upon configuring the levels and the super objects selected, save the template. By default it
would be saved with extension, ‘.xltx’
Note: The Help text for each property and its options is available as the last section in Report
Configuration window. The section can be extended to read the text if long.
36
3.4.2.1 Settings/Configurations to be done for Repeater-Tabular and Repeater-Chart element
properties prior to generating the report:
Property
# Default value Description
name
1 Chart Wrap False True/False depending upon the report requirement
This value is set to ‘True’ only when the charts of
similar type are to be displayed and are needed to be
wrapped
2 Condition Select appropriate This field sets the connection between two levels.
Field option from the For level 1, the value will be none.
dropdown
3 Data Select appropriate This field is used to determine rendering of data in
rendering option from the this level.
mode dropdown – Single
/ Multiple
4 Extra Rows at Enter appropriate The value in this field will be used to keep empty
Bottom integer value. rows after the table
5 Extra Rows at Enter appropriate The value in this field will be used to keep empty
Top integer value. rows before the table
6 Query Enter appropriate This property allows users to write a custom query to
Override value get the data as per choice. This will override
whatever query is generated by reporting engine
7 Show Table True True/False depending upon the report requirement.
If this value is false, the table will not be displayed in
the generated report.
8 Show Table True True/False depending upon the report requirement
Header If this value is false, the headers for the tabular data
will not be displayed in the generated report.
37
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
Property
# Default value Description
name
1 Advanced False True/False depending upon the report requirement
Formatting This is ‘True’ if the column header formatting should
For Header override the default formatting.
38
Property
# Default value Description
name
6 Level Name Appropriate string This is name of the configuration level to which this
is displayed. This data element belongs
property value
cannot be edited by
the user
7 NumericDataT Select the This property will enable to hide the negative values
reatment appropriate option and/or zeros in the generated report
from the dropdown
8 Order By Asc Asc/Desc depending upon the report requirement
9 Order Priority None Select the appropriate option from the dropdown
The above two properties are used for sorting of data
in the report.
a. Sorting is applicable to tabular data (repeater
and non-repeater data)
b. Both ascending and descending type of sorting
is supported
c. Maximum of 3 levels of sorting are supported by
the add-in.
iv. Primary
v. Secondary
vi. Tertiary
d. The default value is ‘None’.
e. At a given instance, a value can be assigned to
only one of the element. This means, if Primary
sort is applied to ‘A’ element, the same sort
order cannot be assigned to element ‘B’
f. When sorting option is opted in the template, the
charts displayed in the report will also be
according to the sort option opted
10 Override False True/False depending upon the report requirement.
Default This property is set to ‘True’ if the template
Formatting formatting is to be overridden by Excel formatting
done by the user
11 Position Excel position of the cell
12 XPosition Numeric value corresponding to the Excel column
holding the data element
13 YPosition Numeric value corresponding to the Excel row
holding the data element.
Note: For more information on the functionality of the property, please refer the Help text for each
property which is available as the last section in Report Configuration window. The section can be
extended to read the text if long.
For chart, the same settings as of non-repeater objects are applicable for repeater.
Note: The template configuration is saved in MS Access database. If user replaces the database with
blank database then, user defined templates will be lost
39
Chapter 5 Modify Template and Delete Template
Note: If the tabular super objects are manually moved or rows/columns inserted in the template, then
the X and Y position of the super object has to be edited manually by the user. If it is not edited, the
caption and value for the object will appear at the original location in the generated report.
7. Upon modification the user can save the template. Once the template is saved, the template
properties will reflect the modification date and time.
Note: The Bruker (factory) templates cannot be modified. The user has to save the template with
another name and then modify it.
40
5.2 Delete an Existing Template
1. Launch MS Excel and login to Bruker reporting tool
2. A blank template canvas will be displayed to the user.
3. Excel will also display the Tool box panel and the Report configuration panel.
4. In the tool box panel select the appropriate template for deletion in Existing Templates drop
down and then click on button ‘Delete’
5. A confirmation message is displayed to the user
6. Upon receiving confirmation; the template will be deleted from the database. An information
message will be displayed after successful deletion of the template.
Note: The Bruker (factory) templates cannot be deleted. If the user tries to do so an appropriate error
message will be displayed to the user.
41
Chapter 6 Generate Report
All reports for either the factory templates or user created templates can be generated via MS Data
Review > View Results > Reports > Excel Reports
To generate reports using MS Excel reporting tool, the files of .xms format
should be used. Report generation for .tmp files is not supported.
42
4. Reports for Factory templates and User Templates can be created using any of the above
mentioned 3 options.
5. Select Excel Report to View window will display the list of templates based on the type of
menu item selected and the Calibration Type set in Method file used to reprocess the recalc
list.
6. Following table explains what templates will be displayed for the two options:
43
Menu item → Show report using current data Show report using current recalc
Calibration file
Type
↓
ISTD method Select Excel Report to View window Select Excel Report to View window
will display the list of templates for: will display the list of templates
7. If no report is selected the button ‘Show Excel Report’ is disabled. It is enabled when a report
is selected.
Note: Only one report can be generated at a given instance with interactive reporting. For multiple
report generation at a given instance, the user has to opt for ‘Make reports using current method file’
44
8. On double clicking the report from the list or clicking ‘Show Excel Report’ button, the report is
generated and displayed in MS Excel
45
Fig.: Recent Report button in Select Excel Report to View
12. The Exit button on Select Excel Report to View will close the window.
46
6.3 Automatic report generation (Make report for the template
specified in the method)
1. Multiple reports at a given instance can be generated for selected data file, selected
compound or current recalc list using the option:
a. Make reports using current method file
2. In this, the templates can be specified in the method file and upon processing the recalc list
with this method file, the user can select to generate the reports for the templates specified in
the method file.
Following is the procedure to generate reports for templates specified in the method:
1. Launch Method Builder and open the appropriate method where the templates need to be
specified.
2. In method, navigate to SCION Mass Spec Control > Channel 1=MS Data > Standard MS
Reports > Excel Report Templates. The following UI will be seen:
47
c. Generation mode and location to save the generated reports.
4. The section Templates for Data Files will allow the user to select the templates for single data
file or delete the selected templates. It would also allow selecting a data file and previewing
the report for the selected data file similar to Interactive reporting. The buttons available for
these functions would be:
a. Select: Upon clicking this button, a window, ‘Select Report Templates’ is displayed
that lists the available templates. This list is displayed as per information mentioned in
5.2 Interactive reporting in MS ExcelInteractive reporting in MS Excel– Bullet 5. A Formatted: Font: Arial, 10 pt
maximum of 5 templates can be selected and listed.
b. Delete: If a selected template is to be removed, then click on the template to be
removed to select it and then click on Delete. The template would be removed
c. Select Data File for Preview: On clicking on this button, the user will be allowed to
navigate and select the data file for which the report is to be previewed via method
file. Once it is selected, the path and name of the data file will be displayed against
‘Data file’
d. Preview: After selecting the data file, when Preview button is clicked, the report will
be generated and displayed in MS Excel for the data file selected.
5. The section Templates for Recalc Files will allow the user to select the templates for multiple
data file of a recalc list or delete the selected templates. It would also allow selecting a recalc
file and previewing the report for the selected recalc file similar to Interactive reporting. The
buttons available for these functions would be:
a. Select: Upon clicking this button, a window, ‘Select Report Templates’ is displayed
that lists the available templates. This list is displayed as per information mentioned in
5.2 Interactive reporting in MS ExcelInteractive reporting in MS Excel – Bullet 5. A Formatted: Font: Arial, 10 pt
maximum of 5 templates can be selected and listed.
b. Delete: If a selected template is to be removed, then click on the template to be
removed to select it and then click on Delete. The template would be removed
c. Select Recalc File for Preview: On clicking on this button, the user will be allowed to
navigate and select the recalc file for which the report is to be previewed via method
file. Once it is selected, the path and name of the recalc file will be displayed against
‘Recalc file’
d. Preview: After selecting the recalc file, when Preview button is clicked, the report will
be generated and displayed in MS Excel for the recalc file selected.
6. Generation mode and location to save the generated reports following options are available
a. Generate reports during processing: When this option is selected, the reports will
be generated immediately after the recalc file is processed with the method file. The
reports will be generated and saved at the pre-configured location.
Note: If this option is selected, then while processing the recalc file in Process View, the user has to
select the option ‘Make Reports’. If Make Reports is not selected, then no reports would be generated
and saved at the pre-configured location.
b. Prepare during processing: When this option is selected, the data for the reports
will be extracted and stored in the database after the recalc file is processed with the
method file. However, no reports will be generated and stored at the pre-configured
location.
c. Save reports to location of data or recalc file: When this option is selected, the
generated reports will be stored at the location where the data or recalc file is
present.
d. If another location is to be specified, uncheck the option, ‘Save reports to location of
data or recalc file’ and then click on ‘Select Path’ button to select the required
location.
48
e. A drop down is available with two options; XLSX and PDF. This option is used to
specify the format in which the reports should be generated and saved.
f. Defaults: Press this button to load this dialog with the factory default parameters.
g. Restore: Push this button to restore the current set of parameters to their values prior
to the last method save operation.
7. Once the templates are specified for data and recalc files, the storage location is configured;
save the method and reprocess the recalc file using this method.
8. In MS Data Review > Process View > Processing Rules, select the option, Make Reports’ and
click on Process.
49
Fig.: Method file and recalc file selected for processing. Make Reports option is also selected
in processing rules.
9. After the data files are processed, the generation of report will start and the status of report
generation will be displayed in Process View.
Fig.: Reports are generated at the end of the processing action when ‘Generate during
processing’ option is selected in method file.
50
10. The reports will be stored at the location in respective folders of the template name. This
means, at the specified location, a folder for each specified template will be created and the
individual reports will be saved inside the respective folders.
11. The user can navigate to the location and check the reports.
12. The name of the report folder and reports generated will be in the following format
a. Report Folder: <template name>
b. Report name:
i. For Multiple and Multiple compound report: <template name>_<recalc file
name>_< Date(yyyy-mm-dd)>_<Time(hr-mins-secs-miliseconnds)>
ii. For Single and Single compound report: <template name>_<data file name
>_< Date(yyyy-mm-dd)>_<Time(hr-mins-secs-miliseconnds)>
13. In method file if the option ‘Prepare during processing’ is selected, then upon processing the
recalc list, the data is extracted and stored in the database. The user then has to navigate to
Results View > Reports > Excel Reports > Make reports using current method file
14. A window is displayed with details for:
a. The templates for which the reports are to be generated
b. Recalc file location and name
c. Data files location and name
d. Status of report generation
e. Storage location for reports.
f. Output type : XLSX or PDF
g. Buttons to trigger the report generation and Exit
Fig.: Make reports using current method file – Details of the reports and the storage location is
displayed in the window
51
15. Click on Generate Excel Reports button to start the report generation.
Note: Once Generate Excel Reports button is pushed and report generation starts, the user is not
allowed to perform another action in MS Data Review.
16. The status of report generation will be displayed in ‘Reports’ section. On completion of
generating reports, the button Exit will be enabled.
17. The user can navigate to the location and check the reports.
18. The reports will be stored at the location in respective folders of the template name. This
means; a folder for each specified template will be created at the specified location and the
individual reports will be saved inside the respective folders.
52
6.3.2 Protection of report generated in MS Excel format.
The generated reports in MS Excel can be protected so that it cannot be modified by the user. This
can be achieved using in-built MS Excel functionality.
4. A pop-up window will be displayed. By default the options, ‘Select locked cells’ and ‘Select
unlocked cells’ will be selected and no password is assigned. The user can assign a
password to protect the sheet.
5. Click on OK. Another pop-up window is displayed where the user has to re-enter the
password and click on OK
6. The sheet is protected and no changes such as adding/deleting rows and columns, formatting
cells etc are allowed to be done. If the user tries to modify the report, following message is
displayed to the user:
53
Fig.: Error message displayed when user tries to modify a protected worksheet.
8. The user needs to enter the password when unprotecting the sheet if a password is set during
protecting the sheet.
9. Protection can be applied for various activities such as formatting, adding/deleting rows and
columns etc.
Following are the levels of protection that can be assigned to the generated report:
In the protect sheet dialog box, various permissions can be assigned while protecting the sheet.
1. Select Locked cells and Select Unlocked cells options if selected, the worksheet will be
completely protected and no changes will be allowed
2. Format cells, Format columns, Format rows options if selected, the user will be allowed to
apply formatting to cells, columns and rows
3. Insert rows, Insert columns options if selected, the user will be allowed to insert rows and
columns in the protected report
4. Delete rows, Delete columns options if selected, the user will be allowed to delete rows and
columns in the protected report
5. Sort option if selected, the user will be allowed to use the MS Excel functionality of Sort.
Note: It would be responsibility of lab in-charge to set the workbook with desired protection level.
54
Chapter 7 Import-Export utility
The Import Export utility is provided with the tool to enable the user to import templates to the
database and export templates from the database.
The utility can be launched by double clicking on ‘ImportExportUtility.exe’. The UI will be the following:
55
The utility will display the following:
1. Factory Template Folder: Default path will be displayed. The user can Browse to the required
location
2. User Template Folder: Default path will be displayed. The user can Browse to the required
location
3. Backup Folder: Default path will be displayed. The user can Browse to the required location
4. Template Available In Database: The template list will be displayed, the list will contain the
factory templates and the user templates
5. Template Available in Backup: The templates that are available to be imported from the
Backup folder will be listed here.
6. Following 3 functional buttons:
a. Export: Selecting single/multiple templates in ‘Template Available In Database’ list
and clicking on Export button will export the templates to the configured Backup
folder
b. Import: Selecting single/multiple templates in ‘Template Available In Backup’ list and
clicking on Import button will import the templates to database.
c. Refresh: Clicking on Refresh button will refresh the contents.
56
7.1 How to use Import Export Utility
Import Export utility enables the user to create templates on 1 machine and then import these new
templates to another machine. The utility is helpful to perform both – Import and Export of templates
The User templates created on a different machine can be imported to the database of another
machine.
1. Create a new template or save a factory template with a new name at the required location.
2. Once the template is saved in the user required location, it is also simultaneously saved at
location:
C:\BrukerWS\Reporting\Backup
3. In the Backup folder, along with the template an xml file is also generated and saved.
Fig.: Template and xml created in Backup folder when new template is created.
Note: When a template is created or modified and saved in user required folder, its backup would
always be saved in the backup folder located at:
<Installation Directory>\BrukerWS\Reporting\Backup
4. While importing, the Backup folder should contain the template in ‘.xltx’ format along with the
xml file.
5. Launch the Import Export utility by double clicking the ‘ImportExportUtility.exe’ located at,
<Installation directory>\BrukerWS\ImportExportUtility
6. Browse to the Backup folder if required. The templates in Backup folder will be listed in
‘Template Available In Backup’
7. Select one or multiple templates and click ‘Import’ button.
57
8. The templates are imported to the database and will be displayed in ‘Template Available In
Database’ list
9. While importing if any of the template name is similar to already existing template name, then
following confirmation is displayed to the user.
Fig.: Confirmation message when importing template name is similar to already existing
template name.
10. If the user clicks on Yes, the template is overwritten. If the user clicks No, the import does not
take place.
11. While importing if any of the template name is similar to a factory template name, then
following error is displayed and import is not allowed.
58
Fig.: Error message when importing template name is similar to Factory template name.
The User templates and/or Factory templates can be exported to a folder which can be then imported
to the database on another machine.
1. Launch the Import Export utility by double clicking the ‘ImportExportUtility.exe’ located at,
<Installation directory>\BrukerWS\ImportExportUtility
2. Browse to the Factory Templates and User Templates folder if required.
3. Browse to the location where the exported templates need to be saved. By default, the path of
the Backup folder will be displayed.
4. Select one or multiple templates from ‘Template Available In Database’ list and click ‘Export’
button
59
Fig.: Templates from Database selected for Export.
5. The templates are exported from the database and will be displayed in ‘Template Available In
Backup’ list. The exported templates and their corresponding xml files will be stored at the
configured location.
6. While exporting if any of the template names is similar to already exported template name,
then following confirmation is displayed to the user.
60
Fig.: After export, the templates and xml files are stored at the preconfigured location
7. If the user clicks on Yes, the template is overwritten. If the user clicks No, the export does not
take place.
61
Fig.: Confirmation message when exporting template name is similar to already exported
template name.
62
7.2 Delete functionality supported in Import Export Utility
Import Export utility allows to delete the user template/s from the database and/or Backup folder.
Fig.: Delete menu is displayed on right clicking the selected templates in Templates Available
in Backup list
63
Fig.: Confirmation message when deleting template from Backup folder.
6. If the user clicks on Yes, the templates are deleted. If the user clicks No, the delete does not
take place.
7. Upon selecting Yes, the xml and the .xltx templates are deleted from the configured backup
folder.
64
7.2.2 Delete templates in User Templates folder
Fig.: Delete menu is displayed on right clicking the selected templates in Templates Available
in Database list
65
Fig.: Confirmation message when deleting template from User Template folder.
6. If the user clicks on Yes, the templates are deleted. If the user clicks No, the delete does not
take place.
7. Upon selecting Yes, the .xltx templates are deleted from the configured user template folder.
Note: The delete functionality can be used for User Templates only. The factory templates cannot be
deleted or overwritten using the Import Export utility.
8. If a Factory template is selected from ‘Template Available In Database’ list for deletion,
following error will be displayed and deletion of factory template will not take place.
66
Fig.: Error message displayed when factory template is selected for deletion.
67
Chapter 8 Factory templates available with the tool
Analysis and
ESTD_ByTargetCompound ESTD Multiple
Baseline
All Sample
ESTD_Sample ESTD Single
types
All Sample
ESTD_Sample_NotDetected ESTD Single
types
All Sample
ISTD_ByCompoundGroup ISTD Multiple
types
Analysis and
ISTD_ByTargetCompound ISTD Multiple
Baseline
All Sample
ISTD_CompactByCompound ISTD Multiple
types
ISTD_FilterBySampleAmount_Single
ISTD Analysis Multiple
Plot
All Sample
ISTD_NotDetectedByCompound ISTD Multiple
types
All Sample
ISTD_ResultsByCompound ISTD Multiple
types
All Sample
ISTD_ResultsSummary ISTD Multiple
types
All Sample
ISTD_Sample ISTD Single
types
All Sample
ISTD_Sample_Compact ISTD Single
types
All Sample
ISTD_Sample_CondensedQualifier ISTD Single
types
All Sample
ISTD_Sample_NotDetected ISTD Single
types
ISTD_Sample_ResultsQualifierRatio All Sample
ISTD Single
s types
ESTD and All Sample
LIMSExport_Full Multiple
ISTD types
ESTD and
Outlier_Accuracy Calibration Multiple
ISTD
ESTD and
Outlier_Accuracy_SinglePlot Calibration Multiple
ISTD
68
TemplateName Method Sample Type Report category
ESTD and
Outlier_BlankConcentration Blank Multiple
ISTD
Outlier_BlankConcentration_SinglePlo ESTD and
Blank Multiple
t ISTD
Calibration,
ESTD and
Outlier_CalibrationLimitOfDetection Analysis and Multiple
ISTD
Verification
Calibration,
Outlier_CalibrationLimitOfDetection_Si ESTD and
Analysis and Multiple
nglePlot ISTD
Verification
ESTD and
Outlier_CalibrationRange Analysis Multiple
ISTD
ESTD and
Outlier_CalibrationRange_SinglePlot Analysis Multiple
ISTD
ESTD and
Outlier_QC Verification Multiple
ISTD
ESTD and
Outlier_QC_SinglePlot Verification Multiple
ISTD
ESTD and
Outlier_QCRelativeStandardDeviation Verification Multiple
ISTD
69
TemplateName Method Sample Type Report category
ESTD and
WS_Calibration_Curves Calibration Multiple
ISTD
ESTD and All Sample
WS_ControlChart Multiple
ISTD types
ESTD and All Sample
WS_ResultsList Multiple
ISTD types
ESTD and All Sample
WS_Sample Single
ISTD types
ESTD and All Sample
WS_Sample_ByTargetCompound Single_Compound
ISTD types
70
Chapter 9 Trouble Shooting
Sr.
Problem observed Trouble shoot
No.
1 Overlapping charts in the In case different charts should be placed adjacent to
generated report each other, they should be placed in such a way that
they do not fall in the same column. If they do, the
generated report will display overlapped charts
2 Report saved in PDF format do When reports are saved as PDF, the spectrum is not
not display the spectrum displayed properly. It is recommended to print the
appropriately report in PDF format using a PDF printer
3 In template designed, the user Save the user created templates with extension .xlt.
created templates are not listed If it is saved as .xlsx, they would not be listed in Your
in Existing Template >Your Templates section.
Templates
4 When “Make Reports for current The complete report could not be rendered due to
method file” is used, report for limitation of resources. Try to generate reports using
recalc file is not generated and less number of data files in a recalc file
saved at configured location
5 WS_ControlChart contains Check the report configuration in method file >
wrong charts or the report does Scion Mass Spec > Channel=1 MS Data >
not contain any charts Summary Report Format > Control Charts
71
Sr.
Problem observed Trouble shoot
No.
6 The system crashes while The probable reason could be due to the underlying
generating an Excel report technologies used by Reporting Tool that have
limitations on their usage. E.g.:
• Excel consumes certain GDI objects for every
image displayed on the generated report. If the
number of images to be displayed is large, then
the GDI count also grows to a point where it
cannot be supported by Excel process
72
Chapter 10 Limitations and specifications for MS Access and MS
Excel
Sr.
Feature Maximum Limit
No.
1 Open workbooks Limited by available memory and system
resources
2 Worksheet size 1,048,576 rows by 16,384 columns
3 Column width 255 characters
4 Row height 409 points
5 Page breaks 1,026 horizontal and vertical
6 Total number of characters that a cell 32,767 characters
can contain
7 Characters in a header or footer 255
8 Sheets in a workbook Limited by available memory (default is 3
sheets)
9 Colors in a workbook 16 million colors (32 bit with full access to 24
bit color spectrum)
10 Named views in a workbook Limited by available memory
11 Unique cell formats/cell styles 64,000
12 Fill styles 256
13 Line weight and styles 256
14 Unique font types 1,024 global fonts available for use; 512 per
workbook
15 Number formats in a workbook Between 200 and 250, depending on the
language version of Excel that you have
installed
16 Names in a workbook Limited by available memory
17 Windows in a workbook Limited by available memory
18 Panes in a window 4
19 Linked sheets Limited by available memory
20 Scenarios Limited by available memory; a summary
report shows only the first 251 scenarios
21 Changing cells in a scenario 32
22 Adjustable cells in Solver 200
73
Sr.
Feature Maximum Limit
No.
23 Custom functions Limited by available memory
24 Zoom range 10 percent to 400 percent
25 Reports Limited by available memory
26 Sort references 64 in a single sort; unlimited when using
sequential sorts
27 Undo levels 100
28 Fields in a data form 32
29 Workbook parameters 255 parameters per workbook
30 Items displayed in filter drop-down 10,000
lists
31 Noncontiguous cells that can be 2,147,483,648 cells
selected
Sr.
Feature Maximum Limit
No.
1 Number precision 15 digits
2 Smallest allowed negative number -2.2251E-308
3 Smallest allowed positive number 2.2251E-308
4 Largest allowed positive number 9.99999999999999E+307
5 Largest allowed negative number -9.99999999999999E+307
6 Largest allowed positive number via 1.7976931348623158e+308
formula
7 Largest allowed negative number via -1.7976931348623158e+308
formula
8 Length of formula contents 8,192 characters
9 Internal length of formula 16,384 bytes
10 Iterations 32,767
11 Worksheet arrays Limited by available memory
12 Selected ranges 2,048
13 Arguments in a function 255
14 Nested levels of functions 64
15 User defined function categories 255
16 Number of available worksheet 341
functions
17 Size of the operand stack 1,024
74
Sr.
Feature Maximum Limit
No.
18 Cross-worksheet dependency 64,000 worksheets that can refer to other
sheets
19 Cross-worksheet array formula Limited by available memory
dependency
20 Area dependency Limited by available memory
21 Area dependency per worksheet Limited by available memory
22 Dependency on a single cell 4 billion formulas that can depend on a single
cell
23 Linked cell content length from closed 32,767
workbooks
24 Earliest date allowed for calculation January 1, 1900 (January 1, 1904, if 1904 date
system is used)
25 Latest date allowed for calculation December 31, 9999
26 Largest amount of time that can be 9999:59:59
entered
Sr.
Feature Maximum Limit
No.
1 Charts linked to a worksheet Limited by available memory
2 Worksheets referred to by a chart 255
3 Data series in one chart 255
4 Data points in a data series for 2-D Limited by available memory
charts
5 Data points in a data series for 3-D Limited by available memory
charts
6 Data points for all data series in one Limited by available memory
chart
75
10.2 MS Access Database specifications and limits
The following list of tables applies to Microsoft Access 2010 and Access 2007 databases. More
details can be obtained from:
http://office.microsoft.com/en-us/access-help/access-2010-specifications-HA010341462.aspx
10.2.1 General
Sr.
Attribute Maximum
No.
1 Total size for an Access 2010 2 gigabytes, minus the space needed for
database (.accdb), including all system objects.
database objects and data
2 Total number of objects in a database 32,768
3 Number of modules (including forms 1,000
and reports that have the HasModule
property set to True)
4 Number of characters in an object 64
name
5 Number of characters in a password 14
6 Number of characters in a user name 20
or group name
7 Number of concurrent users 255
10.2.2 Table
Sr.
Attribute Maximum
No.
1 Number of characters in a table name 64
2 Number of characters in a field name 64
3 Number of fields in a table 255
4 Number of open tables 2,048 including linked tables and the tables
opened internally by Access
5 Table size 2 gigabyte minus the space needed for the
system objects
6 Number of characters in a Text field 255
7 Number of characters in a Memo field 65,535 when entering data through the user
interface;
1 gigabyte of character storage when entering
data programmatically
8 Size of an OLE Object field 1 gigabyte
9 Number of indexes in a table 32 including indexes created internally to
maintain table relationships, single-field and
composite indexes.
76
Sr.
Attribute Maximum
No.
10 Number of fields in an index or 10
primary key
11 Number of characters in a validation 255
message
12 Number of characters in a validation 2,048
rule including punctuations and
operators
13 Number of characters in a field or 255
table description
14 Number of characters in a record 4,000
(excluding Memo and OLE Object
fields) when the
UnicodeCompression property of the
fields is set to Yes
15 Number of characters in a field 255
property setting
10.2.3 Query
Sr.
Attribute Maximum
No.
1 Number of enforced relationships 32 per table, minus the number of indexes that
are on the table for fields or combinations of
fields that are not involved in relationships*
2 Number of tables in a query 32*
3 Number of joins in a query 16*
4 Number of fields in a recordset 255
5 Recordset size 1 gigabyte
6 Sort limit 255 characters in one or more fields
7 Number of levels of nested queries 50*
8 Number of characters in a cell in the 1,024
query design grid
9 Number of characters for a parameter 255
in a parameter query
10 Number of AND operators in a 99*
WHERE or HAVING clause
11 Number of characters in an SQL Approximately 64,000*
statement
*Maximum values might be lower if the query includes multivalued lookup fields.
77