Agendamento¶

The Scheduler is an application for managing background jobs in DHIS2. Background jobs can do a number of tasks, such as running analytics, synchronizing data and meta data, or sending a push analysis report. The application provides the ability to create, modify and delete such jobs.

The Scheduler comes bundled with DHIS2 and is accessed through the App Menu.

The start page of the Scheduler app shows an overview of existing jobs. By default, pre-defined system jobs are hidden. To view these, click Include system jobs in list in the top right corner.

When you create or modify a job, it will be scheduled according to the selected schedule. To run a job on demand, go to the job list, click the "Actions" button of the job you want to run and click "Run manually". This action is only available for enabled jobs.

Criar um emprego¶

1. Open the Scheduler app and click the "New job" button in the top right corner.

2. Escolha um ** Nome ** adequado para o novo trabalho.

3. Select the Job type you want to schedule using the drop-down menu.

4. Select a schedule for the job. Each job type has its own scheduling type, either Cron scheduling or Delay scheduling.

   1. For Cron scheduled job types you can set a schedule using the Spring scheduling syntax. You can also select a predefined Cron expression by clicking "Choose from preset times". This schedule will only start a new job run if the previous job run has finished, to prevent the system from spawning too many jobs.

   2. For Delay scheduled jobs you can set a delay in seconds. Unlike the Cron scheduled jobs, these jobs aren't executed according to a set schedule, but with a specific delay in between job runs. The delay timer starts when a job ends, starting a new job run when the delay timer reaches zero. This will continue as long as the job is enabled.

5. If the job type is customizable, a Parameters section will appear below the scheduling settings. These additional options specify the details of the scheduled job, and will vary depending on the job type.

6. Press the Save button to confirm the job creation. On successful job creation you will be redirected to the job overview, where the newly created job will now be listed.

Newly created jobs are enabled by default.

Editing a job¶

With the proper permissions, you can modify the details of user-created jobs. To quickly enable or disable a user created job from running, use the switches in the On/off column on the landing page of the Scheduler app. Note that system jobs are always enabled and cannot be disabled.

Further editing of user jobs:

1. Click the "Actions" button of the job you want to edit and click "Edit" (only user jobs can be edited).

2. When done editing, press the Save button to persist the changes.

Excluindo um trabalho¶

1. Click the "Actions" button of the job you want to delete and click "Delete" (only user jobs can be deleted).

2. Confirme pressionando ** Delete ** novamente na janela pop-up.

User jobs can also be deleted from the editing screen.

Tipos de trabalho¶

A seção a seguir descreve os vários tipos de trabalho.

Disable Inactive Users¶

Users that have not been active - not logged in - for a number of months can automatically be disabled. Select the number of inactive months as the job parameter. All users that have not logged in for that number of months or longer will be disabled by the job. Disabled users will no longer be able to log into the system.

The Reminder days before parameter can be set to send a reminder email to those users the specified number of days before their account is due to expire. If users do not log in further reminder emails are sent each halving the previous number of days. For example if the number of days is set to 7 the first email is sent 7 days in advance, the second 3 days and the third and last 1 day in advance. If the value is not set (blank) no reminder is sent.

Tabela de recursos¶

A tarefa da tabela de recursos é responsável por gerar e atualizar as tabelas do banco de dados de recursos. Essas tabelas são usadas por vários componentes no DHIS 2 e têm como objetivo simplificar as consultas no banco de dados.

Observe que, ao especificar qualquer um dos trabalhos da tabela analítica, as tabelas de recursos podem fazer parte do processo e não é necessário especificar também um trabalho da tabela de recursos.

Tabela analítica¶

A tarefa de tabelas analíticas é responsável por gerar e atualizar as tabelas analíticas. As tabelas analíticas são usadas como base para as consultas analíticas de dados no DHIS2. Aplicativos como painel, visualizador e mapas recuperam dados dessas tabelas por meio da API de análise DHIS2 e devem ser atualizados para que os dados analíticos se tornem disponíveis. Você pode agendar esse processo para ser executado regularmente por meio de um tipo de trabalho de tabela de análise.

O trabalho da tabela de análise irá, por padrão, preencher os dados de todos os anos e elementos de dados. Os seguintes parâmetros estão disponíveis:

