ext.sulis.datamagic

Class DataMagic

Object

DataMagic

All Implemented Interfaces:

RemoteAccess

public class DataMagic
extends Object
implements RemoteAccess

purpose: web & cmd line based tool/api for mass-update of windchill objects & atts

Author:

pnierkamp@sulis.de 20120805 pn; merged back rev10 changes to 9.x version. using CsvData for R/W ops now. 20120806 pn; added support for changing the filename (filename of applicationdata) 20120808 pn; added query support for docType, authApp, LCState 20120830 pn; added 'continueOnError' support (checkbox on resultspage, only for format2!) 20121108 pn; added (enhanced) support for container filtering. (regex...) 20121114 pn; added new search abilities 20130320 pn; bugfix for subfolder move / revision handling 20130827 pn; added support for updating persitInfo = modifier, modified, creator, created 20130902 pn; fixed licensing issue 20130902 pn; added type filter for number based search 20130919 pn; optimized result reporting 20131108 pn; bugfixing for format1 (quotes on/off) 20131108 pn; bugfixing for type definitiion handling. requires attmagic now 20131127 pn; bugfixing for cluster/node hostname detection. use wt.rmi not java.rmi! 20131127 pn; moved iba definition into datamgic class. performance improvement 20140206 pb; Deleted unused public final DTBYPE and other constants. Increased Minor version 20140218 pn; fixed data assembly for query logic sm rules... 20140403 pn; new features, bugfixes, cleanup... 20140403 pn; folder / location search rewritten 20140409 pn; format2 support call_custom 20140414 pn; bugfix for querymagic 20140717 pn; csv key is uppercase now. fix eval in read_format2 20140722 pn; bugfixing for parsing format2 20140728 pn; added undo checkout 20140911 pn; bound to enhanced/fixed querymagic 2.21 20140929 pn; bugfix for resultlog handling & iba update (-> attmagic, take care of case sensitivity for att names) 20150413 pn; bugfix/enhancement for oid rows. also check col2 if oid is specified. 20151112 pn; support added for security labels 20160114 pn; support custom method call. 20151123 pn; notexists iba support + callCustomMethod improvements 20160125 pn; fixed queryformat1 mode. show commeted results if dmmsg 20160204 pn; improved custommethod handling 20160518 pn; added cadname search 20160611 pn; improved custommethod call return value handling 20160624 pn; added iterate for format2 20160628 pn; fix/enhancement for call_custom 20160630 pn; encapsulate iterate with transaction (prevent bad checkedout obj in case of checkin failure) 20160701 pn; major rework on work handling for format2. store list of actions in list -> maintain order given by format2 workfile 20160719 pn; bugfix for do_move if srcContainer is "cabinet" 20160720 pn; bugfix for do_move, val is empty. added checks. made major/minor private. jsp is using getter

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALLOWEDATTS
static String	ALLOWEMPTY
static String	ALLOWNEWIBA
static String	ATTMARK
static String	CONFIGBASE
static String	CONFIGFILENAME
static String	CONT_ON_ERR
static String	CREATEREP
static String	DELREP
static String	DM_ACTION_CALLMETH
static String	DM_ACTION_DELITER
static String	DM_ACTION_JUSTFIND
static String	DM_ACTION_KILLIBA
static String	DM_ACTION_MOVEOBJ
static String	DM_PATH
static String	DM_VALIDATOR
static SimpleDateFormat	FORMATTER_TS
static SimpleDateFormat	FORMATTERZ
static String	HTTPGWHOSTNAME
static String	IBAMARK
static String	ITERATE
static String	LOGFILENAME
static String	MOVEOBJ_FOLDER
static String	MOVEOBJ_WTC
static String	OP_API
static String	OP_SQL
static String	OPMODE
static String	PAGECUR
static String	PAGERESULTS
static String	PAGESIZE
static String	REPLACEATT
static String	REPLACEIBA
static String	REPLACEMETHSTR
static String	REPLACERULE
static String	REPLACESTR
static String	REPLACETARGET
static String	REPLACETARGET_ATT
static String	REPLACETARGET_IBA
static String	REPLACETARGET_NAME
static String	REPLACETARGET_NUMBER
static String	REPLACETARGETATT
static String	REPLACETYPE
static String	REPLACETYPE_CALLMETH
static String	REPLACETYPE_DELITER
static String	REPLACETYPE_IBA
static String	REPLACETYPE_JUSTFIND
static String	REPLACETYPE_MOVEOBJ
static String	REPLACETYPE_MOVETOLI
static String	REPLACETYPE_MOVETOM
static String	REPLACETYPE_REMOVEIBAONALLIT
static String	REPLACETYPE_RULE
static String	REPLACETYPE_TXT
static String	RESULTFILENAME
static String	RMIHOSTNAME
static boolean	SERVER
static String	SHOWRESULT
static String	SIMULATE
static String	UPLOADJSP
static String	WEBAPPNAME
static String	WORKBASE
static String	WORKFILENAME
static String	WTHOME

