com.ibm.tivoli.maximo.report.cognos.metadata.player

Class ActionLogPlayer

java.lang.Object

com.ibm.tivoli.maximo.report.cognos.metadata.player.ActionLogPlayer

public class ActionLogPlayer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ActionLogPlayer(java.lang.String url, java.lang.String namespaceId, java.lang.String userName, java.lang.String password) This constructor is responsible for initializing the Cognos manager
ActionLogPlayer(java.lang.String url, java.lang.String namespaceId, java.lang.String userName, java.lang.String mxtoken, java.lang.String mxtokenurl) This constructor is responsible for initializing the Cognos manager

Method Summary

Modifier and Type	Method and Description
void	playScript(java.lang.String projectBaseDir, java.io.Reader in, java.lang.String dataSourceName, java.lang.String contentStorePackageLocation) This method is responsible of executing an action log script on Cognos server.
void	playScript(java.lang.String projectBaseDir, java.io.Reader in, java.lang.String dataSourceName, java.lang.String contentStorePackageLocation, boolean useTransientAction) This method is responsible of executing an action log script on Cognos server.
void	playScript(java.lang.String projectBaseDir, java.lang.String script, java.lang.String dataSourceName, java.lang.String contentStorePackageLocation) This method is responsible of executing an action log script on Cognos server.
void	playScript(java.lang.String projectBaseDir, java.lang.String script, java.lang.String dataSourceName, java.lang.String contentStorePackageLocation, boolean useTransientAction) This method is responsible of executing an action log script on Cognos server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionLogPlayer

public ActionLogPlayer(java.lang.String url,
                       java.lang.String namespaceId,
                       java.lang.String userName,
                       java.lang.String password)
                throws CognosHandlerException

This constructor is responsible for initializing the Cognos manager

Parameters:

url - the url of the Cognos Server, it is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Environment -> Dispatcher URI for external applications

namespaeId - the namespace for the authentication provider configured on Cognos Server. It is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Security -> Authentication -> ->Namespace ID

userName - the username of the Cognos user

password - the password og the Cognos user

Throws:

CognosHandlerException - if exception occurred while connecting to the Cognos server

ActionLogPlayer

public ActionLogPlayer(java.lang.String url,
                       java.lang.String namespaceId,
                       java.lang.String userName,
                       java.lang.String mxtoken,
                       java.lang.String mxtokenurl)
                throws CognosHandlerException

This constructor is responsible for initializing the Cognos manager

Parameters:

url - the url of the Cognos Server, it is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Environment -> Dispatcher URI for external applications

namespaeId - the namespace for the authentication provider configured on Cognos Server. It is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Security -> Authentication -> ->Namespace ID

userName - the username of the Cognos user

mxtoken - the token of the Cognos user

mxtokenurl - the authentication url used for token validation in the MXCSP

Throws:

CognosHandlerException - if exception occurred while connecting to the Cognos server

Method Detail

playScript

public void playScript(java.lang.String projectBaseDir,
                       java.lang.String script,
                       java.lang.String dataSourceName,
                       java.lang.String contentStorePackageLocation)
                throws CognosHandlerException

This method is responsible of executing an action log script on Cognos server.

The method do the following:
1. Generate the folder name for the framework manager project. It appends the maximo integration object name to the current data time.
2. Create the framework manager project.
3. Open the framework manager project.
4. Loop on the transactions in the script and execute them one by one.
5. Save the project.
6. Close the project

Parameters:

projectBaseDir - the directory where the framework manager project directory will be created

script - the action log to be executed

dataSourceName - the Cognos data source name connecting to the Maximo database

contentStorePackageLocation - the location where the Cognos package will be published in the content store

Throws:

CognosHandlerException - if exception occurred while executing the script

playScript

public void playScript(java.lang.String projectBaseDir,
                       java.lang.String script,
                       java.lang.String dataSourceName,
                       java.lang.String contentStorePackageLocation,
                       boolean useTransientAction)
                throws CognosHandlerException

This method is responsible of executing an action log script on Cognos server.

Parameters:

projectBaseDir - the directory where the framework manager project directory will be created

script - the action log to be executed

dataSourceName - the Cognos data source name connecting to the Maximo database

contentStorePackageLocation - the location where the Cognos package will be published in the content store

useTransientAction - should this action log be executed with a transient action? Required for multiserver support.

Throws:

CognosHandlerException - if exception occurred while executing the script

playScript

public void playScript(java.lang.String projectBaseDir,
                       java.io.Reader in,
                       java.lang.String dataSourceName,
                       java.lang.String contentStorePackageLocation)
                throws CognosHandlerException

This method is responsible of executing an action log script on Cognos server.

The method do the following:
1. Generate the folder name for the framework manager project. It appends the maximo integration object name to the current data time.
2. Create the framework manager project.
3. Open the framework manager project.
4. Loop on the transactions in the script and execute them one by one.
5. Save the project.
6. Close the project

Parameters:

projectBaseDir - the directory where the framework manager project directory will be created

in - the reader of the action log script to be executed

dataSourceName - the Cognos data source name connecting to the Maximo database

contentStorePackageLocation - the location where the Cognos package will be published in the content store

Throws:

CognosHandlerException - if exception occurred while executing the script

playScript

public void playScript(java.lang.String projectBaseDir,
                       java.io.Reader in,
                       java.lang.String dataSourceName,
                       java.lang.String contentStorePackageLocation,
                       boolean useTransientAction)
                throws CognosHandlerException

This method is responsible of executing an action log script on Cognos server.

The method generates the folder name for the framework manager project. It appends the maximo integration object name to the current data time.

If the useTransient argument value is false, the method will also do the following individual steps: 1. Create the framework manager project.
2. Open the framework manager project.
3. Loop on the transactions in the script and execute them one by one.
4. Save the project.
5. Close the project

If the useTransient argument value is true, the method will create the project and execute the action log in a single step. In this case the script will only include one transaction.

Parameters:

projectBaseDir - the directory where the framework manager project directory will be created

in - the reader of the action log script to be executed

dataSourceName - the Cognos data source name connecting to the Maximo database

contentStorePackageLocation - the location where the Cognos package will be published in the content store

useTransientAction - should this action log be executed with a transient action? Required for multiserver support.

Throws:

CognosHandlerException - if exception occurred while executing the script