uCosminexus Service Platform, Basic Development Guide

[Contents][Glossary][Index][Back][Next]

5.9.4 Upgrading version of business processes

This section describes the operations that you can implement, operations that you cannot implement after upgrading the version of business process and precautions to be taken when upgrading the version.

Organization of this subsection
(1) Operations that you can implement after the version upgradation
(2) Operations that you cannot implement after upgrading a version
(3) Points to be noted when upgrading the version of business process

(1) Operations that you can implement after the version upgradation

This table describes the operations that you can implement after upgrading the version of business process.

Table 5-16 TableOperations that you can implement after upgrading the version

# Target activity Operations Remarks
1 Receive activity#1 Changing the activity name -
2 Changing the operation name In some cases, you require to change the operation name, depending on the changes after upgrading the version.
For operation names that must be changed, see #4, #7, #15 and #18.
3 When you use the user-defined reception, you must add a new user reception.#3#6
4 Changing the body assigned variable When you change the body assigned variable specified in the reference destination of the correlation set, you must change the operation name.
5 When you use the user-defined reception, you must add a new user-defined reception.#6
6 Adding, changing or deleting the header assigned variable When you use the SOAP reception, you must add a new user-defined reception.#4#6
7 Adding, changing and deleting the assigned correlation set When you add, change or delete a assigned correlation sets, you must change the operation name. Accordingly, when you use the user-defined reception, you must add a new user-defined reception.#6
8 Correlation set (pair of name and value) must be unique in all the versions.
9 Changing the communication model When you use the user-defined reception, you must add a new user-defined reception.#6
10 Changing the instance generation -
11 Adding and deleting an activity -
12 Reply activity#1 Changing the activity name -
13 Changing the operation name You might have to change the operation name depending on the change contents after upgrading the version.
For the operations that require change of operation name, see #4, #7, #15 and #18.
14 When you use the user-defined reception, you must add a new user-defined reception.#3#6
15 Changing the body assigned variable When you change the body assigned variable specified at the correlation set reference destination, you must change the operation name.
16 When you use the user-defined reception, you must add a new user-defined reception.#6
17 Adding, changing and deleting the header assigned variable When you use the SOAP reception, you must add a new user-defined reception.#4#6
18 Adding, changing and deleting the allocation correlation set When you add, change or delete an allocation correlation set, you must change the operation name. accordingly, when you use the user-defined reception, you must add a new user-defined reception.#6
19 Correlation set (pair of name and value) must be unique in all the versions.
20 Changing and deleting the fault name When you use SOAP reception, you must add a new user-defined reception.#5#6
21 Adding and deleting an activity -
22 Other activities Adding, changing and deleting an activity When you add, change or delete the allocation correlation set in the invoke service activity, correlation set (pair of name and value) must be unique in all the versions.
23 User-defined reception#2 Adding the user-defined reception#7 You can add the user-defined reception to be used in latest version.
You can also add the user-defined reception to be shared in latest and other versions.
24 Changing the user-defined reception#7 You can change the user-defined reception regardless of version.
25 Deleting the user-defined reception You can delete the user-defined reception used only in the latest version.

Legend:
-: Corresponding description does not exist.

#1
Target version for performing operation, is the latest version. You cannot perform operations like reference or change in versions other than the latest version.

#2
You can reference the user-defined reception regardless of the version.

#3
This is not required when you change other operation names defined in the user-defined reception or add operation name to user-defined reception, by using the user-defined reception.

#4
This is not required when data validation function is inactive (when "IGNORE" is specified in the telegram-notfound-soapheader property of the HCSC server random definition file) and change does not have impact on operation.

#5
This is not required when changing the other operation name defined in the user-defined reception.

#6
To add a new user-defined reception, see "(3)(b) Notes when using the user-defined reception".

#7
You must define the user-defined reception by considering the definition contents of corresponding business process. Comtability with version other than latest version is checked in the validation of user-defined reception. For details on validation of the user-defined reception, see "2.10 Validating the user-defined reception" in the "Service Platform Reception and Adapter Development Guide".

(2) Operations that you cannot implement after upgrading a version

Following table describes the operation that you cannot implement after upgrading the version of business process.

Table 5-17 TableOperations that you cannot implement after upgrading a version

# Target activity Operation Remarks
1 Business process#1 Changing the service ID -
2 Changing the persistence of status -
3 Changing the business process -
4 User-defined reception#2 Adding the user-defined reception You cannot add the user-defined reception used in versions other than the latest version.
5 Deleting the user-defined reception You cannot delete the user-defined reception defined when upgrading the version.

