Skip to main content

Placeholder Basics

Updated this week

To display data from docu tools in a PDF or Excel Report, we use placeholders. These placeholders serve as markers within your Template, indicating where the data from docu tools should be inserted. For example, you can create a placeholder like {​{project-name}​} in the Template, which will be dynamically filled with the actual project name in docu tools when generating the Report.

There are different groups of placeholders for Excel and Word, as some are only available in one or the other. By effectively using these placeholders, you can create dynamic and flexible Templates that accurately represent the data from your projects, Reports, and Tasks.

Syntax and Design of Placeholders

All placeholders are enclosed in double curly braces {​{}​} and must follow the exact syntax provided, regardless of the language used in the Template text: For example, {​{pin-number}​} is a valid placeholder that retrieves the Number of the selected Pin. However, placeholders like {pin-number}, {​{pinnummer}​}, or {​{pinnumber}​} are invalid due to incorrect syntax and will not function.

Placeholders do not work if they contain spaces. To create a placeholder for a multi-word Title, replace the space with a hyphen -, e.g., use {​{dataset-room-info}​} instead of {​{dataset-Room info}​}.

The appearance of the output is defined based on the formatting of the placeholder in the Template. So if your Report does not look the way you want, you need to change the Template. On the other hand, the dynamic data will be displayed as it is entered in docu tools. So if there is a typo in the displayed Pin Title, it must be changed in the corresponding Pin in docu tools.

Placeholder Sections

When working with Task and Pin placeholders, a specific structure must be observed. Since Pins and Tasks often repeat in a Report, it is important to define the specific section where these placeholders appear. This limited area is filled with data from a Pin or Task, repeating as often as they appear in the Report.

These sections always begin with {​{pins}​} or {​{tasks}​} and end with {​{/pins}​} or {​{/tasks}​}. All content between these placeholders will be displayed repeatedly depending on the number of Pins or Tasks. It is important to note that the additional / is exclusively included in the closing tag.

Other sections include:

  • {​{pin-sort}​} and {​{/pin-sort}​} - Area for placeholders for Pin sorting.

  • {​{pin-medias}​} and {​{/pin-medias}​} - Space for {​{pin-media-file-name}​} in Excel Reports.

  • {​{comments}​} and {​{/comments}​} - Area for Task comments.

  • {​{attendees}​} and {​{/attendees}​} - Section for contact placeholders.

There are also sections where the text is only displayed if a condition is met. Normally, placeholders in the Report are not displayed if there are no data to fill them. For example, if there are no Tasks in a particular Pin, the Task placeholders will not be displayed. However, to add a heading that is displayed when the corresponding content is present, If placeholders have been introduced. These sections are positioned outside the opening and closing placeholders and verify the presence of content. Headings are only displayed when there is actually content that meets the specified condition.

We have defined the following if-sections:

  • {​{if-tasks}​} and {​{end-if-tasks}​} - Headings are only displayed if there is at least one active Task in the Pin.

  • {​{if-media}​} and {​{end-if-media}​} - Headings are only displayed if there are actually Media contents.

  • {​{if-task-comment}​} and {​{/if-task-comment}​} - Headings are only displayed if the Task contains comments.

These placeholders can be used as follows:

```

{​{pins}​}

{​{if-media}​}

Pin Photos

{​{end-if-media}​}

{​{picture-table-small}​}

{​{/pins}​}

```

The heading "Pin Photos" will not be displayed in the Report if the Pin contains no photos.

Inactive Content in Reports

In Reports, inactive Tasks and Media are excluded. However, inactive Pins are included in the Report.

Report Placeholders

  • {​{today}​} - The date of the Report creation for easy identification of the Report's timeliness, facilitating appropriate tracking and monitoring of progress in troubleshooting over time.

  • {​{weeknumber}​} - Displays the Number of the week in which the Report was created.

  • {​{author}​} - Specifies the name of the user who created the Report.

  • {​{author-email}​} - Displays the E-mail address of the Report creator.

  • {​{author-number}​} - Displays the phone Number of the user who created the Report.

  • {​{author-company}​} - Displays the company of the Report creator.

  • {​{report-title}​} - Displays the Title given to the Report during creation in the app.

  • {​{report-filter}​} - Displays the Filter used for creating the Report. It works when the Report is created in the List view of Reports.

  • {​{pagebreak}​} - Adds a page break in Word Reports.

Tip: General page breaks can be inserted directly into the Word Template as static elements. If you want to insert a page break after every Pin or Task, simply insert the placeholder {​{pagebreak}​}.

Placeholders for Creating a Signature Field

These placeholders enable direct signing within the iPad app and contribute to the final output of the Report:

  • {​{signature-NAME}​} - Displays a signature field during Report creation, which is then output in the final Report.

  • {​{signaturename-NAME}​} - Generates a text field for the signer's name during Report creation on an iPad, which is then included in the Report.

NOTE: Since these placeholders can be used multiple times within a Report Template, it is important to distinguish them from each other. The "NAME" segment of the placeholder should be replaced with a meaningful Description indicating the location in the Report where you want to display the specific signature and name.

For example, set up a Report with two signature and name fields by using the following syntax in the Template:

Signature template

The Report will display the results as shown below:

Signature in report

These placeholders are included in our Default Report Template "Construction diary".

Placeholders for Weather Information

The placeholders provide weather-related data based on the location specified in your project settings. To ensure their functionality, consider the validation on the right side of the address.

  • {​{weather-icon-info}​} - Displays the weather forecast for the specified project address with a small weather icon. The placeholder is formatted as a table that includes the weather icon in the first column and the forecast Description and temperature details in the second column.

  • {​{weather}​} - When this placeholder is used in a Report Template, a new section appears in the Report creation window that automatically preselects the weather data for the current day. By Clicking the Edit button, you can select or change the date. Using the delete button resets the date to the current day. This placeholder does not include a weather icon.

  • {​{pin-weather}​} - This placeholder provides the weather from the day the Pin was created.

Placeholders for Pin Sorting

With these placeholders, you can organize Reports by Plans and Categories and attach a Title to ensure proper sorting in the table of contents.

If there is no specific sorting placeholder, the app uses the Default sorting from the Pin/Task List. However, the sorting placeholders override the app's Default sorting. NOTE: These placeholders are only available for Word Reports.

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

```

{​{pin-sort}​}

...Sorting placeholders...

{​{pin}​}

...Pin placeholders...

{​{/pin}​}

{​{/pin-sort}​}

```

  • {​{pin-sort}​} - Opens the Pin sorting area.

  • {​{/pin-sort}​} - Closes the Pin sorting area.

  • {​{sort-by-plan}​} - This function arranges the Pins by the name of the Plan they are assigned to, then sorts them by their Pin Numbers.

  • {​{sort-by-category}​} - This function sorts Pins by their respective Categories, with the Categories sorted in alphabetical order from Z to A.

  • {​{pin-sort-title}​} - This placeholder is used in conjunction with one of the two previous placeholders. It serves to display the name of the sorted Plan or Category.

Did this answer your question?