Package and Deployment between K2 Versions
KB002070
PRODUCT
Important Notes:
- Corresponding service types of those in the package must be present on the target location or the deployment is blocked
- Packages created in K2 Appit and/or K2 Cloud is only valid for 60 days to help minimize cross version checking
- If you created a package in a K2 version earlier than that of the target environment, deployment of this package is not blocked. However, successful deployment of these older packages is not guaranteed due to potential platform changes between K2 versions
- If you run into an issue while deploying an older package into a newer environment, try the following:
- Recreate the package in a source environment with the same version as the intended target environment
- If you still have issues after deploying the new package in the target environment, log a K2 support ticket
For example:
- You originally had only one K2 Cloud instance and you built a solution and created a package when this K2 environment was running K2 Cloud Update 1
- Months later that instance was upgraded to Update 2. Additionally, at around the same time, your organization purchased a second K2 Cloud environment also running K2 Cloud Update 2, and you want to deploy the solution you created on Update 1 to that new environment
You are permitted to deploy the package created months earlier on Update 1 to the new Update 2 environment. If you run into deployment issues, or issues using the solution, you need to recreate the package. You recreate the package based on the solution in the original environment (since that environment was upgraded and matches the target version). Use this new package to deploy in the new target K2 environment.
Simple K2 Package and Deployment scenario map
The following is a simple guide to understanding what can be deployed into a target environment via K2 Package and Deployment:
| Package created in | Deploying to | |||
| K2 Cloud | K2 Five | |||
| K2 Cloud | Yes | No | ||
| K2 Appit | No | No | ||
| K2 Five | Yes* | Yes | ||
| K2 blackpearl 4.7 | No | No | ||
| Package created in | Deploying to | |||
| K2 blackpearl 4.7 | K2 Five | Appit | K2 Cloud | |
| K2 blackpearl 4.7 | Yes | No | No | No |
| K2 Five | No | Yes | No | Yes* |
| Appit | No | No | Yes | No |
| K2 Cloud | No | No | No | Yes |
- You cannot deploy any packages that are missing assets such as design tooling, customizations, etc. that are not present in the target environment. See the Detailed K2 Package and Deployment scenario map table below for more details
- Always plan a test deployment to ensure it functions as you expect it to
- K2 Cloud is updated more frequently than K2 Five
- K2 Five to K2 Cloud deployments are not regression tested with every K2 Cloud update
- K2 reserves the right to modify K2 Cloud in a way that could cause K2 Five to K2 Cloud deployments to not deploy successfully. In the event this occurs, it is expected that the subsequent K2 Five update will align the platforms again
- K2 does not plan to release code fixes on K2 Five to K2 Cloud upgrade issues. These fixes will be included in the subsequent K2 Five release
Detailed K2 Package and Deployment scenario map
The following is a more detailed guide to understanding what can be deployed into a target environment via K2 Package and Deployment than above with additional explanation and remediation (if applicable):
| Package Created Version | Deployment Location Version | Deployment Location | Supported? | Notes | Remediation |
| Pre 4.7 / 4.7 | K2 Five | On-Prem | No | 4.7 (and prior) Packages cannot be deployed into K2 Five | Upgrade source environment to K2 Five, on-prem package and deploy from there and then deploy into target environment. |
| Pre 4.7 / 4.7 | Appit | Cloud | No | 4.7 (and prior) Packages cannot be deployed into Appit | There is no support for deploying K2 blackpearl packages to Appit. |
| Pre 4.7 / 4.7 | K2 Cloud | Cloud | No | 4.7 (and prior) Packages cannot be deployed into K2 Cloud | Upgrade source environment to K2 Five, package Forms, Views and SmartObjects and deploy to K2 Cloud.
NOTE: This scenario must still comply to the K2 Five - K2 Cloud requirement detailed below. |
| Appit | K2 Five | On-Prem | No | No support to deploy Appit Packages to K2 Five | |
| Appit | K2 Cloud (upgrade) | Cloud | No | No support to deploy Appit Packages to K2 Cloud. | Repackage solution from source K2 Cloud then deploy to target K2 Cloud environment. |
| Appit | K2 Cloud (clean) | Cloud | No | No support to deploy Appit Packages to K2 Cloud. | |
| K2 Five (upgrade) | K2 Five (upgrade) | On-Prem | Yes | No anticipated issue deploying Packages. | |
| K2 Five (upgrade) | K2 Five (clean) | On-Prem | Yes | Everything in the source application will Package; however, if that Package contains a Workflow Definition that is from K2 Workflow (Legacy) the Package will not be allowed to deploy. | 4.7 based designer (K2 Studio, VS and/or Silverlight) workflow solutions can only deploy to K2 Five if that environment was upgraded from K2 blackpearl 4.7. If these legacy solutions are required on K2 Five, then plan to install 4.7 and then upgrade to Five. |
| K2 Five (clean) | K2 Five (clean) | On-Prem | Yes | No anticipated issue deploying Packages. | |
| K2 Cloud (upgrade) | K2 Cloud (upgrade) | Cloud | Yes | No anticipated issue deploying Packages. | |
| K2 Cloud (upgrade) | K2 Cloud (clean) | Cloud | Yes | Everything in the source application will Package; however, if that Package contains a Workflow Definition that is from K2 Workflow (Legacy) the Package will not be allowed to deploy. | |
| K2 Cloud (clean) | K2 Cloud (clean) | Cloud | Yes | No anticipated issue deploying Packages. | |
| K2 Five (upgrade) | K2 Cloud (upgrade) | Cloud | Yes | Visual Studio and K2 Studio workflows will be blocked from deploying.
Silverlight designed workflows will only be allowed to deploy if the target K2 Cloud instance has Silverlight Designer enabled.
Custom components in the package (such as custom SmartForms controls or themes) will be blocked from deploying if the target environment does not also possess those customizations. | Remove blocked components from the package. |
| K2 Five (upgrade) | K2 Cloud (clean) | Cloud | Yes | Visual Studio and K2 Studio workflows will be blocked from deploying.
Silverlight designed workflows will only be allowed to deploy if the target K2 Cloud instance has Silverlight Designer enabled.
Custom components in the package (such as custom SmartForms controls or themes) will be blocked from deploying if the target environment does not also possess those customizations. | Remove blocked components from the package. |
| K2 Five (clean) | K2 Cloud (clean) | Cloud | Yes | No anticipated issue deploying packages with native K2 capabilities; any customized components within the package will be blocked from deployment if the customization doesn't exist in the target location. | |
| K2 Cloud (upgrade/clean) | K2 Five (upgrade/clean) | On-Prem | No | No support to deploy K2 Cloud Packages to K2 Five. |
