Maximo 7.6.1.2 API

java.lang.Object
- psdi.configure.CommonShell
- - psdi.configure.Unlcvt

All Implemented Interfaces:: UpgConstants

public class Unlcvt
extends CommonShell
implements UpgConstants

Unload and Convert utility. Gets information from a database and generates an output file that can be used for creating another database. The output filename is Unlcvt. (File extension is "ora" for Oracle, "sqs" for SqlServer, and "ddl" for DB2.) Also see the -o parameter.

Developers with an existing Maximo database who are performing a refresh using a MAXIMO tablespace can run this script as is, using SQL*Plus or ISQL. Anyone who is creating a new database must run this via Maxinst.

This runs independently of MXServer. MXServer should NOT be running at the same time as this program, otherwise the database may be changing at the same time that this program is trying to determine what to output.

The commandline parameters for Unlcvt are as follows, in addition to those in the superclass CommonShell.

Parameter ID	Parameter Value	Description
-b	(none)	Output format for inserting data supports PreparedStatement in Maxinst. This is to support very large databases.
-d	(none)	The output directory parameter is ignored; the file is always output to the MXServer root.
-e	(none)	"Execute sql" is always True for Unlcvt, hence the commandline param is not used.
-l	(none)	"Log sql" is always True for Unlcvt, hence the commandline param is not used.
-m	Integer	Will limit output file size to the specified number of lines. If more lines are needed then additional output files will be written, using the same filename as the original plus a number (2, 3, 4, etc.). Maxinst will be able to read in these multiple files.
-o	Output filename	Output filename; defaults to "Unlcvt" + appropriate extension for db platform. Created in the MXServer root directory.
-x	Output database platform	This is optional. If not specified, the output file will be formatted for the same database platform as the input database (Oracle to Oracle, or SQLServer to SQLServer). If this parameter is specified, the output will be for the specified platform. Valid values are in `UpgConstants`.

See Also:: CommonShell

Field Summary
- Fields inherited from class psdi.configure.CommonShell
  listStream
- Fields inherited from interface psdi.configure.UpgConstants
  DB2, doNotUpdateACTION, doNotUpdateALNDOMAIN, doNotUpdateAPPLICATIONAUTH, doNotUpdateAUTOKEY, doNotUpdateCONDITION, doNotUpdateCONTRACTPROPERTY, doNotUpdateCONTRACTTYPE, doNotUpdateCROSSOVERDOMAIN, doNotUpdateDOCTYPES, doNotUpdateLANGUAGE, doNotUpdateMAXAPPS, doNotUpdateMAXCONDDETAIL, doNotUpdateMAXCONTROLVALUE, doNotUpdateMAXDOMAIN, doNotUpdateMAXLOGAPPENDER, doNotUpdateMAXLOGGER, doNotUpdateMAXMENU, doNotUpdateMAXMESSAGES, doNotUpdateMAXMODULES, doNotUpdateMAXPROP, doNotUpdateMAXPROPVALUE, doNotUpdateMAXROLE, doNotUpdateMAXSEQUENCE, doNotUpdateMAXSERSECURITY, doNotUpdateMAXSERVICE, doNotUpdateMAXTABLEDOMAIN, doNotUpdateMAXVARS, doNotUpdateMAXVARTYPE, doNotUpdateMXCOLLAB, doNotUpdateMXCOLLABREF, doNotUpdateNUMERICDOMAIN, doNotUpdateNUMRANGEDOMAIN, doNotUpdatePORTLET, doNotUpdatePRICALC, doNotUpdateSECURITYRESTRICT, doNotUpdateSIGOPTION, doNotUpdateSYNONYMDOMAIN, doNotUpdateTAXTYPE, doNotUpdateWORKPRIORITY, doNotUpdateWORKTYPE, doNotUpdateWPEDITSETTING, messageCache, NEWONLY, OLDANDNEW, OLDONLY, ORACLE, SQLINET, SQLMICROSOFT, SQLSERVER, SYSDATATABLES, SYSTEMTABLES, UNKNOWN

Constructor Summary

Constructors
Constructor and Description

Unlcvt()
This constructor does nothing.

Unlcvt(MXServer server)
This constructor accepts parameter for MXServerRemote and sets value for mxs.

