Pin Placeholders

docu tools Service Team
docu tools Service Team
  • Updated

The provided placeholders supply pin related information in the reports.

NOTE: The inclusion of all pin related placeholders is structured within a section marked by an open and close tag format. The section starts with the opening tag {{pins}}, followed by the addition of other pin placeholders in the usual manner. To conclude, the section is terminated by the closing tag {{/pins}}. It's important to note the presence of the additional / specifically only in the closing tag. The exception from this rule are the sortation placeholders, the pin area is added within the sort area.

Pin details placeholders

  • {{pins}} - Open the pin area.
  • {{/pins}} - Close the pin area.
  • {{pin-number}} - Diplay the pin number.
  • {{pin-creation-date}} - Displays the date when the pin was created in the app.
  • {{pin-created-by}} - Shows the name of the user who created the pin.
  • {{pin-status}} - Provides the current state of the pin - open, closed, inactive. Learn more about pin states here.
  • {{pin-category}} - Shows the current category of the pin.
  • {{pin-title}} - Provides the title of the pin.
  • {{pin-closed-on}} - If the pin is closed, this shows the date it was closed. If it's open, it returns an empty value.
  • {{pin-closed-by}} - If the pin is closed, this placeholder provides the name of the user, who marked is as closed. If the pin is still open, the placeholder returns an empty value.
  • {{pin-link}} - Provides a link to the pin in the app. Only active project members with the correct role can access it. For example, subcontractors without assigned tasks won't be able to see the pin.
  • {{pin-qr-code}} - Generates a QR code for the pin. Similar to pin links, only active project members with the correct role can access the pin using this code. This placeholder is only available for word reports.
  • {{pin-qr-list}} - Used outside od the pins section, this placeholder displays a list of QR codes for all Pins, included in the report. The QR codes can than be scanned using our iOS apps and the Pins will be directly opened if the user has the rigths to access them. This placeholder is only available for word reports.
  • {{pin-task-progress}} - Displays the progress of tasks within the pin, e.g., 2/5 tasks completed.
  • {{pin-plan-name}} - Shows the name of the plan where the pin is located.
  • {{pin-plan-version}} - Provides the version number of the current plan revision.
  • {{plan-folder-name}} - Refers to the name of the folder where the plan is stored.
  • {{pin-group}} - Lists all groups (excluding filter groups) to which the pin is added.

Pin sortation placeholders

These placeholders allow you to organize reports by plans and categories, and you can attach a title to ensure proper sorting within the table of contents.

If there's no specific sorting placeholder, the app will use the default sorting from the pin/task list. However, the sorting placeholders will override the app's default sortation.

NOTE: These placeholders are only available for reports in Word format.

NOTE: The sorting placeholders should encompass the pin area within the sort area. The correct usage is:

```

{{pin-sort}}

...sortation placeholders...

{{pin}}

...pin placeholders...

{{/pin}}

{{/pin-sort}}

```

  • {{pin-sort}} - Open the pin sortation area.
  • {{/pin-sort}} - Close the pin sortation area.
  • {{sort-by-plan}} - This function arranges pins according to the name of the plan they are associated with, followed by sorting the pins based on their pin numbers.
  • {{sort-by-category}} - This function organizes Pins based on their respective categories, sorting the categories in alphabetical order from Z to A.
  • {{pin-sort-title}} - This placeholder is utilized in conjunction with either of the preceding placeholders. It serves to display the name of the sorted plan or category.

For instance, it can be employed within the following layout:

layout-for-category

The report will reflect the results as illustrated below:

result-for-category

Plan views placeholders

NOTE: These placeholders are only available for reports in Word format.

  • {{pin-plan-snippet-large}} - This placeholder offers a plan snippet for each pin in the report. It displays the pin's position on the plan along with a minimap showing the entire plan and the specific location of the provided plan snippet. The zoom level of the plan snippet and the size of the minimap can be adjusted during report creation. The small plan snippet provides a highly zoomed-in section of the plan, while the medium and large levels show progressively larger portions of the plan.
  • {{plan-snippet-overview-a4}} - Provides the entire plan in A4 format, including the selected pins for the report, displayed on a whole A4-sized page.
  • {{plan-snippet-overview-a5}} - Displays the plan, including the selected pins for the report, in A5 format.

