historyLevel property not found when creating tables manually

Details

Type: Bug
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: 5.9
Fix Version/s: 5.11
Component/s: Engine
Labels:
None

Number of attachments :
0

Description

1) Create tables manually using the Activiti DDLs
2) Run Activiti in ProcessEngineConfiguration.DB_SCHEMA_UPDATE_FALSE mode -> exception is thrown because historyLevel property is not in DB
3) We overrode dbSchemaCheckVersion() to make this work (see below)

            @Override
            public void dbSchemaCheckVersion() {
            	if (isEngineTablePresent()) {
            		Integer configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel();
            		PropertyEntity historyLevelProperty = selectById(PropertyEntity.class, "historyLevel");
            		if (historyLevelProperty == null) {
            			PropertyEntity property = new PropertyEntity("historyLevel", Integer.toString(configuredHistoryLevel));
        	    	    insert(property);
            		}
            	}

            	super.dbSchemaCheckVersion();
            }

We verified the error and the fix using Oracle DB and DDLs.

Issue Links

duplicates

ACT-1333 Fix upgrade script

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Tom Baeyens added a comment - 08/Nov/12 8:31 AM

I see this on line 11 in the engine create scripts:

insert into ACT_GE_PROPERTY
values ('schema.history', 'create(5.11-SNAPSHOT)', 1);

I don't understand how the property is not found after you ran the activiti ddls manually. Please reopen and add more clues if we should look at this in more detail.

Show

Tom Baeyens added a comment - 08/Nov/12 8:31 AM I see this on line 11 in the engine create scripts: insert into ACT_GE_PROPERTY values ('schema.history', 'create(5.11-SNAPSHOT)', 1); I don't understand how the property is not found after you ran the activiti ddls manually. Please reopen and add more clues if we should look at this in more detail.

Hide

Permalink

Etienne Studer added a comment - 08/Nov/12 1:11 PM - edited

Hi Tom

The property not found is called 'historyLevel' which is not the same as the property 'schema.history':

...
int configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel();
PropertyEntity property = new PropertyEntity("historyLevel", Integer.toString(configuredHistoryLevel));
...

vs.

PropertyEntity dbHistoryProperty;
if ("5.0".equals(dbVersion)) {
  dbHistoryProperty = new PropertyEntity("schema.history", "create(5.0)");
  insert(dbHistoryProperty);
} else {
  dbHistoryProperty = selectById(PropertyEntity.class, "schema.history");
}

Regards, Etienne

Show

Etienne Studer added a comment - 08/Nov/12 1:11 PM - edited Hi Tom The property not found is called 'historyLevel' which is not the same as the property 'schema.history': ... int configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel(); PropertyEntity property = new PropertyEntity( "historyLevel" , Integer .toString(configuredHistoryLevel)); ... vs. PropertyEntity dbHistoryProperty; if ( "5.0" .equals(dbVersion)) { dbHistoryProperty = new PropertyEntity( "schema.history" , "create(5.0)" ); insert(dbHistoryProperty); } else { dbHistoryProperty = selectById(PropertyEntity.class, "schema.history" ); } Regards, Etienne

Hide

Permalink

Etienne Studer added a comment - 08/Nov/12 1:33 PM - edited

This code in DbSqlSession#dbSchemaCheckVersion() expects a property called 'historyLevel' (which is different from 'schema.history'):

  Integer configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel();
  PropertyEntity historyLevelProperty = selectById(PropertyEntity.class, "historyLevel");
  if (historyLevelProperty==null) {
    if (errorMessage==null) {
      errorMessage = "";
    }
    errorMessage += "no historyLevel property specified";
  }

Note that this property 'historyLevel' is programmatically added in DbSqlSession#dbSchemaCreateEngine rather than through the scripts. Hence the scripts are not fully complete.

protected void dbSchemaCreateEngine() {
  executeMandatorySchemaResource("create", "engine");
    
  int configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel();
  PropertyEntity property = new PropertyEntity("historyLevel", Integer.toString(configuredHistoryLevel));
  insert(property);
}

Solution (in my opinion): Change the current code in DbSqlSession#dbSchemaCheckVersion such that the historyLevel property is added if missing, rather than throwing an exception:

...
Integer configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel();
PropertyEntity historyLevelProperty = selectById(PropertyEntity.class, "historyLevel");
if (historyLevelProperty==null) {
  // add property instead of throwing an exception since this is a valid case (when creating the tables manually via scripts, there will be no such property yet)
  historyLevelProperty = new PropertyEntity("historyLevel", Integer.toString(configuredHistoryLevel));
  insert(historyLevelProperty);
}
...

Show

Etienne Studer added a comment - 08/Nov/12 1:33 PM - edited This code in DbSqlSession#dbSchemaCheckVersion() expects a property called 'historyLevel' (which is different from 'schema.history'): Integer configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel(); PropertyEntity historyLevelProperty = selectById(PropertyEntity.class, "historyLevel" ); if (historyLevelProperty== null ) { if (errorMessage== null ) { errorMessage = ""; } errorMessage += "no historyLevel property specified" ; } Note that this property 'historyLevel' is programmatically added in DbSqlSession#dbSchemaCreateEngine rather than through the scripts. Hence the scripts are not fully complete. protected void dbSchemaCreateEngine() { executeMandatorySchemaResource( "create" , "engine" ); int configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel(); PropertyEntity property = new PropertyEntity( "historyLevel" , Integer .toString(configuredHistoryLevel)); insert(property); } Solution (in my opinion): Change the current code in DbSqlSession#dbSchemaCheckVersion such that the historyLevel property is added if missing, rather than throwing an exception: ... Integer configuredHistoryLevel = Context.getProcessEngineConfiguration().getHistoryLevel(); PropertyEntity historyLevelProperty = selectById(PropertyEntity.class, "historyLevel" ); if (historyLevelProperty== null ) { // add property instead of throwing an exception since this is a valid case (when creating the tables manually via scripts, there will be no such property yet) historyLevelProperty = new PropertyEntity( "historyLevel" , Integer .toString(configuredHistoryLevel)); insert(historyLevelProperty); } ...

Hide

Permalink

Etienne Studer added a comment - 15/Nov/12 12:47 PM

I've verified that the solution of adding the missing property rather than throwing an exception works in all cases:

1) creating scripts manually and running in DB_SCHEMA_UPDATE_FALSE mode
2) creating scripts automatically by running in DB_SCHEMA_UPDATE_XYZ mode

Show

Etienne Studer added a comment - 15/Nov/12 12:47 PM I've verified that the solution of adding the missing property rather than throwing an exception works in all cases: 1) creating scripts manually and running in DB_SCHEMA_UPDATE_FALSE mode 2) creating scripts automatically by running in DB_SCHEMA_UPDATE_XYZ mode

Hide

Permalink

Tom Baeyens added a comment - 22/Nov/12 2:27 AM

thanks, fred

Show

Tom Baeyens added a comment - 22/Nov/12 2:27 AM thanks, fred

People

Assignee:

Frederik Heremans

Reporter:

Etienne Studer

Vote (0)

Watch (3)

Dates

Created:

30/Mar/12 7:32 AM

Updated:

22/Nov/12 2:27 AM

Resolved:

22/Nov/12 2:27 AM