package

Contains a model and all the folders, queries, reports, views, shortcuts, URLs, and job definitions associated with that model.

Use a package to organize all objects related to a particular application.

A package is created when a modeler publishes a model from IBM® Cognos® Framework Manager. Users can view the contents of a package in their web portal.

We recommend that you represent instances of this type as non-leaf nodes in a tree structure.

This class

References

Used by the following properties:

Container Information

Contains instances of the following classes
Contained by instances of the following classes

Properties

This class has the following properties.

configuration

Specifies the package configuration.

Configuration data for the package is stored as a contained object. This allows administrators to use a security policy to restrict the ability to change this data. The default security policy for packages allows many roles to update the package.

This property

  • must have at most 1 item

contact

Refers to a person or group of people who are responsible for the object.

This property

contactEMail

Specifies the email address of the person or group of people who are responsible for the object.

This property

  • is of type string

    is encoded as type tns:stringProp

dataSources

Reserved.

New in Version 8.4 — Package Data Sources

This property was added.

defaultPortalAction

Specifies the default action for an object in a portal.

When users click the hyperlinked name in the portal, the default action specified, such as view, run, or open for editing, is performed.

This property

  • is of type bibus » packageActionEnum

    is encoded as type tns:packageActionEnumProp

  • has a default value of view

drillPaths

Contains the drill paths. A drill path is used to drill through from a source to a target.

For example, a drill path can specify how to get from one report to another to allow a user to access related or more detailed information.

effectiveUserCapabilities

Contains the current user's capabilities for the object. This value is determined by intersecting the set of user capabilities granted by bibus » package » userCapabilityPolicies property with the set of user capabilities granted to the user globally, as returned by bibus » session » userCapabilities property.

In order for a capability to be effective for the object, it must be granted to the user both globally and for the object.

This property

  • is an array of type bibus » userCapabilityEnum

    is encoded as type tns:userCapabilityEnumArrayProp

  • is read-only

  • can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required

New in Version 8.4 — Object Capabilities

This property was added.

New in Version 10.1.0 — Object Capabilities Properties

This property can now be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required.

items

Contains the child objects for this object.

New in Version 8.3 — Package Hierarchies

This property was extended to allow instances of the bibus » package class to be contained by instances of this property.

New in Version 8.4 — PowerPlay 8 Integration

This property was extended to allow instances of the bibus » basePowerPlay8Report class to be contained by instances of this property.

New in Version 8.4 — Dashboards

This property was extended to allow instances of the bibus » dashboard class to be contained by instances of this property.

New in Version 9.0.0 — Support for IBM Cognos Express

This property was extended to allow instances of the bibus » launchable class to be contained by instances of this property.

New in Version 10.1.0 — Variable Support for Data Movement Tasks

This property was extended to allow instances of the bibus » dataMovementTaskAlias class to be contained by instances of this property.

model

Specifies a model contained by this package.

Administrators can set a distinct security policy for each model, differing from the security policy set for the package that contains it.

This property

packageBase

Specifies the path to the ancestor package. The format of this property is the same as the format of the bibus » baseClass » searchPath property.

If the object is not a descendant of a package, the value of this property is the path to the root object.

This property

  • is of type string

    is encoded as type tns:stringProp

  • is read-only

  • must contain no more than 4096 characters

  • can be acquired from a containing object

New in Version 8.3 — Package Hierarchies

This property is deprecated. Use the bibus » baseClass » ancestors property instead.

planningApplication

Reserved.

This property

  • must have at most 1 item

powerPlay8Configuration

Specifies the PowerPlay® configuration data for this object.

This property contains data to be used only by IBM Cognossoftware. The structure of this data is subject to change without notice. Client applications should not attempt to interpret or modify this data.

This property

New in Version 8.4 — PowerPlay 8 Integration

This property was added.

repositoryRules

This property

  • is an array of type bibus » repositoryRule

    is encoded as type tns:repositoryRuleArrayProp

  • can be acquired from a containing object

New in Version 10.1.1 — Support for IBM Cognos Content Archival

This previously reserved feature, introduced in Version 10.1.0, is now available for use.

New in Version 10.2.1 — Support for archiving a namespace or namespaceFolder

The bibus » account, bibus » namespace, and bibus » namespaceFolder classes have been extended to include this property.

New in Version 10.2.0 — New Repository Service (REST) API

The Repository Service REST API allows for navigation and retrieval of resources stored in an external repository.

For more information, see the Repository Service API reference chapter.

retentions

Contains a set of retention rules, each associated with a specified class of child object that this parent can contain. These rules specify values for deleting child objects. For example, you can specify that Content Manager keep the latest three versions, or keep versions created in the last three months. IBM Cognos Connection limits retention configuration by either versions or duration.

The following rules are added to a new instance of this class when it is created by an IBM Cognos component:

Table 1. Rules for a new package object
Versioned Class Maximum Age Maximum Count Ordered By
bibus » model class 0 bibus » baseClass » creationTime property

This property

routingHints

Specifies the routing hints for this object.

This property

  • is an array of type string

    is encoded as type tns:stringArrayProp

  • can be acquired from a containing object

New in Version 8.3 — Package Hierarchies

This property can now be acquired.

routingServerGroup

Specifies the name of the server group that should handle requests using this object.

This property is calculated using the content » determineRouting(objectPaths) method . The related objects are determined using information available to Content Manager about the object class. For example, a user's membership in a group or role can be derived from the user's Passport.

This property

  • is of type string

    is encoded as type tns:stringProp

  • is read-only

  • can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required

routingServerGroupEdition

Specifies the edition of the service that should handle requests using this object.

This property

  • is of type string

    is encoded as type tns:stringProp

  • is read-only

  • must contain no more than 20 characters

  • must contain exactly three decimal numbers consisting of one or more decimal digits separated by a decimal point ('.')

  • is searchable

  • can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required

New in Version 8.4 — Software Editions

This property was added.

serverGroup – deprecated

Specifies the server group associated with this object. This property is not used by IBM Cognos Analytics.

This property

  • is of type string

    is encoded as type tns:stringProp

  • is deprecated and will be removed in a future version of the product

  • can contain at least 255 characters

  • can be acquired from a containing object

userCapabilities

Contains the current user's capabilities for the object, as defined by the userCapabilityPolicies property.

This property

  • is an array of type bibus » userCapabilityEnum

    is encoded as type tns:userCapabilityEnumArrayProp

  • is read-only

  • can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required

New in Version 8.4 — Object Capabilities

This property was added.

New in Version 10.1.0 — Object Capabilities Properties

This property can now be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required.

userCapabilityPolicies

Contains the user capability policy for the object.

This property

  • is an array of type bibus » userCapabilityPolicy

    is encoded as type tns:userCapabilityPolicyArrayProp

  • can be acquired from a containing object

New in Version 8.4 — Object Capabilities

This property was added.

userInterfaces

Specifies the user interfaces that can be used with this package. If this property contains no entries, any user interface may be used with this package. If this property contains one or more entries, only the specified user interfaces may be used with this package.

This property

  • is an array of type bibus » uiComponentEnum

    is encoded as type tns:uiComponentEnumArrayProp

  • can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required