Skip to content

Column Expansion Procedure (ver.1.4.8 and later)

Overview

In Community Edition, 26 columns are available for each of Class, Numeric Value, Date, Description, Check and Attachments, 156 columns in total, but in Enterprise Edition you can expand the columns.

DB Upper Limit of Columns Available in Enterprise Edition Remarks
SQL Server Up to 900 in total across the six column types
PostgreSQL Up to 900 in total across the six column types
MySQL Up to 256 in total across the six column types MySQL can be used with Pleasanter ver1.4.9.0 and later.

The expanded columns are created with serial numbers starting from "001" (Classification001, Classification002 and so on).
Follow these steps when you expand the columns or change the number of expanded columns.

Cautions

Expanding the columns changes the table structure of the table with a deadline (the Issues table) and the record table (the Results table). In particular, when you reduce the number of columns, the columns themselves are deleted from the table, so the data registered in the columns added by the column expansion is lost. Always take a backup before you expand the columns.

Prerequisites

These steps assume that you have upgraded Pleasanter to Enterprise Edition.

Outline of the Steps

  1. Backing up the database
  2. Editing and placing Issues.json and Results.json
  3. Running CodeDefiner
  4. Checking the column expansion

Operation Procedure

1. Backing Up the Database

Back up the database according to the environment you use. Our online manual is also a useful reference.
FAQ: How to backup and restore Pleasanter's DB data

2. Editing and Placing Issues.json and Results.json

Change Issues.json and Results.json in \App_Data\Parameters\ExtendedColumns under the Pleasanter installation folder (*).

  • Issues.json: the table with a deadline
    {
   "TableName": "Issues",
   "ReferenceType": "Issues",
   "Class": 0,
   "Num": 0,
   "Date": 0,
   "Description": 0,
   "Check": 0,
   "Attachments": 0
}
  • Results.json: the record table
    {
   "TableName": "Results",
   "ReferenceType": "Results",
   "Class": 0,
   "Num": 0,
   "Date": 0,
   "Description": 0,
   "Check": 0,
   "Attachments": 0
}

  • Settings

    Column Description
    Class The number of columns to add to Classification
    Num The number of columns to add to Numeric Value
    Date The number of columns to add to Date
    Description The number of columns to add to Description
    Check The number of columns to add to Check
    Attachments The number of columns to add to Attachments

When you install following the steps in our online manual, the Pleasanter installation folder is as follows. Read it as appropriate for the environment you use.

  1. Windows environment
    C:\web\pleasanter\Implem.Pleasanter
  2. Linux environment
    /web/pleasanter/Implem.Pleasanter
  3. Azure App Service environment
    C:\home\site\wwwroot\

3. Running CodeDefiner

Run CodeDefiner with reference to our online manual.

  1. Windows environment
  2. Open a Command Prompt (or PowerShell or a terminal) and run the following commands.
    cd C:\web\pleasanter\Implem.CodeDefiner
dotnet Implem.CodeDefiner.dll _rds
  3. Confirm that it is Enterprise Edition.
    Confirm that "<INFO> Configurator.OutputLicenseInfo: This edition is "Enterprise Edition"." is shown in the log, and select "y".
    The CodeDefiner log on Windows showing "Enterprise Edition"
    • The Licensee in the license information can be garbled depending on the CLI you use.

If running CodeDefiner would reduce the number of expanded columns in use, the error message "<ERROR> Configurator.CheckColumnsShrinkage: The columns will be shrinked." is displayed, it exits and CodeDefiner is not run. When this error occurs, the columns that would be reduced are displayed as shown below, so check again whether the parameter file and the license are applied correctly.
The CodeDefiner log ending in an error because columns would be reduced

If you accept the reduction of the columns, specify the argument "/f" and run it.

dotnet Implem.CodeDefiner.dll _rds /f

  1. Linux environment
  2. Run the following commands. refers to the user specified in the "script for the Pleasanter service". For details, refer to our online manual.
    cd /web/pleasanter/Implem.CodeDefiner
sudo -u <the user that starts Pleasanter> /usr/local/bin/dotnet Implem.CodeDefiner.dll _rds

  3. Confirm that it is Enterprise Edition.
    Confirm that "<INFO> Configurator.OutputLicenseInfo: This edition is "Enterprise Edition"." is shown in the log, and select "y".
    The CodeDefiner log on Linux showing "Enterprise Edition"

    • The Licensee in the license information can be garbled depending on the CLI you use.

    If running CodeDefiner would reduce the number of expanded columns in use, an error occurs and CodeDefiner is not run. When this error occurs, the columns that would be reduced are displayed as shown below, so check again whether the parameter file and the license are applied correctly.
    The columns that would be reduced, listed when the error occurs on Linux

    If you accept the reduction of the columns, specify the argument "/f" and run it.
    sudo -u <the user that starts Pleasanter> /usr/local/bin/dotnet Implem.CodeDefiner.dll _rds /f
    1. Azure App Service environment
    1. Select CodeDefiner from the directory list of Kudu and confirm that the prompt becomes C:\home\site\CodeDefiner.
    2. Run the following command.

    dotnet Implem.CodeDefiner.dll _rds /p C:\home\site\wwwroot

    3. Confirm that it is Enterprise Edition.
    Confirm that "<INFO> Configurator.OutputLicenseInfo: This edition is "Enterprise Edition"." is shown in the log, and select "y".
    The CodeDefiner log on Azure App Service showing "Enterprise Edition"
    * The Licensee in the license information can be garbled depending on the CLI you use.

    If running CodeDefiner would reduce the number of expanded columns in use, an error occurs and CodeDefiner is not run. When this error occurs, the columns that would be reduced are displayed as shown below, so check again whether the parameter file and the license are applied correctly.
    The columns that would be reduced, listed when the error occurs on Azure App Service

    If you accept the reduction of the columns, specify the argument "/f" and run it.

    dotnet Implem.CodeDefiner.dll _rds /p C:\home\site\wwwroot /f

The paths above are those for an installation that follows the steps in our online manual. Read them as appropriate for the environment you use.

4. Checking the Column Expansion

  1. Restart Pleasanter with reference to our online manual.
  2. Windows environment
    1. Open Internet Information Services (IIS) Manager.
    2. In the left pane, select "Sites" - "Default Web Site", and click "Restart" in the right pane.
  3. Linux environment
    1. Run the following command.
      sudo systemctl restart pleasanter

  4. Azure App Service environment

    1. Open the App Service and click "Restart".

  5. Log in to Pleasanter, open any table, and from "Administration" - "Manage Table" on the navigation menu, confirm on the "Editor" tab that the expanded columns (Classification001, Numeric Value001 and so on) are shown in the option list.