documentation for:  14_2_Agile2TCWrapper_cls
created:            18.10.2024 S.Gueth

--------------------------------------------------------------------------------------------------------------------------------------------------------------------
#Doc: SubAction: Agile2TCWrapper 
[#New: 3.2000;18.10.2024;S.Gueth]
      
CLA CommandLineArguments:
-------------------------

JobManagerCmdTools.exe 

-Action                             "CustomCmdTools_2016_04" 
-SubAction                          "Agile2TCWrapper"
-ServerSettingsXML                  "c:\jobMgr\Root\ServerSettings-TestSystem.xml"          #Doc: full path to JobMgr Server settings xml file
-A2X_Output_XML                     "c:\path\to\A2X_Output.xml"                             #Doc: full path to A2X_Output.xml file
-A2X_PackageName                    "A2X1723-184251"                                        #Doc: defines the A2X package name and JobMgr group name (has to be unambiguously)
-TCSiteID                           "PDETCPROD"                                             #Doc: JobMgr Site ID for TC Site
-ExportRootPath_DP                  "ExportRootPath_DP"                                     #Doc: defines the export root path for the prt files from agile
-MsgLog_DPNE                        "c:\path\to\wrapper.log"                                #Doc: defines full path to the logfile for this wrapper

-SiteDefID                          "AgileAutomatedImport"                                  #Doc: JobMgr Site ID for Agile Objects (optional, default: AgileAutomatedImport)
-AgileDbSiteID                      "AgileSQLDef"                                           #Doc: JobMgr Site ID for Agile DB Site (optional, default: AgileSQLDef)
-MaxImportRuntime_min               720                                                     #Doc: defines the maximum import runtime in minutes, wrapper will terminate when the runtime is longer then the timespan (optional, default: 720 -> 12 hours)
-CheckProcessStatusInterval_min     5                                                       #Doc: defines how often the process status should be checked in minutes (optional, default: 5 min)  
-SuccessfulImports_IrPuidFile       "c:\path\to\IrPuids.txt"                                #Doc: defines full path to the file where all IrPuids of successfully imported objects are listed (optional) 
-SkipObjectsImportFromXMLFile       True                                                    #Doc: defines if wrapper should skip the import of JobManager objects from A2X file (optional,default: false)
                                                                                                  with this option enabled, the wrapper will only check the status
                                                                                                  this can be helpful when the wrapper ran into timeout before the process was finished (default Is false)
-ForceMigrateAllObjects             True                                                    #Doc: defines if all objects from A2X file should be migrated (optional,default: false)  
                                                                                                  with this option enabled, the wrapper will migrate all objects from the A2X file, independent from the last modify date
                                                                                                  by default the wrapper will only migrate objects that not exists in the JobManager or if the last modify date has changed



Result Codes:
-------------------------
-1  :   initial resultcode when program was started
0   :   everything is OK -> all objects have benn successfully imported into teamcenter
1   :   Exception in in [Agile2TCWrapper_cls.Run] method
10  :   Exception in [Agile2TCWrapper_cls.InitWrapper] method
11  :   ServerSettings_XML file does not exists, check parameter -ServerSettings_XML
12  :   ServerSettings Load error
13  :   check parameter -ExportRootPath_DP
14  :   check parameter -TCSiteID
15  :   check parameter -A2X_Output_XML
16  :   check parameter -A2X_PackageName
17  :   error on writing file #SuccessfulImports_IrPuidFile#, check parameter -SuccessfulImports_IrPuidFile
20  :   Exception in [Agile2TCWrapper_cls.ImportAgileObjectsFromXMLFile] method
21  :   Error in on importing Agile Objects into JobManager
30  :   EX in [Agile2TCWrapper_cls.CheckForTCImportFinish]
31  :   Error on getting JobManager Objects from db
32  :   No JobManager Objects found for group #A2X_PackageName#
40  :   Max import runtime reached -> wrapper was stopped
50  :   EX in [Agile2TCWrapper_cls.A2XProcessStatusEval]
51  :   N Objects have an error on tc import process
52  :   N Objects are still running on tc import process
53  :   N Objects still have to be processed on tc import process
