OxyGen Code
FAQs
| 1. What are the system requirements for OxyGen Code? | |
|
To use OxyGen Code, you will need the following: You can run OxyGen Code on the following operating systems: i) Microsoft Windows XP or a later version ii) Microsoft Windows Vista iii) Microsoft Windows Server 2003 or a later version iv) Microsoft Windows 2000 Service Pack 3 (SP3) or a later version The following .NET Framework version should be installed: i) .NET Framework 2.0 or a later version |
|
| 2. What database managers OxyGen Code runs against? | |
|
OxyGen Code generates code against the following database managers: i) MS SQL Server 2000 or a later version ii) MS SQL Express |
|
| 3. What type of code does Oxygen Code generates? | |
|
OxyGen Code generates T-SQL (stored procedures), data access layer, business layer and the following presentation layers: i) ASP.NET ii) XML Web Services iii) Windows Communication Foundation (WCF). |
|
| 4. What it OxyGen Code Management Studio? | |
|
OxyGen Code Management Studio (OCMS) is the IDE that facilitates the following operations: i) Manage the processing instructions associated to the database tables and table columns. ii) Validate existing processing instructions for a specified database to make sure that they conform with the code generator rules. iii) Configure and invokes the code generation process. iv) Load previously generated code generation sessions. |
|
| 5. How does OxyGen Code know what code needs to generate? | |
| Beside standard create, retrieve, update delete (CRUD) functionality, OxyGen Code generates the code based on the processing instructions that are specified for each table and table column within the database. | |
| 6. What is a processing instruction? | |
|
Processing Instructions are nothing more than persisted configuration information. They are saved as Extended Properties against the particular schema element. Processing Instructions are applied against the following schema elements: i) Tables. ii) Table Columns. |
|
| 7. What types of table Processing Instructions are available in OxyGen Code? | |
|
The following table processing instructions are currently available in OxyGen Code: i) Select (Custom Query) ii) ResolveManyToMany (Join Table Resolution) iii) Reference Type Marker (RefTypeMarker) iv) EntityName v) Cacheable |
|
| 8. When would I use Select Processing Instruction? | |
|
Select Processing Instruction lets a user specify a Custom Query. Ordinarily, columns that are used as part of a Key (primary key or foreign key) will automatically be used as filter conditions for the built-in queries. To generate queries using columns that are not part of a primary key or a foreign key, use a Select Processing Instruction. |
|
| 9. When would I use ResolveManyToMany Processing Instruction? | |
| In a situation where there is a join table between two primary tables, using ResolveManyToMany Processing Instruction will inform the code generator engine to generate code that resolves or de-normalizes the join table. | |
| 10. When would I use RefTypeMarker Processing Instruction? | |
| When the RefTypeMarker Processing Instruction is specified, additional stored procedures and methods are generated that will make it easier to use reference tables (lookup tables). | |
| 11. When would I use EntityName Processing Instruction? | |
|
Use the EntityName Processing Instruction to assign a name, other than the table name, to the class that will be generated from a
particular table. By default, the code generation engine will use the table name as the class name. The usage of the EntityName Processing Instruction can be stylistic or compulsory. Stylistic reasons to use the EntityName Processing Instruction would be the following: i) Your table names contain prefixes or suffixes. ii) You want your classes to use names that are consistent with the application domain. iii) The database tables were initially poorly named. Compulsory reasons to use the EntityName Processing Instruction would be the following: i) A table name contains a white space. ii) There are two tables with the same name but in different schemas. For example, the database contains two Customer tables: Sales.Customer and dbo.Customer. iii) The table name is a C# keyword. For example, if you have a table named 'Class', you will have to apply an EntityName Processing Instruction against that table. |
|
| 12. When would I use Cacheable Processing Instruction? | |
|
Use the Cacheable Processing Instruction to include the object instances, from the generated classes, into the caching mechanism. Only the instances of classes that are generated from tables marked as Cacheable will be candidates for caching. If the underlying table data is changed, the cached objects are expired from the cache (SQL Server 2005 only). By default, all tables with the RefTypeMarker Processing Instruction are cached. Caching is only recommended for tables that change infrequently. This means that transactional tables are bad candidates for the Cacheable Processing Instruction. |
|
| 13. What types of column Processing Instructions are available in OxyGen Code? | |
|
The following column processing instructions are currently available in OxyGen Code: i) FieldName |
|
| 14. When would I use FieldName processing instruction? | |
|
Use the FieldName Processing Instruction to assign a name, other than the column name, to the Field and Property that will be generated from a particular column. By default, the OCG will use the column name as the field name. The usage of the FieldName Processing Instruction can be stylistic or compulsory. Stylistic reasons to use the FieldName Processing Instruction would be the following: i) Your column names contain prefixes or suffixes ii) You want your class properties to use names that are consistent with the application domain iii) The table columns were initially poorly named Compulsory reasons to use the EntityName Processing Instruction would be the following: i) A table column name contains a white space ii) The is a column name that is the same as the table name that this column belongs to. iii) The column name is a C# keyword. |
|