NOTE: The placeholders designated for plan overviews in A4 and A5 format are designed to function in conjunction with the 'sort by plan' placeholder - {{sort-by-plan}}. It is crucial to ensure that these placeholders are positioned within the pin sortation area for their intended use. The correct usage looks like this:

```

{{pin-sort}}

{{sort-by-plan}}

{{plan-snippet-overview-a4}} or {{plan-snippet-overview-a5}}

{{pin}}

...pin placeholders...

{{/pin}}

{{/pin-sort}}

```

Dataset placeholders

  • {{all-datasets}} - Displays all dataset links attached to a pin on separate rows. The format showcases the dataset title followed by the ID and title, such as: "Crafts: 08 - Electro"; "Room list: 2.008 - WC/Shower.
  • {{alldatasets-all-info}} -This placeholder provides all additional information from dataset links used in the pin, presenting it in a tabular format within your report. This placeholder is only available for word reports.
  • {{dataset-DATASETNAME}} - Retrieves the information from the "ID" and "Title" columns for the selected dataset. To utilize this placeholder, replace "dataset name" with the specific dataset you want to showcase in the report. For instance, if there's a dataset named "Room Info" with a datasetlink: ID - 1, Title (Room) - Living room, the placeholder will be referred to as {{dataset-room-info}}. It will display in the report as: 1 - Living room. When multiple links are selected from the same dataset, they will be separated by a comma - 1 - Living room, 2 - Bathroom.
  • {{dataset-column-DATASETNAME--COLUMNNAME}} - This placeholder returns data from a specific column (defined by "COLUMNNAME") within a chosen dataset ("DATASETNAME"). It's important to note that there must be two hypens -- between the dataset name and the column name. For instanse: {{dataset-column-room-info--room}} will display only the room in the report: "Living room".

NOTE: If the dataset or column name consists of multiple words, replace the empty spaces with a hyphen, e.g., use {{dataset-room-info}} instead of {{dataset-Room info}}.

Pin media placeholders

NOTE: These placeholders are only available for reports in Word format.

  • {{Pin-Media}} - Displays all media files and notes, attached to the pins, except for pictures and sketches. It lists files and audio recordings in a table, followed by all comments, and then showcases all photos in a small picture table with three pictures in a row.
  • {{if-media}} and {{end-if-media}} - When placed outside the open and close media placeholders, these check if there is any media content present. Headlines are shown only if there is actual media content following the condition.
  • {{pin-media-without-notes}} - Displays all files, attached to the pin. It excludes notes and pictures.

Pictures placeholders

NOTE: These placeholders are only available for reports in Word format. The only exception is the {{pin-media-file-name}} placeholder.

  • {{picture-table-small}} - Exhibits three pictures on each row with creation date, time, and descriptions provided under each photo.
  • {{picture-table-medium}} - Shows two pictures side by side in each row. Beneath the pictures, the creation date, time, and descriptions are provided.
  • {{picture-table-large}} - Displays one picture per row in maximum size, along with creation date, time, and description if available.
  • {{picture-table-small-notime}} - Exhibits three pictures on each row without information regarding creation date and time.
  • {{picture-table-medium-notime}} - Displays two pictures side by side in each row without providing creation date and time information.
  • {{picture-table-large-notime}}. - Shows a large picture table with one picture per row in maximum size. It does not include creation date or time information.
  • {{picture-table-small-filename}} - COMING SOON
  • {{picture-table-medium-filename}} - Shows two pictures on each row with file names of the photos included under the photos, just before the creation date and time, for precise referencing.
  • {{picture-table-large-filename}}. - COMING SOON
  • {{all-pin-media-file-names}} - Provides a list of the names of all media files, separated by ";".
  • {{pin-feature-image}} - This placeholder shows the very first picture from the pin gallery, which is also the main image displayed at the top of the pin (known as the feature image).
  • {{pin-media-file-name}} - This placeholder returns the file name of a picture. It's utilized within a section enclosed by {{pin-medias}} and {{/pin-medias}}. This placeholder is exclusively applicable in an Excel report template. For additional information, refer to the article on "Excel Placeholders".