Fields inherited from interface RemoteAccess

versionID

Constructor Summary

Constructors

Constructor and Description
DataMagic()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	askUserYesNo(String questionTxt)
static HashMap<String,Vector>	buildAllowedKeys()
static Map	callCustomUpdateMethod(Map params)
static boolean	checkAccess()
static HashMap<String,String>	doQuery(HashMap<String,String> queryParams)
static HashMap<String,String>	doSqlQuery(HashMap<String,String> queryParams)
static void	doUndoCheckAll(List<Persistable> coObjects)
static Vector	doUpdate(HashMap queryParamsIN)
static TreeMap	getAllIBA()
static String	getDataMagicUploadURL()
static String	getDataMagicURL()
static HashMap<String,String>	getDefaultParams()
static Persistable	getLatestIteration(Persistable obj)
static String	getLicensingMessage()
static int	getMajor()
static int	getMinor()
static String	getNextKey(String rule)
static String	getTitle()
static String	getWorkDir()
static String	getWorkfileURL(String workfilename)
static boolean	isLicensed()
static HashMap<String,String>	loadConfig(File configFile)
static void	main(String[] args)
static Vector	parseRuleString(String ruleStr, HashMap<String,Vector> allowedKeys)
static Map<String,List<Map<String,String>>>	parseWorkfile_format2(List<Map<String,String>> data, String logfileName)
static void	printUsage()
static String	renderActionButton(String url, String action, String buttonTxt, HashMap<String,String> params)
static String	renderLicLimit()
static String	renderPreview_format1(List<Map<String,String>> data, int curPage, boolean showResult, boolean pageResult)
static String	renderPreview_format2(List<Map<String,String>> data, int curPage, boolean showresult, boolean pageresult, Map queryParams)
static String	renderPreview(File workfile, Map queryParams)
static String	renderResult_format1(List<Map<String,String>> data, int curPage, boolean showResult, boolean pageResult)
static String	renderResult_format2(List<Map<String,String>> data, int curPage, boolean showresult, boolean pageresult, Map queryParams)
static String	renderResult(File workfile, HashMap queryParams)
static void	saveConfig(File configFile, HashMap<String,String> queryParams)
static void	updateWorkfile_format1(List<Map<String,String>> data, String logfileName)
static void	updateWorkfile_format2(List<Map<String,String>> data, String logfileName, HashMap queryParams)
static void	writeWorkfile(HashMap<String,String> worklist, HashMap<String,String> queryParams)

Methods inherited from class Object

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

Field Detail

SERVER

public static final boolean SERVER

RMIHOSTNAME

public static final String RMIHOSTNAME

HTTPGWHOSTNAME

public static final String HTTPGWHOSTNAME

WEBAPPNAME

public static final String WEBAPPNAME

WTHOME

public static final String WTHOME

DM_PATH

public static final String DM_PATH

DM_VALIDATOR

public static final String DM_VALIDATOR

WORKBASE

public static final String WORKBASE

CONFIGBASE

public static final String CONFIGBASE

UPLOADJSP

public static final String UPLOADJSP

FORMATTERZ

public static SimpleDateFormat FORMATTERZ

FORMATTER_TS

public static SimpleDateFormat FORMATTER_TS

ATTMARK

public static final String ATTMARK

See Also:

Constant Field Values

IBAMARK

public static final String IBAMARK

See Also:

Constant Field Values

ALLOWEDATTS

public static final String[] ALLOWEDATTS

SIMULATE

public static final String SIMULATE

See Also:

Constant Field Values

ITERATE

public static final String ITERATE

See Also:

Constant Field Values

ALLOWEMPTY

public static final String ALLOWEMPTY

See Also:

Constant Field Values

ALLOWNEWIBA

