Deployment Packages

SAP CPQ administrators use deployment process to move changes made in one SAP CPQ environment (e.g. sandbox or test) to the production environment. So far, administrators had to send entities separately, one by one (e.g. product, category, permission group…). This process has been improved to simplify and shorten a time needed to complete the task by enabling users to send entitites together in a package.
This new feature is called „Deployment Packages“ and will be available starting with SAP CPQ Release 2016.3. Details about it follow.

Administration of Deployment Connections

The first improvement is the ability for SAP CPQ administrator to connect different environments to perform deployment between them. Prior to 2016.3 Release, only SAP Sales Cloud CPQ support team members were able to connect environments on administrators request. In order to connect two environments, administrator must know log in details for the destination environment:

  1. URL (e.g. sandbox.webcomcpq.com)
  2. Domain name (e.g sampledomain)
  3. Admin username
  4. Admin password


Deployment Packages feature is located under CPQ SetupGeneralDeploy / Send Changes.

When you navigate to this location a screen that displays information about current and connected environments is displayed. (See figure 1.1)

Figure 1.1 – Deployment Setup tab


There are two tabs on the page:

  • Deployment setup
  • Deployment packages

You will use Deployment setup tab when you want to connect your SAP CPQ tenant with other SAP CPQ environments/tenants.
To do so, click on the button Add Connected Environment. A pop up is displayed. Fill out all fields with the appropriate data about the desired environment/tenant which you want to connect to your current environment. (See figure 1.2)

Figure 1.2 – Adding connected environment


Once you are done, your connected environment is displayed in the Connected environments list under Deployment Setup tab. (See figure 1.1)

Note that you can connect one or more environments to your current environment.

Deployment Packages

So far, a SAP CPQ administrator was able to deploy only one SAP CPQ entity at a time.

Note that when we say „CPQ entity“, we actually mean any business object that could be found in SAP CPQ (e.g. product, user type, crm integration, category, etc.). It is also referred to as a Package Component.


Deployment packages feature enables administrator to send one or more SAP CPQ entities combined in a package. To see a list of packages that you have already sent to some destination, or to send a new package, go to Deployment Packages tab. (See figure 1.3)

Figure 1.3 – A list of Deployment Packages


Create Deployment Package

This section describes how to create new Deployment Package and provides more details on SAP CPQ entities that can be sent.

The concept of Deployment Package is imagined to simplify the task of sending changes from one to another environment and make it more flexible. Therefore, you are able to create an deployment package, save it and later modify as you wish. Once you are completely sure that all desired changes are included in the package, you can send it to the destination. Here is the list of SAP CPQ entities that can be sent within Deployment Package:

  • Products
  • Permissions
  • Cart Level Aggregates
  • Workflow
  • Item Action Workflow
  • CRM integration
  • User types
  • Territories
  • Notifications
  • Markets
  • Currencies
  • Approval Rules
  • Categories
  • Scripts
  • Guided Selling
  • Custom Tables


As you choose the entity that you want to send, you are introduced with the checklist of other related entities that will be sent along with it. For each entity this list is provided at the right side of the screen. In Figure 1.5, you can see how a checklist looks like when we choose to send a product.

Figure 1.5 – List of related entities that are sent along with the product


An administrator is free to create, delete, upload, download, send, edit or clone its Deployment Package. All actions are available for Deployment Packages that were not yet sent to the destination environment. (See figure 1.6)

Figure 1.6 – Available Deployment Packages actions


If you want to create a new package, you can click on Create Package button, or upload a previously created and downloaded zipped deployment package. You can download your newly created package any time if you want to have your local repository of deployment packaged. Also you can edit the existing package, delete it, send it to the destination or clone it.
If you have received an Deployment Package from another environment, then you have one more action available – deploy. (See figure 1.7)

Figure 1.7 – Deploy received Deployment Package


An example of Deployment Package creation follows.

Example – Creation of a new Deployment Package


In order to create new deployment package follow next steps.

  • Log into SAP CPQ as administrator and go to SetupGeneralDeploy/Send Changes
  • If no destination environment has been defined yet, you can define it under tab Deployment Setup as described earlier in this page administration of Deployment Connections
  • Go to Deployment Packages tab and click on Create Package button. A form to input data regarding new Package is displayed.
  • Fill out form fields and from the dropdown list choose which entity (also referred as Package Component), you want to send. In this example, we will choose Product. Click on add button. (See Figure 1.8)


Figure 1.8 - Adding Package Component to Deployment Package


  • Click on add button. New form is displayed. Fill out form fields and click on button Add to Package. (See figure 1.9)

Figure 1.9 – Adding Product to Deployment Package


You are back to Deployment Packages tab where you can see the Product you want to send in the list of Deployment Package components. If you want to add another entity to the Deployment Package, follow previous steps and choose the desired Package Component. For this example we added two more Package Components – Global Script and Market. (See figure 1.10).

Figure 1.10 – Adding more Deployment Components to Deployment Package


  • Click on Save button to return to list of deployment packages


Deploy received Deployment Package

Once you send your deployment package to the destination environment, you want to apply changes included in that package. To do so, you should login to the destination environment/domain as administrator and go to SetupGeneralDeploy/Send changes.
Under Deployment Packages tab you will see a list of both – deployment packages that are crated by you or another administrator and packages that are received from source environment. To apply changes received through the deployment package, find your package in the list and click on deploy action. (See figure 1.7 above). As you click on deploy action, you are introduced with the screen where you should answer to some questions defined by the Deployment Questionnaire and set the component deploy priority. (See Figure 1.11)

Figure 1.11 – Deploying the package


Deployment Questionnaire

When a SAP CPQ administrator click to deploy Deployment Package, some of the components require additional information. Deployment Questionnaire has a duty to get required additional information from the SAP CPQ administrator and help to complete deployment process with ease. If some deployment component does not require additional information, it will be deployed without involving deployment questionnaire.

Also, since deployment packages may contain components with dependencies, administrators are provided with the ability to select the order of deployment for components within the package.

All questions are clear and self-descriptive, so, you as an SAP CPQ administrator will not have any problems to answer them in order to craft your deployment package in the way that suits your needs.

When you are done with questionnaire, proceed with the deploy by clicking on deploy button at the bottom of the questionnaire. If everything goes fine, you will get the information that the deployment is done successfully. If not, you will be informed about the error.

Troubleshooting

Beside network communication problems (which is extremely rare), there are other two errors that you can encounter during deployment:

  • Shipping name already exists
  • User Type Name Already In Use

The first error is caused by the situation when a shipping method (find more about shipping method on this link - Shipping) with the same same exists on both the destination and source environment, but with different system_id.

system_id is the field that uniquely identify each entity (in this case each Shipping).

Similarly, the second error is caused by the situation when user type with the same name exists on both the destination and source environment, but with different system_id.

The solution in both cases is to go to the source destination and change system_id of the conflicted shipping name or user type.
Follow next steps to modify system_id for a particular shipping:
Go to SetupPricing/CalculationsShipping. Find the shipping method that is problematic from the list of shipping methods, and click on edit action.
Shipping method edit form is displayed. (See Figure 1.12).

Figure 1.12 - Edit system_id on shipping method


Click on pen icon next to the system_id field and it becomes editable. Enter system_id that matches the system_id for the same Shipping method on destination folder and click Save.

You are here: CallidusCloud SAP CPQ Online HelpAdmin Page HelpGeneral SettingsDeployment Packages