Notes placeholders

  • {{pin-notes}} - Shows all notes of a pin sepaated by ";".
  • {{pin-notes-format}} - This placeholder showcases each note individually, including information about the creation date and time under each one. This placeholder is only available for word reports.

Attached files placeholders

NOTE: These placeholders are only available for reports in Word format.

  • {{attach-documents}} - Displays the content from all PDF files attached to the pins in the report. This feature allows for convenient viewing of the attached PDF contents within the report itself, eliminating the need to switch to another document.
  • {{attach-documents-format}} - Exhibits the content of the attached PDF documents in the appropriate scale to ensure clear and easily readable presentation within the report.

Tasks placeholders

  • {{if-tasks}} and {{end-if-tasks}} - When placed outside the open and close task placeholders, these check if there are any tasks in the pin. Headlines are shown only if there is at least one active task following the condition.
  • {{tasks}} - Open the area for placeholders related to tasks.
  • {{/tasks}} - Closes the tasks area.

NOTE: The task area is located within the pins area, e.g.:

{{pins}} ...Pins placeholders... {{tasks}} ...Tasks placeholders... {{/tasks}} {{/pins}}

To learn more about the tasks related placeholders, please refer to the dedicated article.

GPS data and Pin location placeholders

  • {{pin-latitude}} - Pin gps data - latitude.
  • {{pin-longitude}} - Pin gps data - longitude.
  • {{pin-altitude}} - Pin gps data - altitude.
  • {{pin-x}} - Shows the location of the pin on the X axis of the plan in percent from the starting point top left.
  • {{pin-y}} - Shows the location of the pin on the Y axis of the plan in percent from the starting point top left.

Pin fields placeholders

Pin field placeholders help display various types of information in a report, offering flexibility in its structure. These placeholders start with 'pf,' followed by the field name and the desired value for display. You can effortlessly access pregenerated placeholders for your pin fields within the app:

  1. Navigate to project settings.
  2. Select the "Pin designs" tab.
  3. Access the detail view for a field.
  4. Click on the `{{}}`` icon to view related placeholders.
  5. Copy each one with the provided button.

Pin field placeholders

Types of Pin Field Placeholders:

  • {{pf-FIELDNAME-title}} - Returns only the title of the selected field, like "Costs".
  • {{pf-FIELDNAME-value}} - Returns only the value, entered in the pin field, e.g. 75.
  • {{pf-FIELDNAME-title-value}} - Showcase the pin field title and the value, such as "Costs: 75".
  • {{pf-FIELDNAME-title-suf}} - Display the field title and the suffix, for instance "Costs (€)".
  • {{pf-FIELDNAME-value-suf}} - Return the field value and the suffix, like "75 €".
  • {{pf-FIELDNAME-title-value-suf}} - Display the field title, value and suffix, for example "Costs: 75 €".
  • {{pf-FIELDNAME-suf}} - Display only the suffix, like "€".

Moreover, there are other specific pin field placeholders available:

  • {{pin-tags}} - Provides the tags added to the pin.
  • {{all-pf}} - Presents all pin fields in a table format with field titles in the first column and their values in the second.

Placeholder for Pin slider colors

  • {{pfc-FIELDNAME}} - This specialized placeholder retrieves the value of the pin slider field, displaying it as a color within the report. To implement this, the slider field must be configured in a specific manner, naming the slider values according to the colors intended for display in the report.

For instance, consider a Pin slider field named "Priority" with three values: Green, Yellow, and Red, as depicted below:

Pin colors slider

Subsequently, the placeholder {{pfc-priority}} should be formatted within a table as follows:

Pin colors slider in template

The report will reflect the results as illustrated below:

Pin colors slider report

NOTE: This placeholders is only available for word reports.

These placeholders offer versatility in customizing your report structure.

Was this article helpful?

/