• Home
  • Support
  • OnTime for IBM
  • FAQ
  • Administration
  • More information on the OnTime Group Calendar Administration task

More information on the OnTime Group Calendar Administration task

By default the OnTime Group Calendar Administration task ("admin") runs every night at 2am on the OnTime Group Calendar Administration Server. The admin-task can also be initiated on demand from the OnTime Group Calendar Config database or from the IBM Domino Server console using "tell ontimegc admin". 

One of the purposes of the admin-task is to process information read by the synchronization process from mail files into the Configuration database such as mail file Access Control List (ACL), calendar settings profile document (work hours etc.) In OnTime Group Calendar each user has 3 documents:

  • User document (maintained by the admin-task)
  • Calendar document (maintained by the synchronization task, created on first synchronization of a user)
  • Settings document

It's important to know that all user based calls to OnTime Group Calendar is processed from the "user document" and hence the admin-task is required to run to "bring in" information read from the mail file. For instance if a user changes his/her work hours in the mail file OnTime Group Calendar will first need to synchronize the user (reads information from the mail file into into the "calendar document") and then run the admin-task to transfer the information from the "calendar document" to the "user document". OnTime Group Calendar maintains a very strict separation between which tasks may write to which documents to avoid data corruption and save/replica conflicts.

Sometimes the admin-task will take a while to run - sometimes even a long time if you have many thousands of users in OnTime Group Calendar. This is of course because the admin-task does a lot of things from maintaning users from associated directories to maintaining groups and groups membership. That doesn't mean that moving the admin-task to a separate server cannot be a good idea as it certainly will optimize I/O but it describes why the task may take a while to run.

Please note:  For most organisations there should be no need to run admin during the day or even multiple times a day. It runs daily at 2am.

If you need to run the admin-task during the day consider using one of the sub-commands to tell the admin-task exactly what you would like it to do. If you only want to process static groups i.e. update group membership you could run "tell ontimegc admin gs" from the IBM Domino Server console. 

All of the "sub commands" from the admin-task is available to be run separately as shown in the below table. The sub-commands are listed in the actual sequence they are run.

Description

Console Command

Load*

Day**

Hour***

Update users
Reads in users, rooms and resources from the Domino Directories setup in OnTime Group Calendar. This operation also transfers certain pieces of information from the "calendar document" to the "user document" i.e. work hours etc. read from the mail files during synchronization of users.

tell ontimegc admin u

X

X

 

Fixup / cleanup
Does maintenance work associated with the internal data structures when required during upgrade between versions.

tell ontimegc admin f

X

X

 

Static groups
Processes static groups as configured in OnTime Group Calendar considering users currently in OnTime Group Calendar e.g. that must have been brought into OnTime Group Calendar by the "users sub-command" first. The process also makes sure that private groups does not contain invalid users.

tell ontimegc admin gs

X

X

 

Dynamic groups
Processes dynamic group definitions as configured in OnTime Group Calendar considering users currently in OnTime Group Calendar e.g. that must have been brought into OnTime Group Calendar by the "users sub-command" first.

tell ontimegc admin gd

X

X

 

External groups
Processes external groups as configured in OnTime Group Calendar considering users currently in OnTime Group Calendar e.g. that must have been brought into OnTime Group Calendar by the "users sub-command" first.

tell ontimegc admin ge

X

X

 

Directory (NAB) groups
Processes Domino Directory groups ("NAB") as configured in OnTime Group Calendar considering users currently in OnTime Group Calendar e.g. that must have been brought into OnTime Group Calendar by the "users sub-command" first.

tell ontimegc admin gn

X

X

 

Process ACLs
Reads the mail file ACL read during the synchronization of a user and writes the exploded result to the "users document" for the particular user.

tell ontimegc admin a

X

X

 

Process roles
Processes the role definitions according to the rules and assigns roles to users. Required to run for a change in a role to take effect.

tell ontimegc admin r

X

X

 

Rooms and resources
Reads information for rooms and resources as read from the coresponding room and resource database during synchronization. This process updates information such as capacity, restriction on rooms etc. meaning data maintained in the room and resource database(s).

tell ontimegc admin o

X

X

 

Process settings
Assigns Default Settings to users based on the configuration in the OnTime Group Calendar Configuration database. Changing Default Setting documents requires this command to be run to take effect.

tell ontimegc admin s

X

X

 

Cutom fields
Computes restrictions for custom fields and copies info to the user document.

tell ontimegc admin c

   

X

Process replica documents
Cleans up mail file replica information generated by the OnTime Group Calendar cluster sub-system.

tell ontimegc admin e X X  

* When task loads on OnTime GC admin server
** Daily job that runs at 2am
*** Job that runs every hour

Please note: Starting from version 4.2.2 you can now control which admin sub-commands run on which days and on load in Global Settings. You also have the option of terminating a running admin-task by issuing the follow command on the IBM Domino Server console.

Set Config OnTimeGCAdmin=Quit

Tuesday, 09 June 2015 Posted in Administration