• ** Últimos anos: ** O número dos últimos anos para preencher as tabelas analíticas. Por exemplo, se você especificar 2 anos, o processo atualizará os dados dos dois últimos anos, mas não atualizará os dados mais antigos. Este parâmetro é útil para reduzir o tempo que o processo leva para ser concluído e é apropriado se os dados mais antigos não foram alterados e quando se deseja atualizar os dados mais recentes.
• ** Ignorar tabelas de recursos: ** Ignorar tabelas de recursos durante o processo de atualização da tabela de análise. Isso reduz o tempo que o processo leva para ser concluído, mas faz com que as alterações nos metadados não sejam refletidas nos dados analíticos.
• ** Ignorar tipos de tabela: ** Ignorar um ou mais tipos de tabela de análise. Isso reduz o tempo que o processo leva para ser concluído, mas faz com que esses tipos de dados não sejam atualizados nos dados analíticos.

Tabela de análise contínua¶

A tarefa de tabelas analíticas é responsável por gerar e atualizar as tabelas analíticas. As tabelas analíticas são usadas como base para as consultas analíticas de dados no DHIS2. Aplicativos como painel, visualizador e mapas recuperam dados dessas tabelas por meio da API de análise DHIS2 e devem ser atualizados para que os dados analíticos se tornem disponíveis. Você pode agendar esse processo para ser executado regularmente por meio de um tipo de trabalho de tabela de análise.

O trabalho de tabela de análise contínua é baseado em duas fases:

• _Atualização mais recente: _ Atualização dos dados mais recentes, onde mais recente se refere aos dados que foram adicionados, atualizados ou removidos desde a última vez que os dados mais recentes ou os dados completos foram atualizados. Este processo acontecerá freqüentemente.
• _Atualização completa: _ Atualização de todos os dados ao longo de todos os anos. Este processo acontecerá uma vez por dia.

O trabalho da tabela de análise contínua freqüentemente atualiza os dados mais recentes. O processo de dados mais recente utiliza uma partição de banco de dados especial que é usada para conter apenas os dados mais recentes. Essa partição pode ser atualizada rapidamente devido à quantidade relativamente pequena de dados. A partição aumentará de tamanho até que uma atualização completa seja realizada. Uma vez por dia, todos os dados de todos os anos serão atualizados. Isso limpará a partição mais recente.

O trabalho da tabela de análise irá, por padrão, preencher os dados de todos os anos e elementos de dados. Os seguintes parâmetros estão disponíveis:

• ** Hora do dia de atualização completa: ** A hora do dia em que a atualização completa será feita. Por exemplo, se você especificar 1, a atualização completa será realizada à 1h.
• ** Últimos anos: ** O número dos últimos anos para preencher as tabelas analíticas. Por exemplo, se você especificar 2 anos, o processo atualizará os dados dos dois últimos anos, mas não atualizará os dados mais antigos. Este parâmetro é útil para reduzir o tempo que o processo leva para ser concluído e é apropriado se os dados mais antigos não foram alterados e quando se deseja atualizar os dados mais recentes.
• ** Ignorar tabelas de recursos: ** Ignorar tabelas de recursos durante o processo de atualização da tabela de análise. Isso reduz o tempo que o processo leva para ser concluído, mas faz com que as alterações nos metadados não sejam refletidas nos dados analíticos.

Tracker search optimization¶

The tracker search optimization job is responsible for generating and updating the trigram indexes for relevant tracked entity attributes. Trigram indexes improve the performance of searching tracked entity instances based on specific tracked entity attribute values. The usefulness of trigram indexes depends on whether the tracked entity attribute is configured as unique or if they are configured as searchable (when connected to program/tracked entity type). You can configure the job to choose which tracked entity attributes should be trigram indexed. The job also takes care of deleting any obsolete indexes that have been created earlier but are no more required due to change in metadata configuration.

The following parameters are available:

• Attributes: The list of attributes that needs a trigram index created. For each attribute, a partial trigram index will be created. As an example, if you specify "firstname" and "lastname" attribute, the process will create two separate trigram indexes for the corresponding attributes "firstname" and "lastname". Note that, if the attribute provided in this parameter is not indexable (either because they are not unique or not searchable), such attributes are simply ignored by the process and no trigram index will be created for them.
• Skip index deletion: Skip obsolete index deletion during the trigram index process. If set to true, indexes that are deemed obsolete will not be deleted.

Sincronização de dados¶

DHIS2 provides synchronisation of data between remotely distributed instances and a central instance of DHIS2. This can be useful e.g. when you have deployed multiple stand-alone instances of DHIS2 which are required to submit data values to a central DHIS2 instance. Both tracker data and aggregate data synchronization is supported.

Estas são as etapas para ativar a sincronização de dados:

• Go to Synchronization Settings, enter the remote server URL, username and password. Press the TAB button to automatically save the new password. Refresh the page and check that the filled values are still present. Note that the password field will be empty after the refresh, since this value is encrypted, so you can consider it saved.

