---
version: "latest"
language: "en"
---
# Easy Link Checker - Cloud
## Documentation
*
### [π Get started](https://doc.eps.ch/pelcc/latest/get-started.md)
* [Overview](https://doc.eps.ch/pelcc/latest/overview.md)
*
### [π οΈ Admin Guide](https://doc.eps.ch/pelcc/latest/admin-guide.md)
* [Instance link check](https://doc.eps.ch/pelcc/latest/instance-link-check-page.md)
* [Global Settings](https://doc.eps.ch/pelcc/latest/global-settings.md)
*
### [π Documentation](https://doc.eps.ch/pelcc/latest/documentation.md)
* [Space link check](https://doc.eps.ch/pelcc/latest/space-admin-page.md)
* [Confluence internal links](https://doc.eps.ch/pelcc/latest/confluence-page-links.md)
* [Further configuration](https://doc.eps.ch/pelcc/latest/further-configuration.md)
* [Detailed Results](https://doc.eps.ch/pelcc/latest/detailed-results.md)
* [Broken links](https://doc.eps.ch/pelcc/latest/false-positives.md)
* [1 more pages](https://doc.eps.ch/pelcc/latest/documentation.md)
*
### [π Release information](https://doc.eps.ch/pelcc/latest/release-information.md)
* [Release Notes](https://doc.eps.ch/pelcc/latest/release-notes.md)
* [End User License Agreement](https://doc.eps.ch/pelcc/latest/end-user-license-agreement.md)
---
version: "latest"
language: "en"
---
# π οΈ Admin Guide
* [Instance link check](https://doc.eps.ch/pelcc/latest/instance-link-check-page.md)
* [Global Settings](https://doc.eps.ch/pelcc/latest/global-settings.md)
---
version: "latest"
language: "en"
---
# Confluence internal links
## AC links
When inserting links to other Confluence pages, Atlassian uses a custom link representation behind the scenes instead of a regular URL. These types of links can also break just like any other links. This special link format is also mentioned in the [Confluence Storage Format reference](https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html) and looks like the following.
link text
The Easy Link Checker is capable of checking these types of links. The results are displayed in separate tables in the result view captioned with **Broken Confluence links** and **Working Confluence links** respectively.
*** ** * ** ***
## AC Links with special characters
AC links that contain special characters can cause problems during verification. The link checker relies on the CQL Search Query from the Confluence Cloud API, but this query fails when certain characters are present. In particular, double quotes (") break the search entirely. As a result, any link containing a double quote is automatically flagged as broken. While these links may still function correctly, the app cannot verify them due to the search limitation.
*** ** * ** ***
## Other internal links
Although Confluence uses the `ac:link` format described above to link to Confluence pages in most situations, regular URLs are also supported by Confluence. The Easy Link Checker also supports verification of such Confluence internal URLs. The following forms are currently supported:
* `/wiki/spaces/spacekey/pages/1234`
* `/wiki/spaces/spacekey/pages/1234/pagetitle`
* `/wiki/spaces/spacekey/blog/2000/01/01/1234/blogtitle`
* `/wiki/spaces/spacekey/blog/2000/01/01/1234`
* `/wiki/spaces/spacekey`
* `/wiki/spaces/spacekey/overview`
---
version: "latest"
language: "en"
---
# Detailed Results
The **Detailed Results**show the results of a link check.
Detailed Results \| Image
*** ** * ** ***
## Summary
The **Summary** show a short overview of the link check results.
Summary \| Image
*** ** * ** ***
## Download Results Button
The **Download Result**button allows the user to download the link check result as a .xlsx file. The downloaded file contains a short summary of all results and the broken links and their location.
Downloaded file \| Image
*** ** * ** ***
## Detailed Results
The **Detailed Results**show all the link check results. It consists of 5 categories (Broken Links, Broken Confluence Links, Working Links, Working Confluence Links \& Excluded)
Depending which link check has been performed different cells get displayed in the detailed results.
* **Website Link Check**: URL, Status Text
* **Instance Link Check**: URL, Page, Space, Status Text
* **Link Check**: URL, Page, Status Text
Example Instance Link Check Results \| Image
*** ** * ** ***
## Action Buttons
The user has the option to directly **replace** or **exclude** a broken link after a link check.
* **Replace Button**: This button opens a replacement dialog in which the user can paste the correct working link. The link gets replaced directly on the corresponding confluence page.
* **Exclude Button**: This button adds the link to the excluded option in the further configuration. When the next link check is performed, this specific link will be in the excluded section. The exclude button is only available for normal links. Confluence link can't be excluded.
Action Buttons \| Image
---
version: "latest"
language: "en"
---
# π Documentation
* [Space link check](https://doc.eps.ch/pelcc/latest/space-admin-page.md)
* [Confluence internal links](https://doc.eps.ch/pelcc/latest/confluence-page-links.md)
* [Further configuration](https://doc.eps.ch/pelcc/latest/further-configuration.md)
* [Detailed Results](https://doc.eps.ch/pelcc/latest/detailed-results.md)
* [Broken links](https://doc.eps.ch/pelcc/latest/false-positives.md)
* [ELC Macros](https://doc.eps.ch/pelcc/latest/elc-macros.md)
---
version: "latest"
language: "en"
---
# ELC Macros
* [Link check macro](https://doc.eps.ch/pelcc/latest/link-check-macro.md)
* [Website link check macro](https://doc.eps.ch/pelcc/latest/website-link-check-macro.md)
* [Instance link check macro](https://doc.eps.ch/pelcc/latest/instance-link-check-macro.md)
---
version: "latest"
language: "en"
---
# End User License Agreement
**This EULA is in addition to the Atlassian Marketplace Terms of Use (** [Atlassian Marketplace Terms of Use \| Atlassian](https://www.atlassian.com/licensing/marketplace/termsofuse)**).**
*** ** * ** ***
## Policies
* [Privacy Policy](https://doc.eps.ch/pelcc/latest/privacy-policy.md)
* [Security Policy](https://doc.eps.ch/pelcc/latest/security-policy.md)
*** ** * ** ***
## Introduction
Unless otherwise indicated, the App is the property of EPS Software Engineering AG. The software and services provided by EPS Software Engineering AG are at all times subject to these terms and conditions. By using the App you confirm your acceptance of, and agree to be bound by, these term and conditions. These terms and conditions shall constitute the agreement between you and EPS Software Engineering AG ("this Agreement").
*** ** * ** ***
## Agreement to Terms and Conditions
This Agreement takes effect on the date on which you install the App into any Confluence installation.
*** ** * ** ***
## Disclaimer
It is not warranted that any software supplied by EPS Software Engineering AG will meet your requirements or that its operation will be uninterrupted or error free. EPS Software Engineering AG exclude and expressly disclaim all express and implied warranties or conditions not stated in this Agreement (including without limitation, loss of profits, loss or corruption of data, business interruption or loss of contracts), so far as such exclusion or disclaimer is permitted under the applicable law. This Agreement does not affect your statutory rights.
*** ** * ** ***
## Warranties and Limitation of Liability
EPS Software Engineering AG warrants that its software and services will be provided using reasonable care and skill on a non-exclusive basis. Where EPS Software Engineering AG supplies any goods supplied by a third party, EPS Software Engineering AG does not give any warranty, guarantee or other term as to their quality, fitness for purpose or otherwise, but shall, where possible, assign the benefit of any warranty, guarantee or indemnity given by the person supplying the goods to EPS Software Engineering AG. Except in respect of death or personal injury caused by EPS Software Engineering AG's negligence, EPS Software Engineering AG shall not be liable to you by reason of any representation (unless fraudulent), or any implied warranty, condition or other term, or any duty at common law, for any loss of profit or any indirect, special or consequential loss, damage, costs, expenses or other claims (whether caused by EPS Software Engineering AG's negligence or the negligence of its servants or agents or otherwise) which arise out of or in connection with the provision of any goods or services by EPS Software Engineering AG. EPS Software Engineering AG shall not be liable or deemed to be in breach of contract by reason of any delay in performing, or failure to perform, any of its obligations if the delay or failure was due to any cause beyond its reasonable control. Any estimates given by EPS Software Engineering AG as to the time of completion of performance of its services (whether completion of the whole or a part of those services) or delivery of its software shall be estimates only and time shall not be of the essence. EPS Software Engineering AG when providing electronic media shall take reasonable care to avoid introducing computer viruses to your computer systems and shall not be liable to you by reason of any virus unknowingly introduced to your system by it for any loss of profit or any indirect, special or consequential loss, damage, costs, expenses or any claims which arise out of or in connection with such introduction of a computer virus. Notwithstanding contrary clauses in this Agreement, in the event that EPS Software Engineering AG are deemed liable to you for breach of this Agreement, you agree that EPS Software Engineering AG's liability is limited to the amount actually paid by you for your services or software, which amount calculated in reliance upon this clause. You hereby release EPS Software Engineering AG from any and all obligations, liabilities and claims in excess of this limitation.
*** ** * ** ***
## Notices and Consents
Any notice, request or other communication to either party by the other under this Agreement shall be given by email, fax or conventional mail and shall be confirmed by conventional mail.
*** ** * ** ***
## Assignment of Rights
You shall not assign this Agreement or any benefits or interests arising under this Agreement without EPS Software Engineering AG's prior written permission, such not to be unreasonably withheld.
*** ** * ** ***
## Ownership
The ownership of marketing materials, any software or electronic media, methodologies, strategies, research and designs shall remain with EPS Software Engineering AG. EPS Software Engineering AG reserves the right to use in any way it wishes any programming tools, skills, content, methodologies, strategies and techniques acquired or used in performing its duties under this Agreement. The ownership of any data content created using the software shall remain with the author of that content. EPS Software Engineering AG provides permission for vector and raster representations within the software that it owns to be combined with the representation that the author has created and for the combined result to be persisted in either vector and/or raster format. You may use such graphically persisted representation that you create for any purpose that does not interfere with the business operations of EPS Software Engineering AG.
*** ** * ** ***
## Publicity Rights
EPS Software Engineering AG may not identify you as an EPS Software Engineering AG customer in promotional materials. EPS is granted the right to obtain written permission from you. The permission must be obtained in accordance with the chapter Notices and Consents.
*** ** * ** ***
## General Terms and Law
This Agreement is governed by the laws of Switzerland. You acknowledge that no joint venture, partnership, employment, or agency relationship exists between you and EPS Software Engineering AG as a result of your use of these services. You agree not to hold yourself out as a representative, agent or employee of EPS Software Engineering AG. You agree that EPS Software Engineering AG will not be liable by reason of any representation, act or omission to act by you. EPS Software Engineering AG's performance under this Agreement is subject at all times to existing laws and legal process and nothing contained in this Agreement is in derogation of EPS Software Engineering AG's right to comply with law enforcement requests or requirements relating to your use of EPS Software Engineering AG or information provided to or gathered by EPS Software Engineering AG with respect to such use.
*** ** * ** ***
## Entire Agreement
If any of the provisions of this Agreement is judged to be illegal or unenforceable, the remainder shall continuation in full force and the effect of the remainder of them will be not be deemed to be prejudiced (unless the substantive purpose of this Agreement is then frustrated, in which case either party may terminate this Agreement forthwith on written notice). This Agreement constitutes the entire agreement between EPS Software Engineering AG and you with respect to your use of services, software and/or goods provided by EPS Software Engineering AG, and it supersedes all prior or contemporaneous communications and proposals, whether oral or written, between EPS Software Engineering AG and you with respect thereto. Each party confirms that it has not relied on any representation not recorded in this document inducing it to enter into this Agreement. The address for communication to EPS Software Engineering AG by conventional mail unless you are otherwise notified shall be:
EPS Software Engineering AG
Obere Bahnhofstrasse 19
CH-9500 Wil
Switzerland
---
version: "latest"
language: "en"
---
# Broken links
## Causes
[HTTP status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) are used to decide whether a URL is working or broken. Some websites might return erroneous status codes even though the URL works as expected when visited by the end user. There are several reasons why this might happen.
*** ** * ** ***
## False positives
False positives are URLs that are flagged as broken, but are actually working if visited by a user. There are multiple reasons why this could happen.
### Authentication
Some websites require authentication to view the content behind a URL. These websites should return the status code [401 Unauthorized](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401) to indicate that authorisation is required when no authorisation details have been provided.
Currently, there are no mechanisms in the Easy Link Checker to provide authentication credentials. We are however planning to support such mechanisms in the future. As of now, the solution is to exclude the affected links or to accept the returned status code, as explained below.
### Rate limiting
There are websites that have implemented mechanisms to prevent excessive access to their resources. These mechanisms, referred to as rate limiting, restrict the number of requests a user or IP address can make within a specified time frame. During link checking, a large number of requests may be sent to the same web site, which can cause the requests to be rate limited. If this happens websites should return the status code [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429). However, some websites may return a different status code or no data at all, causing a time out.
To work around rate limiting, the affected links can be excluded from link checking or the status code can be accepted. See below for more information.
### Slow websites and timeouts
Websites can also be slow or not respond at all. Currently a timeout of 5 seconds is configured. If a website does not respond within this time frame the corresponding URL will be considered as broken. At the moment the timeout value is not configurable but we will try to change that in the upcoming releases.
To mitigate this problem one can exclude the affected URLs.
*** ** * ** ***
## Mitigation
### Link exclusion
Links can be included and excluded from the scanning process as describe in the [Filtering links section](https://doc.eps.ch/pelcc/latest/further-configuration.md#Filtering-links) on the [Further configuration page](https://doc.eps.ch/pelcc/latest/further-configuration.md). Excluded links will be listed in a separate category in the result table.
### Status code
Erroneous status codes can be accepted with the [Accepted status codes](https://doc.eps.ch/pelcc/latest/further-configuration.md#Accepted-status-codes) option on the [Further configuration page](https://doc.eps.ch/pelcc/latest/further-configuration.md).
### HTTP vs HTTPS
Most websites today use HTTPS (`https://`) and might not support HTTP (`http://`) anymore. It is not uncommon to redirect requests from an HTTP to the corresponding HTTPS URL using [HTTP redirection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections). If this is the case, the links should be successfully classified by the Easy Link Checker. However, there are websites which return erroneous status codes for all HTTP URLs or they might use other redirection mechanisms. In any case, it is advisable to change your URLs to use HTTPS instead of HTTP if the website offers it.
---
version: "latest"
language: "en"
---
# Further configuration
Under **Further configuration** users have the possibility to exclude or include specific links. There is also the option to enable the scanning of email addresses and set accepted [++HTTP status codes++](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status).
Further Configuration \| Image
*** ** * ** ***
## Filtering links
Links can be included or excluded from the scanning process. Each line in the include or exclude option is treated as a separate parameter where every parameter is treated as a [regular expression](https://regexone.com/). For example this means that [dot characters](https://regexone.com/lesson/wildcards_dot) (`.`) are matching against any character. lychee's equivalent documentation can be found at [Filtering Links](https://lychee.cli.rs/recipes/filtering-links/#_top).
### Exclude links
Links can be excluded from the scanning process. One of the reasons to that is to ignore [false positives](https://doc.eps.ch/pelcc/latest/false-positives.md).
### Include links
By default links are included in the scanning process. If however a link is excluded by a previous rule it can be included again, meaning that includes take precedence over excludes. This makes sense if the inclusion is more specific than the exclusion.
### Example
For example `atlassian\.com` could be excluded while `confluence\.atlassian\.com` could be included again. Note that if the [dot character](https://regexone.com/lesson/wildcards_dot) was unescaped (not prefixed with `\`) a domain such as `atlassianXcom.com` would also be excluded.
*** ** * ** ***
## Email addresses
Users optionally can enable the scanning of email addresses. This option is disabled by default. lychee's equivalent feature is documented in [Mail Addresses](https://lychee.cli.rs/troubleshooting/mail/).
*** ** * ** ***
## Accepted status codes
Links are considered to be working if they return a valid [HTTP status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). In many cases, the default behaviour of which status codes are accepted and which are rejected is sufficient. But some websites may return erroneous status codes that the user considers as successful. (β [false positive](https://doc.eps.ch/pelcc/latest/false-positives.md)) lychee's related option is documented under [Status Codes](https://lychee.cli.rs/troubleshooting/status-codes/).
*** ** * ** ***
## Global Rules Viewer
Confluence Administrators can configure [global rules](https://doc.eps.ch/pelcc/latest/global-settings.md). These rules can be viewed by pressing the **Show Global Rules** Button at the bottom of the **Further Configuration** section.
Global Rules Viewer \| Image
---
version: "latest"
language: "en"
---
# π Get started
* [Overview](https://doc.eps.ch/pelcc/latest/overview.md)
---
version: "latest"
language: "en"
---
# Global Settings
Global Settings define link checker settings at the instance level.
Before each link check runs, local settings are merged with the global settings.
Only Confluence administrators can access and modify these settings.
**Navigation:**
Go to **Confluence Administration (βοΈ)** β **Easy Link Checker** β **Instance Link Checking** β **Global Settings** (second tab)
Global Settings apply to all link checks except the [Website link check macro](https://doc.eps.ch/pelcc/latest/website-link-check-macro.md).
*** ** * ** ***
## Configuration
The two main options of the global settings are the selection of **Pages to exclude** and **Spaces to exclude**. The selected pages and space will never be link checked.
Take a look at [++**Further configuration**++](https://doc.eps.ch/pelcc/latest/further-configuration.md) to see how the additional options can be configured.
Global settings configuration \| Image
*** ** * ** ***
## Global Settings Viewer
Non-admin users can view the active Global Settings in read-only mode.
The Global Settings Viewer is available inside all macros and sections affected by these settings.
---
version: "latest"
language: "en"
---
# Instance link check macro
Users can insert a macro called **Instance** **link check macro** on Confluence pages. When inserting the macro a configuration screen is opened. This configuration screen can also be accessed later by clicking on the **Edit** button of the macro. The macro inserts a button on the page. Once the page is saved the button can be clicked to perform the link checking.
Inserting the macro \| Image
Edit button on the macro \| Image
*** ** * ** ***
## Configuration
The two main options of the macro are the selection of **Pages to exclude** and **Spaces to exclude**. All pages and spaces except the selected ones are link-checked.
Take a look at [**Further configuration**](https://doc.eps.ch/pelcc/latest/further-configuration.md) to see how the additional options can be configured.
Link check macro configuration \| Image
*** ** * ** ***
## Results
After the link check is performed, the [detailed results](https://doc.eps.ch/pelcc/latest/detailed-results.md) get displayed.
*** ** * ** ***
Security: Users can only check links on pages they're permitted to view.
---
version: "latest"
language: "en"
---
# Instance link check
Confluence administrators can access the Instance Link Checking page in Confluence Administration.
This page allows you to run a link check across the entire Confluence instance.
**Navigation** :
Go to **Confluence Administration** (βοΈ) β **Easy Link Checker** β **Instance Link Checking**
Non-administrators cannot open the Instance Link Checking page, but they can still use the [instance link check macro](https://doc.eps.ch/pelcc/latest/instance-link-check-macro.md).
*** ** * ** ***
## Configuration
The two main options of the instance link check are the selection of **Pages to exclude** and **Spaces to exclude**. All pages and spaces except the selected ones are link-checked.
Take a look at [++**Further configuration**++](https://doc.eps.ch/pelcc/latest/further-configuration.md) to see how the additional options can be configured.
Instance link check configuration \| Image
*** ** * ** ***
## Results
After the link check is performed, the [detailed results](https://doc.eps.ch/pelcc/latest/detailed-results.md) get displayed.
---
version: "latest"
language: "en"
---
# Link check macro
Users can insert a macro called **Link check macro** on Confluence pages. When inserting the macro a configuration screen is opened. This configuration screen can also be accessed later by clicking on the **Edit** button of the macro. The macro inserts a button on the page. Once the page is saved the button can be clicked to perform the link checking.
Inserting the macro \| Image
Edit button on the macro \| Image
*** ** * ** ***
## Configuration
The two main options of the macro are the selection of **Pages to check** and **Spaces to check**. The selected pages and spaces are scanned for broken links once the page is saved and the button is used.
Take a look at [**Further configuration**](https://doc.eps.ch/pelcc/latest/further-configuration.md) to see how the additional options can be configured.
Link check macro configuration \| Image
*** ** * ** ***
## Results
After the link check is performed, the [detailed results](https://doc.eps.ch/pelcc/latest/detailed-results.md) get displayed.
---
version: "latest"
language: "en"
---
# Overview
Content on the web is often short-lived and URLs tend to break quickly. This phenomenon of hyperlinks becoming dysfunctional over time is called [link rot](https://en.wikipedia.org/wiki/Link_rot). Although the phenomenon itself cannot be prevented, Easy Link Checker helps Confluence users to easily identify broken links in an automated manner. Behind the scenes Easy Link Checker makes use of a tool and library called [lychee](https://lychee.cli.rs/).
Currently, the Easy Link Checker offers the following starting points:
* The [space link check page](https://doc.eps.ch/pelcc/latest/space-admin-page.md) allows space administrators to check links of the space
* The [instance link check page](https://doc.eps.ch/pelcc/latest/instance-link-check-page.md) allows org administrators to check links on the instance
* The [link check macro](https://doc.eps.ch/pelcc/latest/link-check-macro.md) allows any user to check links of any pages or spaces
* The [website link check macro](https://doc.eps.ch/pelcc/latest/website-link-check-macro.md) allows to check external websites for broken links
* The [instance link check macro](https://doc.eps.ch/pelcc/latest/instance-link-check-macro.md) allows users to check links on the confluence instance
---
version: "latest"
language: "en"
---
# Privacy Policy
EPS Software Engineering AG built the Easy Link Checker - Cloud app as a Commercial app. This SERVICE is provided by EPS Software Engineering AG and is intended for use as is.
This page is used to inform visitors regarding our policies with the collection, use, and disclosure of Personal Information if anyone decided to use our Service.
If you choose to use our Service, then you agree to the collection and use of information in relation to this policy. The Personal Information that we collect is used for providing and improving the Service. We will not use or share your information with anyone except as described in this Privacy Policy.
The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at Easy Link Checker - Cloud unless otherwise defined in this Privacy Policy.
*** ** * ** ***
## Data Storage
Unless otherwise stated, our Cloud Apps do not store customer data locally, but rather store assets, required for the successful operation of our services, in the corresponding Atlassian Cloud product.
An exception that applies to all Cloud Apps is the storage of Atlassian-provided data, required to operate the services. This includes *AddOnKey* , *ProductType* , *ClientKey* , *BaseUrl* , *ServiceEntitlementNumber* , *SharedSecret*.
---
version: "latest"
language: "en"
---
# π Release information
* [Release Notes](https://doc.eps.ch/pelcc/latest/release-notes.md)
* [End User License Agreement](https://doc.eps.ch/pelcc/latest/end-user-license-agreement.md)
---
version: "latest"
language: "en"
---
# Release Notes
## 24.03.2026 - Feature Release
**New Features**
* **Global rules** added to set link check configuration at the instance level
* Links are now **checked** before they are replaced
* Results now update in **real time** when excluding or replacing a link
### 15.12.2025 - UI and Feature Release
**UI Improvements**
* Refined the user interface across the entire app
* Cleaner menus for smoother, more intuitive navigation
* Added a pie chart to visualize link-check results
**Action Buttons**
* After a link check completes, the user can choose to **exclude** or **replace** any broken links
* **Exclude**: Removes the link from all future link checks
* **Replace**: Updates the broken link on the Confluence page with a new link provided by the user
### 03.09.2025 - Feature and Bugfix Release
**Instance Check**
* Confluence admin page to perform link check on entire confluence instance
* Macro to perform link checking on entire instance
* Ability to download history of link check as Excel file
**Fixed Bugs**
* Updated link checker service to newest version for more reliable link checking
### 20.05.2025 - Feature and Bugfix Release
**Website link check macro**
* Macro to perform link checking on external websites
**Fixed Bugs**
* Fixed link checking on bigger spaces
### 04.06.2024 - Feature Release
**Support of internal Confluence links**
* Support of internal URLs in the following form:
* `/wiki/spaces/spacekey/pages/1234/pagetitle`
* `/wiki/spaces/spacekey/blog/2000/01/01/1234/blogtitle`
* `/wiki/spaces/spacekey/overview`
* Support of Confluence's `ac:link` [page link type](https://doc.eps.ch/pelcc/latest/confluence-page-links.md)
### 01.03.2024 - Initial Release
**Features**
* Link checking of any URLs on Confluence pages
* [Space admin page](https://doc.eps.ch/pelcc/latest/space-admin-page.md) to perform link checking on the space
* [Link check macro](https://doc.eps.ch/pelcc/latest/link-check-macro.md) to perform link checking on any pages and spaces
---
version: "latest"
language: "en"
---
# Security Policy
In addition to participating in the required cloud security program, we maintain appropriate organizational and technical measures to ensure data security, in particular to protect your personal data. These measures are updated from time to time to reflect the state of the art. Unfortunately, no data transmission or data storage system can be guaranteed to be 100% secure. If you have reason to believe that your interaction with us is no longer secure, please [contact us](https://focuspro.atlassian.net/servicedesk/customer/portals).
---
version: "latest"
language: "en"
---
# Space link check
Space administrators can access the Space Link Checking page in the Space Settings.
This page allows you to run a link check across the entire Confluence space.
**Navigation** :
Go to **Space settings** (βοΈ) β **App links** β **Link check Space**
Non-administrators cannot open the Space Link Checking page, but they can still use the [link check macro](https://doc.eps.ch/pelcc/latest/link-check-macro.md).
*** ** * ** ***
## Configuration
The main option of the space link check is the selection of **Pages to exclude**. The selected pages not be link checked.
Take a look at [++**Further configuration**++](https://doc.eps.ch/pelcc/latest/further-configuration.md) to see how the additional options can be configured.
Space link check configuration \| Image
*** ** * ** ***
## History
At the top of the **Space Link Check** page, you'll find the link check history.
A new entry is created each time a link check is executed. Clicking an entry opens the [detailed results](https://doc.eps.ch/pelcc/latest/detailed-results.md) of that specific check.
The history entry itself contains only a summary and a list of broken links. Working links are not stored in the history.
Space link check history \| Image
*** ** * ** ***
## Results
After the link check is performed, the [detailed results](https://doc.eps.ch/pelcc/latest/detailed-results.md) get displayed.
---
version: "latest"
language: "en"
---
# Website link check macro
Keep your entire web presence healthy - not just inside Confluence.
Easy Link Checker automatically scans any public website for broken or dead links. Simply enter a URL, and we'll check all links on that page to help you prevent link rot and improve user experience.
*** ** * ** ***
## Key Capabilities
* **External link scan:** Check every link on a given webpage.
* **Company website support:** Regularly audit your homepage for broken links.
* **Confluence integration:** View all results directly inside Confluence in a centralized report.
Inserting the macro \| Image
Edit button on the macro \| Image
*** ** * ** ***
## Configuration
The main options of the macro is the text box **Website URL's** to enter the website URL's. The URL's are scanned for broken links once the page is saved and the button is used.
Take a look at [**Further configuration**](https://doc.eps.ch/pelcc/latest/further-configuration.md) to see how the additional options can be configured.
External website macro configuration \| Image
*** ** * ** ***
## Results
After the link check is performed, the [detailed results](https://doc.eps.ch/pelcc/latest/detailed-results.md) get displayed.
---
version: "latest"
language: "en"
---
# Easy JQL Properties - Cloud
## Documentation
*
### [π Get started](https://doc.eps.ch/pejpc/latest/get-started.md)
* [Overview](https://doc.eps.ch/pejpc/latest/overview.md)
*
### [π‘ Use Cases](https://doc.eps.ch/pejpc/latest/use-cases.md)
* [Try out your first properties](https://doc.eps.ch/pejpc/latest/try-out-your-first-properties.md)
* [Show User Properties in Issues](https://doc.eps.ch/pejpc/latest/show-user-properties-in-issues.md)
*
### [π οΈ Admin guide](https://doc.eps.ch/pejpc/latest/admin-guide.md)
* [Global Settings](https://doc.eps.ch/pejpc/latest/global-settings.md)
* [Project Overview](https://doc.eps.ch/pejpc/latest/project-overview.md)
* [Create User Property custom fields](https://doc.eps.ch/pejpc/latest/create-user-property-custom-fields.md)
*
### [π Documentation](https://doc.eps.ch/pejpc/latest/documentation.md)
* [Setting Properties on Project Level](https://doc.eps.ch/pejpc/latest/setting-properties-on-project-level.md)
* [Setting Properties on User Level](https://doc.eps.ch/pejpc/latest/setting-properties-on-user-level.md)
* [Use Properties in JQL](https://doc.eps.ch/pejpc/latest/use-properties-in-jql.md)
*
### [π Release information](https://doc.eps.ch/pejpc/latest/release-information.md)
* [Release Notes](https://doc.eps.ch/pejpc/latest/release-notes.md)
* [End User License Agreement](https://doc.eps.ch/pejpc/latest/end-user-license-agreement.md)
---
version: "latest"
language: "en"
---
# π οΈ Admin guide
* [Global Settings](https://doc.eps.ch/pejpc/latest/global-settings.md)
* [Project Overview](https://doc.eps.ch/pejpc/latest/project-overview.md)
* [Create User Property custom fields](https://doc.eps.ch/pejpc/latest/create-user-property-custom-fields.md)
---
version: "latest"
language: "en"
---
# Create User Property custom fields
To display the issue reporters user properties in Jira issues, you need to use custom fields. Create a custom field for each user property you want to show in Jira issues.
When creating the custom fields, make sure, to use the field type **User Property**.
Please enter the property key of the user property you want to display in the Jira issues in the **Description** field.
Select the field type \| Image
After pressing the **Create** button, select in which screens the custom field should be shown.
* The custom field will only show a value, if the reporter has set a value for the respective property and the property is active.
* The description field should only contain one property key. To display multiple user properties create multiple custom fields with different user property keys.
For a more detailed example, refer to [Show User Properties in Issues](https://doc.eps.ch/pejpc/latest/show-user-properties-in-issues.md).
---
version: "latest"
language: "en"
---
# π Documentation
* [Setting Properties on Project Level](https://doc.eps.ch/pejpc/latest/setting-properties-on-project-level.md)
* [Setting Properties on User Level](https://doc.eps.ch/pejpc/latest/setting-properties-on-user-level.md)
* [Use Properties in JQL](https://doc.eps.ch/pejpc/latest/use-properties-in-jql.md)
---
version: "latest"
language: "en"
---
# End User License Agreement
**This EULA is in addition to the Atlassian Marketplace Terms of Use (** [Atlassian Marketplace Terms of Use \| Atlassian](https://www.atlassian.com/licensing/marketplace/termsofuse)**).**
*** ** * ** ***
## Privacy Policy
EPS Software Engineering AG built the Easy JQL Properties - Cloud app as a Commercial app. This SERVICE is provided by EPS Software Engineering AG and is intended for use as is.
This page is used to inform visitors regarding our policies with the collection, use, and disclosure of Personal Information if anyone decided to use our Service.
If you choose to use our Service, then you agree to the collection and use of information in relation to this policy. The Personal Information that we collect is used for providing and improving the Service. We will not use or share your information with anyone except as described in this Privacy Policy.
The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at Easy JQL Properties - Cloud unless otherwise defined in this Privacy Policy.
*** ** * ** ***
## Security Policy
In addition to participating in the required cloud security program, we maintain appropriate organizational and technical measures to ensure data security, in particular to protect your personal data. These measures are updated from time to time to reflect the state of the art. Unfortunately, no data transmission or data storage system can be guaranteed to be 100% secure. If you have reason to believe that your interaction with us is no longer secure, please [contact us](https://focuspro.atlassian.net/servicedesk/customer/portals).
*** ** * ** ***
## Data Storage
Unless otherwise stated, our Cloud Apps do not store customer data locally, but rather store assets, required for the successful operation of our services, in the corresponding Atlassian Cloud product.
An exception that applies to all Cloud Apps is the storage of Atlassian-provided data, required to operate the services. This includes *AddOnKey* , *ProductType* , *ClientKey* , *BaseUrl* , *ServiceEntitlementNumber* , *SharedSecret*.
*** ** * ** ***
## Introduction
Unless otherwise indicated, the App is the property of EPS Software Engineering AG. The software and services provided by EPS Software Engineering AG are at all times subject to these terms and conditions. By using the App you confirm your acceptance of, and agree to be bound by, these term and conditions. These terms and conditions shall constitute the agreement between you and EPS Software Engineering AG ("this Agreement").
*** ** * ** ***
## Agreement to Terms and Conditions
This Agreement takes effect on the date on which you install the App into any Confluence installation.
*** ** * ** ***
## Disclaimer
It is not warranted that any software supplied by EPS Software Engineering AG will meet your requirements or that its operation will be uninterrupted or error free. EPS Software Engineering AG exclude and expressly disclaim all express and implied warranties or conditions not stated in this Agreement (including without limitation, loss of profits, loss or corruption of data, business interruption or loss of contracts), so far as such exclusion or disclaimer is permitted under the applicable law. This Agreement does not affect your statutory rights.
*** ** * ** ***
## Warranties and Limitation of Liability
EPS Software Engineering AG warrants that its software and services will be provided using reasonable care and skill on a non-exclusive basis. Where EPS Software Engineering AG supplies any goods supplied by a third party, EPS Software Engineering AG does not give any warranty, guarantee or other term as to their quality, fitness for purpose or otherwise, but shall, where possible, assign the benefit of any warranty, guarantee or indemnity given by the person supplying the goods to EPS Software Engineering AG. Except in respect of death or personal injury caused by EPS Software Engineering AG's negligence, EPS Software Engineering AG shall not be liable to you by reason of any representation (unless fraudulent), or any implied warranty, condition or other term, or any duty at common law, for any loss of profit or any indirect, special or consequential loss, damage, costs, expenses or other claims (whether caused by EPS Software Engineering AG's negligence or the negligence of its servants or agents or otherwise) which arise out of or in connection with the provision of any goods or services by EPS Software Engineering AG. EPS Software Engineering AG shall not be liable or deemed to be in breach of contract by reason of any delay in performing, or failure to perform, any of its obligations if the delay or failure was due to any cause beyond its reasonable control. Any estimates given by EPS Software Engineering AG as to the time of completion of performance of its services (whether completion of the whole or a part of those services) or delivery of its software shall be estimates only and time shall not be of the essence. EPS Software Engineering AG when providing electronic media shall take reasonable care to avoid introducing computer viruses to your computer systems and shall not be liable to you by reason of any virus unknowingly introduced to your system by it for any loss of profit or any indirect, special or consequential loss, damage, costs, expenses or any claims which arise out of or in connection with such introduction of a computer virus. Notwithstanding contrary clauses in this Agreement, in the event that EPS Software Engineering AG are deemed liable to you for breach of this Agreement, you agree that EPS Software Engineering AG's liability is limited to the amount actually paid by you for your services or software, which amount calculated in reliance upon this clause. You hereby release EPS Software Engineering AG from any and all obligations, liabilities and claims in excess of this limitation.
*** ** * ** ***
## Notices and Consents
Any notice, request or other communication to either party by the other under this Agreement shall be given by email, fax or conventional mail and shall be confirmed by conventional mail.
*** ** * ** ***
## Assignment of Rights
You shall not assign this Agreement or any benefits or interests arising under this Agreement without EPS Software Engineering AG's prior written permission, such not to be unreasonably withheld.
*** ** * ** ***
## Ownership
The ownership of marketing materials, any software or electronic media, methodologies, strategies, research and designs shall remain with EPS Software Engineering AG. EPS Software Engineering AG reserves the right to use in any way it wishes any programming tools, skills, content, methodologies, strategies and techniques acquired or used in performing its duties under this Agreement. The ownership of any data content created using the software shall remain with the author of that content. EPS Software Engineering AG provides permission for vector and raster representations within the software that it owns to be combined with the representation that the author has created and for the combined result to be persisted in either vector and/or raster format. You may use such graphically persisted representation that you create for any purpose that does not interfere with the business operations of EPS Software Engineering AG.
*** ** * ** ***
## Publicity Rights
EPS Software Engineering AG may not identify you as an EPS Software Engineering AG customer in promotional materials. EPS is granted the right to obtain written permission from you. The permission must be obtained in accordance with the chapter Notices and Consents.
*** ** * ** ***
## General Terms and Law
This Agreement is governed by the laws of Switzerland. You acknowledge that no joint venture, partnership, employment, or agency relationship exists between you and EPS Software Engineering AG as a result of your use of these services. You agree not to hold yourself out as a representative, agent or employee of EPS Software Engineering AG. You agree that EPS Software Engineering AG will not be liable by reason of any representation, act or omission to act by you. EPS Software Engineering AG's performance under this Agreement is subject at all times to existing laws and legal process and nothing contained in this Agreement is in derogation of EPS Software Engineering AG's right to comply with law enforcement requests or requirements relating to your use of EPS Software Engineering AG or information provided to or gathered by EPS Software Engineering AG with respect to such use.
*** ** * ** ***
## Entire Agreement
If any of the provisions of this Agreement is judged to be illegal or unenforceable, the remainder shall continuation in full force and the effect of the remainder of them will be not be deemed to be prejudiced (unless the substantive purpose of this Agreement is then frustrated, in which case either party may terminate this Agreement forthwith on written notice). This Agreement constitutes the entire agreement between EPS Software Engineering AG and you with respect to your use of services, software and/or goods provided by EPS Software Engineering AG, and it supersedes all prior or contemporaneous communications and proposals, whether oral or written, between EPS Software Engineering AG and you with respect thereto. Each party confirms that it has not relied on any representation not recorded in this document inducing it to enter into this Agreement. The address for communication to EPS Software Engineering AG by conventional mail unless you are otherwise notified shall be:
EPS Software Engineering AG
Obere Bahnhofstrasse 19
CH-9500 Wil
Switzerland
---
version: "latest"
language: "en"
---
# π Get started
* [Overview](https://doc.eps.ch/pejpc/latest/overview.md)
---
version: "latest"
language: "en"
---
# Global Settings
As an administrator of your Jira instance, you can access the settings for Easy JQL Properties in the Jira Global Settings under **Apps** . Navigate to **Easy JQL Properties - Global Settings** in the **App** section.
Global Settings \| Image
*** ** * ** ***
## Configuring Properties
There are four different types of properties. To determine the appropriate choice, consider how you intend to utilise it within the JQL.
* String Property: Allows for searching for the exact phrase only (exact search).
* Text Property: Allows for searching for particular words (fuzzy search).
* Number Property: Allows for numeric range ordering and searching.
* Date Property: Allows for date range searching and ordering.
Each property can be configured with a name, description, type, and, if necessary, predefined values for selection. The selected type determines how the property appears to users. Supported types include:
* String Property: Textfield, Dropdown, Multi-Dropdown
* Text Property: Textfield, Dropdown, Multi-Dropdown
* Number Property: Number, Range
* Date Property: Date-Picker
For Dropdown and Multi-Dropdown types, users can enter options separated by commas in the values. For Range type, start, end, and steps can be defined, separated by commas in the values.
String Property Examples \| Image
Text Property Examples \| Image
Number Property Examples \| Image
Date Property Examples \| Image
Users will only be able to view and set properties that are marked as active.
---
version: "latest"
language: "en"
---
# Overview
The Easy JQL Properties Plugins enable you to define 30 properties at the project or user level to be indexed for the Jira Query Language. They offer four distinct property types:
* **15 String properties** enable searching for an exact phrase only.
* **5 Text properties** allow searching for specific words.
* **5 Number properties** ease range ordering and field searching.
* **5 Date properties** support date range searches and ordering.
Explore Easy JQL Properties for Projects on the Marketplace
Explore Easy JQL Properties for Users on the Marketplace
---
version: "latest"
language: "en"
---
# Project Overview
The **Project** **Overview** page allows you to view all your Jira projects in a single table with their respective JQL properties and filter them dynamically using an advanced filter system.
**Note:** only properties that are set to "active" in the [Global Settings](https://doc.eps.ch/pejpc/latest/global-settings.md) are displayed in the overview table.
Project Overview \| Image
*** ** * ** ***
## 1. Navigate to the Project Overview
* In Jira, click on the **Settings icon** in the top right
* Navigate to **Marketplace apps β Easy JQL Properties for Projects**
* Click on **EJPP Project Overview**
Find Project Overview \| Image
*** ** * ** ***
## 2. Creating your first filter
* Click the **Add filter**button at the top of the page β a new filter bar appears
* In the filter bar, click the **Add Property**dropdown
* Select a property from the list (e.g., **Priority**)
* A new filter button appears in the bar
* Click on the newly created filter button (e.g., **Priority**)
* A pop-up opens based on the property type
* Select or enter your filter value
* Click **Save**
The table automatically updates to show only projects matching your filter!
* a property can only be used **once** per filter bar
* all properties, which were set to "active" in the [Global Settings](https://doc.eps.ch/pejpc/latest/global-settings.md), are listed in the "add property" dropdown
Example Filter \| Image
*** ** * ** ***
## 3. Using different filter types
The filter system supports **four property types**, each with its own filter interface:
String Properties \| Multi-Select
**Used for:** Properties with predefined values (e.g., Priority, Status)
**Features:**
* Multi-select-dropdown
* Search functionality
* Shows all existing values from projects
**Example:**
* Property: "Deployment"
* Options: Cloud, Data Center
* Filter: Select "Cloud" and "Data Center"
* Result: Shows projects with Deployment = Cloud **AND** Data Center
Number Properties \| Single Value or Range
**Used for:**Numeric values (e.g., Budget, Team Size, Downloads)
Features:
* Toggle between **single value** or **range**
* Range supports min/max (both optional)
* Input validation for numbers only
Example:
| **Mode** | **Configuration** | **Result** |
|----------|----------------------|------------------------------|
| Single | Value: 1000 | Projects with exactly 1000 |
| Range | Min: 50, Max 1000 | Projects between 50 and 1000 |
| Range | Min: 50, Max empty | Projects with 50 or more |
| Range | Min: empty, Max 1000 | Projects with 1000 or fewer |
Date Properties \| Single Value or Range
**Used for:**Date values (e.g., Release-Date, Created-Date)
**Features:**
* Toggle between **single value** or **range**
* Calendar picker for easy selection
* Range supports from/to (both optional)
**Example:**
| **Mode** | **Configuration** | **Result** |
|----------|----------------------------------|-------------------------------|
| Single | 2024-06-15 | Projects on exactly this date |
| Range | From: 2024-01-01, To: 2024-12-31 | Projects in 2024 |
| Range | From: empty, To: 2024-12-31 | Projects before end of 2024 |
| Range | From: 2024-01-01, To: empty | Projects from 2024 onwards |
Text Properties \| Free Text Search
**Used for:**Text fields with free-form content (e.g., Description, Notes)
**Features:**
* Case-insensitive substring search
* Matches partial text
**Example:**
* Property: "Description"
* Filter: "meeting"
* Result: Projects with "meeting", "Meeting", "weekly meetings" in description
*** ** * ** ***
## 4. Remove Filters
### Remove a single filter:
* Click the **X icon** next to the property name in the filter button
### **Remove an entire filter bar:**
* Click the **X button** on the right side of the filter bar
*** ** * ** ***
## Understanding the Filter logic
**Within a Filter Bar (AND-logic)**
All filter buttons in the same bar must match for a project to qualify.
Example: "Priority = High" AND "Downloads \> 100" means a project needs **both** conditions to be shown.
**Between Filter Bars (OR-logic)**
A project qualifies if it matches any one of your filter bars.
Example: Projects matching Bar 1 **or** Bar 2 **or** Bar 3 will be shown.
**Special Cases:**
* No filter bars or empty filter barsβ All projects displayed
* Empty filter buttons β Ignored (treated as "no filter")
* Multiple bars with the same filter button β Creates complex OR-conditions
---
version: "latest"
language: "en"
---
# π Release information
* [Release Notes](https://doc.eps.ch/pejpc/latest/release-notes.md)
* [End User License Agreement](https://doc.eps.ch/pejpc/latest/end-user-license-agreement.md)
---
version: "latest"
language: "en"
---
# Release Notes
Because we can't control the plugin versions in cloud, we reference the date when releases were made.
*** ** * ** ***
## xx.06.2026 - Feature Release
**Project Overview for Easy JQL Properties for Project**
Get a complete overview of the active properties across all your projects in the new *Project Overview*. Combine filters to narrow down your search and get the results you need.
**Easy JQL Properties for Project Paid Release**
Updating will require you to purchase a license. If you do not wish to purchase a license right away, you can wait to update the app and continue using the old version without the new features.
### 07.08.2024 - Improvement Release
**Smaller Improvements**
* Added documentation links
### 24.07.2024 - Improvement Release
**Smaller Improvements**
* Added Icons
* Added Dark Mode Support
### 22.07.2024 - Feature Release
**User Property custom fields**
Added the ability to display the reporters user properties directly within the issues. For more details, see [Show User Properties in Issues](https://doc.eps.ch/pejpc/latest/show-user-properties-in-issues.md).
**Admins can manage user properties**
All user properties can now be managed not only by the respective user but also by a global administrator.
### 05.06.2024 - Initial Release
**Define Properties at project level**
Defining 30 properties at the project level.
**Define Properties at user level**
Defining 30 properties at the project level.
**Four distinct property types:**
* **15 String properties**
Enable searching for an exact phrase only.
* **5 Text properties**
Allow searching for specific words.
* **5 Number properties**
ease range ordering and field searching.
* **5 Date properties**
support date range searches and ordering.
---
version: "latest"
language: "en"
---
# Setting Properties on Project Level
As a project admin, you can view and set the properties on project level in the **Project Settings** . Navigate to **Easy JQL Properties for Projects** under **Apps**.
*** ** * ** ***
## Defining Properties
After defining the property values, click the **Save** button to store them.
String Property Examples \| Image
Text Property Examples \| Image
Number Property Examples \| Image
Date Property Examples \| Image
Due to limitations imposed by Atlassian, it's necessary to use predetermined property names in the JQL. You can observe these names in the name column.
---
version: "latest"
language: "en"
---
# Setting Properties on User Level
You will find the Easy JQL Properties for Users under **Apps** β **YOUR APPS** β **Easy JQL Properties for Users**.
*** ** * ** ***
## Defining Properties
After defining the property values, click the **Save** button to store them.
String Property Examples \| Image
Text Property Examples \| Image
Number Property Examples \| Image
Date Property Examples \| Image
Due to limitations imposed by Atlassian, it's necessary to use predetermined property names in the JQL. You can observe these names in the name column.
---
version: "latest"
language: "en"
---
# Show User Properties in Issues
To display the issue reporters user properties in Jira issues, follow these steps. Ensure you have global administrator permissions for the Jira instance. Note that the properties should already have values set according to [Setting Properties on User Level](https://doc.eps.ch/pejpc/latest/setting-properties-on-user-level.md).
*** ** * ** ***
Click the gear icon in the top right corner of the screen and select **Work items**.
Issues settings \| Image
In the left-hand navigation, select **Fields** under **Fields** . Then, click **Create new field** in the top right corner.
Create custom field \| Image
In the **Field Type** dropdown, search for **User Property**.
Enter a name for the custom field that will be displayed in your issues.
In the **Description** field, enter the property key of the user property you want to show in the Jira issues. The property key can be found in the global settings of the **Easy JQL Properties for Users**.
Once everything is set, click **Create**.
Select the field type \| Image
Associate the custom field with the relevant screens, then click **Update**.
Associate the field to screens \| Image
After completing these steps, the issues will display the newly configured custom field, showing the set name and user property value of the issue reporter on the specified screens.
Property shown in Issue \| Image
---
version: "latest"
language: "en"
---
# Try out your first properties
First, configure the properties in the global settings under **Settings** β **Marketplace apps** . There, you choose the app you want to use. In our example, we use the **Easy JQL Properties for Projects β EJPP Global Settings**.
Find the Global Settings \| Image
Now, we set a name, a type and optionally a description. Values will be set later.
Also, don't forget to activate the property under **Active** and click **Save**.
Global Settings \| Image
Next, we move into our project and go to the **Project settings** β **Easy JQL Properties for Projects** and see, that the properties we saved are now accessible to set for all users with project admin permissions.
Here, we can set a value for our property and save it.
Define values \| Image
Lastly, we click **Filters** β **Search work items** . There, we make sure, the filter is set to **JQL** on the very left of the screen.
We can now use our defined values in the input field.
Search with JQL \| Image
See [Use Properties in JQL](https://doc.eps.ch/pejpc/latest/use-properties-in-jql) for a guide on how to use the JQL search.
---
version: "latest"
language: "en"
---
# π‘ Use Cases
* [Try out your first properties](https://doc.eps.ch/pejpc/latest/try-out-your-first-properties.md)
* [Show User Properties in Issues](https://doc.eps.ch/pejpc/latest/show-user-properties-in-issues.md)
---
version: "latest"
language: "en"
---
# Use Properties in JQL
To test the saved properties, click on **Filters** and choose **View all Issues** . From there, set the search criteria to **JQL**.
*** ** * ** ***
## Supported Property Operators
You can use the different types of properties for various comparisons and searches.
* **String Properties** support only the `=` operator
* **Text Properties** support only the `~` operator
* **Number Properties** support `<`, `=<`, `>=`, `>`, `=`, `!=` operators
* **Date Properties** support `<`, `=<`, `>=`, `>`, `=`, `!=` operators
The dates follow the format YYYY-MM-DD.
Due to limitations imposed by Atlassian, it's necessary to use predetermined property names. You can observe the property name when defining the values for the properties.
*** ** * ** ***
## Use Project Properties
To search using the project properties, follow this schema:
project.
### Examples
Give me all the issues from projects located in Switzerland.
project.jqlStringProperty1 = "CH"
Give me all the issues from projects that the Marketing team is working on.
project.jqlTextProperty2 ~ "Marketing"
Give me all the issues from projects with a budget higher than 10'000.
project.jqlNumberProperty1 > 10000
Give me all the issues from projects that need to be finished until 2024-01-01.
project.jqlDateProperty1 =< 2024-01-01
*** ** * ** ***
## Use User Properties
To search using the project properties, follow this schema:
reporter.
assignee.
### Examples
Give me all the issues that were reported by users from building 2.
reporter.jqlStringProperty1 = "Building 2"
Give me all the issues where users from the development team work on.
assignee.jqlTextProperty2 = "Development"
Give me all the issues where new employees work on (have worked on less than 3 projects yet).
assignee.jqlNumberProperty1 < 3
Give me all the issues where the reporters are away over Christmas.
reporter.jqlDateProperty1 < 2023-12-17
---
version: "latest"
language: "en"
---
# Page Tree Creator - DC / Server
## Documentation
*
### [π Get Started](https://doc.eps.ch/pptcs/latest/get-started.md)
* [Overview](https://doc.eps.ch/pptcs/latest/overview.md)
* [Create a Simple PTC Template](https://doc.eps.ch/pptcs/latest/create-a-simple-ptc-template.md)
* [Use a PTC Template](https://doc.eps.ch/pptcs/latest/use-a-ptc-template.md)
*
### [π‘ Use Cases](https://doc.eps.ch/pptcs/latest/use-cases.md)
* [Add a PTC Template to the Confluence Create Dialog](https://doc.eps.ch/pptcs/latest/add-a-ptc-template-to-the-confluence-create-dialog.md)
* [Reuse Placeholder Values (PRO)](https://doc.eps.ch/pptcs/latest/reuse-placeholder-values-pro.md)
* [Workflow with the PTC Create Issue Automation (PRO)](https://doc.eps.ch/pptcs/latest/workflow-with-the-ptc-create-issue-automation-pro.md)
* [Reference to Target or Source](https://doc.eps.ch/pptcs/latest/reference-to-target-or-source.md)
* [External datasource as placeholder options (PRO)](https://doc.eps.ch/pptcs/latest/external-datasource-as-placeholder-options-pro.md)
*
### [π οΈ Admin Guide](https://doc.eps.ch/pptcs/latest/admin-guide.md)
* [General Setting](https://doc.eps.ch/pptcs/latest/general-setting.md)
* [Security Setting](https://doc.eps.ch/pptcs/latest/security-setting.md)
* [Datasource Settings (PRO)](https://doc.eps.ch/pptcs/latest/datasource-settings-pro.md)
*
### [π Documentation](https://doc.eps.ch/pptcs/latest/documentation.md)
* [PTC Templates](https://doc.eps.ch/pptcs/latest/ptc-templates.md)
* [PTC Placeholders](https://doc.eps.ch/pptcs/latest/ptc-placeholders.md)
* [PTC Counter Configuration (PRO)](https://doc.eps.ch/pptcs/latest/ptc-counter-configuration-pro.md)
* [PTC Macros](https://doc.eps.ch/pptcs/latest/ptc-macros.md)
* [Third party macro integration](https://doc.eps.ch/pptcs/latest/third-party-macro-integration.md)
* [1 more pages](https://doc.eps.ch/pptcs/latest/documentation.md)
*
### [π Release Information](https://doc.eps.ch/pptcs/latest/release-information.md)
* [Release Notes](https://doc.eps.ch/pptcs/latest/release-notes.md)
* [Known Issues](https://doc.eps.ch/pptcs/latest/known-issues.md)
* [End User License Agreement](https://doc.eps.ch/pptcs/latest/page-tree-creator-server.md)
---
version: "latest"
language: "en"
---
# Add a PTC Template to the Confluence Create Dialog
With the Page Tree Creator, it is possible to add PTC Templates to the Confluence Create Dialog.
Confluence Create Dialog \| Image
To add a PTC Template to the create dialog, you have to open the PTC Template Macro on the Template page.
Visibility section in PTC template macro \| Image
On the Visibility tab, there is a checkbox **Show in Create Dialog**, which must be checked.
There are also additional options, for limiting the display of said Template.
If Global Visibility is checked, the Template is always shown in the Create Dialog.
If Global Visibility isn't checked, it is possible to add specific spaces, or space categories, to just show the template in the Create Dialog, when the user is on one of these specified spaces.
Additional options for display limitation \| Image
For more information about the PTC Template Macro, visit [Template Macro](https://doc.eps.ch/pptcs/latest/template-macro.md) .
---
version: "latest"
language: "en"
---
# π οΈ Admin Guide
* [General Setting](https://doc.eps.ch/pptcs/latest/general-setting.md)
* [Security Setting](https://doc.eps.ch/pptcs/latest/security-setting.md)
* [Datasource Settings (PRO)](https://doc.eps.ch/pptcs/latest/datasource-settings-pro.md)
---
version: "latest"
language: "en"
---
# Advanced: Add fields
Start with the article [Get Field IDs - via REST API](https://doc.eps.ch/pptcs/latest/Workflow-with-the-PTC-Create-Issue-Automation-(PRO).1921810461.html#PTCSWorkflowwiththePTCCreateIssueAutomation(PRO)-GetFieldIDs-viaRESTAPI) to understand how you can collect your field id.
*** ** * ** ***
## Step 1: Add a PTC Create Issue Automation macro to your PTC Template or any Confluence page
Following the guide [Create a Simple PTC Template](https://doc.eps.ch/pptcs/latest/create-a-simple-ptc-template.md)
*** ** * ** ***
## Step 2: Configure the PTC Create Issue Automation macro
* Fill in all the required fields.
* Switch to the **Add fields** tab
* Add a field id of your choice (in our case "description")
* "description" is the field id from the Jira Field "Description"
* Click the **Add Field** button
* Add a Placeholder of your choice (in our case "__Issue Description__") (it is also possible to set a static value for your **Jira Field Value**)
* Save your page
Added Field - Description \| Image
*** ** * ** ***
**Multi line format**
It is possible to combine a Jira added field placeholder (e.g __issue description__) with a PTC Placeholder macro to set the type to "Multi Line".
Additionally, combined with a PTC Default Value macro a multi line default value can be used.
---
version: "latest"
language: "en"
---
# Advanced: Combine with PTC Default Value macro
You are also able to combine the [PTC Create Issue Automation](https://focuspro.atlassian.net/wiki/pages/resumedraft.action?draftId=1921810461) macro with the [PTC Default Value](https://doc.eps.ch/pptcs/latest/default-value-macro-pro.md) macro.
**Note:** You can use this functionality on following PTC Create Issue Automation macro fields:
* Project Key
* Issue Type ID
* Summary
* Linked Issue Key and Relationship
* **Add fields**
*** ** * ** ***
## Step 1: Add a PTC Create Issue Automation macro to your PTC Template or any Confluence page
Following the guide [Create a Simple PTC Template](https://doc.eps.ch/pptcs/latest/create-a-simple-ptc-template.md)
*** ** * ** ***
## Step 2: Configure the PTC Create Issue Automation macro
Set placeholders for all fields.
* Project Key β __Project Key__
* Issuetype Id β __Issue Type__
* Issue Summary β __Summary__
*** ** * ** ***
## Step 3: Configure Pages with button (target page)
On the page where the PTC button is located (Create Pages or Create Space Button) insert a PTC Default Value macro for your placeholders (for example for __Project Key__).
Inside the macro body inset your default value (like you would use the PTC Default Value macro as normal)
For the project key placeholder you need to insert a valid project key e.g "*TESTPRO*"
For the issue type you need to insert a valid issue type Id e.g "*10102*"
* in this case we insert the Project Key from our test project ("*TESTPRO"*)
*** ** * ** ***
## Step 4: Instantiate your template with the PTC button
Now, you can see your previously selected project key, in the Replace Placeholder dialog.
The same applies to the issue type.
Project Key placeholder configured with PTC Default Value not editable \| Image
---
version: "latest"
language: "en"
---
# Advanced: Create a linked issue
With these optional parameters, you are able to link Jira issues with each other.
*** ** * ** ***
## Step 1: Add a PTC Create Issue Automation macro to your PTC Template or any Confluence page
Following the guide [Create a Simple PTC Template](https://doc.eps.ch/pptcs/latest/create-a-simple-ptc-template.md)
*** ** * ** ***
## Step 2: Configure the PTC Create Issue Automation macro
* First, fill in all the required fields.
* Add the two optional parameters
* (1) **Linked Issue Relationship**
* (2) **Linked Issue Key**
* Configure the two fields
* With Placeholders: __Relationship__ and __Issue to be Linked__
* With static values:
* Relationship: Id of link type. For example: "10001" (clones) or "10001:inward" (is cloned by)
* Linked Issue Key: key of the issue to be linked. For example "PTC-21"
* Save your page
Get the id of your issue link types via REST API
https:///rest/api/2/issueLinkType
Optional parameters \| Image
*** ** * ** ***
## Step 3: Instantiate the page with the Tools-menu option or PTC Button
In the Replace Placeholder dialog, once you have selected a project and an issue type, all fields related to the PTC Create Issue Automation macro and your selection will appear.
Replace Placeholder dialog \| Image
The Relationship placeholder will be a drop down menu with all available options if not set as a static value
* Select a Relationship
* Enter a Valid Issue Key for the **Issue to be linked** placeholder
* Click create
Open the newly created issue in Jira. Under Linked Issues, you can now see you issue relation.
---
version: "latest"
language: "en"
---
# Advanced: Use newly created Issue Number on Confluence page(s) or macros
In the PTC Create Issue Automation macro you have the option to set a **Issue number placeholder** parameter, the placeholder you define here will be replaced on the Confluence page with the new created issue number.
* In the page title or body
* As page label
* Confluence or Other third-party macros
Issue number placeholder \| Image
It's also possible to recreate the complete Issue Key. The issue key can be used to link issues with one another like epic link, issue links or subtasks.
**Note:** The issue key consisting of two pieces of information:
**Project Key** and **Issue Number**
* \[*project_key* \]-\[*issue_number*\] will be β PTC-21
*** ** * ** ***
## For Example
* Define a placeholder for the project key inside the PTC Create Issue Automation (e.g __Project Key__) and configure a Issue Number Placeholder (e.g __Issue Number__).
* Now you can combine these "__Project Key__-__Issue Number__" on the new page this will automatically replaced with the correct replacements. The final result will be a valid Issue Key which you can use freely.
* Combine it with a the PTC Default Value macro (Epic Link, Linked Issue etc)
* Combine it with the PTC Jira macro and Confluence Jira macro on a child page. (see [PTC Jira](https://doc.eps.ch/pptcs/latest/jira-macro.md) macro)
---
version: "latest"
language: "en"
---
# Create a Jira issues with the Page Tree Creator
## Step 1: Add a PTC Create Issue Automation macro to your PTC Template or any Confluence page
Following the guide [Create a Simple PTC Template](https://doc.eps.ch/pptcs/latest/create-a-simple-ptc-template.md)
*** ** * ** ***
## Step 2: Configure the PTC Create Issue Automation macro
Configure for example the macro like below with Placeholders.
PTC Create Issue Automation Macro \| Image
* Project Key β __Project Key__
* Issuetype Id β __Issue Type__
* Issue Summary β __Summary__
Save your page
**Note:** This are the minimum required configurations you need.
*** ** * ** ***
## Step 3: Instantiate your new template with the PTC app
* Use the Create Pages or Create Space Button
* Also possible in the tools-menu on the right, Copy Page Tree or Create Space
* Select a target and pages and click next
* In the Replace Placeholder dialog, you can see the placeholders __Project Key__ and __Issue type__
* Now you can select a Jira project, and then the issue type. The issue types may vary for different projects.
Replace Placeholder dialog with selected Project \| Image
* As soon as you select an Issue Type, all other associated fields for that particular issue type are loaded into the Replace Placeholder dialog.
* For example Summary
* All fields that are required in Jira
* Added fields in the PTC Create Issue Automation macro (see below)
* Fill out the fields and click **Create**
*** ** * ** ***
## Final Result
On the new page, you will now find a Jira macro that links the Confluence page to the Jira issue:
On the Jira issue you can find a section **Issue Links** β **Description Page** there is your link to the Confluence Page.
Created Page with Page Tree Creator \| Image
---
version: "latest"
language: "en"
---
# Create a Simple PTC Template
## Create a Template
1. Go to any existing Confluence page or create a new page
2. Open the page edit mode and add a [Template Macro](https://doc.eps.ch/pptcs/latest/template-macro.md)
1. Select a Name for your template e.g. "Meeting Notes"
2. Add any placeholder you like in the placeholder tab on the left
3. Go to visibility and check show in create dialog (Only needed for option 1)
3. Add [PTC Placeholders](https://doc.eps.ch/pptcs/latest/ptc-placeholders.md) to your page
4. Add as many subpages as you like and reuse the placeholders or create new ones
5. [Use your template](https://doc.eps.ch/pptcs/latest/use-a-ptc-template.md)
---
version: "latest"
language: "en"
---
# Create epics and associated issues
## Create a template for an epic
### Step 1: Prepare to create a Jira issue with the issue type epic
Follow [Create a Jira issues with the Page Tree Creator](https://doc.eps.ch/pptcs/latest/create-a-jira-issues-with-the-page-tree-creator.md)
Either select the issue type epic, when creating the issue or make it fixed.
The issue type id of epic can be found via the following REST API:
`https:///rest/api/2/issuetype`
JSON
{
"self":"http://localhost:2990/jira/rest/api/2/issuetype/10000",
"id":"10000", <--------- THIS IS THE ID OF THE ISSUE TYPE EPIC
"description":"Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down.",
"iconUrl":"http://localhost:2990/jira/images/icons/issuetypes/epic.svg",
"name":"Epic",
"subtask":false
}
Enter Issuetype ID \| Image
### Step 2: Add a PTC Default Value macro to save the epic issue key
Follow [Use newly created Issue Number](https://doc.eps.ch/pptcs/latest/advanced-use-newly-created-issue-number-on-conflue.md) and [Combine with PTC Default Value macro](https://doc.eps.ch/pptcs/latest/advanced-combine-with-ptc-default-value-macro.md)
Define a Placeholder in the Default Value macro to be used for assigning issues to the epic.
Define placeholder for assigning issue to epic \| Image
*** ** * ** ***
## Create a template to assign an issue to an epic
### Step 1: Prepare to create a Jira issue with the additional field for epic link
Follow [Create a Jira issues with the Page Tree Creator](#)
Add an additional field for the epic link with the value being the placeholder from the default value macro.
The field id of epic can be found via the following REST API:
`https:///rest/api/2/field`
JSON
{
"id": "customfield_10002", <--------- THIS IS THE FIELD ID OF EPIC LINK
"name": "Epic Link",
"custom": true,
"orderable": true,
"navigable": true,
"searchable": true,
"clauseNames": [
"cf[10002]",
"Epic Link"
],
"schema": {
"type": "any",
"custom": "com.pyxis.greenhopper.jira:gh-epic-link",
"customId": 10002
}
}
Add additional field for epic link \| Image
*** ** * ** ***
## Instantiate your pages
### Step 1: Instantiate your template to create the epic
The macro body of the Default value macro will be filled out with the corresponding epic issue key.
### Step 2: Instantiate your template to create an issue being assigned to the epic
Copy the second template as a descendant to the new epic page.
The epic link will be set with the epic issue key.
---
version: "latest"
language: "en"
---
# Create Issue Automation Macro (PRO)
With the PTC Create Issue Automation macro you can easily create Jira issues when you instantiate a template with the PTC.
Just insert the macro on the template page and configure it for your purpose.
You can add placeholders in the macro parameters and even use the [Default Value Macro](https://doc.eps.ch/pptcs/latest/default-value-macro-pro.md) to configure the Create Issue Automation.
On instantiation of a PTC template a Jira issue will be created in your primary Jira application. On the created Confluence page a Confluence Jira macro will be inserted and in the created Jira issue there will be a field **Description Page** under **Issue Links** linking to the Confluence page where the issue was first created using the PTC.
* Currently we only support one primary Jira Application Link
* Currently not all Jira fields are supported (see [Supported Jira Field-Types](https://doc.eps.ch/pptcs/latest/Create-Issue-Automation-Macro-(PRO).1905557625.html#PTCSCreateIssueAutomationMacro(PRO)-SupportedJiraField-Types))
* For the correct configuration of the **Added Fields** it is important that you insert the correct Jira **field id** . (Jira **field id** does not equal Jira **field name** ). For more information on how to find the correct FieldId's, please refer to the [Get Field IDs - via REST API](https://doc.eps.ch/pptcs/latest/Workflow-with-the-PTC-Create-Issue-Automation-(PRO).1921810461.html#PTCSWorkflowwiththePTCCreateIssueAutomation(PRO)-GetFieldIDs-viaRESTAPI)
* For some use case examples see [Workflow with the PTC Create Issue Automation](https://doc.eps.ch/pptcs/latest/workflow-with-the-ptc-create-issue-automation-pro.md)
*** ** * ** ***
## Create Issue Automation workflow in the Placeholder Replace dialog
The Create Issue Automation macro will automatically load and prompt the user to fill out any Jira fields that are required for issue creation after selecting the project and issue type.
Also, fields that you have added in **Add fields** (User Added Fields) but do not belong to the creation of an issue will be removed.
On the other hand, fields that are required for creation (Jira Added Fields) are loaded into the Replace Placeholders dialog.
| **Parameter** | **Displayed in Placeholder Replace dialog** ||
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| | **Field Label** | **Input Type** |
| Project Key | Cleaned Placeholder (without placeholder marker) *If static:* pre-selected if exists | Dropdown |
| Issuetype ID | Cleaned Placeholder (without placeholder marker) *If static:* pre-selected if exists | Dropdown |
| Issue Summary | Cleaned Placeholder (without placeholder marker) *If static:* Will be not displayed | Text Input |
| User Added Fields | Cleaned Placeholder (without placeholder marker) *If static:* Will be not displayed | Depends on configuration |
| Jira Added Fields | The label of added fields are always the Jira **field id** * Jira Added Fields are required for the issue creation. The PTC resolves these fields on his own and will load them into the Replace Placeholder dialog. | Depends on configuration |
*** ** * ** ***
## Macro Parameters
### Macro Parameters Tab - Configure Issue
Macro parameters should either be filled with ++one++ placeholder ++or++ a static value. If you configure a static value for the project or issue type those Dropdowns will not be editable in the Replace Placeholder dialog.
**Note:** If you are using placeholders you can configure your placeholders with the [Default Value Macro (PRO)](https://doc.eps.ch/pptcs/latest/default-value-macro-pro.md) for more dynamic use of your PTC Templates.
| **Parameter** | **Description** |
|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Project Key **required** | The key of the project in which the issue should be created |
| Issuetype ID **required** | The issue type id of the issue to be created (e.g 10100) |
| Issue Summary **required** | The summary of the issue to be created |
| Automation Required **required** | Set if the Jira Issue creation is required. If checked: * The user is **not** able to instantiate the template without creating a Jira Issue If unchecked: * The user has the choice to select a toggle button **Create Jira Issue** to skip the Jira Issue creation in the Relace Placeholder dialog. If the issue creation is skipped the Jira issue will not be created and there will not be a Confluence Jira macro on the created page. |
| **Optional Parameter** | |
| Confluence Page **Optional** | Insert a placeholder to have a dropdown in the placeholder replacement dialog to select a Confluence Page, which will be linked to the new created issue. |
| Issue Number placeholder **optional** | Insert a placeholder to have the placeholder be replaced by the issue number of the created issue. You can then use this placeholder in the other parts of the template and sub pages as usual. (e.g. JIRA-15 has issue number 15) |
| Linked Issue Relationship **optional** | Insert a placeholder to have a dropdown in the Replace Placeholder dialog to select the relationship between the created issue and the issue you link to it. **Note:** This only works together with the **Linked Issue Key** parameter. e.g for clones insert "10001" and for is cloned by "10001:inward" |
| Linked Issue Key **optional** | Insert a placeholder to replace it with an issue key to be linked to your newly created issue. **Note:** This only works together with the **Linked Issue Relationship**. |
### Macro Parameters Tab - Add fields
In the **Add fields** section you can configure additional fields. Fields that are not required for issue creation but you'd like to fill out anyway.
As soon as you click the Add Field button, two new text fields and one check-box appear:
* Jira Field ID
* Jira Field Value
* Required
Added Jira Field with fieldId and placeholder as value \| Image
| **Parameter** | **Description** |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| (1) Jira Field id | Enter a valid Jira **field id**(see Get Jira Field ID) **Note:** The Jira **field id** is **not**the same as the Jira field name! (e.g. the Jira Field "Description" has field id "description", custom fields usually have an id like "customfield_10101") |
| (2) Jira Field Value | Enter a placeholder which will be displayed in the Placeholder Replace dialog. * You can configure your placeholder with the [Default Value Macro (PRO)](https://doc.eps.ch/pptcs/latest/default-value-macro-pro.md) for more dynamic use of your template. or * Set a static value. The static value will be inserted as value and not displayed in the Replace Placeholder dialog. |
| (3) Required | If checked: * The user has to fill out the input field before template instantiation If unchecked: * The input field can be empty and will be ignored in the Jira Issue Creation. |
### Self-resolving Jira Fields
| **Self-resolving Fields** ||
|-------------|----------------------------------------------------------------------------------------------------|
| Reporter | The **Reporter** is automatically set to the user who instantiated the template page. |
| Issue Links | An **Issue Links** with the name "Description Page" is created with a link to the PTC target page. |
### Supported Jira Field-Types
| **Type** | **Name** | **Default Value Macro** |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Text Field | type: string |  supported |
| Number Field | type: number |  supported |
| Select List (single choice) | type: option |  Only works with id of option |
| Select List (multi choice) | type: array items : option |  Only works with id of option and only one option as default |
| e.g Epic Link | type: any |  supported |
| Date | type: date |  supported |
| Assignee | type: user |  Not supported |
| User  Currently only works on Confluence 8.4 or higher versions | type: user |  Not supported |
| Component | type: component | |
| Priority | type: priority |  Only works with id of priority (see below on how to get the id of the priorities) |
| Version (single choice) | type: version |  Only works with id of version (see below on how to get the id of the priorities) |
| Version (multi choice) | type: array items: version |  Only works with id of version (see below on how to get the id of the priorities) |
| Labels | type: array items: string |  supported (split by comma for multiple labels as default) |
**Get ids of priority for a project**
Find out what priority ids can be used as default value. Open the following URL in your browser, making sure that you substitute `` and `` with your actual Jira Base URL and your Jira project.
https:///rest/api/2/project//priorityscheme
Overview of all priorities:
https:///rest/api/2/priority
**Get ids of version for a project**
Find out what version ids can be used as default value. Open the following URL in your browser, making sure that you substitute `` and `` with your actual Jira Base URL and your Jira project.
https:///rest/api/2/project//versions
*** ** * ** ***
## Combination with PTC Placeholder Macro
A Create Issue Automation Macro can be combined with a PTC Placeholder Macro with following types.
### Jira Field Type: Text Field
* Placeholder Type Multiline: Allows user to insert a multi line value. e.g for description of issue
* Placeholder Type Datapicker: Allows user to select a value from an [external Datasource](https://doc.eps.ch/pptcs/latest/external-datasource-as-placeholder-options-pro.md)
---
version: "latest"
language: "en"
---
# Create Pages Button Macro
With the Create Pages Button macro, you can copy a page or a page tree with a single click. The Create Pages Button can be inserted on any regular Confluence page.
*** ** * ** ***
## Macro Parameters
| **Parameter** | **Input Field Type** | **Description** |
|--------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Button Name **required** | Text Field | Give your button a name, special characters and placeholders are allowed. |
| Source Page **required** | Text Field / Dropdown | Specifies the root page of your template. This template is a normal confluence page. When the button is clicked, the root page and all its children are used as template for the new page tree. |
| Target Page | Dropdown | Defines where the new pages are added to. If the field is empty the target page will be the child page of the page where the button is. |
| Top Page Labels | Text Field | Values entered here are attached only to the root page of the newly created page tree. |
| Permitted Groups | Test Field | Groups entered here are allowed to use the button. If no group is specified all users are allowed to use the button. |
| Hide disabled Button | Checkbox | If checked, the button is hidden for users who haven't got permission to use the button. |
| Resolve Page Titles | Checkbox | If **unchecked** and using the button with same parameters for a second time, it would result in an error. If **checked**, duplicated page title conflicts are avoided |
| Watch Pages | Dropdown | Select if only the main/source page, all pages or no pages should be watched after instantiation. |
| Edit Mode | Checkbox | If checked, you get redirected to the edit mode of the copied page after instantiation. |
| Copy Options | Checkbox | Defines the content that will be copied to the new page * Attachments - Attachments will be copied * Labels - Labels will be copied * Restrictions - Restrictions will be copied |
*** ** * ** ***
## Customize Wizard - Macro Parameters
| **Parameter** | **Input Field Type** | **Description** |
|------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Source Select | Radio Button | Defines whether the source page option is displayed in the creation wizard * Show - Displays source selection in the creation wizard. * Hide - Hides the source selection in the creation wizard. * Disabled - Displays source selection in the creation wizard but disables the dropdowns. |
| Target Select | Radio Button | Defines whether the target page option is displayed in the creation wizard * Show - Displays target selection in the creation wizard. * Hide - Hides the target selection in the creation wizard. * Disabled - Displays target selection in the creation wizard but disables the dropdowns. |
| Page Selection | Checkbox | When checked, the user will be able to select/deselect sub-pages of the page being copied in the wizard. If a page is selected, it will be copied. |
| Show Page Title Prefix | Checkbox | Defines whether the page title prefix input field is displayed in the creation wizard |
| Show Copy Options | Checkbox | Defines whether the checkbox to change the copy behavior of the selected item is displayed in the wizard. * Attachments - Show option to copy Attachments * Labels - Show option to copy Labels * Restrictions - Show option to copy Restrictions |
[Next Page](https://doc.eps.ch/llms-full.txt/1)