To use Cognos product documentation, you must enable JavaScript in your browser.

Deployment Rules When Importing

This section lists the objects in the content store and the rules that apply when they are imported into a target environment. The rules are different depending on whether you deploy the entire content store or selected public folders and directory content. The method you choose determines which objects are included in the import and how conflicts are resolved when an object already exists in the target environment.

Objects in the content store represent entries in the portal and the properties of those entries. For example, the object reportView represents a report view entry in the portal and the object runHistory represents the run history of an entry. For more information about objects, see the Cognos 8 Developer Guide.

Objects in Public Folders inherit deployment rules by default, depending on whether you are deploying the entire content store , or only selected Public Folders and directory content .

Conflict Resolution Rules

A conflict can occur when the entry that you want to import from the deployment archive already exists in the target content store. When this happens, one of the following conflict resolution rules is used:

Rule

Description

Replace

Replaces the entry and its children.

The entry and all its children are removed from the source content store. The new entry and all its children are added to the source content store.

Keep

Keeps the entry.

The properties of the entry and all its children are not updated. Existing children of the entry are kept. New children may be added.

Update

Updates the entry.

The properties of the entry and its children are updated. Existing children of the entry are kept. New children may be added.

Merge

Merges the properties of the entries with existing entries.

If an entry has no children, replace and update have the same end result.

Rules For Deploying the Entire Content Store

When you deploy the entire content store, different conflict resolution rules apply to the different areas of the content store.

The default conflict resolution rule for deploying the entire content store is replace, unless specified differently in the deployment rules for the following areas:

Configuration

When you import the entire content store, objects in the configuration area of the content store are excluded by default.

If you used the advanced settings to include configuration information , the configuration is updated rather than replaced. Therefore, existing dispatchers and their configuration in the target environment do not change. However, new dispatchers may be added to the configuration. You may need to unregister dispatchers that are imported if they are not applicable to the target environment .

The following table lists the objects in the configuration area of the content store, whether they are included during import, and the conflict resolution rule used. The alignment of the object names represents the hierarchy of the objects. When a parent object is included, its children are also included

Because the root and parent object is replaced, children from the deployment archive replace the existing set of children in the target environment. Therefore, conflicts are unlikely to occur when the children are imported. If a conflict occurs, the conflict resolution rule is to replace the children.

Object name

Included

Rule

configuration

No

Update*

configuration folder

No

Update

dispatcher

No

Update

account

No

Replace

pageDefinition

No

Replace

*Note: This rule applies only when you manually include the configuration objects using the advanced settings.

Capability

All the objects in the capability area of the content store are included and replaced when you import the entire content store.

The following table lists the objects in the capability area of the content store, whether they are included in the import, and the conflict resolution rule used.

Entry type

Included

Rule

capability

Yes

Update

securedFunction

Yes

Update

securedFeature

Yes

Replace

Content

All the objects in the content area of the content store are included and replaced when you import the entire content store.

Deployment

All the objects in the deployment area of the content store are included and replaced when you import the entire content store except for the importDeployment object, which is handled differently.

To import, you use an importDeployment object in the target environment. The importDeployment object and its children are not replaced so that the import can complete and a deployment history record can be created. All the other importDeployment objects are replaced.

The following table lists the objects in the deployment area of the content store.

Entry type

Included

Rule

adminFolder

Yes

Replace

exportDeployment

Yes

Replace

deploymentHistory

Yes

Replace

adminFolder

Yes

Replace

importDeployment

Yes

Replace

deploymentHistory

Yes

Replace

Directory

Before importing a third party namespace, Cognos 8 verifies that the namespace exists in the startup configuration of the target environment. If the namespace does not exist, an error occurs and the import moves on the next object.

Before importing an account, group, or role, Cognos 8 verifies that the account, group, or role exists in the third party namespace in the target environment. For more information, see Including References to Third-party Namespaces.

The members of the System Administrators group are always merged when this group is imported.

If you select the option to include user information when you import, the account object for third party namespaces and some of its children are included.

The following table shows the objects in the directory area of the content store.

Entry type

Included

Rule

directory

Yes

Update

namespace (third party)

Yes

Update

namespaceFolder

Yes

Update

account

Set in options

Update

credential

Set in options

Replace

session

No

Not applicable

graphic

No

Not applicable

output

No

Not applicable

runTimeState

No

Not applicable

folder

Set in options

Replace

namespace (Cognos)

Yes

Update

namespaceFolder

Yes

Update

account (anonymous account)

No

Not applicable

