Redeployment restrictions for modifying a solution

You can redeploy a solution to an object store. For example, you can update the solution design and then deploy the solution to a production object store that already contains cases for the solution. Modifying a case and redeploying it affects existing case data and new case data. Before you modify an existing solution, make sure that your changes will not cause problems when you redeploy the solution to an object store that already was associated with that solution.

The following table describes the effects of redeploying a modified solution to an object store.

Table 1. Effects of solution design changes
Type of changes	Result	Comments
New item, such as a new property, a new document class, a new case type, a new activity, or a new role	No issues.
Delete an item, such as a property, a business object, a document class, a case type, an activity, or a role	No issues.	The item is removed only from the solution definition. The item is not removed from the target object store or the Content Platform Engine. Remove any unused roles or in-baskets by using the Process Configuration Console. When you redeploy the solution, IBM® Business Automation Workflow does not remove properties or business objects from the case type definition class in the target object store. As a result, these items continue to appear in existing cases and are available when case workers create new cases of the case type. All active work items that reference case properties also continue to display the property values. If you remove a property or business object from the case type definition class, it is removed from all existing cases and is not available for new cases. This action is destructive, data is loss on existing cases and can result in errors with running work items for properties. This action might require detailed review from all stakeholders of the cases.
Remove a property from a child or parent document class	No issues.	The property is not removed from document class in the target object store or Content Platform Engine. In the development environment, you can edit the document class definition in IBM Administration Console for Content Platform Engine to remove the property.
Adding a property that was previously removed from a child or parent document class to a different document class in the same tree	Not supported.	The change is not replicated correctly in the document class tree in the target object store or Content Platform Engine.
Solution name or prefix	Not supported.	You cannot change the solution name or the solution prefix.
Solution description	No issues.
Solution icon	No issues.
The property data type, the unique ID (also called symbolic name), or the cardinality for existing properties	Not supported.	Content Platform Engine does not support the following changes to an existing property: Changing the type of the property, for example, changing from Boolean to String. Changing the unique ID Changing a single-value property to a multi-value property or changing a multi-value property to a single-value property If you need to change the data type or cardinality, you must reset the development environment in Case Builder, then change the property in the solution. See the note after this table for more information on the unique ID.
The property name or description	Existing items are affected.	All existing and new instances of a case and document use the updated property name (display name) and description.
The default value for a property	Only new items are affected.	New instances of a case or document that has the property will use the updated default values. Existing instances are unchanged.
The minimum or maximum value for a property	Some existing items are affected.	The existing values are validated against the new minimum or maximum value only when there is an update to the property. New instances are validated against the new minimum or maximum value. Changing the minimum and maximum values can cause a case to have invalid values. The business analyst should manage solution backward compatibility or use the external data service integration to address the change requirements.
Choice lists for a property	Existing items are affected.	Changing the choice list values or adding a choice list causes the new values to be displayed as choices. Note: It is recommended that you do not remove choice list values because application features can be affected. For example, searching for cases that contain the removed values. The business analyst should manage solution backward compatibility or use the external data service integration to address the change requirements.
Required property setting	Some existing items are affected.	Existing instances require a value for the property only if the instance is updated. New instances require a value for the property. The business analyst should manage solution backward compatibility or use the external data service integration to address the change requirements.
Hidden property setting	Existing items are affected.	All existing instances of the property and new instances use the updated setting. If the property was changed from hidden to visible, then all existing instances and new instances display the property. If the property was changed from visible to hidden, then all existing instances and new instances do not display the property.
Modify a role name in a deployed solution.	When the solution is redeployed, Case Client will display the previous role name and the new role name.	Use Process Configuration Console to remove the unwanted role name.
Modify an in-basket name or hide an in-basket	When the solution is redeployed, Case Client will display the previous in-basket name and the new in-basket name.	Use Process Configuration Console to remove the unwanted in-basket name.
Document class unique ID (also called symbolic name)	Not supported.	Content Platform Engine does not support changing the unique ID.
Document class name and description	New and existing items are affected.	New and existing instances use the new display name and description.
Case type unique ID (also called symbolic name)	Not supported.	Content Platform Engine does not support changing the unique ID.
Case type name and description	New and existing items are affected.	New and existing instances use the new display name and description.
Initiating document class for a case type to a different type or to none	New cases are affected.	Existing case instances are not affected because the initiating document class only determines when new cases are created. Only a new instance of a document can start a new case. An existing document cannot start a case.
Case folder structure for a case type	New cases are affected.	New instances of the case use the updated folder structure. In the production environment, your IT administrator can run the case synchronizer utility for existing case instances to add new case subfolders as needed.
Case views	New and existing items are affected.	New and existing case instances use the new view definitions.
New case page or case view page for a case type	Existing cases are affected.	Existing cases and new cases use the updated page definitions.
Activity unique ID (also called symbolic name)	Not supported.	Content Platform Engine does not support changing the unique ID.
Activity name and description	Only new items are affected.	Only new instances use the new display name. Activity instances do not have descriptions.
The criteria changes for an activity with a A property condition is met precondition The precondition changes from A document is filed in the case or A case property is updated to A property condition is met Or, any precondition changes to No precondition	Only new items are affected	You can redeploy the solution, and then ask your IT administrator to run the precondition checker utility to make this change in existing cases.
Activity precondition, any other change	No issues	If this solution is in development, you can reset the test environment and redeploy.
Activity start changed from Manual to Automatic	No issues.	Existing activities keep the existing Manual setting.
Activity start changed from Automatic to Manual	No issues.	Existing activities keep the existing Automatic setting. New activities use the Manual setting. Users must manually start new activities.
Activity start changed from Manual or Automatic to Discretionary	Not supported for all use cases	If there are any existing regular activity items with IBM Case Foundation process in waiting state, or in manual and ready state, the activity process might not start, so the change is not recommended.
Activity start changed from Discretionary to Manual or Automatic	No issues.	Existing activities keep the existing Discretionary setting. New activities use the new setting.
Changing the document class that is used in the A document is filed in a case precondition	No issues.	Affects new instances as well as existing instances that are in waiting state.
Changing the properties used in the A case property is updated precondition	No issues.	Affects new instances and existing instances that are in waiting state.
Required activity setting	New cases are affected.	In the production environment, your IT administrator can run the case synchronizer utility for existing case instances to reflect new activity settings as needed.
Repeatable activity setting	No issues.	An activity can be changed to repeatable as long as the precondition is either A document is filed in a case or A case property is updated.
Create new non-repeatable and non-discretionary (automatic or manually) activity	New cases are affected.	Existing cases do not have the new activity. In the production environment, your IT administrator can run the case synchronizer utility for existing case instances to reflect new activity types as needed.
Add a new activity within a container activity	New and existing cases are affected.	If a container activity has not started, it will include the new activities. In the production environment, your IT administrator can run the case synchronizer utility for existing case instances to reflect new activity types as needed.
Create new repeatable (File or Property update) activity	New cases are affected.	Existing cases do not have the new activity.
Create new discretionary activity	New and existing cases are affected.	Existing cases can also include the new activity.
Add a new activity to a group	New cases are affected.	Existing cases do not have the new activity. In the production environment, your IT administrator can run the case synchronizer utility for existing case instances to reflect new activity types as needed.
Remove an activity from a group (change an inclusive or exclusive activity to not grouped)	Only new cases are affected.	Existing cases with activities that are required by an inclusive group or activities that are disabled by exclusive group remain in the previous state and cannot be changed.
Move an activity from one group to another (moving from no grouping to the inclusive group or exclusive group or changing the group)	Only new cases are affected.	Existing activity instances maintain their grouping relationships.
Workflow name for an activity	Not supported within Case Builder.	Case Builder uses the unique identifier for the activity as the name of the workflow, and the unique identifier cannot be changed.
Launch step or page	Existing cases are affected.	The new page is used.
Workflow definition	Some existing cases are affected.	Any existing instances of activities with workflows that have started are not affected. New activities use the new workflow version.
Rule definition	Some existing cases are affected.	Any existing instances of activities with workflows that have started and are past the step that invokes the rule are not affected. New or existing workflows that have not reached the step that invokes the rule use the new rule version.

Remember: Case Builder uses the term unique ID for the Content Platform Engine symbolic name property. The unique ID is not the same as the Content Platform Engine ID property, which is a globally unique identifier (GUID).