With print templates, you can adapt generic print content graphically to the customer’s requirements. Also, you can provide document forms. You can either use print templates available in Siveillance Control or create your own. Print templates can consist of one or more pages. The sequence of the pages is derived from the sequence of subnodes of the print template. The following categories of print templates are available in Siveillance Control:
- Alarm printout
- Event printout
- Spatially triggered event printout
- Graphic printout
- List printout
- Access route plans printout
After an update, the print templates available in Siveillance Control are reset to the default print templates. Non-standard print templates will be lost after an update. If you want to keep the added print templates it is recommended to export the print templates preparatory to an update. After the update, the exported print templates can be imported again.
Creating Print Templates
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click the Print templates node and select Create Print Template.
- In the Instance Name field, enter a name.
- From the Print Template Category drop-down list, select a category. You have the following options:
- Message: You can print messages in the system that contain detailed information concerning the message and graphic sequences for subordinate detectors.
- Event: You can print events in the system that contain detailed information on the event, associated messages and other details.
- List: You can print lists with all columns configured and displayed in the graphical user interface, for example the Object, Message, Event list and Operator Log.
- Graphics: You can print graphics.
- Object: You can print detailed information on objects.
- Access Route Plan: You can print access routes for the fire services.
- Click Finish.
Creating Print Template Pages
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click a print template and select Create Print Template Page.
- In the Instance Name field, enter a name.
- You have the following options:
- To create a print template page with the same layout for multi-page printouts, mark the Multiple instances possible checkbox.
- To create a print template page with the different layouts for each print page, unmark the Multiple instances possible checkbox.
- Click Finish.
Duplicating Print Templates
You can duplicate the existing print templates including all print template pages.
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click a print template and select Duplicate Print Template.
- In the Instance Name field, enter a name.
- Click Finish.
Duplicating Print Template Pages
You can duplicate the existing print template pages.
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click a print template page and select Duplicate Print Template Page.
- In the Instance Name field, enter a name.
- Click Finish.
Exporting Print Templates
You can only export your own print templates as a TMPL file. To export default print templates, create a copy of the required print template.
- Either the Engineering or Graphics Editor perspective is displayed.
- In the Graphics Tree view of the Graphics Editor perspective, right-click one or more print templates and select Export.
- To export print templates, enter the following information:
- File name: Define a directory to where you want to export the print template file. Enter the directory path or click . Enter the file name and click Save.
- Password: Enter a password. The password has to fulfill the current password policy configured in the Siveillance Control preferences. For more information, refer to: Configuring Password Policies.
- Confirmed password: Enter the password again for confirmation.
- Click Finish.
- A message about a successful export appears in the info line as a new entry.
Importing Print Templates
- The Engineering perspective is displayed.
- Click Import Data.
- In the Data channel drop-down list, select Print templates and click Next.
- Select a print template file you want to import and click Next.
- Enter the password that was used during the export of print templates and click Next.
- In the MOX Detail Change dialog box, keep the default settings and click Next. For more information, refer to: Advanced Import Settings.
- Select the import settings. For more information, refer to: Import Settings.
- Click Finish.
- A message about a successful import appears in the info line as a new entry.
- The print templates appear in the Graphics Tree view.
Defining the Layout for Print Template Pages
A print template page has specific layout features and dynamic content. You can either create the same or different layout for each print template page.
- The Graphics Editor perspective is displayed.
- Open a print template page.
- To define a page size, enter the width and height in millimeters in the Object Properties view.
Example: To define the print template pages in the DIN A4 landscape format, enter 297 in the Width and 210 in the Height text fields.
Do not place any objects outside the page margins. Otherwise, the objects cannot be printed.
- To scale the page margins, you have the following options:
- Move the edge of the dotted rectangle.
- Select the dotted rectangle and enter the width and height in millimeters in the Object Properties view. You cannot delete the page margins.
Example: To define the page margins in the DIN A4 landscape format, enter 277 in the Width and 190 in the Height text fields.
- To add a header or footer, right-click the template in the editor and select Edit Header/Footer.
- The edit mode is activated.
- Add elements to the header and footer position using the drawing tools. The elements can also later be assigned in the Object Properties view.
- Click Save.
Adding Text and Template Variables
Text variables are a common form for dynamic contents. You can add text variables to the print template pages.
- The Graphics Editor perspective is displayed.
- A print template page is displayed.
- Click Insert Text.
- To add placeholders, enter {$} (for example Event {$}).
- To each placeholder, a variable is added. This variable is assigned the current value at runtime.
- Select a context. Different variable contexts are available depending on the template category.
- Select a type defining the different configuration options for the variable.
- For every placeholder in the text area the corresponding variable definitions appear in the Variables list.
- Select a variable.
- The associated variable is selected in the list and the variable parameters appear.
- The associated placeholder is highlighted in the text field.
- The variable settings appear in the parameter group field.
Object Variables
Object type variables always reference a live object from the database. The particular object involved depends on the context. In the case of a template in the Event category, the actual event is referenced, for example, by the Triggering object. The attribute to be displayed, for example the instance name, can be selected as a parameter for every object. In the case of referenced objects, the name of the attribute to be displayed for the reference can be selected from a combo box.
Adding Graphic Sections to Print Template Pages
You can use graphic placeholders to add graphic sections to the print template pages. The following possibilities for referencing a graphic section are available:
- Sequence-element and explicit line number
- Sequence-element and dynamic line number
- Direct references to viewport object
- Variable reference to viewport instance name
- The Graphics Editor perspective is displayed.
- A print template page is displayed.
- Click Insert graphic placeholder.
- With the mouse button pressed down, sketch a rectangle.
- Release the mouse button.
- Define the properties of placeholders. You have the following parameters:
- Context: The graphics viewport is displayed by default.
- Graphic Viewport: To add a specific graphic section, click next to the Graphic Viewport field and select an appropriate graphic section. Only the specific graphic section will be statically displayed in every printout, independent of its context, for example alarm, event or access route plan. If no configuration is made, the graphic section is filled by the system. To add a specific graphic section outside of a sequence, click Variable, add a variable and select a context. For more information, refer to: Adding Text and Template Variables. On the runtime client the graphic section will be resolved depending on the active context of the printout, for example alarm, event or access route plan. The resolve value matches the instance name of the graphic section.
- Graphic Viewport from Sequence: To add a graphic section defined for a specific sequence element, mark the checkbox and enter a sequence line number. This number must match the number configured for the viewport sequence element. For more information, refer to: Defining Access Route Plans.
- On the runtime client the specific graphic section is displayed that corresponds to the sequence line number of the sequence element.
- Sequence Line Number: This option is only visible if the Graphic Viewport from Sequence checkbox is marked. To add a graphic section defined for a sequence element that matches dynamically to the placeholder, mark the Graphic viewport from sequence checkbox and enter -1.
- On the runtime client the graphic section is displayed that matches dynamically to the placeholder. The placeholder is filled with the next sequence element that doesn’t match any other placeholder on the same page in the printout.
- Graphic Viewport Orientation: You can change the orientation or rotation of any graphic viewport. In a layout with landscape format, the width of the graphic viewport exceeds its height, whereas in a layout with portrait format, the height of the graphic viewport exceeds its width. The portrait-oriented graphic viewport supports a 180° rotation, while the landscape-oriented graphic viewport allows rotations of 90° and 270°.
- Remove Frame in Printout: To not display any frame in printouts, keep the default settings. Otherwise, unmark the checkbox.
- Optimal Scaling: To scale the integrated graphic viewport into the placeholder based on the size of the contained elements, mark the checkbox. Otherwise, keep the default settings. The graphic viewport will be inserted based on the source graphic’s official drawing bounds.
- Optimal Scaling Margin (%): When the Optimal Scaling checkbox is marked, the content of the graphic viewport can be scaled with a corresponding margin by specifying a percentage value, instead of being precisely fitted into the placeholder.
- Click OK.
Adding List Texts to Print Template Pages
- The Graphics Editor perspective is displayed.
- A print template page is displayed.
- Click Insert list text placeholder.
- With the mouse button pressed down, sketch a rectangle.
- Release the mouse button.
- Define the properties of placeholders. You have the following parameters:
- Context: The graphics viewport is displayed by default.
- Line Spacing (mm): To increase or decrease the amount of vertical space between lines of text and the distance between symbols, enter a value in millimeters.
- Click OK.
- To exit the edit mode, double-click the frame of the placeholder.
Adding Tree Structures to Print Template Pages
- The Graphics Editor perspective is displayed.
- A print template page is displayed.
- Click Insert tree structure placeholder.
- With the mouse button pressed down, sketch a rectangle.
- Release the mouse button.
- Define the properties of placeholders. You have the following parameters:
- Context: The graphics viewport is displayed by default.
- Tree Type: The graphics tree is displayed by default.
- Line Spacing (mm): To increase or decrease the amount of vertical space between lines of text and the distance between symbols, enter a value in millimeters.
- Indent (mm): To increase or decrease indent, enter a value in millimeters.
- Click OK.
- To exit the edit mode, double-click the frame of the placeholder.
Adding Table Texts to Print Template Pages
- The Graphics Editor perspective is displayed.
- A print template page is displayed.
- Click Insert table text placeholder.
- With the mouse button pressed down, sketch a rectangle.
- Release the mouse button.
- To exit the edit mode, double-click the frame of the placeholder.
Adding Legends to Print Template Pages
Legends serve to depict the visible elements on the access route plans that hold significance for the fire services. They are crucial for quickly gaining an overview of both the contents and the situation. To add a legend to print template pages, proceed as follows:
- The Graphics Editor perspective is displayed.
- A print template page is displayed.
- Click Insert legend placeholder.
- With the mouse button pressed down, sketch a rectangle.
- Release the mouse button.
- Define the properties of placeholders. You have the following parameters:
- Remove Frame in Printout: To not display any border in printouts, keep the default settings. Otherwise, unmark the checkbox.
- Font Size: To increase or decrease the font size of the values used in the legend, enter a value in millimeters.
- Symbol Size: To increase or decrease the size of the legend's symbols, enter a value in millimeters.
- Line Spacing (mm): To increase or decrease the amount of vertical space between lines of text and the distance between symbols, enter a value in millimeters.
- Click OK.
- To edit the legend, double-click it.
Editing Print Templates
You can edit the object properties of a print template.
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, click a print template whose properties you want to change and enter your changes in the Object Properties view.
Editing Print Template Pages
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, click a print template page whose properties you want to change and enter your changes in the Object Properties view. For more information refer to: Graphics Editor Tools.
Deleting Print Templates
You can delete print templates. Contained print template pages are deleted, but remain in the database.
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click a print template and select Delete Object(s).
- Click Yes.
Deleting Print Template Pages
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click a print template page and select Delete Object(s) from Database.
- Click Yes.
Creating Print Template Annotations
You can assign one or more print templates to the objects (for example detector groups), which are then used as a template for the respective printout at the time of printing. The print templates are automatically inherited by subordinate objects.
- Either the Engineering, Annotations, Access Route Plans or Print Configuration perspective is displayed.
- In the Location Tree of the Engineering or Annotations perspective, right-click an object and select Create Annotation > Create Print Template Annotation.
- In the System Tree of the Access Routes Plans perspective, right-click an object and select Create Annotation > Create Print Template Annotation.
- You can specify the following parameters:
- Print Template Category: Select a print template category.
- Print Template: Select a graphics template.
- Discipline: Select a discipline.
- Comment: Add a comment if necessary.
- Click Finish.
Editing Print Template Annotations
- Either the Annotations, Access Route Plans or Print Configuration perspective is displayed.
- In the Print Templates view, right-click the annotation you want to edit and select Edit Print Template Annotation.
- Enter your changes.
- Click Finish.
- To display the modified values, click Refresh.
Deleting Print Template Annotations
- Either the Annotations, Access Route Plans or Print Configuration perspective is displayed.
- In the Print Templates view, right-click the annotation you want to delete and select Delete Print Template Annotation.
- Click Yes.
Creating Print Template Attachments
You can enrich printouts for messages, events and access route plans by attachments that provide additional information for the operator. You can only add PDF files as attachment. You can define multiple print template attachments. The number of files is not limited as long as the CUPS printer can handle them. This also applies to the size of the attachments. Larger paper formats are re-scaled to the standard paper format. Keep in mind that print template attachments (PDF files) are always printed last if both, print template pages and print template attachments are created in the print templates. The order cannot be changed.
- A printer (CUPS) has been configured for the printout.
- On the server a directory for storing the PDF documents is available.
- The Siveillance Control server has permissions to access this directory (read).
- The directory path has been set in a specific preference of Siveillance Control. For more information refer to: Configuring Directory Paths for Print Template Attachments.
- A corresponding printing template has been configured to reference one of the PDF documents in the server’s directory as an attachment.
- The Graphics Editor perspective is displayed.
- In the Graphics Tree view > Print templates, select one of the following folders:
- Alarm printout
- Event printout
- Spatially triggered event printout
- Access route printout
- Right-click the folder and select Create Print Template Attachment.
- In the Instance Name field, enter a name.
- Enter an optional name for Attachment Subdirectory. You can only add one subdirectory. For example: In the root directory /usr/viewpoint/attachments specified in the preferences a subdirectory messages for attachments is added. The /usr/viewpoint/attachments/messages directory is searched for the attachment.
- Enter an Attachment File name for the PDF. You have the following options:
- A static file name: Enter a name.
- Object-related variables: Select variables by clicking . You can select multiple variables.
- A combination of both prefix and suffix and variables: For example, enter a prefix and select a variable by clicking . Then enter a suffix.
The following examples explain how the names for the print template attachments are composed for an alarm printout attachment with prefix MDLK_01_11x and suffix .pdf:
If you select Change of State > Detector Group > Instance Name, the variable for the name of the detector group is used. The detector group contains the detector with the alarm message. The instance name 30102 will lead to MDLK_01_11x30102.pdf.
If you select Change of State > Originating Object > Instance Name, the variable for the name of the detector of the alarm message is used. The instance name 30101 will lead to MDLK_01_11x30101.pdf.
If Siveillance Control object names use special characters they will be replaced during evaluation of the dynamic PDF attachment name. An asterisk (*) in the name is replaced by the letter “x”; a slash (/) is replaced by an underscore (_). If a detector with this name exists in Siveillance Control 01/11*30101 and a PDF attachment is configured with a variable to the detector name “${originatingMO.instanceName}.pdf” during printout the server would look for a PDF file 01_11x30101.pdf.
- Click Finish.
- The print template attachment is configured.
Validating Print Template Attachment Configurations
You can check configured attachments without triggering a whole printout.
- The Graphics Editor perspective is displayed.
- In the Graphics Tree, right-click the attachment.
- Select Validate attachment configuration.
- Select a message, an event or a detector group as a reference object for which you want the attachment file to be validated.
- Click Finish.
- The results of the validation appear.
Configuring Directory Paths for Print Template Attachments
You can specify a directory path to store the print template attachments.
- A directory has been defined on the server system where printouts are processed.
- This directory is defined for the engineering server, if you want to use this functionality on the engineering client.
- This directory is also defined for the runtime system, if you want to use the functionality on the runtime client. In this case, the directory needs to be either accessible locally or as a linked network directory.
- The server has read permission on the directory.
- Select Window > Preferences.
- Select Siveillance Control > Printing.
- Add the file directory.
- Click Validate.
- If the directory exists on the server or the directory can be accessed by the server, the system validates and a success message in green letters appears. The directory path is configured successfully.
- If the error message The given directory could not be found on the server’s filesystem appears, check on the server for the directory or choose another directory and complete the validation again.
- To also be able to use the PDF attachment for the runtime client, repeat the configuration of the directory path on the runtime client. This is only necessary, if the runtime client cannot access it as a network directory. Otherwise, the servers can reference the same directory and one validation is sufficient.