Recommendations

ObjectGears is an extensive and complex system. This is why we are bringing here couple of recommendations that can save you time with future maintenance and development of the whole system.

System objects

Models

• Simplicity pays - your applications will be easier to maintain and update.
• Document everything - your colleagues will familiarize themself easier and it will be possible to find out even with a certain time distance, whether certain behaviour is erroneous or intentional (you will have it described in referénce documentation).

Jobs

• Distribute the job load into a longer period of time. Do not start jobs that work on the same data at the same time.

Scripts and modules

• Do not use scripts and modules created by somebody else in the system without making sure you know what they exactly do. You will reduce risk of data loss by regular back up.
• Use codes of script blocks with your company custom prefix in order you avoid problems with models that you will want to import later. E.g.: mycompany_mycode, ibm_metautils, apple_mobilesend...

Languages

• Enable only languages that you will really use. One main language, that the most of the company uses, set as default.

Reports

• Look at report usage. Reports that are not used shall be deleted. Users will then easily find reports that they really use.

General

Codes

• Use codes without hyphens, rather then underscore. Use a single word if possible.
• Use a single code for a single language.
• Pay attention to codes for global objects (e.g. model, role…). They are unique over all the objects of the given type in instance and all the future ones that you ceate or download from internet.
• Do not call objects xxx_1, xx_2, xx_3, but always according to their meaning, what they are used for.
• Do not call reference columns according to the class that they refer to but according to their meaning in the model. Do not create names employee_1, employee_2, employee_3, but manager, teamleader, team_members.

Administration

• Delete continuously objects that you do not use (e.g. distribution groups, email templates...). This will help you to keep order in the objects. Decreasing the database size will also make response of the whole system faster.
• Let emails with errors occurred be sent to your email (see web.config parameter SendErrorToEmail). This will notify you about errors in the system fast.

Security

• Limit the access right administrator or IT owner only to users that really need them.
• Remove access right to logon to the system to users that do not work for you or that should not have access to the system any more. By that you will avoid possible security incidents.
• Do not use a single role for everything. Create a sufficient number of roles with sufficient granularity. Typical arguments "...there is no time to create new role..." and "...we will change it later to comply..." shall fail.

ObjectGears system

Instance

• Don`t be afraid to split ObjectGears system in more instances. You will get several benefits. See Another ObjectGears instance.

Update

• Update the ObjectGears szstem regularly - you will get new fnctions and corrections of reported bugs.
• Use new available models in the company.

Backup

• Perform daily incremental back up and weekly full back up.
• Delete logs and class archives - permanent database size increase slows down the system gradually. You can e.g. delete previous year logs every year in March. Optionally, you can make this data accessible in another instance that will not slow down production instance. You will get an overview how historical data are really used by users at the same time.