A number of component settings are available for each layout component of an invoice/credit note or payslip format to allow the size, position, formatting and other characteristic of the component to be defined and edited.
The component settings can be viewed and modified by clicking on a component within the components list in the Component List and Property Grid pane or by clicking on the component on the layout, as highlighted in the example below.
Once the relevant component is selected, click Component Settings within the Component List and Property Grid pane to display the component settings for the component you have selected, as shown in the example below.
The table below lists and describes the settings that are available for each type of component.
...
Setting
...
Applies to which Component Types?
...
Sub Setting
...
Description
...
Options Available
...
Display
...
All
...
Location X
...
Defines the X coordinate that specifies the position of the component.
...
A numeric value can be keyed in.
...
...
...
Location Y
...
Defines the Y coordinate that specifies the position of the component.
...
A numeric value can be keyed in.
...
...
...
Width
...
Defines the width of the component, in millimetres.
...
A numeric value can be keyed in.
...
...
...
Height
...
Defines the width of the component, in millimetres.
...
A numeric value can be keyed in.
...
...
...
Display Option
...
Where a payslip is printed over multiple pages, this setting determines if the component appears on each page, on the last page only or on all pages except the last page.
Picklist containing the following options:
...
Border
...
All except the following:
Logo Remittance Line
...
Border Line Colour
...
Colour of the border that displays around the component.
...
List of system-defined colours.
...
...
...
Border Line Style
...
Style of the line used to render the border around the component.
...
List of the following system-defined options:
None Dash DashDot
DashDotDot Dot
Solid
...
...
...
Border Line Thickness
...
Thickness of the lined used to render the border around the component.
...
List of the following system-defined options:
Thinnest Thinner Thin Thick Thicker Thickest
...
...
...
Show Border
...
Determines if a border is displayed around the component.
...
Checkbox
...
Header
...
All except the following:
Logo Remittance Line
...
Header Size
...
Defines the height of the header on the component, in millimetres. For example, where a component is a table of items, the header contains the column headings.
...
A numeric value can be keyed in.
...
...
...
Show Header
...
Determines if the component displays a header.
...
Checkbox
...
Labels
...
Heading
...
Tax Invoice/Payslip Label
...
Text that is to be displayed at the top of an invoice/credit note (for example: Tax Invoice).
...
A string of text can be keyed in.
...
Rows/Columns
...
All except the following:
Logo Remittance Line
...
Edit Columns
...
Displays the Document Designer Table Properties screen, thereby allowing a list of items to be added to the component.
For more information, see Table Properties.
...
Button
...
...
Invoice Items
...
Display Rounding Line
...
This option is available in v11.22 onwards.
If selected, a rounding difference line is displayed at the bottom of the Invoice Items table. If a column in the table is configured to display a total within the Invoice Totals component, the rounding line shows the rounding differenc e between the sum of the values in the column and the corresponding total shown within the Invoice Totals component.
...
...
...
...
Rounding Line Label
...
Literal text that is to appear as a label against the rounding line.
This field is available only if the Display Rounding Line op tion is enabled.
...
A string of text can be keyed in.
...
...
Sub-group Totals
...
Invoice Items
...
Include a Sub Totals Row
...
If selected, sub-totals will be displayed within the following columns of Invoice Items table, if they are included in the document format:
Quantity Pay Total Margin Oncosts Tax
Total Charge
...
Checkbox - defaults
to the deselected state.
...
...
...
...
Group Sub Totals By
...
Determines how invoice/credit items are to be sub-totalled.
For example, if the Item Date option is selected, a sub-total will be displayed for all invoice/credit items that have the same item date.
...
Picklist
...
...
Image
...
Logo
...
Image
...
Displays the filename of the image displayed within the component.
...
Displayed by the system.
...
...
...
...
Add
...
Allows the user to browse to a file location where the required image file is located.
...
Button
...
...
...
...
Use Pay Company Logo
...
If selected, sets the image file stored against the Payslip Logo field on Pay Company record as the image displayed with in the component.
...
Checkbox – defaults to deselected state.
...
...
Line
...
Remittance Line
...
Line Colour
...
Sets the colour of the line component.
...
List of system-defined colours.
...
...
...
...
Line Style
...
Sets the type of line for the selected component
...
Picklist displays the options of:
None Dash DashDot
Dash Dot Dot Dot
Solid (default)
...
...
...
...
Line Thickness
...
Sets the thickness of the line component.
...
List that displays the options of:
Thinnest (default) Thinner
Thin Thick Thicker Thickest
...
...
...
...
Orientation
...
Sets the orientation of the line.
...
List that displays the options of:
Vertical
Horizontal (default)
...
...
Layout components that are part of a document format, with the exception of Logo and Remittance Line components, are essentially tables consisting of a number of cells. Each cell may contain the following:
a text label such as a column header or any other literal text
a data item (database field) or a group of data items that display values stored in the database.
The example below shows invoice items that have been formatted into a table format. In this example the table has been formatted to display column headers, where the text displayed inside each column header is literal text. The values within each subsequent row of the table are populated with data items.
Table properties are available for each component of a layout that is based on a table. The table properties define attributes such as the following:
the contents of each cell (e.g. literal text or data items)
formatting of the cell contents (e.g. font face, font size, font colours, background colours, text wrapping)
display of grid lines.
Table properties are viewed and modified via the Document Format Table Properties screen. To display the Document Format Table Properties screen, in the Component List and Property Grid pane, select Component Settings > Rows/Columns and click I as shown in the example below.
The table below lists and describes the options available on the Document Format Table Properties screen for managing the table properties of a layout component.
...
Field
...
Description
...
Item List
...
Lists the literal text labels and data items that appear in the table.
...
Name
...
Name of the text label or data item.
...
Format
...
...
Order By
...
If the item selected in the item list represents a column header (column header text), this field allows the sort order of the column to be defined.
For example, if set to Order By 1 the values displayed within the corresponding column will form the primary sorting criteria for items listed in the table.
This option is available only for the Invoice Items component for invoice formats only and lists the following options:
None Order By 1
Order By 2
Order By 3
Order By 4
...
Supress When Duplicated
...
If ticked, the item is displayed once the first time it occurs within the table and is not repeated against each row to which it corresponds.
...
Visible
...
If ticked, the selected item is visible when a document based on this format is generated.
...
Height
...
Specifies the height, in millimetres, of the table cell within which the item is displayed.
...
Wrap Text
...
If ticked, the text within the cell in which the item is displayed wraps onto the next line if it does not fit within the width of the cell. Otherwise, text may extend passed the boundary of the cell.
...
Grid
...
...
Grid Line Colour
...
Determines the colour of the grid lines that define the boundaries of the cell in which the item appears.
...
Grid Line Style
...
Determines the type of lines used for the grid lines that define the boundaries of the cell in which the item appears. Lists the following options:
None Dash DashDot
Dash Dot Dot Dot
Solid (default)
...
Grid Line Thickness
...
Determines the thickness of the grid lines that define the boundaries of the cell in which the item appears. Lists the following options:
Thinnest (default) Thinner
Thin Thick Thicker Thickest
...
Show Grid Lines Bottom
...
If ticked, a grid line is displayed along the bottom edge of the cell in which the item appears.
...
Show Grid Lines Left
...
If ticked, a grid line is displayed along the left edge of the cell in which the item appears.
...
Show Grid Lines Right
...
If ticked, a grid line is displayed along the right edge of the cell in which the item appears.
...
Show Grid Lines Top
...
If ticked, a grid line is displayed along the top edge of the cell in which the item appears.
...
Show Header Grid Line
...
If ticked, a grid line is displayed between the cell in which the item appears and the header of the table.
...
Header – options in this section allow an item to be displayed as a label within the header of the table
...
...
Header Text
...
Defines the literal text that appears in the column header.
Can be blank if the item is a field value that is to be displayed within the component instead of a label that is to appear within the header of a table.
...
Text Colour
...
Determines the colour in which the header text is to be displayed.
...
Font
...
Determines the font face and font size in which the header text is to be displayed.
...
Horizontal Text Alignment
...
Determines the horizontal alignment of the header text within the cell. Lists the following options:
None Right Centre Left
...
Vertical Text Alignment
...
Determines how the vertical alignment of the header text within the cell. Lists the following system-defined options:
None Top Centre Bottom
...
Background Colour
...
Determines the background colour of the cell.
...
Padding Bottom
...
Defines the amount of whitespace, in millimetres, between the header text and the bottom edge of the cell in which it appears.
...
Padding Left
...
Defines the amount of whitespace, in millimetres between the header text and the left edge of the cell in which it appears.
...
Padding Right
...
Defines the amount of whitespace, in millimetres, between the header text and the right edge of the cell in which it appears.
...
Padding Top
...
Defines the amount of whitespace, in millimetres, between the header text and the top edge of the cell in which it appears.
...
Item – options in this section determine the data item(s) (data base fields) that display inside a table cell
...
...
Database Field
...
Displays the database field name of the data item that is displayed inside the cell.
You can click a button to launch the Document Designer Data Items screen, which allows you to select a database field or a group of database fields that are to be displayed for the selected item within the layout component.
...
Text Colour
...
Defines the colour of the text in which the data item is displayed within the cell.
...
Font
...
Defines the font face and font size used to display the data item within the cell.
...
Horizontal Text Alignment
...
Defines the horizontal alignment of the data item text within the cell. Lists the following options:
None Right Centre Left
...
Vertical Text Alignment
...
Defines the vertical alignment of the data item text within the cell. Lists the following options:
None Top Centre Bottom
...
Background Colour
...
Defines the background colour of the data item within the cell.
...
Padding Bottom
...
Defines the amount of whitespace, in millimetres, between the data item text and the bottom edge of the cell in which it appears.
...
Padding Left
...
Defines the amount of whitespace, in millimetres, between the data item text and the left edge of the cell in which it appears.
...
Padding Right
...
Defines the amount of whitespace, in millimetres, between the data item text and the right edge of the cell in which it appears.
...
Padding Top
...
A number of component settings are available for each layout component of an invoice/credit note or payslip format to allow the size, position, formatting and other characteristic of the component to be defined and edited.
The component settings can be viewed and modified by clicking on a component within the components list in the Component List and Property Grid pane or by clicking on the component on the layout, as highlighted in the example below. Note: the right hand Property panel is collapsed in this screen shot.
...
Once the relevant component is selected, the Property panel on the right displays the component settings for the component you have selected, as shown in the example below.
...
The table below lists and describes the settings that are available for each type of component.
Setting | Applies to which Component Types? | Sub Setting | Description | Options Available |
Display | All | Location X | Defines the X coordinate that specifies the position of the component. | A numeric value can be keyed in. |
Location Y | Defines the Y coordinate that specifies the position of the component. | A numeric value can be keyed in. | ||
Width | Defines the width of the component, in millimetres. | A numeric value can be keyed in. | ||
Height | Defines the width of the component, in millimetres. | A numeric value can be keyed in. | ||
Display Option | Where a payslip is printed over multiple pages, this setting determines if the component appears on each page, on the last page only or on all pages except the last page. | Picklist containing the following options:
Is unavailable for the following layout components:
| ||
Border | All except the following:
| Border Line Colour | Colour of the border that displays around the component. | List of system-defined colours. |
Border Line Style | Style of the line used to render the border around the component. | List of the following system-defined options:
| ||
Border Line Thickness | Thickness of the lined used to render the border around the component. | List of the following system-defined options:
| ||
Show Border | Determines if a border is displayed around the component. | Checkbox | ||
Header | All except the following:
| Header Size | Defines the height of the header on the component, in millimetres. For example, where a component is a table of items, the header contains the column headings. | A numeric value can be keyed in. |
Show Header | Determines if the component displays a header. | Checkbox | ||
Labels | Heading | Tax Invoice/Payslip Label | Text that is to be displayed at the top of an invoice/credit note (for example: Tax Invoice). | A string of text can be keyed in. |
Rows/Columns | All except the following:
| Edit Columns | Displays the Document Designer Table Properties screen, thereby allowing a list of items to be added to the component. | Button |
Invoice Items | Display Rounding Line | If selected, a rounding difference line is displayed at the bottom of the Invoice Items table. If a column in the table is configured to display a total within the Invoice Totals component, the rounding line shows the rounding difference between the sum of the values in the column and the corresponding total shown within the Invoice Totals component. |
| |
Rounding Line Label | Literal text that is to appear as a label against the rounding line. | A string of text can be keyed in. | ||
Sub-group Totals | Invoice Items Pay Items | Include a Sub Totals Row | If selected, sub-totals will be displayed within the following columns of Invoice Items table, if they are included in the document format. If they are not included, the options below will not be shown to pick from:
For payslips, if they are included in the document format:
For a Supplier based payslip type , if they are included in the document format:
| Checkbox - defaults |
Group Sub Totals By | Determines how invoice/credit/payslip items are to be sub-totalled. | Picklist | ||
Image | Logo | Image | Displays the filename of the image displayed within the component. | Displayed by the system. |
Add | Allows the user to browse to a file location where the required image file is located. | Button | ||
Use Pay Company Logo | If selected, sets the image file stored against the Payslip Logo field on Pay Company record as the image displayed with in the component. | Checkbox – defaults to deselected state. | ||
Line | Remittance Line | Line Colour | Sets the colour of the line component. | List of system-defined colours. |
Line Style | Sets the type of line for the selected component | Picklist displays the options of:
| ||
Line Thickness | Sets the thickness of the line component. | List that displays the options of:
| ||
Orientation | Sets the orientation of the line. | List that displays the options of:
|