• Using the Scheduler app, create a new job using the "Event Programs Data Sync" and/or "Tracker Programs Data Sync" job type. Make sure it is enabled when you finish. (Note: If the "Program Data Synchronization" job, available in previous versions, was set up in Scheduler app before, it was automatically replaced by the two new jobs "Event Programs Data Sync" and "Tracker Programs Data Sync" with the identical settings. )

Alguns aspectos do recurso de sincronização de dados devem ser considerados:

• The local DHIS2 instance will store the password of the user account on the remote instance encrypted in the local database. The remote account is used for authentication when transferring data. For security purposes make sure you set the encryption.password configuration parameter in hibernate.properties to a strong password.

• Deploying the remote server on SSL/HTTPS is strongly recommended as the username and password are sent in clear text using basic authentication and could be intercepted by an attacker.

• The data synchronization uses the UID property of data elements, category option combos and organisation units to match the meta-data. Hence the synchronization is dependent on these three meta-data objects being harmonized on the local and remote instance in order to work appropriately.

• The first time DHIS2 runs the synchronization job, it will include any data available. The subsequent synchronization jobs will only include data added and changed since the last successful job. A synchronization job is considered successful only if all the data was saved successfully on the remote server (Any data successfully synced will remain on the receiving instance, regardless if the job eventually fails). Whether the job was successful or not can be decided from the import summary returned from the central server.

• The initial synchronization job may take a significant amount of time, possibly slowing down your instance, depending on how much data is being synchronized. It could be a good idea to configure the job to run when there are few online users, then later change this to your own preference. If you do not want or need to synchronize all the data, there is a possibility to skip some of the data being synchronised.

When DHIS2 synchronizes tracker data, it determines the set of data to synchronize based on the last time it was synchronized. Each of the tracked entity instances and events have their own records of when they where last successfully synchronized.

• The system will start a synchronization job based on the rules set in the configuration of the job. If the synchronization job starts while there is no connection to the remote server, it will retry up to three times before it aborts. The job will run again at a scheduled time.

• The server handles each set of programs separately, which means one set of programs can be synchronized successfully, while the other fails. The failure or success of one doesn't influence the other, as the last successful synchronization time is tracked individually for each item as previously mentioned.

• The attributes of TrackedEntityInstances (TrackedEntityAttribute) and the data elements of ProgramStages (ProgramStageDataElement) which have an option "Skip synchronization" turned on will not be synchronized. This feature allows you to decide to not synchronize some sensitive or not relevant data and to keep them only locally.

• The authority Ignore validation of required fields in Tracker and Event Capture (F\_IGNORE\_TRACKER\_REQUIRED\_VALUE\_VALIDATION) should be used when there is a requirement that some mandatory attribute / data element has at the same time a "Skip synchronization" property turned on. Such a setting will lead to validation failure on the central server as the given attribute / data element will not be present in the payload.

The validation won't fail for the user with this authority. The authority should be assigned to the user, on the central server, that will be used for synchronization job.

• In specific cases, the initial synchronization of all the data can be undesirable; for example, when a database on the local instance is a fresh copy of the database present on the central instance, or when it is preferred to not synchronize old data in favor of initial synchronization taking less time.

The syncSkipSyncForDataChangedBefore SettingKey can be used to skip the synchronisation of all the data (data values, Event and Tracker program data, complete data set registrations) that were last changed before the specified date. The SettingKey is used in the synchronization job all the time. Therefore, if you need to synchronize the old data, you should change the SettingKey.

• Both Tracker Programs and Event Programs synchronization job supports paging in order to avoid timeouts and to deal with unstable network. Default page size for "Event Programs Data Sync" job is set to 60. Default page size for "Tracker Programs Data Sync" job is set to 20.

If default values do not fit your purpose, own page size can be specified via parameter in particular sync job in Scheduler app.

Programação de sincronização de metadados¶

DHIS2 provides a feature for synchronizing meta data from a remote instance to a local instance of DHIS2. This can be useful when you have deployed multiple stand-alone instances of DHIS2 and you need to create meta data in all the local instances similar to the central DHIS2 instance.

Estas são as etapas para ativar a sincronização de metadados:

• Go to Settings > Synchronization, enter the remote server URL, username and password and click Save.

• Go to Metadata administration > Scheduling. Under Metadata synchronization set strategy to Enabled, select the time-period and click Start.

Alguns aspectos do recurso de sincronização de metadados a serem considerados:

• The local DHIS2 instance will store the password of the user account of the remote instance in its database. The remote user account is used for authentication when transferring/downloading data. For security purposes make sure you set the encryption.password configuration parameter in hibernate.properties to a strong password.

• Deploying the remote server on SSL/HTTPS is strongly recommended as the username and password are sent in clear text using basic authentication and could be intercepted by an attacker.