Constructors
Constructor and Description
`Unlcvt()` This constructor does nothing.
`Unlcvt(MXServer server)` This constructor accepts parameter for MXServerRemote and sets value for `mxs`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildGrants()` Write the "grant..." statements (none for DB2).
`void`	`cacheSequences()` Cache the sequences for later use in `createSequences`.
`void`	`createCatalog()` Create catalog for SqlServer text search.
`void`	`createIndexes()` Write "drop index" and "create index" statements.
`void`	`createLexer()` Create lexer for Oracle text search.
`void`	`createOutfile(java.lang.String outdir, java.lang.String outfile)` Create "Unlcvt" + appropriate extension in MXServer root directory.
`void`	`createRowstampTriggers()` Write sql to create the rowstamp triggers.
`void`	`createSequences()` Sql to drop and create Oracle and DB2 sequences.
`void`	`createTablesAndViews()` Write the "drop table" and "create table" statements.
`void`	`endSetup(java.lang.String outdir, java.lang.String outfile, java.util.HashMap params)` Determine values for `dbOut` and `outFileNameDefault`, then call super.
`java.util.TreeMap`	`getMetadata()` Get the metadata for all Maximo tables.
`void`	`loadTables()` Write the "insert into (table ...)" statements.
`static void`	`main(java.lang.String[] argv)` Main.
`void`	`miscFinalStuff()` Any miscellaneous final commands should be invoked from this method.
`void`	`printCommit()` Print a "commit" statement.
`void`	`printHeader()` Print the header text at the beginning of the script.
`void`	`process()` Main processing method for this program.
`void`	`setup(java.util.HashMap params)` Set `log` and `execute` to True, then call super.
`void`	`showMsg(java.lang.String str)` Display a one-line message to the console and to the logfile.
`void`	`updateMaxSequence()` Update maxsequence.mareserved with the proper values.
`void`	`writeSql(java.util.ArrayList list)` Write a series of sql statements to the output file.
`void`	`writeSql(java.lang.String sql)` Write a sql statement to the output file.

Methods inherited from class psdi.configure.CommonShell
doCall, doDB2TextSearchCall, doSql, doSql, doSql, doSql, doWait, endProcess, endProcessInstance, endSetupInstance, execRuntime, getDisplayMessage, getDisplayMessage, getOutfile, getOutstream, getProperty, getRootDirName, logSql, reformatForDB2, reformatForSqlsvr, setConnection, setDB2TextOutput, setupFromPropfile, setupInstance, setupNested, setupNestedInstance, setUserLangCode, showMXException, showMXException

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Unlcvt
```
public Unlcvt()
```
    This constructor does nothing. Used when running from the DOS prompt.
  - Unlcvt
```
public Unlcvt(MXServer server)
```
    This constructor accepts parameter for MXServerRemote and sets value for mxs.
- Method Detail
  - process
```
public void process()
             throws java.lang.Exception
```
    Main processing method for this program.
    
    Specified by:
    
    process in class CommonShell
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.mxServerIsUp(java.lang.String), printHeader(), createLexer(), createCatalog(), createSequences(), getMetadata(), createTablesAndViews(), buildGrants(), loadTables(), createIndexes(), createRowstampTriggers(), miscFinalStuff(), updateMaxSequence(), printCommit()
  - printHeader
```
public void printHeader()
                 throws java.lang.Exception
```
    Print the header text at the beginning of the script.
    
    Throws:
    
    java.lang.Exception
  - cacheSequences
```
public void cacheSequences()
                    throws java.lang.Exception
```
    Cache the sequences for later use in createSequences.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    sequences
  - createSequences
```
public void createSequences()
                     throws java.lang.Exception
```
    Sql to drop and create Oracle and DB2 sequences.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.buildSequences(java.util.HashSet, boolean)
  - printCommit
```
public void printCommit()
                 throws java.lang.Exception
```
    Print a "commit" statement.
    
    Throws:
    
    java.lang.Exception
  - getMetadata
```
public java.util.TreeMap getMetadata()
                              throws java.lang.Exception
```
    Get the metadata for all Maximo tables.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    cacheSequences(), Util.getObjectMeta(java.lang.String, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
  - createTablesAndViews
```
public void createTablesAndViews()
                          throws java.lang.Exception
```
    Write the "drop table" and "create table" statements.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.buildCreateTableStatement(java.util.HashMap, boolean, boolean, java.lang.String, boolean), Util.buildCreateViewStatement(java.util.HashMap, boolean, boolean)
  - loadTables
```
public void loadTables()
                throws java.lang.Exception
```
    Write the "insert into (table ...)" statements.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.writeDumpTable(java.lang.String, java.util.TreeMap, java.io.PrintStream), printCommit()
  - buildGrants
```
public void buildGrants()
                 throws java.lang.Exception
