folder

Contains the set of application content objects, such as queries, reports, job definitions, and other folders.

Use instances of this class to organize objects in the web portal, so they are easier to find and manipulate.

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.

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

effectiveUserCapabilities

Contains the current user's capabilities for the object. This value is determined by intersecting the set of user capabilities granted by bibus » folder » 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.

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.

powerPlay8Configuration

Specifies the PowerPlay® configuration data for this object.

This property contains data to be used only by IBM® Cognos®software. 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.

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.