IBM Support

How to change retention rules of a data set object

Troubleshooting


Problem

In Cognos Analytics, Properties page of a data set does not show how many history objects and report versions are configured to keep in the content store. Functionality to change number of objects to keep is missing.

Resolving The Problem

Here are the steps to change retention rules of a data set object:
IMPORTANT: Be careful with CMTools. It is possible to delete important content without any prompt to confirm the intent. Always create a backup of the content store before using the CMTools utility.
CMTools is installed with the Content Manager (Data Tier) on Windows
Make sure a cold backup of the content store is available
1. Start primary Content Manager
2. In Content Manager installation, navigate to bin64\utilities\cm\CMTools
3. Run CMTools.exe
4. In CMTools navigate to Window - Preferences and set a valid CM URI
5. Log in as a System Administrator
6. Open the CMTools perspective Window - Open perspective
7. Go to the CMTester (classic) tab
8. Access Cognos in a web browser, navigate to the data set object, open Properties and copy the value of ID property, i28CFA79014AD411BA8B25743A87FDCC1, for instance.
9. In CMTools - CMTester (classic) choose query.xml from the Request template drop-down list
10. In the Request area, replace #PATH# with the storeID("<ID>"), storeID("i28CFA79014AD411BA8B25743A87FDCC1") for instance, replace #PROPERTY1# with searchPath, replace #PROPERTY2# with retentions, replace #SORT_BY# with defaultName
11. Press Send button
12. Copy the entire XML from the Response area, it looks like
<cm1:queryResponse ...>
        <result ...>
            <item xsi:type="cm:dataSet2">
                <searchPath xsi:type="cm:stringProp">
                    <value ...>/content/folder[@name='Event']/dataSet2[@name='DataSet 1']</value>
                </searchPath>
                <retentions xsi:type="cm:retentionRuleArrayProp">
                    <value ... SOAP-ENC:arrayType="cm:retentionRule[2]">
<item ...><objectClass ...>history</objectClass><prop ...>creationTime</prop><maxObjects xsi:type="xsd:integer">5</maxObjects></item>
<item ...><objectClass ...>reportVersion</objectClass><prop ...>creationTime</prop><maxObjects xsi:type="xsd:integer">1</maxObjects></item>
</value>
                </retentions>
            </item>
        </result>
    </cm1:queryResponse>
    
13. Change value in the maxObjects XML element of the rule for history and reportVersion objects to the wanted number, do not change other values
14. In CMTools select update.xml in the Request template drop-down list
15. Replace bus:report with bus:dataSet2
16. Replace #Path# with the value of the searchPath XML element in the response.
17. Replace defaultName XML element retentions XML element altered in the response
18. Replace #RETURNPROP# with retentions
19. Press Send button
20. Verify that returned retentions are as wanted

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSTSF6","label":"IBM Cognos Analytics"},"ARM Category":[{"code":"a8m3p000000hBL9AAM","label":"Administration-\u003EContent Administration"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
14 March 2022

UID

ibm16563027