Skip to main content
Skip table of contents

Bookmarks

General Information

Bookmarks allow you to create a structured framework for documentation.

  • When documentation is organized into its own folders using bookmarks, you can compile PDF books on various aspects of a product or project for different purposes.

  • Bookmarks form the foundation for using the Binder Tool.

See: Binder Tool

Add a Bookmark

  1. Select the Archive tab.

  2. Go to Others > Bookmark.

  3. Select the classification related to the bookmark.

  4. Choose the context-specific action "New Bookmark."

    • Flow opens the Add Bookmark dialog.

  5. Accept, enter, or search for the next available bookmark ID.

  6. Enter the bookmark name.

  7. Enter or search for descriptions from the dictionary.

  8. Select a template from the list opened by the preselection button, for example:

    • Mapping XML Template (FI)

    • Offer XML Template (Project/EN)

    • Offer XML Template (Project/FI)

  9. Select the publicity level.

  10. Create the bookmark by selecting OK.

add_bookmark.png

Add Collection Criteria

If you add collection criteria to a bookmark, do not add a structure to it.
Write the collection criteria using the names of Flow fields and their values.

  1. Select the bookmark.

  2. Choose the action Bookmark > .

  3. Select the Collection Criteria section.

  4. Enter the condition's order number in the Order field.

    • Conditions are interpreted in numerical order.

  5. Enter the Condition, which consists of the field name and its content:

    • Write the Flow field name in uppercase letters.

    • Add an equals sign (=).

    • Enter the field's content (value) within quotation marks.

    • Example: CLASSIFICATION="10|12"

  6. Click OK.

    • Flow adds a row for the new collection condition.

  7. Repeat steps 4–6 as needed.

  8. Select the action Bookmark > check-in.

bookmark_rules_to_collect.png

Example of a Collection Criterion

The Binder Tool collects documents that meet two conditions: classification "40|403" (Service) and status "Approved."

CLASSIFICATION and STATENAME are the field names in Flow.

bookmark_rules_to_collect_example.png

Collection rules for the mapping tool based on file format

In the mapping tool’s ZIP folder structure, files can also be collected based on their file format.
By default, if no collection rules for file format conversions are defined, only the main files are collected into the ZIP.


Example of a file format collection rule

CODE
EXPORT_FILE_FORMAT=.docx: .pdf, .vxp: .vxp;.pdf;.dwg
  • For objects whose main file is a .docx, only the .pdf file is collected, if such exists.

  • For objects whose main file is a .vxp, the files .vxp, .pdf, and .dwg are collected.

  • The example means that only the PDF files converted from Word documents are collected. For Vertex drawings, in addition to the original VXP files, the converted PDF and DWG files are also collected.

The rule syntax is:

CODE
EXPORT_FILE_FORMAT=[main_file_extension]: [collected_extensions separated by semicolons], [main_file_extension2]: [collected_extensions2], ...
  • The main file and collected extensions are separated by a colon :

  • Collected extensions are separated by a semicolon ;

  • Different file formats are separated by a comma ,


Examples of possible combinations

CODE
EXPORT_FILE_FORMAT=
.docx: .pdf,
.pdf: .pdf;.dwg,
.dwg: .pdf;.dxf,
.xlsx: .csv;.pdf,
.vxp: .vxp;.pdf;.dwg,
.jpg: .jpg;.png;.tif,
.png: .png;.pdf,
.txt: .pdf,
.xml: .xml;.json,
.ifc: .ifc;.pdf;.dwg

exportFileFormatEnkkuIsompi1.png

Inheritance of the file format collection condition

The file format collection conditions are inherited within the ZIP folder structure of the mapping tool. Flow indicates inheritance with an asterisk (*) in the rule table of the mapping tool. See more on the page Use Binder Tool | Bookmark-structure-rules

Define a Structure if Needed

  • The structure allows you to define a hierarchy similar to a product structure for the documentation generated by the Binder Tool.

  • If you add a structure to a bookmark, do not add collection criteria to it.

  1. Select the bookmark.

  2. Choose the action Bookmark > .

  3. Select the Structure section.

  4. Enter or search for the bookmark ID or create a new bookmark in the structure:

    • Enter the bookmark ID and select Add, or

    • Select Search Items, which opens the bookmark search screen where you can select one or more bookmarks, or

    • Select New to create a new bookmark.

  5. Select the action Bookmark > check-in.

example_of_bookmark_structure.png

Example of a Bookmark Structure

The bookmark Offer Document collects documentation in the following order:

  1. Offer Documents (Tarjousdokumentit)

  2. Technical Specifications (Tekniset erittelyt)

  3. Layout Drawings (Layout piirustukset)

bookmark_structure_example.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.