Configuration and Management of PlantReporter Report Templates in Relative Project Paths for Collaboration Projects

PlantReporter is a specialized software solution designed for use in plant design and documentation projects. It facilitates the creation, management, and distribution of reports and documentation within projects across various industrial environments. PlantReporter is particularly valuable for teams working on collaborative projects, as it ensures adherence to standards and consistency in reporting.

When working on collaboration projects, it is important to ensure that report templates are saved in the correct relative project path. This guarantees that the check-in/check-out mechanisms work correctly.

Follow the steps below to configure the reports correctly:

1. Avoid Using Custom Path for Collaboration Projects

• Important: Do not specify a relative path in project path under the “Custom Path” option. Doing so will disable the check-in/check-out mechanisms necessary for collaboration projects.
• This setting is primarily intended for using static, user-specific paths on the hard drive.

2. Change the Report Template Storage Path

• If you want to store reports in a location other than the default path (\ACPlantTools\PlantReporter\ReportFiles), you need to modify the xml file once for each user.
• This configuration file is stored locally on each user’s machine.

  

3. Configure the Path in PlantReporter.xml

• The PlantReporter.xml file is located in the following directory:
  %ProgramData%\ACPlant Consult\PlantTools\PlantReporter
• Ensure the path in this file is set up with a structure similar to the following example:
  <ProjectRelativePath>Related Files\01_AUXALIA</ProjectRelativePath>

Note: The folder structure provided is just an example. You can customize the path according to your project needs, but it must follow a similar format to ensure proper functionality.

4. Automatic Folder Creation

• When a new project is selected, if the specified folder (e.g., Related Files\01_AUXALIA) does not exist, it will be automatically created.

5. Import Reports into the Project

• Initially, the folder will not contain any report templates. You need to import the report templates manually into PlantReporter using the “Import” function. Once imported, the templates will be available to all users collaborating on the project.