credential

No

Not applicable

session

No

Not applicable

graphic

No

Not applicable

output

No

Not applicable

runTimeState

No

Not applicable

folder

No

Not applicable

contact

Yes

Replace

distributionList

Yes

Replace

role

group

Yes

Replace

dataSource

Yes

Replace

dataSourceConnection

Yes

Replace

dataSourceNameBinding

Yes

Replace

dataSourceSignon

Yes

Replace

printer

Yes

Replace

Portal

All objects in the portal area of the content store are updated when you import the entire content store.

Rules For Partial Deployment

When you deploy public folders and directory content rather than the entire content store, you select which of the following objects to include:

The default conflict resolution rule for partial deployment is update, unless specified differently in the deployment rules for the content and directory areas.

When you deploy public folders and directory content, you cannot include objects from the configuration, capability, exportDeploymentFolder, and importDeploymentFolder areas of the content store .

For information about how third-party references are deployed, see Including References to Third-party Namespaces.

Content

When a parent object is updated, new children from the deployment archive are added and join the existing set of children in the target environment. If a conflict occurs, the conflict resolution rule is to replace the children.

Because all job steps are replaced, no conflict is possible when importing jobStepDefinition objects.

If you include report output versions and run histories and you keep existing entries, the associated objects from the archive are merged with the objects in the target environment. Even though the objects are merged, the retention rules still apply. A full merge may not occur because some objects may be discarded.

Entry type

Included

Rule

content

No

Not applicable

package

root level folder

Yes when selected

Update

model

Yes

Replace

modelView

Yes

Replace

folder

Yes

Update

jobDefinition

Yes

Update

jobStepDefinition

Yes

Replace

jobHistory

Yes

Merge or replace

Set in Option 6

schedule

Yes

Keep or replace

Set in Option 7

query

report

Yes

Update

reportCache

 

Not applicable

cacheOutput

 

Not applicable

reportView

Yes

Update

reportVersion

Set in Option 5

Merge or replace

Set in Option 5

output

Set in Option 5

Replace

graphic

Set in Option 5

Replace

page

Yes or no

Set in Option 5

Replace

SQL

Set in Option 5

Replace

runHistory

Set in Option 6

Merge or replace

Set in Option 6

schedule

Set in Option 7

Keep or replace

Set in Option 7

shortcut

Yes

Replace

URL

Yes

Replace

query

agentView

Yes

Update

reportVersion

Set in Option 5

Merge or replace

Set in Option 5

output

Set in Option 5

Replace

runHistory

Set in Option 6

Merge or replace

Set in Option 6

schedule

Set in Option 7

Keep or replace

Set in Option 7

Directory

If you include data sources, connections, and signons, and you keep existing entries, the associated objects from the archive are merged with the objects in the target environment. Even though the objects are merged, the retention rules still apply. A full merge may not occur because some objects may be discarded.

Note that when you want to include Cognos groups and roles, and distribution lists and contacts, these items must be stored in a folder within the namespace in order to be deployed.

The members of distribution lists, groups, and roles in the archive are not merged with the contents in the target environment. Instead, the set of distribution lists, groups, and roles are merged with the set already existing in the target environment. However, the members of the System Administrators group are always merged when this group is imported. For more information, see Including Cognos Groups and Roles.

Entry type

Included

Rule

directory

No

Not applicable

namespace (third party)

No

Not applicable

namespaceFolder

No

Not applicable

account

No

Not applicable

credential

No

Not applicable

session

No

Not applicable

graphic

No

Not applicable

output

No

Not applicable

runTimeState

No

Not applicable

folder

No

Not applicable

namespace (Cognos)

No

Not applicable

namespaceFolder

Yes if Option 1 or Option 2 is true, and they are stored in a folder within the namespace

Update

account (anonymous)

No

Not applicable

credential

No

Not applicable

session

No

Not applicable

graphic

No

Not applicable

output

No

Not applicable

runTimeState

No

Not applicable

folder

No

Not applicable

contact

Set in Option 2

Merge or replace

Set in Option 2

distributionList

Set in Option 2

Merge or replace

Set in Option 2

role

group

Set in Option 1

Merge or replace

Set in Option 1

dataSource

Set in Option 3

Merge or replace

Set in Option 3

dataSourceConnection

Set in Option 3

Keep or replace

Set in Option 3

dataSourceNameBinding

Set in Option 3

Keep or replace

Set in Option 3

dataSourceSignon

Set in Option 4

Keep or replace

Set in Option 4

printer

No

Not applicable