Deploying Reports

This chapter describes how to deploy reports from a development, test, or production environment to another environment. This chapter only describes how to deploy with a disconnected client. It includes the following topics:

Process of Deploying Reports

You can use Application Deployment Manager (ADM) to deploy reports from a development or test environment to a production environment. You use ADM to prepare the report template data for deployment. You use it to consolidate report information into a single deployment package. A deployment package is a set of files that represent the report files. Siebel CRM stores these files in a predefined package folder. It also stores a package descriptor file that includes the details of the package contents. For more information about ADM, see Siebel Application Deployment Manager Guide.

To deploy reports, do the following tasks:

Preparing the Deployment Environment

This task is a step in Process of Deploying Reports.

To prepare the deployment environment

Make sure you finished developing and testing reports in the development environment.
Do the following work in the development environment:
1. Install version 5.0 or later of the Perl software.
2. Make sure you include the Application Deployment Manager (ADM) component group as part of the Siebel Server installation process.
  For more information about installing Siebel Servers, see Siebel Installation Guide for the operating system you are using.
3. Set up ADM so that it meets your deployment requirements. You must use a Siebel Management Server and you must install Siebel Management Agents.
  For more information about setting up ADM, see Siebel Installation Guide for the operating system you are using.

Packaging the Report Files in the Development Environment

This topic describes how to package the report files in the development environment.

This task is a step in Process of Deploying Reports.

To package the report files in the development environment

Manually copy the files that you must deploy from the SIEBSRVR_ROOT\XMLP folder in the development environment to the following folder in the production environment:
```
SharedFolder\PackageName\file\siebsrvr\XMLP\subfolder_name
```
where:
- SharedFolder is a shared folder that resides on a computer in the production environment.
- PackageName is the name of the ADM package folder that contains the report files that you must deploy.
- file is the type of file, such as database, repository, and so on.
- siebsrvr\XMLP\subfolder_name is the Siebel Server folder structure.
  1. Copy the XML files to the following folder:
```
SharedFolder\PackageName\file\AppServer\XMLP\DATA
```
  2. Copy the RTF and XSL files to the following folder:
```
SharedFolder\PackageName\file\AppServer\XMLP\TEMPLATES 
```
  3. Copy the XLIFF files to the following folder:
```
SharedFolder\PackageName\file\AppServer\XMLP\enu\xliff
```
Run the following command to create a descriptor file for the package:
```
admpkgr generate "shared folder\package name"
```
where:
- shared folder\package name is the shared folder and package name where the packages that you must deploy reside.

Deploying the Report Files to the Production Environment

This topic describes how to deploy the report files to the production environment.

This task is a step in Process of Deploying Reports.

To deploy the report files to the production environment

Navigate to the installation folder where the Siebel Management Server is installed.
Run the following command to create a package folder structure:
```
admpkgr init SharedFolder\PackageName
```
where:
- SharedFolder\PackageName is the shared folder package name where the packages that you must deploy reside.
  You must specify a path in a shared location.
  If an error occurs, then the path to the JAR files might not be correct. To fix this error, make sure the CLASSPATH variable references the correct path to the JAR files in the admpkgr.bat file in the Management Server installation folder.
Run the following command to call the deploy.bat file to load the package to the server database:
```
deploy_enterprise load username password PackageName
```
where:
- enterprise is the name of the Siebel enterprise that you provide during configuration.
- username and password are the username and password account of the Siebel user who is deploying the package.
- PackageName is the name of the package you created in Step 2 of the previous topic.
Run the following command to create a session for the deployment:
```
deploy_enterprise create username password PackageName
```

Run the following copy command to deploy the package:

deploy_enterprise copy username password PackageName

Navigate to the following folder on the Siebel Server:
```
siebsrvr\XMLP
```
Verify that the files you placed in the deployment package described in Step 1 in the previous topic are available in the correct folders.

Packaging Report Database Records in the Development Environment

