Create an assay report template

Click Add in the Assay Report Template Manager to create a new template. The template wizard opens.

Tip: Most pages of the wizard offer additional options via a right-click context menu.

1. Configure Assay Report information

   

   Enter a name for the template, and a title for any report generated using the template.

   Click , or double-click in the Choose information fields list, to add an item to the list of the information fields included in the template. Choose the information field from the list in the

   Information Field column. The Label field is updated to reflect your choice of information field. To overwrite the default label for the information field, double-click in the Label field and enter a new label.

   Click to delete the selected information fields. Click or to change the position of the selected information fields in the list.

   When you have configured all necessary generic report information, press the Next > button.

2. Add assay report cuts

   

   On the second page of the wizard, you must choose the cuts that you would like to be present in any assay report generated using the template.

   By default, the template is configured to use perfect cuts. You can make flowsheet cuts available in the template, provided that you have one or more flowsheets available in the Flowsheet Manager, by selecting the name of the flowsheet from the Allow Products From the Following Flowsheet drop down list. Note that perfect cuts continue to be available upon electing to use flowsheet cuts, thereby enabling you to add a mixture of both flowsheet and perfect cuts to the template. See Create a flowsheet.

   To add a new cut, double click below the current list of items in any of the three columns. A new row will appear, which allows you to enter the product name, its type, and relevant IVT and FVT values, as described in the following table.

   Field	Description
   Name	A descriptive name for the cut.
   Type	The type of the cut. By default, all cuts are perfect. Flowsheet cuts are available if a flowsheet is in use in the template.
   IVT	The initial vapour temperature of the cut. To indicate that a cut is a condensate cut, you can enter the value IBP (initial boiling point) in this field.
   FVT	The final vapour temperature of the cut. To indicate that a cut is a residue cut, you can enter the value FBP (final boiling point) in this field.

   Double-clicking on any white cell in a cut row allows you to type a new value into it. When configuring a cut, any invalid values will be shown in red, and will need to be corrected before you can continue through the wizard.

   To configure a perfect cut, double-click in the Type field and select Perfect from the drop down list. To configure a flowsheet cut, select the name of the flowsheet product from the list instead. Note that flowsheet cuts will only be available if you have previously chosen to make a flowsheet available for use in the template.

   To change the temperature unit of your specified cut points, double click on either the IVT or FVT column header. Choose between C, F, K and R from the temperature unit drop down box. Press Yes when asked if you would like to convert the entered values to the new unit if you would like your entered vapour temperatures to be converted to your new temperature unit, or No to leave them as is.

   Once a temperature unit has been selected, the temperature unit of the other vapour temperature column will be adjusted automatically.

   When you have configured the cuts to be present in your Assay Report template, press the Next> button to continue.

3. Choose properties

   

   On the next page of the wizard you need to choose which properties will be present in any Assay Report generated using the template.

   To add a new property, double click below the current list of items in any of the three columns. A new row will appear, which allows you to enter the name of the property, the property itself and the property units, as described in the following table:

   Field	Description
   Name	A descriptive name for the property.
   Property	The property itself, which may be selected using a Property Control.
   Unit	The unit you would like this property value to be reported in. By default, the unit for a property is automatically set when the property is selected using the Property Control.

   Double-clicking on any white cell in a property row allows you to type a new value into it.

   When you have completed this page, press the Next> button to continue.

4. Select Layout Type

   

   In the next page of the wizard, you need to select the layout of the report. Three options are available:

   • Information section followed by cut sections: An output report based on the template will display the default Information section followed by a series of Property sections, one for each property configured in the template. Each Property section will show values for the property, for each of the cuts configured in the template.

   • Information section followed by property sections: An output report based on the template will display the default Information section followed by a series of Cut sections, one for each cut configured in the template. Each Cut section will show values for the cut, for each of the properties configured in the template.

   • Custom: An output report based on the template that will display some combination of Information, Property and Cut sections, as determined in the template by the remaining steps of the Assay Report Template wizard.

     Once you have selected the report layout of your choice, click Next> to continue. If you have selected either the Information section followed by cut sections or the Information section followed by property sections options, it remains only to review a summary of the report template. Otherwise, the various sections comprising the report need to be verified individually. See Review Summary Page below.