```
    Write the "grant..." statements (none for DB2).
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.buildGrants(java.lang.String, boolean, boolean)
  - createIndexes
```
public void createIndexes()
                   throws java.lang.Exception
```
    Write "drop index" and "create index" statements.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.getIndexMeta(String, boolean), Util.rebuildIndexes(java.util.TreeMap, boolean, boolean, boolean, boolean)
  - miscFinalStuff
```
public void miscFinalStuff()
                    throws java.lang.Exception
```
    Any miscellaneous final commands should be invoked from this method.
    
    Throws:
    
    java.lang.Exception
  - createRowstampTriggers
```
public void createRowstampTriggers()
                            throws java.lang.Exception
```
    Write sql to create the rowstamp triggers. (If this outputs SqlServer, this returns without doing anything.)
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.getRowstampTriggerSql(java.lang.String, boolean)
  - updateMaxSequence
```
public void updateMaxSequence()
                       throws java.lang.Exception
```
    Update maxsequence.mareserved with the proper values. This update is performed only for SqlServer.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    Util.updateMaxSequence(java.util.HashSet)
  - createLexer
```
public void createLexer()
                 throws java.lang.Exception
```
    Create lexer for Oracle text search.
    
    Throws:
    
    java.lang.Exception
  - createCatalog
```
public void createCatalog()
                   throws java.lang.Exception
```
    Create catalog for SqlServer text search.
    
    Throws:
    
    java.lang.Exception
  - writeSql
```
public void writeSql(java.util.ArrayList list)
              throws java.lang.Exception
```
    Write a series of sql statements to the output file.
    
    Parameters:
    
    list - List of sql statements
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    writeSql(String)
  - writeSql
```
public void writeSql(java.lang.String sql)
              throws java.lang.Exception
```
    Write a sql statement to the output file. If this is Oracle, this method writes ";" on the next line, else writes "go" on the next line.
    
    Parameters:
    
    sql - The sql statement
    
    Throws:
    
    java.lang.Exception
  - showMsg
```
public void showMsg(java.lang.String str)
```
    Display a one-line message to the console and to the logfile.
    
    Overrides:
    
    showMsg in class CommonShell
    
    Parameters:
    
    str - The one-line message to be displayed.
  - setup
```
public void setup(java.util.HashMap params)
           throws java.lang.Exception
```
    Set log and execute to True, then call super.
    
    Overrides:
    
    setup in class CommonShell
    
    Parameters:
    
    params - Parameters (see class javadocs).
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    CommonShell.setup(java.util.HashMap)
  - endSetup
```
public void endSetup(java.lang.String outdir,
                     java.lang.String outfile,
                     java.util.HashMap params)
              throws java.lang.Exception
```
    Determine values for dbOut and outFileNameDefault, then call super.
    
    Overrides:
    
    endSetup in class CommonShell
    
    Parameters:
    
    outdir - Output directory (ignored -- uses MXServer root).
    
    outfile - Output filename (ignored -- uses value calculated in this method).
    
    params - HashMap of parameters.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    CommonShell.createOutfile(java.lang.String, java.lang.String), CommonShell.endSetupInstance(java.lang.String, java.lang.String, java.util.HashMap)
  - createOutfile
```
public void createOutfile(java.lang.String outdir,
                          java.lang.String outfile)
                   throws java.lang.Exception
```
    Create "Unlcvt" + appropriate extension in MXServer root directory. (The -o parameter may be used to specify a different output filename.)
    
    Overrides:
    
    createOutfile in class CommonShell
    
    Parameters:
    
    outdir - This is ignored.
    
    outfile - Output filename.
    
    Throws:
    
    java.lang.Exception
  - main
```
public static void main(java.lang.String[] argv)
```
    Main.
    
    See Also:
    
    setup(java.util.HashMap), process(), CommonShell.endProcess(boolean)

Class Unlcvt

Field Summary

Fields inherited from class psdi.configure.CommonShell

Fields inherited from interface psdi.configure.UpgConstants

Constructor Summary

Method Summary

Methods inherited from class psdi.configure.CommonShell

Methods inherited from class java.lang.Object

Constructor Detail

Unlcvt

Unlcvt

Method Detail

process

printHeader

cacheSequences

createSequences

printCommit

getMetadata

createTablesAndViews

loadTables

buildGrants

createIndexes

miscFinalStuff

createRowstampTriggers

updateMaxSequence

createLexer

createCatalog

writeSql

writeSql

showMsg

setup

endSetup

createOutfile

main