public static final String ALLOWNEWIBA

See Also:

Constant Field Values

SHOWRESULT

public static final String SHOWRESULT

See Also:

Constant Field Values

PAGERESULTS

public static final String PAGERESULTS

See Also:

Constant Field Values

PAGESIZE

public static final String PAGESIZE

See Also:

Constant Field Values

PAGECUR

public static final String PAGECUR

See Also:

Constant Field Values

REPLACETYPE

public static final String REPLACETYPE

See Also:

Constant Field Values

REPLACETYPE_TXT

public static final String REPLACETYPE_TXT

See Also:

Constant Field Values

REPLACETYPE_IBA

public static final String REPLACETYPE_IBA

See Also:

Constant Field Values

REPLACETYPE_RULE

public static final String REPLACETYPE_RULE

See Also:

Constant Field Values

REPLACETYPE_MOVETOM

public static final String REPLACETYPE_MOVETOM

See Also:

Constant Field Values

REPLACETYPE_MOVETOLI

public static final String REPLACETYPE_MOVETOLI

See Also:

Constant Field Values

REPLACETYPE_REMOVEIBAONALLIT

public static final String REPLACETYPE_REMOVEIBAONALLIT

See Also:

Constant Field Values

REPLACETYPE_DELITER

public static final String REPLACETYPE_DELITER

See Also:

Constant Field Values

REPLACETYPE_CALLMETH

public static final String REPLACETYPE_CALLMETH

See Also:

Constant Field Values

REPLACETYPE_JUSTFIND

public static final String REPLACETYPE_JUSTFIND

See Also:

Constant Field Values

REPLACETYPE_MOVEOBJ

public static final String REPLACETYPE_MOVEOBJ

See Also:

Constant Field Values

REPLACESTR

public static final String REPLACESTR

See Also:

Constant Field Values

REPLACEMETHSTR

public static final String REPLACEMETHSTR

See Also:

Constant Field Values

REPLACERULE

public static final String REPLACERULE

See Also:

Constant Field Values

REPLACEIBA

public static final String REPLACEIBA

See Also:

Constant Field Values

REPLACEATT

public static final String REPLACEATT

See Also:

Constant Field Values

REPLACETARGET

public static final String REPLACETARGET

See Also:

Constant Field Values

REPLACETARGETATT

public static final String REPLACETARGETATT

See Also:

Constant Field Values

REPLACETARGET_ATT

public static final String REPLACETARGET_ATT

See Also:

Constant Field Values

REPLACETARGET_NAME

public static final String REPLACETARGET_NAME

See Also:

Constant Field Values

REPLACETARGET_NUMBER

public static final String REPLACETARGET_NUMBER

See Also:

Constant Field Values

REPLACETARGET_IBA

public static final String REPLACETARGET_IBA

See Also:

Constant Field Values

MOVEOBJ_WTC

public static final String MOVEOBJ_WTC

See Also:

Constant Field Values

MOVEOBJ_FOLDER

public static final String MOVEOBJ_FOLDER

See Also:

Constant Field Values

DELREP

public static final String DELREP

See Also:

Constant Field Values

CREATEREP

public static final String CREATEREP

See Also:

Constant Field Values

OPMODE

public static final String OPMODE

See Also:

Constant Field Values

OP_SQL

public static final String OP_SQL

See Also:

Constant Field Values

OP_API

public static final String OP_API

See Also:

Constant Field Values

CONT_ON_ERR

public static final String CONT_ON_ERR

See Also:

Constant Field Values

LOGFILENAME

public static final String LOGFILENAME

See Also:

Constant Field Values

WORKFILENAME

public static final String WORKFILENAME

See Also:

Constant Field Values

RESULTFILENAME

public static final String RESULTFILENAME

See Also:

Constant Field Values

CONFIGFILENAME

public static final String CONFIGFILENAME

See Also:

Constant Field Values

DM_ACTION_KILLIBA

public static final String DM_ACTION_KILLIBA

See Also:

Constant Field Values

DM_ACTION_DELITER

public static final String DM_ACTION_DELITER

See Also:

Constant Field Values

DM_ACTION_CALLMETH

public static final String DM_ACTION_CALLMETH

See Also:

Constant Field Values

DM_ACTION_JUSTFIND

public static final String DM_ACTION_JUSTFIND

See Also:

Constant Field Values

DM_ACTION_MOVEOBJ