Legend:
-: Corresponding description does not exist.

#1
Target version for performing operation, is the latest version. You cannot perform operations like reference or change in versions other than the latest version.

#2
You can reference the user-defined reception regardless of version.

When you upgrade a version of business process, you cannot use following functions in the business process having version other than latest version.

(3) Points to be noted when upgrading the version of business process

When you upgrade a version of business process, you might not be able to execute the business process of version other than latest version, depending on the change contents after version upgradation.

Change the definition information after checking the following contents and verifying the impact of changes. It is recommended to acquire the version upgradation of the definition information, before performing the version upgradation.

(a) Notes when changing the business process definition in the latest version

You can execute the business process of version other than latest version, with the following flow.

  1. From the latest version, reference the business process of a version other than latest version, based on the operation specified at the time of invoking and acquire the reception activity for which the corresponding operation name has been defined.
  2. Acquire the value of correlation set from the message, based on the correlation set acquisition position of reception activity.
  3. Acquire the process being executed, based on the value of correlation set.
  4. Compare the versions of acquired process sequentially from the latest version and if matching version is found, continue process with business process definition of the concerned version.

If you change the business process definition of the latest version after upgrading version of the business process in the environment, having a process instance for which versions other than latest version are not complete, change the business process definition, by considering the impact of above-mentioned process and also the changes done.

Following figure shows the flow of process when executing the business process in version other than latest version, after upgrading the version.

Figure 5-18 FigureFlow of the process when executing the business process of the version other than latest version, after upgrading the version

[Figure]

(b) Notes when using the user-defined reception

When you implement the following operations after upgrading version of the business process in which user-defined reception is used, you must retain the user-defined reception used in the versions other than latest version as it is and add a new user-defined reception to be used in the latest version.

However, you might not be required to add a new user-defined reception, even in the cases mentioned above. For details, see remarks and notes in "Table5-16 Operations that you can implement after upgrading the version".

Following figure shows the example of changing business process when it is required to add a new user-defined reception after upgrading the version.

Figure 5-19 FigureExample of change when it is required to add a new user-defined reception

[Figure]

(c) Notes related to uniqueness of correlation set

If uniqueness of correlation set (pair of name and value) is not maintained after upgrading the version, unexpected process might be invoked in the latest version and the version other than latest version.

Following figure shows the operations in case of specifying correlation set of value same as value before version upgdaration, after upgrading the version.

Figure 5-20 FigureWhen uniqueness of correlation set is not maintained (set up the correlation set in the reception)

[Figure]

(d) Notes in case of making changes related to correlation set

When you implement following operations after upgrading the version, value of correlation set might not match in latest version and version other than latest version.

In such cases, you might not be able to execute the process of version other than latest version. Therefore, you must change the operation name, when you make changes related to the correlation set.

Following figure shows the operations when changing the correlation set after upgrading the version.

Figure 5-21 FigureWhen making changes related to correlation set (change the correlation set name)

[Figure]

Following figure shows the operations when you change the correlation set reference destination, after upgrading the version.

Figure 5-22 FigureWhen making changes related to correlation set (change the correlation set reference destination)

[Figure]

(e) Notes when making changes related to body assigned variables

After upgrading the version, when you make changes in the body assigned variable (part specification) specified in the correlation set reference destination, value of correlation set might not match in the latest version and version other than latest version. In such cases, you might not be able to execute the process of version other than latest version.

Accordingly, when you change the body assigned variable (part specification) specified in the correlation set reference destination, you must change the operation name.

Following figure shows the operations in case of changing the body assigned variable (part specification) after upgrading the version.

Figure 5-23 FigureWhen making changes related to body assigned variable (change the part specification)

[Figure]

As shown in the following figure, when you change the XML schema of body assigned variable after upgrading the version, you can acquire the correlation set value and execute the business process other than that of latest version, if you are able to acquire same value in the latest version and the version other than latest.

Figure 5-24 FigureWhen making changes in the body assigned variables (change the XML schema of the variable)

[Figure]

(f) Notes when deleting operations of the user-defined reception

In the business process that uses the user-defined reception, if you delete the operation of the version other than latest version, after upgrading the version, you might not be able to execute the process of version other than latest version.

Following figure shows the operations in case of deleting the operation of user-defined reception, after upgrading the version.

Figure 5-25 FigureWhen deleting the operation of user-defined reception

[Figure]