File Naming Conventions
These conventions provide clues as to the function of the files. This section explains the file naming conventions so that you can identify files that you may want to copy, rename, and then modify to suit your business needs.
The files delivered with TeamConnect® Legal Matter Management all use the SYS suffix. In order to distinguish the files that were shipped with the product from files that have been customized, solution developers must not simply modify the delivered files, but should at least change the SYS suffix to another string--for example, IMP.
Caution: If you modify any files that are delivered with TeamConnect® Legal Matter Management, you must not use same file names. Instead, copy and rename the files.
TeamConnect® Legal Matter Management file names can include some, but not necessarily all, of the following components in the following order:
The parts of the filename are delimited with capital letters. For example, the file CommonWzMatterPopulateCategoriesQSYS.class has the following parts:
- Common—The Common prefix indicates that this file contains a super class that is inherited by more than one object.
- Wz—The Wz component indicates that this file is used by a wizard.
- MatterPopulateCategories—This descriptive string indicates that the file is used to populate categories for matter records.
- Q—The Q indicates that this file acts as a qualifier.
- SYS—The SYS indicates that the file was delivered with TeamConnect® Legal Matter Management and was not developed during or after implementation.
- class—Indicates a Java file.
The following filename prefixes are used with the SYS files:
- Common—Indicates that the file contains a super class that is inherited by more than one object.
- TCL—Indicates that the file contains utilities used by various class files.
For example, TCLActionHandlerSYS.class contains an action handler utility used by other class files.
The following filename components are used with the SYS files:
- Cjb—Indicates that the file contains a custom Java block (CJB).
- Rule—Indicates that the file is used by a rule. This also indicates that the file is not associated with a wizard.
- Wz—Indicates that the file is used by a wizard.
- WzCjb—Indicates that the file is a CJB for a wizard page.
For example, RuleTCreateBudgetCASYS.class is used by a rule for creating budgets upon the creation of a Transaction record, but the file is not directly associated with a wizard.
The following letters indicate the matter object to which the SYS files apply:
- AC—Advice & Counsel
For example, RuleTUpdateBudgetUASYS.class contains a rule for the Transaction object that updates a budget upon the Update action.
The description is usually an intuitive string that indicates the file's functionality. For example, the string may be as simple as Budget or include a description of a qualifier, such as IsNoFirmsSelectedAndFirmsListEmpty. If the string is prefixed by Matter, the qualifier or action affects more than one matter object.
The following acronyms appear in the descriptive string of some filenames:
- AC—Advice & Counsel
- IP—Intellectual Property
- OC—Outside Counsel
- OP—Opposing Party
For example, WzTValidateFieldsQSYS.class contains qualifiers used by the Transaction object's New Transaction wizard to validate fields.
The following acronyms indicate triggers or qualifiers in the SYS files:
- A—Action (most likely for a wizard action)
- CA—Performs an action on Create
- CUA—Performs an action on Create or Update
- DA—Performs an action on Delete
- AQ—A qualifier for an Approval rule
- UA—Performs an action on Update
For example, CommonWzOutsideCounselBudgetASYS.class contains a common wizard action for the creation of outside counsel budgets.
Note: A file that does not have a prefix in its filename or a trigger/qualifier before the SYS suffix is probably a user interface design XML file that does not use Java. For example, the LawsuitDetailsSYS.xml file is not prefixed by Common or TCL and does not have an A or Q before SYS.
Utility Class Files
The following utility class files perform the corresponding function:
- ConstantsSYS.class—Holds the system constants in TeamConnect® Legal Matter Management. Stores tree positions, custom field names, wizard parameter names, etc.
- TCLAccountUtilitySYS.class—Provides alternatives to the standard TeamConnect Enterprise account-processing methods. Holds transaction, deposit, and withdrawal methods that provide alternatives to the standard TeamConnect Enterprise account-processing API.
Caution: To avoid account-processing errors, you should carefully plan any modifications to the functionality contained in the TCLAccountUtilitySYS.class file.
- TCLBudgetUtilitySYS.class—Holds the budget constants and utilities in TeamConnect® Legal Matter Management.
- TCLFacadeSYS.class—Stores many utility methods used by TeamConnect® Legal Matter Management.
- TCLSecurityUtilitySYS.class—Stores security- and access-management-related utility methods.
The following base class files provide enhanced functionality in CJBs:
- TCLActionHandlerSYS.class—An abstract super class that stores essential utilities shared by all action classes.
- TCLConditionHandlerSYS.class—An abstract super class that is used in qualifiers and stores essential utilities shared by all condition classes.
- TCLCustomBlockSYS.class—An abstract super class used by all custom block classes and stores essential utilities shared by all CJBs.
Batch Display Files for Custom Java Blocks
Most of the CJBs in TeamConnect® Legal Matter Management 3.4 use one XML file and one class file. However, CJBs with batch displays require two additional files to define the new and regular rows of the batch display. For example, the Cost Center block for the Transaction object uses the following four files:
- CjbTCostCenterSYS.class—Java class file
- CjbTCostCenterSYS.xml—Primary XML CJB design file
- CjbTCostCenter_NewRowSYS.xml—XML design file that represents the New Row
- CjbTCostCenter_RegularRowSYS.xml—XML design file that represents the Regular Row The same convention is used for the Cost Center blocks for the Dispute object:
- CjbDCostCenterSYS.class—Java class file
- CjbDCostCenterSYS.xml—Primary XML CJB design file
- CjbDCostCenter_NewRowSYS.xml—XML design file that represents the New Row
- CjbDCostCenter_RegularRowSYS.xml—XML design file that represents the Regular Row
The batch display convention is also used for the Environmental Corrective Action block, which is displayed on the General tab of Dispute records that have the Environmental category:
- CjbDCorrectiveActionSYS.class—Java class file
- CjbDCorrectiveActionSYS.xml—Primary XML CJB design file
- CjbDCorrectiveAction_NewRowSYS.xml—XML design file that represents the New Row
- CjbDCorrectiveAction_RegularRowSYS.xml—XML design file that represents the Regular Row
The batch display convention is also used for the Real Estate Lessee block of the Transaction object, which is displayed on the General tab if the Real Estate category is selected. The Real Estate Lessee block uses the following files:
- CjbTLesseeSYS.class—Java class file
- CjbTLesseeSYS.xml—Primary XML CJB design file
- CjbTLessee_NewRowSYS.xml—XML design file that represents the New Row
- CjbTLessee_RegularRowSYS.xml—XML design file that represents the Regular Row