Product Documentation

Export and import service packages

Jun 05, 2015
Updated: 2013-02-11
Before exporting or importing service packages, ensure the following requirements are met:
  • Verify that the source and destination environments for the service package have the same version of Services Manager installed.
  • Verify that a user is configured with the two schema administrator roles (All Services Schema Administrator and Service Schema Administrator), required to create a custom service or import or export a service.
  • Create the service (Configuration > System Manager > Service Deployment) or configure the property, customer plan, and/or user plans to be transferred.
  • Test and validate the service to be exported. A service that contains errors will not appear in the Services Manager control panel.

You can export and import customer services to transfer them between different Services Manager environments. For example, service developers can create custom services and provide them to customers to import into their environments. Customers can customize service settings and user plans in a test environment and then migrate the settings to a production environment by exporting and importing services.

Service export and import is available for the services provided with Services Manager as well as for customized services. A customized service is created through the control panel, from Configuration > System Manager > Service Schema.

To transfer a service between environments, export a service to a file and then import that file into a different Services Manager environment, as described in this topic. The import deploys and enables the service at the Top Environment Services level.

The export package file includes service properties, customer and user plans, roles and permissions, validation controls, web server controls and assemblies, and provisioning engine assemblies, actions, and rules. A custom service created from the Service Schema page includes only the database records for the service settings and plan properties. Before exporting a custom service, add to it any provisioning engine or web server assembly (.dll) files that contain the code needed to run actions on the provisioning server or to display custom user controls when provisioning the service on the web page. On the Service Deployment page and at the Top Environment Services level, create default plans for the base service offering and update default service properties such as patterns for file locations.

To export a service package

  1. Log on to the Services Manager control panel.
  2. From the Services Manager menu bar, choose Configuration > System Manager > Service Schema.
  3. Expand the service to be exported.
  4. Click Export to view the Export service to file area.
  5. (Optional best practice) Specify the Creator, URL, and Version for the service. The URL should be the full path to the developer’s site.
  6. In the Preview area, review the items to be included in the export file and update as needed.
  7. To add an assembly file (.dll) to the export package for a custom service:
    1. In the Add file area, click Browse, navigate to the .dll file, and click Open.
    2. Choose the folder for the dll file and then click Add.
  8. Click Export.
  9. Save the exported file.

To import a service package

  1. Log on to the Services Manager control panel. This operation requires these user roles: All Services Schema Administrator and Service Schema Administrator.
  2. From the Services Manager menu bar, choose Configuration > System Manager > Service Schema.
  3. Under Service Management, click Import a service.
  4. Click Browse to navigate to and select the service and then click Open.
  5. To review the items included in the package file, click Preview and update the selections as needed. Components that already exist on the system are highlighted.
  6. Click Import. An “Import Complete” message displays, followed by a list of the actions performed during the import. When web components are imported, Services Manager restarts and automatically logs out all users.
  7. Restart all provisioning servers across all locations. The provisioning servers are updated with any new rules and files.
  8. Use the control panel to update customer and user plans and service settings as needed.