Troubleshooting
Warnings
This section provides general information about some elements and objects that can be imported using the Design Import tool.
Design Import Restrictions
- Currently, the design upgrade file is created only for updating a TeamConnect instance design from an older design to newer design. If you need to revert a QA or production TeamConnect instance to an older design version, there are two possible methods:
- If the older design version is captured in an earlier snapshot, use the method described in Reverting to a Previous Snapshot.
- If there is no earlier snapshot, you must make the design changes manually on the development TeamConnect instance, take a snapshot of the current design, and create a corresponding design upgrade file.
- This release of the Design Import tool does not support importing user accounts.
- Deleting System Settings is not supported during importing.
- Please be aware that when you import specific object types, some child elements are deleted from the destination TeamConnect (QA or production) and replaced by the child elements from the source TeamConnect design (from the development instance).
Please see the following table for specific details:
When Importing and Updating the Following Objects: |
The Following Logic Will Apply: |
---|---|
Route stops |
The source design's memberList child elements will replace those of the destination design. |
Home pages |
The source design's contentList child elements will replace those of the destination design. |
Portal panes |
The source design's contentList child elements will replace those of the destination design. |
Rules |
The source design's conditionList, historyDescriptionList, and historyFieldList child elements will replace those of the destination design. |
Wizards |
The source design's pageList and child elements will replace those of the destination design. |
Source Design With No Design Component
Generally, if the source design (from the development TeamConnect instance) does not include a design component (defined at the XML element level) and the destination design includes the corresponding design component, the import deletes that component from the destination TeamConnect database (for example, QA or production TeamConnect).
For example, if a Dispute object definition is being imported and the source XML file contains definitions for four phases, and the destination XML file contains definitions for five phases (including the four phases from the source database plus an additional phase), the import results in the deletion of the unique phase from the TeamConnect destination database.
This deletion would appear in the log file, but that log entry is not tagged with any specific error message.
General Troubleshooting Steps
This section provides a general flow for locating the source of DMT issues within a design "diff." In addition, a few examples of errors you could find in the DMT log file and troubleshooting tips are provided.
- Click the View Log link to open the dmt.log file.
- If a DMT operation is successful, the last line of the log file will contain a success message. Otherwise, the end of the log file will contain a message that the operation failed, followed by detailed messages about each error.
- Search for "FATAL" in the log to find issues that must be resolved for the import (or snapshot creation or upgrade file generation) to complete.
- Afterward, search for "ERROR" in the log for additional issues.
Logging
DMT creates a new log file any time it begins an import, export, or diff operation. The name of the log file is always dmt.log. Any previous log file is renamed to
dmt.import.log.YYYY-MM-DD-HH-MM
where the file extension represents the date and time the previous file was last modified. (Note that the string import
in the example above may instead say export
or diff
, depending upon the operation that was performed.) DMT retains up to 10 log files. The oldest file is deleted when creating a new one would exceed the limit of 10.
Sample Error Messages and Tips
The following are examples of error messages you might find in the log file. Specific details may differ for your designs/diffs but you can apply these to troubleshooting concepts for your specific scenarios.
- Error message:
FATAL - ImExCustomLookupTables.import: caused exception importing custom lookup table=LOOK1UP.xml com.mitratech.teamconnect.foundation.TCException: Cannot delete YDetailLookupItem because it still has 4 EProjDetailObjeValues referencing it
- To locate the corresponding *.XML source file, from your diff path, navigate to:
diff\Lookup Tables\Custom\I.xml
where diff is the path to the diff
If the issue were in a system lookup table, you could find the *.XML file in diff\Lookup Tables\System\LOOK1UP.xml - If you open the source *.XML file, the first line should end like:
"opcode="delete"
This is the command that tries to delete lookup table items. - It is recommended to rename the *.XML file (like *.XML.old) so the DMT will skip the file during import but you can later track changes that might need to be made manually.
- To locate the corresponding *.XML source file, from your diff path, navigate to:
- Error message:
FATAL - ImExCategory.import: exception unmarshalling.Please enter a unique name.
com.mitratech.teamconnect.foundation.TCException: Please enter a unique name.- To locate the corresponding *.XML source file, look in the dmt.log file at the events just above (before) the FATAL message. A sample excerpt follows:
DEBUG - ImExCategory.importCategory: key=OTHE
DEBUG - ImExCategory.importCategory: itemKey=PR01_OTHE, opCode=insert
DEBUG - ImExCategory.importCategory: inserting category for itemKey=PR01_OTHE, parent=PR01
DEBUG - ImExCategory.importCategory: inserting category for itemName=OTHER, key=OTHE, order=0 - The first four characters of the itemKey, PRO1_OTHE, or PRO1, indicates the object for which a duplicate category was found.
- From your diff path, navigate to:
diff\Object Definitions\PRO1\categories.xml
where diff is the path to the diff - Open the categories.xml file and search for "PR01_OTHE" For example, the context could look like:
<Category displayOrder="" name="Other" treePosition="PR01_OTHE" isActive="true" opcode="insert" />
- Generally you must verify that you do not create a category that already exists in the target instance. It is recommended to comment out the corresponding line from the categories.xml file so DMT will skip insertion of the duplicate category.
- To locate the corresponding *.XML source file, look in the dmt.log file at the events just above (before) the FATAL message. A sample excerpt follows:
- Error message:
FATAL - ImExCustomFields.import: caused exception for filename=PR01_0112.xml com.mitratech.teamconnect.foundation.TCException: Cannot delete Detail Field because it still has 1 EProjDetailTextValue referencing it
- To locate the corresponding *.XML source file, from your diff path, navigate to:
diff\Object Definitions\PRO1\Custom Fields\PR01_0112.xml
where diff is the path to the diff - If you open the source *.XML file, the first line should end like:
opcode="delete"
This is the command that tries to delete the detail field. - It is recommended to rename the *.XML file like *.XML.old so the DMT will skip the file during import but you can track changes that might need to be made manually.
- To locate the corresponding *.XML source file, from your diff path, navigate to:
Error Messages and Performance Issues
This section contains some limitations in the Design Snapshot tool or Design Import tool. For most of these issues, workarounds are provided. If a workaround is not provided and you need more information, please contact Mitratech support.
BUILD FAILED message
Issue: An attempt to create a design snapshot, generate a design upgrade file, or import a design upgrade file results in an error message.
Workaround: If you are creating design snapshots from, or importing a design upgrade file to, a TeamConnect instance using an Oracle database, verify that you have the latest ojdbc driver file from Oracle in the DMT \lib directory. Also verify that your class path (environment variable) is not pointing to another directory that might contain a different version of the driver (for example, C:\j2sdk1.5.0_6 \jre\lib\ext).
DMT script errors
Issue: If you are troubleshooting a Design Snapshot tool or Design Import tool operation, and the log contains error messages like the following:
java.sql.SQLException: Data size bigger than max size for this type: 23862
at oracle.jdbc.dbaccess.DBError.throwSqlException(DBError.java:134)
at oracle.jdbc.dbaccess.DBError.throwSqlException(DBError.java:179)
Workaround: Find the latest database driver. If you are using an Oracle thin JDBC driver, you may receive a similar error message when trying to import a design that is 4KB or larger. If you are using an Oracle OCI driver and try to import a design that is 4KB or larger, the entire design will not be imported successfully resulting in functionality limitations.