public static final String DM_ACTION_MOVEOBJ

See Also:

Constant Field Values

Constructor Detail

DataMagic

public DataMagic()

Method Detail

getMajor

public static int getMajor()

getMinor

public static int getMinor()

getTitle

public static String getTitle()

checkAccess

public static boolean checkAccess()
                           throws WTException

Throws:

WTException

isLicensed

public static boolean isLicensed()

getLicensingMessage

public static String getLicensingMessage()

buildAllowedKeys

public static HashMap<String,Vector> buildAllowedKeys()

getDefaultParams

public static HashMap<String,String> getDefaultParams()

parseRuleString

public static Vector parseRuleString(String ruleStr,
                     HashMap<String,Vector> allowedKeys)

getNextKey

public static String getNextKey(String rule)

writeWorkfile

public static void writeWorkfile(HashMap<String,String> worklist,
                 HashMap<String,String> queryParams)
                          throws Exception

Throws:

Exception

doQuery

public static HashMap<String,String> doQuery(HashMap<String,String> queryParams)
                                      throws WTException

Throws:

WTException

getWorkDir

public static String getWorkDir()
                         throws IOException

Throws:

IOException

getDataMagicURL

public static String getDataMagicURL()
                              throws IOException

Throws:

IOException

getDataMagicUploadURL

public static String getDataMagicUploadURL()
                                    throws IOException

Throws:

IOException

getWorkfileURL

public static String getWorkfileURL(String workfilename)
                             throws IOException

Throws:

IOException

doSqlQuery

public static HashMap<String,String> doSqlQuery(HashMap<String,String> queryParams)
                                         throws Exception

Throws:

Exception

callCustomUpdateMethod

public static Map callCustomUpdateMethod(Map params)
                                  throws Exception

Throws:

Exception

updateWorkfile_format1

public static void updateWorkfile_format1(List<Map<String,String>> data,
                          String logfileName)
                                   throws Exception

Throws:

Exception

parseWorkfile_format2

public static Map<String,List<Map<String,String>>> parseWorkfile_format2(List<Map<String,String>> data,
                                                         String logfileName)
                                                                  throws Exception

Throws:

Exception

updateWorkfile_format2

public static void updateWorkfile_format2(List<Map<String,String>> data,
                          String logfileName,
                          HashMap queryParams)
                                   throws Exception

Throws:

Exception

doUpdate

public static Vector doUpdate(HashMap queryParamsIN)
                       throws Exception

Throws:

Exception

getLatestIteration

public static Persistable getLatestIteration(Persistable obj)

renderActionButton

public static String renderActionButton(String url,
                        String action,
                        String buttonTxt,
                        HashMap<String,String> params)

renderPreview

public static String renderPreview(File workfile,
                   Map queryParams)
                            throws Exception

Throws:

Exception

renderLicLimit

public static String renderLicLimit()
                             throws Exception

Throws:

Exception

renderPreview_format2

public static String renderPreview_format2(List<Map<String,String>> data,
                           int curPage,
                           boolean showresult,
                           boolean pageresult,
                           Map queryParams)
                                    throws Exception

Throws:

Exception

renderResult_format2

public static String renderResult_format2(List<Map<String,String>> data,
                          int curPage,
                          boolean showresult,
                          boolean pageresult,
                          Map queryParams)
                                   throws Exception

Throws:

Exception

renderPreview_format1

public static String renderPreview_format1(List<Map<String,String>> data,
                           int curPage,
                           boolean showResult,
                           boolean pageResult)
                                    throws Exception

Throws:

Exception

renderResult

public static String renderResult(File workfile,
                  HashMap queryParams)
                           throws Exception

Throws:

Exception

renderResult_format1

public static String renderResult_format1(List<Map<String,String>> data,
                          int curPage,
                          boolean showResult,
                          boolean pageResult)
                                   throws Exception

Throws:

Exception

loadConfig

public static HashMap<String,String> loadConfig(File configFile)
                                         throws Exception

Throws:

Exception

saveConfig

public static void saveConfig(File configFile,
              HashMap<String,String> queryParams)
                       throws Exception

Throws:

Exception

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

doUndoCheckAll

public static void doUndoCheckAll(List<Persistable> coObjects)

printUsage

public static void printUsage()

askUserYesNo

public static boolean askUserYesNo(String questionTxt)

getAllIBA

public static TreeMap getAllIBA()