IBM Support

SDK FM How to automate publishing a Package with the 'externalize' option selected.

Troubleshooting


Problem

How to automate publishing a Framework Manager package with the option 'externalize'.

Symptom

Unable to script the externalizing of query subjects

Cause

Some special steps need to be taken to be able to get and generate a XML file for the Publishing of a Model.

Resolving The Problem

For IBM Cognos a special setup needs to be done to be able to retrieve and generate an Action XML log that includes the Publishing step of a Model to the IBM Cognos Server.

To make the required publish and externalize information in the transaction history in the logs visible in Framework Manager when you view the Transaction History, there is a configuration flag that needs to be set within the product.
You only do this on the Framework Manager installation that is used in Development.

In IBM Cognos setting this flag will log the publish command by default, and no additional configuration changes are required :

On the computer where you have Framework Manager installed :

1. Open the <Cognos_Root>/templates/bmt/Cr1Model/CR1 Behaviors.xml in a text editor.
2. Search and Modify the following line:
<Action Name="Publish" ID="10" loglevel="1" />
to
<Action Name="Publish" ID="10" loglevel="2" />

3. Restart Cognos , then attempt the publish again.
4. Publish the package with the 'externalize' option selected.
5. View the transaction history and save the published information as an XML file as follows:
5.1 From Menu - Project - View Transaction History - select transaction list entry and
the click on 'Save as Script'.
6. Save the xml file to a location and then execute the following command from the
<Cognos_Root>/bin folder:

bmtscriptplayer -m <path to model cpf file> -a <path to saved xml file> -u userID -p password -s namespaceID

Example:

bmtscriptplayer.exe -a "c:\models\gosales\gosales.cpf -a c:\externalize.xml -u administrator -p admin1234 -s LDAP

Notes for BMTScriptPlayer :

- BmtScriptPlayer has no functionality to validate and upgrade the Action Scripts in any way.
- For validation and possible upgrade use Framework Manager's Run Script option for the action script.
- Action scripts are not transferable between versions, and validation can only be done via FM's Save / Publish actions.
- With the above steps , it can be determined that the FM Action in the GUI , is generating a "new or modified action" in a new constructed Action script.
This should be used then in new Action designed scripts for FM, BMTScriptPlayer and the FM / SDK API for this Cognos Version.

[{"Product":{"code":"SSEP7J","label":"Cognos Business Intelligence"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"Framework Manager","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"10.2.2;10.2.1;10.2;10.1.1;10.1","Edition":"Edition Independent","Line of Business":{"code":"LOB10","label":"Data and AI"}},{"Product":{"code":"SSEP7J","label":"Cognos Business Intelligence"},"Business Unit":{"code":"BU053","label":"Cloud \u0026 Data Platform"},"Component":"Software Development Kit","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"","label":"HP Itanium"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"8.4.1","Edition":"Edition Independent","Line of Business":{"code":"","label":""}},{"Product":{"code":"SSEP7J","label":"Cognos Business Intelligence"},"Business Unit":{"code":"BU053","label":"Cloud \u0026 Data Platform"},"Component":"Framework Manager","Platform":[{"code":"PF033","label":"Windows"}],"Version":"8.4.1","Edition":"Edition Independent","Line of Business":{"code":"","label":""}},{"Product":{"code":"SSTSF6","label":"IBM Cognos Analytics"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":" ","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"11.0","Edition":"Edition Independent","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Historical Number

1029451

Document Information

Modified date:
28 November 2022

UID

swg21341499