Overlays
- 13 Nov 2024
- 4 Minutes to read
- Contributors
- Print
- PDF
Overlays
- Updated on 13 Nov 2024
- 4 Minutes to read
- Contributors
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overlays are a way of applying templates, business information, or logos onto Lasernet reports.
The following is an example of an Overlay: it contains graphics, a logo, and contact information. All of this information is static and is a part of an image or Microsoft Office file.
Overlays can be useful in situations where a specific template is required, which would not be practical (or possible) to recreate as a Subform or an XML file in Lasernet.
Note
It is usually recommended that a Subform is used instead of an Overlay. In a Subform, the information can be dynamically updated based on entity, language, product group, sales person, etc. Moreover, Subforms can be rendered much more quickly and efficiently.
For more information on Lasernet subforms, visit the Lasernet Form Editor Guide.
Overlays can also be managed from within the Lasernet Developer. More information is available in our Lasernet Form Editor Guide.
If your Overlay configuration is not working as expected, check that it is not being overwritten by your configuration in the Lasernet Developer.
How Do Overlays Work?
When working with Overlays within Lasernet FO Connector, three features must be configured:
Overlay Setup: it allows the user to decide which Overlays are applied to which report and when.
Overlays: a combination of Overlay files arranged together to cover the first/middle/last/single page requirements for a document.
Overlay Files: the images that will be applied to the first/middle/last/single pages of the Overlay.
To start configuring these three features, navigate to Lasernet > Setup > Overlays.
Overlay Files
When configuring a new Overlay, the first step is to create an Overlay File. To do so, navigate to Lasernet > Setup > Overlays > Overlay files.
The Overlay files page displays all the Overlay files for this legal entity. On the left side of the page is a list of such files, while on the right is shown a preview of the image the file contains.
Two options exist for loading Overlays:
Click Load overlay files > Load From Lasernet: this will pull through any Overlays created using the Lasernet Print Capture printer.
Click Load overlay files > Load from loaded images: this will pull through any Images identified by the type Overlay that have been loaded to Lasernet > Setup > Lists > Images.
Overlays
Once the Overlay Files are loaded, it is necessary to organize them into Overlays. To do so, navigate to Lasernet > Setup > Overlays > Overlays.
On the Overlays page, all the Overlays for this entity are listed on the left. The details pane displays the Overlay Files and their assigned pages.
In the following example, a separate Overlay Image has been assigned to each page (sinv_first_US for the First page, sinv_middle_US for the Second page, and so on): in this way, it is possible to define different headers, footers, and graphics for each page in a document.
Alternatively, for simpler designs, the same Overlay can be assigned to each page.
Overlay Setup
Once the Overlay Files have been organized into Overlays, it is necessary to assign the Overlays to a report. To do so, navigate to Lasernet > Setup > Overlays > Overlay Setup.
In the Overlay setup page, all the reports in this entity are listed on the left. The detail pane on the right shows all the Overlays assigned to the selected report.
Field name | Description |
|---|---|
Overlay ID | To specify an overlay ID. |
Document type | To specify a document type for the use of overlays. Possible values are as follows: All types, Original, Copy, Pro forma, Pro forma copy. |
To define an overlay use when previewing and archiving. | |
Printer | To define an overlay use when printing. |
Fax | To define an overlay use when faxing. |
Custom Port | To define an overlay use when applying a custom port. |
Description | To add a description of the overlay. |
Condition | None: the function specifies no use of either query or custom fields. Query: the function is used for a Query. Code: the function is used for a custom field |
A Generic overlays option is available as well, which can be used to assign the same Overlay to every report without having to repeat the same process for each individual report.
For example, to add the Logo Overlay to every report, follow these steps:
Click the New button to create a new line in the Overlay List.
Select the Logo Overlay from the dropdown for Overlay ID.
This Overlay will be set as default for all document types, and all destinations, without any criteria. Therefore, this Overlay will be applied to every outgoing report from this legal entity.
If certain reports or circumstances need to be excluded, then a Condition can be set on the Gerneric Overlay.
An individual report can also be excluded by selecting Skip Generic Overlays.
When the Generic Overlays are skipped, a specific Overlay can be configured either from within the Overlay Setup form, or in the report itself.
To do so, follow these steps:
Navigate to Lasernet > Common > Reports.
Select the wanted Report and click Setup > Overlays on the Action pane.
In the page that opens, the Overlays can be configured as in the Overlay Setup form.