• Also ensure that the remote user is not having ALL authority, instead simply create a user with F_METADATA_MANAGE authority so that even if these details are intercepted by a hacker, one cannot have full control of the remote system.

• The meta data synchronization relies on the underlying import layer. Each meta data version is an export of meta data between two given timestamps. Each sync of meta data version is an attempt to import that meta data snapshot into the local instance. The sync of versions is incremental. The local instance will try to download the meta data versions from the central instance one after the other. Failure to sync a specific meta data version will not let the sync proceed to further versions. In case of failures, appropriate changes must be made to meta data at central to ensure that the error gets resolved. Metadata configuration is critical and the user should be careful while rolling out the updates to the production. It's always recommended to have staging environments in place to ensure the sanity of the meta data versions and their impact thereafter. The local instance will sync the meta data from first version so that harmony is maintained and local and central instance will work appropriately.

• The system will attempt a synchronization at the scheduled time. If the local or remote server does not have a working Internet connection at the time, the synchronization will be aborted and re-attempted after as per the retry count as mentioned in the dhis.conf file.

• You can see the time of last successful synchronization with remote server in the scheduling screen next to the "Last success" label.

Predictor¶

This runs selected predictors and/or predictor groups.

The relative start and end parameters determine the periods in which data will be predicted, corresponding to the date on which the predictor job is run:

• Relative start counts the days from the job date to the earliest date on which a predicted period may start. It can be positive or negative. For example, a value of 3 means predict into periods that start at least 3 days after the predictor run. A value of -3 means predict into periods that start at least 3 days before the predictor run.

• Relative end counts the days from the job date to the latest date on which a predicted period may end. It can be positive or negative. For example, a value of 9 means predict into periods that end at least 9 days after the predictor run. A value of -9 means predict into periods that end at least 9 days before the predictor run.

Setting these values can give you very flexible control over when predictions will be made, especially if your predictor job is set to run daily or more frequently. Before you set these values, you should think carefully about when you want predictions for a period to start being made, and when you want them to stop being made. Then you need to compute the appropriate relative start and end dates.

Examples:

1. Requirement: A predictor uses data from the same week as the predicted value. (No past sampled data are used.) After the week ends on Sunday, you expect the data to be entered in the following two days (Monday and Tuesday). You don't want to start predicting data until Wednesday after the week ends because you don't want partial results to be shown. However, data may still be adjusted on Wednesday, so you want to update the predictions also on Thursday. After that, the data are frozen and you don't want to predict for that period anymore.

   Solution: For a job running daily or more frequently, define the relative start as -10 and the relative end as -2 (for periods within 10 to 2 days before the job runs).

   • Before Wednesday of the following week, the period end is greater than 2 days before, so no predictions are made.

   • On Wednesday of the following week, the period started 9 days before and ended 2 days before. Predictions are made because -9 to -2 are within the range -10 to -2.

   • On Thursday of the following week, the period started 10 days before and ended 3 days before. Predictions are made because -10 to -3 are within the range -10 to -2.

   • After Thursday, the previous week started more than 10 days before, so no predictions are made.

   • Predictions are made only on Wednesday and Thursday. On Friday through Tuesday, no predictions are made (and the job finishes very quickly).

2. Requirement: A predictor is used to forecast a limit (average plus twice the standard deviation) for expected non-seasonally varying disease cases based on data from the previous five weeks. Weeks are Monday through Sunday. Predictions should start being made from the previous Tuesday, using available data at that time, and continue being made through Tuesday of the week that the predictions are being made for (by which time it is assumed that the previous week's data are final).

   Solution: For a job running daily or more frequently, define the relative start as -1 and the relative end as 12.

   • Before Tuesday, predictions will not be made for the following week because it ends more than 12 days later.

   • On Tuesday, predictions will be made for the following week which starts in 6 days and ends in 12 days.

   • On Wednesday through the following Tuesday, predictions will be made for the week whose start-to-end dates are Wed: 5 to 11, Thu: 4 to 10, Fri: 3 to 9, Sat: 2 to 8, Sun: 1 to 7, Mon: 0 to 6, and Tue: -1 to 5.

   • Note that on Tuesday, predictions are made for the current week with start-to-end dates -1 to 5, and also for the following week with start-to-end dates 6 to 12. On all other days of the week predictions are made for one week.

You can select which predictors and predictor groups will run during the job:

• Predictors runs individual predictors. They run in the order added.

• Predictor groups runs predictor groups. They run in the order added. The predictors within each group run in the order of their names (comparing Unicode character values).

If both individual predictors and predictor groups are selected in the same job, the individual predictors run first, followed by the predictor groups.