| indent |
|---|
|
{color:green}Have any suggestion on how improve this wiki? Please give us your feedback at [mailto:csf-support@mit.edu]{color}
|
| Panel |
|---|
About this Page| indent |
|---|
|
The following standards or conventions guide SAIS development staff in naming projects. This will hopefully allow developers and others to recognize the general function and purpose of a project.
|
|
| Panel |
|---|
Project Names| indent |
|---|
|
*<domain>**\-<sub domain/product name>-<project |
|
...
Domain Type is related to the functional business areas that the project is associated with. Examples are, academic, admissions, sfs, admin and common.
...
type>*
*Domain Type* is related to the functional business areas that the project is associated with. Examples are, academic, admissions, sfs, admin and common.
*Sub Domain or Product Type* are the areas or products underneath the primary domain. For example, sub domains under "academic" are grading, advising, registration, scheduling. If a domain uses products instead of sub domains, then they would use the product name under the primary domain. For example, products under "admissions" are ectrack, "my.mit.edu" and stargate. |
|
...
*Project Type* should be indicative of the function that the project is responsible for. For instance, if the project is a web application the project type should be "web". If the project provides business services, then the type should be "services". In the unique case of web services clients, the project type should be "client" or "service-client". |
|
...
The goal for naming projects as above is to modularize project functions. For example, the project academic-grading-services, should provide business services related to academic grades in a "jar" file. I can use this resulting "jar" in a variety of ways, I can include it in a web services application or I could use it within a local SAIS application. Here are the project types that SAIS supports: |
|
...
...
Description
...
client
...
Jar file containing service client classes. This includes web service clients.
...
common
...
Jar file containing common code, such as utility classes related to the domain/sub domain/product.
...
ear
...
Ear file that wraps the EJB and/or WEB components for an enterprise application (This is mostly here to for EJB deployment, if no EJBs are present, this is not necessary).
...
ejb
...
Jar file containing EJB and helper classes for the domain/sub domain/product.
...
services
...
Jar file containing business services for the domain/sub domain/product.
...
web
...
|| Description ||
| client | Jar file containing service client classes. This includes web service clients. \\ |
| common | Jar file containing common code, such as utility classes related to the domain/sub domain/product. |
| ear | Ear file that wraps the EJB and/or WEB components for an enterprise application (This is mostly here to for EJB deployment, if no EJBs are present, this is not necessary). \\ |
| ejb | Jar file containing EJB and helper classes for the domain/sub domain/product. \\ |
| services | Jar file containing business services for the domain/sub domain/product. |
| web | War file containing the web related classes for the domain/sub domain/product. This war file also may contain jar files of the project type client, common, and services. |
|
|