This topic describes how to use Application Deployment Manager (ADM) to package report database records.

This task is a step in Process of Deploying Reports.

To package report database records in the development environment

Navigate to the Application Deployment Manager screen, and then the Deployment Projects view.
In the Deployment Projects list, create a new project record.
Complete the project fields, as required.
Make sure the Export to File field contains a check mark so that Siebel CRM creates the export file. It is recommended that you include a BIP prefix in report project name. This prefix allows you to search for your report projects. For descriptions of the project fields, see Siebel Application Deployment Manager Guide.

In the Deployment Filter field in the Deployment Project data type list, create search expressions for the data types to filter only those items of a data type that match the condition for deployment. Save each filter.

For example, assume you create a report in the development environment, and this report includes the following items:

Named Test Account List
References the BIP Accounts - Current Query integration object
Associated with the Account List view

In this example, you enter filter information to deploy the data types to the production environment using information from the following table.

Data Type	Filter
BIP Sample Data Generation	[Name]=' BIP Accounts - Current Query'
BIP Report Template Registration	[Report Name]=' Test Account List'
BIP View Association	[Name]=' Account List View'
BIP Report Template Translations	[Report Name]=' Test Account List'

If a data type is not available, then it might be set to Inactive. Make sure the Active field for each data type contains a check mark. The Active field resides in the Data Type Details view.

This step allows you to query the reports that you are deploying to the production environment. For more information about search expressions, see Configuring Siebel Business Applications.

Enable the report project:
1. Navigate to the Deployment Projects view.
2. In the Deployment Projects list, choose the draft deployment.
  The Status field of the draft deployment project record displays as Draft.
3. Click the Enable button to activate the report project.
ADM populates the Status field with Enabled and the Publication Date/Time field with the date and time of the report project activation.
Export the reports:
1. Navigate to the Application Deployment Manager screen, and then the Deployment Sessions view.
2. Choose the report project you must enabled.
3. Make sure the Export to File and the Deployment Lock fields each contain a check mark.
4. Enter a shared location to store the XML files that contain the database records.
5. Click Deploy.
ADM deploys the database record XML files to the shared location.

Deploying Report Database Records to the Production Environment

This topic describes how to deploy report database records from the development environment to the production environment.

To deploy report database records to the production environment

Navigate to the Application Deployment Manager screen, and then the Deployment Sessions view.
Click the Deployment Sessions Menu button, and then choose Deploy from File.
In the Deploy from File dialog box, enter the file paths from which to deploy the database records:
1. Enter the file path for the XML file that contains the Sample Data Generation file, and then click Import.
2. Enter the file path for the XML file that contains the Report Template Registration file, and then click Import.
3. Enter the file path for the XML file that contains the View Association file, and then click Import.
Make sure you specify the shared location where the database records are stored.
For example, you might enter the following shared locations:
- \\sharedlocation\88-25ZC7_BIP_Sample_Data_Generation.xml
- \\sharedlocation\88-25ZC7_BIP_Report_Template_Registration.xml
- \\sharedlocation\88-25ZC7_BIP_View_Association.xml
In the production environment, make sure ADM deployed the data. Verify that Siebel CRM displays the report in the Run Report pane.
For example, in Step 4 in the previous topic, you created a report named Test Account List. To verify that ADM deployed this report correctly, do the following:
- Navigate to the Accounts screen, and then the Account List view.
- Click the Reports button in the application toolbar.
- Verify that the Report Name list in the Run Report pane includes the Test Account List report.

Deploying Integration Objects to the Production Environment

If you modified a predefined integration object, or created a new one, then you must deploy it to the production environment. For more information, see Modifying Integration Objects.

Use the Siebel Migration Application Incremental Runtime Repository Data Service to migrate and deploy integration object changes to your target environment.

For more information about Siebel Migration and the Migration Application Incremental Runtime Repository Data Service, see Siebel Database Upgrade Guide.