ObjectGears system is an application that enables various configurations and settings. These settings are availbale from the menu Administration. We will describe these settings in following chapters. All operations described here are in competence of Administrator or IT owner of a model.
Models
Initial model creation is in competence of Administrator. Nobody else can create a model. Administrator has to set also IT owner of the model, who will after that create model content. Administrator also defines which roles can be used in particular models. IT owner than can define particular access rights to particular objects for these roles enabled for the model.
Access: Administration / Model
Roles
In order that users can access classes, queries and other objects, roles have to be created by Administrator. Based on configuration these roles are assigned to users in ObjectGears system or according to the membership in groups of Microsoft Active Directory.
Name of the role is displayed in reference to the role in ObjectGears system. Name in the system is an exact name in external system, from which roles are read and linked to roles in ObjectGears system (e.g. name in Active Directory).
You can disable the role in the whole system in a quick way by the property Enabled, without need to remove the role from the system.
Access: Administration / Role
Users
Administrator creates users in ObjectGears system, modifies their records or deletes them. This can be done manually in the application or a special import can be created that creates, modifies and deletes users based on an input file.
Administrator can also define delegations of particular user. Delegation is important for being able to use a deputy for person in workflow.
Access: Administration / Person
Languages
Administrator can define, for which language versions localization of names, description etc. at particular created objects (classes, columns, buttons etc.) shall be offered.
Access: Administration / Languages
Application menu
There are two types of menu in the system. On of them is application menu, that is in competeny of Administrator. If this menu is not defined by Administrator, default application menu is used. In most cases this default menu can meet the needs, however, in some case it may be necessary to modify it.
Access: Administration / Menu
Application parameters
Data parameters are used for user configuration with possibility to change the values in a quick way. Some parameters may be defined as application ones (then they are available from the whole system), other parameters for one particular model only.
Access: Administration / Parameter
Import
Imports are used for data upload into ObjectGears system from external sources. IT owner of model can create import into classes of his/her models. Administrator can create import into internal class with ObjectGears system user.
Access: Administration / Import
Export
Exports are used for creation of files containing data of ObjectGears system classes or queries. IT owner of model can create export of classes or queries of his/her models.
Access: Administration / Export
Distribution groups
Distribution groups are used for creation of lists of recipients, that may be further used in notifications in classes, rules, imports, exports, workflow activities or scripts. Group can be used for sending an email or SMS. List of recipients can be created from ObjectGears syste users, by listing emails or phone numbers. IT owner of model can create distribution group for use in his/her model or in all the models.
Access: Administration / Distribution groups
Organization structure
IT owner can define whatever number of organisation structures of several types that can be after that used above all for access control on particular records.
Access: Administration / Organization structure
Workflow
IT owner can create worklow that can be used in his/her model. Workflow ensures automation of processes according to the definition in the workflow scheme.
Access: Administration / Workflow
Jobs
Jobs are used for a scheduled starting of certain operations, e.g. import, export, workflow, scripts etc. Job settings are in competence of Administrator, because jobs may represent a performance load for the server, that should be distributed during the day and night.
Access: Administration / Jobs
Scripts of administration pages
It is possible to use scripting on some administration pages and enhance page functionality with own actions. In this way, e.g. a button for executing own actions or own control elements for displaying further information can be added easily to pages. More information can be found in description of Scripts of administration pages. This functionality is available for Administrator.
Access: Administration / Scripts of administration pages
Information about application and configuration
This page displays some basic configuration parameters set in the web.config file.
In the second tab it is possible to set which application page is displayed after user logon without defined page (if URL contains only server name) or after accessing Default.aspx page. There are only application pages (pages without defined model) displayed in the selection combobox.
Access: Administration / System / About application
My tasks
My tasks configuration is used for creating a single queue of tasks that the users shall solve. Imagine that you assign tasks from workflow, incident management process and you are using model EasyTask as well. Users would need to keep an eye on several screens where you assign them work. Now they can have all the assigned tasks in a single page.
Access: Administration / My tasks
Modules
Modules are used for extending ObjectGears system functionality with a custom program implemented in a .NET language (C#, VB.net...).
Access: Administration / System / About application / Modules
Application events
ObjectGears system supports four application events:
- After application start
- After user logon
- After error occurence
- At the beginning of the web request
Access: Administration / System / Application events
Event log
Page displays error and informatory messages from the ObjectGears system.
Access: Administration / System / Event log
Event loging
There are special rules applied for event entries into the event log in order mass repeated entries of the same errors within a short period of time are avoided. The same error is such one with the same Error description. In case of an erroneous configuration or an error in scripts large quantity of entries into the event log might be generated which would lead to blocking the whole system. Due to these possible situations there are special rules applied:
- Every 1st -10th error occurrence within 5 minutes is written into the event log
- The 11th and next error occurence which happens max. 5 minutes since the last occurence will not be written into the log. The number of occurences is just stored internally.
- Every next error occurence which is more than 5 minutes since the last entry of the given error into the event log is again written into the event log. At the same time previous error entry is updated with the number of error occurences.
If you need to debug ypur scripts, than do not use method OG.Log.Write, but OG.Log.WriteInfo for entries into the event log. Above mentioned rules are not applied to entries by method OG.Log.WriteInfo and therefore, your entries into event log will be always recorded into the event log.
Functionality Debug
Functionality for debugging is used for more detailed tracking of user activities in the system. Therefore, some key operations for work with data are logged into the Debug log. You can also add your custom debug information by means of scripts (OG.Debug).
Debugging can be set (on page System debugging) only by administrator. One administrator can debug one user only at a moment. After finishing debugging new user can be set for debugging.
Every debug set up is valid for 24 hours and then it is deleted. The log is also deleted at application restart since the log is not stored in the database but it is maintained only in memory.
Follow these steps to debug a particular user:
- Define the user, that you want to debug, on page System debugging and save the setting
- Ask the user perform in the system operation that leads to errors
- On page System debugging display (by means of button Display log) entries generated by user actions
- After finishing debugging cancel the setting of the user on page System debugging and save the setting
Debugging is implemented on pages accessed by a common user, i.e. Datas.aspx, DataDetail.aspx, in the Archive and at notification sending.
Access: Administration / System / Debug