5. If using a custom layout, then create Report sections

   

   If you have elected to use a custom layout, you will need to configure the sections appearing in any report based on the template. By default, the list of sections present in the template is populated with the Information section you configured on the Information page of the wizard, followed by each of the cut sections configured on the Cuts page of the wizard. However, you are free to modify the default sections layout of the template using the section management functions of the Sections page of the wizard, as described below. See Add Assay Report cuts and Configure Assay Report information above.

   Managing Sections

   To add a section to the list of sections present in the template, press the button and select to add either an information, property or cut section from the drop down list. A section of your choice will be added to the list of sections comprising the report template.

   To edit an existing section in the list of sections to be present in the report, double-click in the Section Type column of the section you wish to edit. Modify the type using the drop down list. The title of the section will automatically be updated to reflect your selection. To overwrite the default section title, double-click in the Section Title field and enter a new section title.

   To remove an existing section from the list of sections in the template, select the section in the list and press the button. The selected section is deleted from the list. To rearrange the order of the sections as they will appear in any report based on the template, select a section in the list and press the button to move the selected section up one place in the list, and the button to move the section one place down in the list. Note that the order of the sections in the list will be exactly reflected in any Assay Report output using the template.

   When you have configured the layout of the sections in the template, press the Next> button to continue. Note that the order in which sections are presented for configuration in the remaining steps of the wizard will match the order in which sections are present in your section layout. For example, if your template is laid out with an information section, a cut section, a property section, and another information section, then the order in which the sections will be presented for configuration in the remaining steps of the wizard will be information section, cut section, property section, and then information section again. For this reason, in the remaining steps of the wizard you would not generally expect to edit all the Information sections first, then all the Cut sections, then all the property sections, although this is the order in which the remaining steps of the wizard are presented below.

6. Configure Information sections

   

   If you have elected to use a custom layout, you will need to configure the Information sections that will appear in any report based on the template. You can do this using the section management functions of the Information Section page of the wizard.

   Managing Sections

   To add an Information field to the list of Information fields present in the section, press the button and elect to add either a single information field, or all information fields. The field or fields of your choice will be added to the list of fields comprising the section.

   To edit an existing field in the list of information fields comprising the Information section, double click on the field in the Information section layout and select a new field from the combo box. Only fields listed in your default Information section configuration can be added to the section.

   To remove an existing information field from the list of fields present in the Information section, select the field in the list and press the button. The selected field is deleted from the list of fields comprising the section.

   To rearrange the order of the information fields as they will appear in the section, select a field in the list and press the button to move the selected field up one place in the list, and the button to move the field one place down in the list.

   When you have configured the layout of the Information section press the Next> button to continue.

7. Configure Property sections

   

   If you have elected to use a custom layout, you will need to configure the Property sections that will appear in any report based on the template. You can do this using the section management functions of the Property Section page of the wizard.

   Managing Sections

   To add a cut field or cut fields to the list of fields present in the Property section, press the button and elect to add either a single cut field, or all cut fields. The field or fields of your choice will be added to the list of fields comprising the section.

   To add an information field or information fields to the list of fields present in the Property section, press the button and elect to add either a single information field, or all information fields. The field or fields of your choice will be added to the list of fields comprising the section.

   To edit an existing field in the list of fields comprising the Property section, double-click on the field in the Property section layout and select a new field from the combo box. If the field being edited is an information field, only fields listed in your default Information section configuration can be added to the section. If the field being edited is a cut field, only fields listed in your default Cut section configuration can be added to the section.

   To remove an existing field from the list of fields present in the Property section, select the field in the list and press the button. The selected field is deleted from the list of fields comprising the section.

   To rearrange the order of the fields as they will appear in the Property section of any report based on the template, click the button to move the selected field up one place in the list, and the button to move the field one place down in the list.

   When you have configured the layout of the Property section press the Next> button to continue.

8. Configure Cut sections

   

   If you have elected to use a custom layout, you will need to configure the Cut sections that will appear in any report based on the template. You can do this using the section management functions of the Cut Section pages of the wizard.

   Managing Sections

   To add a property field or property fields to the list of fields present in the Cut section, press the button and elect to add either a single property field, or all property fields. The field or fields of your choice will be added to the list of fields comprising the section.

   To add an information field or information fields to the list of fields present in the Property section, press the button and elect to add either a single information field, or all information fields. The field or fields of your choice will be added to the list of fields comprising the section.

   To edit an existing field in the list of fields comprising the Cut section, double-click on the field in the Cut section layout and select a new field from the combo box. If the field being edited is an information field, only fields listed in your default Information section configuration can be added to the section. If the field being edited is a property field, only fields listed in your default selection of Properties can be added to the section.

   To remove an existing field from the list of fields present in the Cut section, select the field in the list and press the button. The selected field is deleted from the list of fields comprising the section.

   To rearrange the order of the fields as they will appear in the Cut section outton to move the field one place down in the list.f any report based on the template, select a field in the list and press the button to move the selected field up one place in the list, and the b

   When you have configured the layout of the Cut section press the Next> button to continue.

9. Review Summary Page

   

   This final page of the wizard allows you to review the layout of the template. If you are dissatisfied with the template layout, you have the opportunity at this point to press the <Back button to make modifications to the template. Alternatively, you can press Cancel at this point to quit the wizard altogether and return to the Assay Report Template Manager.

   Once you are satisfied with the layout of the template, press the Blue book report button to close the wizard and return to the Assay Report Template Manager proper. The new or edited template will be seen in the Template Manager list, and be available for report generation via the View Report > Assay Report Template menu, where it will be listed below the standard Assay Report template(s). See Blue book report.