Skip to content

solutionexchange/TemplateDependenceChecker

Repository files navigation

TemplateDependenceChecker

Version 2.3

"TemplateDependenceChecker" is a SmartTree enhancement for the Opentext Website Management Server allowing to check the assignment of every template of a content class within all connected projects.

© Stefan Buchali, UDG United Digital Group, www.udg.de

This is third party software. The author is not affiliated in any manner with Open Text Corporation.

Installation

Installing the plugin on the server

Copy the folder "TemplateDependenceChecker" into the folder "plugins" of your CMS installation.
Switch to Server Manager and import the plugin via "Administer Plug-Ins" - "Plug-Ins", action menu "Import Plug-In".
Assign it to all your desired projects and set the appropriate user rights there if necessary.
Activate it.

The plugin then appears in the action menu of every content class node within these projects.

Code settings

TemplateDependenceChecker_dlg.asp

This file contains the dialog box the plugin will start with. Translate the german variables (lines 18-28) if necessary.

TemplateDependenceChecker_do.asp

This file contains the plugin script itself. Translate the german variables (lines 21-33) if necessary.

The plugin must be run under an administrator account. Please enter the corresponding login data in lines 18+19.
This user must have the role "Administrator" and "Template Editor" in all projects, and the number of allowed sessions should be set to at least 2.
The user also must have access to all language variants in every project. If a language variant is denied for him, it will not occur in the report, and there will be no error message regarding this.

How to use

In every project the plugin was assigned, it will appear in the action menu of content classes. After clicking OK, the plugin reads the project variant assignment of the selected content class in every project that is connected to the corresponding content class folder.

Optionally it also counts the number of active instances of the content class within the master project.

This process can take some minutes.

Finally it will show a report that lists:

  • Every connected project
  • And for each one of these projects:
    • Which template of the content class is assigned to a project variant
    • Which one is not assigned at all.
    • The number of active instances of the content class

The report looks like the following block. This block repeats for each project:

Project: <Name of the connected project>

<Name of the 1st template>: -  
<Name of the 2nd template >: Assigned to <Number> project variants

<Name of language variant 1>: <Number> Instances
<Name of language variant 2>: <Number> Instances

(The "-" after the first template means that it is not assigned).

The following error messages can occur:

  • "Insufficient user rights to perform the task" (Variable dlgInsufficientRights):
    The user entered in section TemplateDependenceChecker_do.asp cannot log in.
  • "No rights" (Variable dlgNoRights):
    The user entered in section TemplateDependenceChecker_do.asp is not assigned to the project.
  • "Folder not found" (Variable dlgFolderNotFound):
    The project is connected to the content class folder, but it does not use it.
  • "Content class not found" (Variable dlgContentClassNotFound):
    The content class cannot be accessed (e.g. due to authorization packets).

Changelog

Version 2.3
August 9, 2022
Admin-Login now via Access-Token

Version 2.2
August 25, 2017
Also take instances of the master project into account (optionally)

Version 2.1
May 31, 2017
Language specific counting of instances

Version 2.0
September 10, 2014
Add counting instances

Version 1.2
October 25, 2013
Adaption for version 11 (ENU instead of ENG in plugin XML file)

Version 1.1
April 28, 2011
Adaption for version 10 (ASP object changed)

Version 1.0
May 6, 2009
Plugin created

License and exclusion of liability

This software is licensed under a Creative Commons GNU General Public License. Some rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with TemplateDependenceChecker. If not, see http://www.gnu.org/licenses.

The GNU General Public License is a Free Software license. Like any Free Software license, it grants to you the four following freedoms:

  1. The freedom to run the program for any purpose.
  2. The freedom to study how the program works and adapt it to your needs.
  3. The freedom to redistribute copies so you can help your neighbor.
  4. The freedom to improve the program and release your improvements to the public, so that the whole community benefits.

You may exercise the freedoms specified here provided that you comply with the express conditions of this license. The principal conditions are:

  • You must conspicuously and appropriately publish on each copy distributed an appropriate copyright notice and disclaimer of warranty and keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of the GNU General Public License along with the Program. Any translation of the GNU General Public License must be accompanied by the GNU General Public License.
  • If you modify your copy or copies of the program or any portion of it, or develop a program based upon it, you may distribute the resulting work provided you do so under the GNU General Public License. Any translation of the GNU General Public License must be accompanied by the GNU General Public License.
  • If you copy or distribute the program, you must accompany it with the complete corresponding machine-readable source code or with a written offer, valid for at least three years, to furnish the complete corresponding machine-readable source code.

Any of the above conditions can be waived if you get permission from the copyright holder.