Dataview Categories

You can create categories for your data views. Categories exist when a data view is first associated with them and cease to exist when those data views are deleted.

You should specify a category when creating a data view via the web service API. The data view is then visible via Openspace and Workspace. Creating a view without a category is possible via the web service API, but if such a view is created, it cannot be displayed in Openspace or Workspace. You can use SOAP API - getDataViewDetails to retrieve data views that have no category.

Note: This returns all the data views that have been created using the web service API without specifying a category. If you create a data view in Openspace and Workspace without specifying a category, the BPM clients place them in a category called UNCATEGORIZED.

You can create a hierarchical structure for you categories using forward slashes.

You can use getDataViewCategories to browse your categories. You can specify:

  • name: Slash-separated path to the category in the hierarchy. Leave this blank to return all top-level categories.
  • childDepth. Number of levels of child categories beneath the matching categories. -1 is unlimited depth. Leave blank to return no children.
  • childrenOnly (optional): Use with childDepth. If this is set to true, the category is omitted and only the children are retrieved.

For example, you could have the following categories:

Warehouse/General
Warehouse/General/Audit
Warehouse/End of month reporting/Personal queries/John

The following table describes some possible requests and responses using the above example.

Request Response
name="" All categories are listed.
name=Warehouse, childDepth=1, childrenOnly=true Warehouse/General
Warehouse/End of month reporting
name=Warehouse, childDepth=-1, childrenOnly=true Warehouse/General
Warehouse/General/Audit
Warehouse/End of month reporting
name=Warehouse, childDepth=1, childrenOnly=false Warehouse/General
Warehouse/General/Audit