Cron jobs e daemons

O Koha é apoiado por diversas tarefas em segundo plano. Essas tarefas podem ser executadas periodicamente (tarefas cron) ou executadas continuamente, sendo chamadas de daemons.

Uma tarefa cron é um comando do Linux usado para agendar a execução de um comando ou script no servidor, automatizando tarefas repetitivas. Scripts executados como tarefas cron geralmente modificam arquivos ou bancos de dados; contudo, também podem realizar tarefas que não alteram dados no servidor, como enviar notificações por e-mail.

Um daemon é um comando do Linux que geralmente é iniciado durante a inicialização do sistema e executado em segundo plano para realizar alguma função. O banco de dados usado pelo Koha (MySQL ou MariaDB) é um daemon, assim como o servidor web (geralmente Apache).

O Koha possui muitas tarefas cron que podem ser habilitadas (indexação do mecanismo de pesquisa, geração de avisos de atraso, limpeza de dados e outras) e alguns daemons. Este capítulo os explicará.

Exemplo de crontab

Um exemplo de crontab do Koha pode ser encontrado em misc/cronjobs/crontab.example

O exemplo inclui entradas padronizadas de amostra para as tarefas cron mais utilizadas.

Tarefas cron

As localizações apresentadas na documentação pressupõem uma instalação de desenvolvimento, na qual os arquivos são encontrados em misc/ em relação à raiz do checkout do Git. Se você instalou usando pacotes Debian ou a instalação padrão pelo código-fonte, procure os arquivos em /usr/share/koha/bin/.

Outras localizações são possíveis com métodos de instalação diferentes. Você pode executar uma pesquisa simples com find se os arquivos não estiverem nesses diretórios.

Nota

Para quem possui acesso ao shell e usa pacotes Debian, o comando a seguir é uma maneira fácil de encontrar os arquivos instalados por um pacote Debian:

dpkg -L koha-common

Esse comando fornece uma lista completa dos arquivos instalados pelo pacote koha-common. Assim, você poderá encontrar facilmente o arquivo desejado.

Backup

Backup diário

Caminho do script: misc/cronjobs/backup.sh

Função: cria um backup diário do banco de dados do Koha.

Frequência sugerida: diariamente

Pesquisar

Mapa do site

Caminho do script: misc/cronjobs/sitemap.pl

Função: processa todos os registros bibliográficos de uma instância do Koha e gera arquivos de mapa do site em conformidade com o protocolo descrito em https://sitemaps.org. O objetivo desse script é fornecer aos mecanismos de pesquisa acesso direto aos registros bibliográficos. Isso evita que eles naveguem pelo OPAC do Koha, o que geraria muito tráfego no site e carga de trabalho no servidor.

Nota É gerado um arquivo chamado sitemapindex.xml. Ele contém referências a vários arquivos de mapa do site. Cada arquivo contém no máximo 50.000 URLs e é denominado sitemapXXXX.xml.

Os arquivos devem ser armazenados no diretório raiz do OPAC do Koha. No mesmo diretório, é necessário um arquivo robots.txt com o seguinte conteúdo:

Sitemap: sitemapindex.xml User-agent: * Disallow: /cgi-bin/

Reconstruir índice

Caminho do script: misc/migration_tools/rebuild_zebra.pl

Função: atualiza os índices do Zebra com dados alterados recentemente.

Exigido por: Zebra

Frequência sugerida: a cada x minutos (entre 5 e 15 minutos), dependendo das necessidades de desempenho

Nota Nas instalações mais recentes do Koha, esta tarefa cron foi substituída pelo daemon koha-indexer, que indexa dados novos e modificados do Koha a cada 30 segundos.

Circulação

Fila de reservas

Caminho do script: misc/cronjobs/holds/build_holds_queue.pl

Função: atualiza o relatório da fila de reservas

Exigido por: Relatório da fila de reservas

Frequência sugerida: a cada 1 a 4 horas

Descrição:

• Um script que deve ser executado periodicamente se o sistema da biblioteca permitir que os usuários façam reservas de exemplares disponíveis na estante. Este script determina qual biblioteca deve ser responsável por atender a uma determinada solicitação de reserva.

  Seu comportamento é controlado pelas preferências do sistema StaticHoldsQueueWeight e RandomizeHoldsQueueWeight.

  Se você não quiser que todas as bibliotecas participem do processo de atendimento de reservas de exemplares disponíveis na estante, relacione aqui as bibliotecas que *participam* do processo, informando os branchcodes de todas elas separados por vírgulas (por exemplo, “MPL,CPL,SPL,BML” etc.).

  Por padrão, a fila de reservas será gerada de modo que o sistema tente primeiro atender a reserva usando exemplares que já estejam na biblioteca de retirada, se possível. Se não houver exemplares disponíveis nessa biblioteca, build_holds_queue.pl usará a lista de bibliotecas definida em StaticHoldsQueueWeight. Se RandomizeHoldsQueueWeight estiver desabilitada (como ocorre por padrão), o script atribuirá as solicitações de atendimento na ordem em que as bibliotecas aparecem na preferência do sistema StaticHoldsQueueWeight.

  Por exemplo, se o seu sistema tem três bibliotecas de tamanhos variados (pequena, média e grande) e você deseja que a maior incidência de reservas recaia sobre as bibliotecas maiores antes das menores, você pode configurar StaticHoldsQueueWeight para algo como “GDE,MED,PEQ”.

  Caso você queira que o encargo das reservas recaia de maneira equânime na rede de bibliotecas, simplesmente ative a preferência RandomizeHoldsQueueWeight.Quando esta preferência do sistema está ativa, a ordem na qual cada biblioteca será solicitada a atender reservas será aleatória a cada vez que a lista for gerada.

Reservas expiradas

Caminho do script: misc/cronjobs/holds/cancel_expired_holds.pl

Função: cancela reservas para as quais o usuário definiu uma data de expiração. Se a biblioteca usar as preferências ExpireReservesMaxPickUpDelay e ExpireReservesMaxPickUpDelayCharge, esse script também cancelará reservas que permaneceram por muito tempo na estante de reservas e, se essa for a política da biblioteca, cobrará do usuário pela não retirada.

É possível adicionar um motivo de cancelamento com o parâmetro –reason. Use o código de cancelamento da categoria de valores autorizados HOLD_CANCELLATION

Frequência sugerida: diariamente

Reativar reservas

Caminho do script: misc/cronjobs/holds/auto_unsuspend_holds.pl

Função: verifica as reservas que não devem mais permanecer suspensas e remove a suspensão se a preferência AutoResumeSuspendedHolds estiver definida como ‘permitir’. Isso recoloca o usuário na posição em que estava na fila quando a reserva foi suspensa.

Frequência sugerida: diariamente

Multas

Caminho do script: misc/cronjobs/fines.pl

Função: calcula e cobra (ou incrementa) multas por atraso, por exemplar, nas contas dos usuários. O cálculo usa o período de carência, o intervalo da multa, o valor da multa e outros parâmetros das regras de circulação e multas.

Exigido pela preferência do sistema finesMode

Frequência sugerida: todas as noites

Nota Se a preferência do sistema do Koha ‘finesMode’ estiver definida como ‘production’, as multas serão cobradas nas contas dos usuários. Se estiver definida como ‘test’, as multas serão calculadas, mas não aplicadas.

Nota As multas não serão aplicadas em feriados.

PARÂMETROS - -h|–help

• exibe a mensagem de ajuda

• -l|–log

  • registra a saída em um arquivo (opcional se o parâmetro -o for informado)

• -o|–out

  • diretório de saída dos registros (o padrão é env ou /tmp se o diretório não existir)

• -v|–verbose

  • modo detalhado

• -m|–maxdays

  • quantos dias anteriores de atrasos devem ser processados

  • isso pode melhorar o desempenho ao limitar a quantidade de registros que precisam ser processados. Pode ser seguro restringir o processamento aos atrasos inferiores a X dias, pois as políticas de circulação frequentemente limitam as multas a um valor máximo depois de determinado número de dias.

Multas fixas

Caminho do script: misc/cronjobs/staticfines.pl

Função: cobra uma única multa fixa por qualquer/todos os atrasos pendentes de um usuário. O valor é definido na linha de comando por categoria de usuário ou usa as regras de circulação associadas ao exemplar mais antigo atualmente em atraso (somente no primeiro período de multa). Depois da cobrança, a multa permanece fixa: nenhuma nova multa será adicionada até que a multa existente seja integralmente paga.

Frequência sugerida: todas as noites

Nota Se a preferência do sistema do Koha ‘finesMode’ estiver definida como ‘production’, as multas serão cobradas nas contas dos usuários. Se estiver definida como ‘test’, as multas serão calculadas, mas não aplicadas.

Nota As multas não serão aplicadas em feriados.

Baixa de cobranças em lote

Caminho do script: misc/cronjobs/writeoff_debts.pl

Função: dá baixa em cobranças pendentes nas contas dos usuários.

PARÂMETROS

Nota

As opções para selecionar os registros de dívida a serem baixados são cumulativas. Por exemplo, fornecer --added_before e --type especifica que a linha da conta deve atender a ambas as condições para ser selecionada para baixa.

Nota

Você deve usar pelo menos uma das opções de filtragem para que o script seja executado. Isso evita uma operação acidental de ‘baixar tudo’.

• -h | --help

  • Exibe a mensagem de ajuda.

• -v | --verbose

  • Saída detalhada.

• --added-before

  • Dá baixa em cobranças adicionadas antes da data especificada.

  • As datas devem estar no formato ISO, por exemplo, 2013-07-19, e podem ser geradas com date -d '-3 month' --iso-8601.

• --added-after

  • Dá baixa em cobranças adicionadas depois da data especificada.

  • As datas devem estar no formato ISO, por exemplo, 2013-07-19, e podem ser geradas com date -d '-3 month' --iso-8601.

• --category-code

  • Dá baixa em cobranças de usuários pertencentes às categorias especificadas.

  • Pode ser repetido.

• --type

  • Dá baixa em cobranças do tipo especificado.

  • Aceita uma lista de códigos de tipos de débito.

• --file

  • Dá baixa nas cobranças informadas no arquivo, com um accountlines_id por linha.

  • Se outros critérios forem definidos, serão baixadas somente as cobranças do arquivo que atenderem a esses critérios.

• --confirm

  • Este parâmetro é necessário para efetivamente dar baixa nas cobranças.

  • Executar o script sem este parâmetro apenas exibirá quais cobranças seriam baixadas.

EXEMPLOS DE USO

writeoff_debts.pl --added_after 2023-06-20 --confirm

Dará baixa nas cobranças adicionadas depois de 20/06/2023.

writeoff_debts.pl --added_before `date -d '-3 month' --iso-8601` --category-code K --confirm

Dará baixa nas cobranças com mais de 3 meses de usuários da categoria ‘K’.

Restringir usuários com multas

Caminho do script: misc/cronjobs/debar_patrons_with_fines.pl

Função: adiciona uma restrição manual aos usuários com mais de X em cobranças não pagas.

Frequência sugerida: todas as noites ou conforme a necessidade

PARÂMETROS

• -h | --help

  • Exibe a mensagem de ajuda.

• -a | --amount

  • Valor mínimo que o usuário deve para ser restringido.

  • O padrão é 0, o que significa que qualquer pessoa com qualquer valor devido será restringida.

• -m | --message

  • Mensagem a ser adicionada como comentário da restrição.

• -f | --messagefile

  • Arquivo que contém a mensagem a ser adicionada como comentário da restrição.

• -e | --expiration

  • Data de expiração da restrição.

• -c | --confirm

  • Use este parâmetro para confirmar as alterações.

  • Sem este parâmetro, nenhum usuário será restringido.

• -v | --verbose

  • Mostra quais usuários são afetados.

EXEMPLOS DE USO

debar_patrons_with_fines.pl -a 5 -m "Fines" -v

Mostrará quais usuários têm mais de 5 em cobranças não pagas, mas não os restringirá efetivamente (o parâmetro --confirm está ausente).

debar_patrons_with_fines.pl -a 5 -m "Fines" -e '2024-12-31' -v -c

Restringirá os usuários que devem mais de 5; a restrição terá o comentário “Multas” e expirará em 31/12/2024. A saída do script também mostrará quais usuários foram restringidos.

Atrasos prolongados

Caminho do script: misc/cronjobs/longoverdue.pl

Função: permite especificar prazos para alterar exemplares para diferentes status de perdido e, opcionalmente, cobrá-los usando o preço de reposição indicado no registro do exemplar.

Frequência sugerida: todas as noites

Nota

Os funcionários podem controlar alguns parâmetros da tarefa cron longoverdue pelas preferências do sistema DefaultLongOverdueLostValue e DefaultLongOverdueDays, DefaultLongOverdueSkipLostStatuses, DefaultLongOverdueChargeValue, DefaultLongOverduePatronCategories, DefaultLongOverdueSkipPatronCategories e LostChargesControl.

PARÂMETROS

• -l | --lost

  • Esta opção usa o formato n=lv, em que n é a quantidade de dias de atraso e lv é o valor da categoria de valores autorizados LOST que deve ser atribuído ao exemplar depois dessa quantidade de dias.

  • As preferências do sistema DefaultLongOverdueLostValue e DefaultLongOverdueDays podem ser usadas para definir esses dois valores na interface administrativa, em vez de diretamente na tarefa cron. Se as preferências estiverem definidas, não será necessário usar o parâmetro --lost.

• -c | --charge

  • Especifica qual status de perdido faz o Koha cobrar do usuário o custo de reposição do exemplar.

  • A preferência do sistema DefaultLongOverdueChargeValue pode ser usada para definir o valor na interface administrativa em vez de diretamente na tarefa cron.

  • Se nem o parâmetro --charge nem DefaultLongOverdueChargeValue estiverem definidos, o processo de atrasos prolongados não cobrará do usuário pelo exemplar perdido.

• --confirm

  • Este parâmetro é obrigatório para que o script altere valores. Sem esta opção, o script informará a quantidade de exemplares afetados sem modificar nenhum registro.

• -v | --verbose

  • Este parâmetro exibe a quantidade de exemplares afetados.

• --quiet

  • Este parâmetro suprime a saída normal.

• --maxdays

  • Este parâmetro especifica o fim do intervalo de dias de atraso a ser processado.

  • Se este parâmetro não for especificado, o padrão será 366.

• --mark-returned

  • Este parâmetro remove os exemplares com atraso prolongado dos empréstimos dos usuários.

  • A preferência do sistema MarkLostItemsAsReturned pode ser usada para definir este parâmetro pela interface administrativa, em vez de diretamente na tarefa cron.

• -h | --help

  • Este parâmetro exibe uma mensagem curta de ajuda e encerra o script.

• -man | --manual

  • Este parâmetro exibe a mensagem de ajuda completa e encerra o script.

• --category

  • Este parâmetro limita o processamento a uma categoria de usuário específica. Todas as outras categorias serão excluídas.

  • Este parâmetro pode ser repetido para incluir várias categorias.

  • A preferência do sistema DefaultLongOverduePatronCategories pode ser usada para definir, pela interface administrativa, as categorias a serem incluídas, em vez de defini-las diretamente na tarefa cron.

  Importante

  Este parâmetro não pode ser usado com --skip-category.

  Da mesma forma, a preferência do sistema DefaultLongOverduePatronCategories não pode ser usada com DefaultLongOverdueSkipPatronCategories.

• --skip-category

  • Este parâmetro exclui do processo uma categoria de usuário específica. Todas as outras categorias serão incluídas.

  • Este parâmetro pode ser repetido para excluir várias categorias.

  • A preferência do sistema DefaultLongOverdueSkipPatronCategories pode ser usada para definir, pela interface administrativa, as categorias a serem excluídas, em vez de defini-las diretamente na tarefa cron.

  Importante

  Este parâmetro não pode ser usado com --category.

  Da mesma forma, a preferência do sistema DefaultLongOverdueSkipPatronCategories não pode ser usada com DefaultLongOverduePatronCategories.

• --list-categories

  • Este parâmetro relaciona as categorias de usuários disponíveis que podem ser usadas em --category ou --skip-category e encerra o script.

• --library

  • Este parâmetro limita o processamento a um código de biblioteca específico. Todas as outras bibliotecas serão excluídas.

  • Este parâmetro pode ser repetido para incluir várias bibliotecas.

  • As bibliotecas selecionadas seguem a preferência do sistema LostChargesControl.

  Atenção

  Antes da versão 26.05 do Koha, as bibliotecas selecionadas seguiam a preferência do sistema CircControl.

  Importante

  Este parâmetro não pode ser usado com --skip-library.

• --skip-library

  • Este parâmetro exclui do processo uma biblioteca específica. Todas as outras bibliotecas serão incluídas.

  • Este parâmetro pode ser repetido para excluir várias bibliotecas.

  • As bibliotecas selecionadas seguem a preferência do sistema LostChargesControl.

  Atenção

  Antes da versão 26.05 do Koha, as bibliotecas selecionadas seguiam a preferência do sistema CircControl.

  Importante

  Este parâmetro não pode ser usado com --library.

• --itemtype

  • Este parâmetro limita o processamento a um código de tipo de material específico. Todos os outros tipos de material serão excluídos.

  • Este parâmetro pode ser repetido para incluir vários tipos de material.

  Importante

  Este parâmetro não pode ser usado com --skip-itemtype.

• --skip-itemtype

  • Este parâmetro exclui do processo um tipo de material específico. Todos os outros tipos de material serão incluídos.

  • Este parâmetro pode ser repetido para excluir vários tipos de material.

  Importante

  Este parâmetro não pode ser usado com --itemtype.

• --list-itemtypes

  • Este parâmetro relaciona os tipos de material disponíveis que podem ser usados em --itemtype ou --skip-itemtype e encerra o script.

• --skip-lost-value

  • Este parâmetro exclui do processo um valor LOST específico. Todos os outros valores serão incluídos.

  • A preferência do sistema DefaultLongOverdueSkipLostStatuses pode ser usada para definir, pela interface administrativa, os valores de perdido a serem excluídos, em vez de defini-los diretamente na tarefa cron.

EXEMPLOS DE USO

misc/cronjobs/longoverdue.pl --lost 30=1 --confirm

Definirá o status de perdido como 1 para todos os exemplares com atraso superior a 30 dias (até 366 dias).

misc/cronjobs/longoverdue.pl --lost 60=2 --charge 2 --confirm

Definirá o status de perdido como 2 para todos os exemplares com atraso superior a 60 dias (até 366 dias) e cobrará dos usuários o custo de reposição.

Acompanhar o total de empréstimos

Caminho do script: misc/cronjobs/update_totalissues.pl

Função: atualiza o campo biblioitems.totalissues no banco de dados com a contagem mais recente de empréstimos, baseada nas estatísticas históricas de empréstimos.

Frequência sugerida: todas as noites

Aviso

Se o horário do servidor de banco de dados não corresponder ao do servidor Koha, será necessário considerar essa diferença e provavelmente usar o argumento –since em vez de –interval nas atualizações incrementais.

Nota

Esta tarefa cron pode ser usada se houver preocupação com desempenho. Caso contrário, use a preferência do sistema UpdateTotalIssuesOnCirc.

Gerar arquivo de usuários para circulação off-line

Caminho do script: misc/cronjobs/create_koc_db.pl

Função: gera o arquivo borrowers.db para uso com a ferramenta de circulação off-line do Koha

Frequência sugerida: semanalmente

Renovação automática

Caminho do script: misc/cronjobs/automatic_renewals.pl

Função: renova exemplares se a renovação automática estiver permitida nas regras de circulação e multas.

Frequência sugerida: todas as noites

Importante

Para executá-lo corretamente, é necessário usar o parâmetro –confirm; caso contrário, ele funcionará apenas no modo de teste

PARÂMETROS - -h|–help

• exibe a mensagem de ajuda

• –send-notices

  • envia o aviso AUTO_RENEWALS aos usuários se a renovação automática tiver sido realizada

• -v|–verbose

  • modo detalhado

• -c|–confirm

  • sem este parâmetro, nenhuma alteração será feita e o script será executado no modo de teste

  • sem este parâmetro, o script também usará por padrão o modo detalhado

Devolução automática

Caminho do script: misc/cronjobs/automatic_checkin.pl

Função: registra automaticamente a devolução dos exemplares ao final do período de empréstimo. Isso é definido no nível do tipo de material.

Frequência sugerida: todas as noites

Nota

Opcionalmente, as reservas podem ser atendidas automaticamente quando a devolução dos exemplares for registrada por esse script. Essa opção é habilitada pela preferência do sistema AutomaticCheckinAutoFill.

Solicitações de devolução

Expirar solicitações de devolução

Caminho do script: misc/cronjobs/recalls/expire_recalls.pl

Função: marca automaticamente como expiradas as solicitações de devolução que

• foram feitas, mas não foram atendidas e já ultrapassaram a data de expiração

• estão aguardando retirada por mais tempo que o período definido nas regras de circulação ou na preferência do sistema RecallsMaxPickUpDelay

Frequência sugerida: todas as noites

Solicitações de devolução atrasadas

Caminho do script: misc/cronjobs/recalls/overdue_recalls.pl

Função: marca um exemplar cuja devolução foi solicitada como atrasado se ele não tiver sido devolvido até a data de devolução ajustada

Frequência sugerida: todas as noites

Patronos

Excluir usuários em lote

Caminho do script: misc/cronjobs/delete_patrons.pl

Função: exclui registros de usuários em lote com base nos parâmetros especificados. Esse script excluirá usuários mesmo que tenham reservas, solicitações de EEB, sugestões ou restrições. Ele não excluirá e ignorará usuários que sejam responsáveis por outras contas, tenham empréstimos, possuam valores devidos ou créditos, estejam marcados como protegidos ou tenham permissões de funcionário.

Frequência sugerida: todas as noites para remover regularmente usuários com base em períodos de datas.

Dica

As opções para selecionar os registros de usuários a serem excluídos são cumulativas. Por exemplo, fornecer --expired_before e --library especifica que os registros devem atender a ambas as condições para serem selecionados para exclusão.

PARÂMETROS

• -h ou --help

  • Exibe a mensagem de ajuda.

• -v ou --verbose

  • Modo detalhado.

• -c ou --confirm

  • Adicione esta opção depois dos demais parâmetros para efetivamente excluir os usuários.

  • Sem ela, o script apenas informará quais registros de usuários seriam excluídos.

Nota

Todas as datas devem estar no formato ISO, por exemplo, 2024-07-22. Os períodos podem ser gerados com date -d '-3 month' --iso-8601.

• --not_borrowed_since

  • Exclui usuários que não fizeram empréstimos desde essa data.

  Aviso

  Os usuários cujos empréstimos antigos foram todos anonimizados terão o histórico de circulação vazio; eles serão excluídos se esta opção for usada. A anonimização pode ocorrer porque borrowers.privacy = 2, por tarefas cron que realizam anonimização ou porque o usuário optou por anonimizar o histórico no OPAC.

• --expired_before

  • Exclui usuários cuja data de expiração da conta seja anterior a essa data.

• --last_seen

  • Exclui usuários cuja data borrowers.lastseen seja anterior a essa data.

  • Para que este parâmetro tenha efeito, a preferência do sistema TrackLastPatronActivityTriggers deve estar em uso.

• --category_code

  • Exclui usuários que possuem esse código de categoria.

  • Este parâmetro pode ser usado várias vezes para códigos de categoria adicionais, por exemplo, --category_code AB --category_code CD

• --library

  • Exclui usuários dessa biblioteca.

• --without_restriction_type

  Versão

  Este parâmetro foi introduzido na versão 25.05 do Koha.

  • Exclui usuários que não possuem uma restrição do tipo especificado.

    • Na prática, o script não excluirá usuários que tenham restrições desse tipo. Ele excluirá usuários com qualquer outro tipo de restrição.

  • Este parâmetro pode ser repetido, permitindo especificar vários tipos de restrição.

EXEMPLOS DE USO

delete_patrons.pl --category_code AB --library PVL
--expired_before 2026-01-01 --confirm

Excluirá usuários do código de categoria AB da biblioteca PVL cujas contas expiraram antes de 1º de janeiro de 2026.

delete_patrons.pl --last_seen `date -d '-12 month' --iso-8601`
--without_restriction_type RETAIN --confirm

Excluirá usuários cuja data da última atividade seja superior a 12 meses e que não possuam uma restrição do tipo RETAIN.

Anonimizar dados dos usuários

Caminho do script: misc/cronjobs/batch_anonymise.pl

Função: remove borrowernumbers do histórico de circulação para preservar as estatísticas, mas retirar os dados do usuário por motivos de privacidade.

Pseudonimizar estatísticas existentes

Versão

Este script foi introduzido na versão 24.05 do Koha.

Caminho do script: misc/maintenance/pseudonymize_statistics.pl

Função: preenche retroativamente a tabela pseudonymized_transactions com transações antigas da tabela statistics.

A tabela pseudonymized_transactions começa a ser preenchida quando a preferência do sistema Pseudonymization é habilitada. Se a biblioteca quiser usar transações pseudonimizadas do período anterior à habilitação, este script poderá pseudonimizar as estatísticas existentes (anteriores).

Frequência: em vez de ser executado regularmente, este script é mais útil como execução única. Depois que a pseudonimização estiver habilitada e o script tiver sido executado uma vez, não haverá necessidade de executá-lo novamente.

PARÂMETROS

• -h ou --help

  • Exibe a mensagem de ajuda.

• -v ou --verbose

  • Modo detalhado.

• -c ou --confirm

  • Sinalizador de confirmação: adicione esta opção depois dos demais parâmetros. Sem ela, o script será executado no modo de teste e nenhuma alteração será feita.

• -b ou --before

  • Especifique uma data e uma hora. Todas as transações realizadas nesse momento ou antes dele serão pseudonimizadas.

    • A data e a hora devem estar no formato “YYYY-MM-DD HH:MM:SS”.

    • Se usar somente uma data, você poderá formatá-la como YYYY-MM-DD.

  • Isso é útil se a pseudonimização já estiver em execução há algum tempo e você precisar pseudonimizar apenas as transações anteriores à sua habilitação.

  • Se executar o script sem este parâmetro, todas as estatísticas com data imediatamente anterior ao momento atual serão pseudonimizadas.

Dica

Verifique até que data retrocedem as entradas da tabela statistics antes de usar este script. Se necessário, reduza as estatísticas com o script cleanup_database.pl.

EXEMPLO DE USO

pseudonymize_statistics.pl --before "2024-12-31 23:59:59" --confirm

Cria transações na tabela pseudonymized_transactions a partir das transações da tabela statistics datadas de 31 de dezembro de 2024 às 23:59:59 ou antes.

Restringir usuários com avisos que falharam

Versão

Este script foi introduzido na versão 24.11 do Koha.

Caminho do script: misc/cronjobs/restrict_patrons_with_failed_notices.pl

Função: adiciona restrições às contas dos usuários quando eles são destinatários de avisos por e-mail ou SMS cujo envio falhou.

Exige: RestrictPatronsWithFailedNotices

Frequência: semanal. Por padrão, o script afeta avisos que falharam nos últimos 7 dias.

PARÂMETROS

• -h ou --help

  • Exibe a mensagem de ajuda.

• -v ou --verbose

  • Modo detalhado.

• -c ou --confirm

  • Sinalizador de confirmação: o script alterará o banco de dados, aplicando uma restrição aos usuários com avisos por SMS e e-mail que falharam.

Atualizar categorias de usuários

Caminho do script: misc/cronjobs/update_patrons_category.pl

Função: atualiza para outra categoria especificada a categoria dos usuários que atendem aos critérios informados. Pode ser usado para converter usuários infantis de uma categoria infantil para uma categoria adulta quando atingirem o limite máximo de idade definido na categoria de usuário.

Este script substitui o script j2a.pl.

Frequência sugerida: todas as noites

DESCRIÇÃO

Este script foi projetado para atualizar usuários de uma categoria para outra usando critérios especificados em argumentos da linha de comando.

PARÂMETROS

• –too_old Atualiza se o usuário estiver acima do limite máximo de idade de sua categoria de usuário atual.

• –too_young Atualiza se o usuário estiver abaixo do limite mínimo de idade de sua categoria de usuário atual.

• –fo=X|–fineover=X Atualiza se o valor total das multas na conta do usuário for superior a X.

• –fu=X|–fineunder=X Atualiza se o valor total das multas na conta do usuário for inferior a X.

• –rb=date|regbefore=date Atualiza se a data de registro do usuário for anterior à data informada.

• –ra=date|regafter=date Atualiza se a data de registro do usuário for posterior à data informada.

• -d –field name=value Atualiza se a condição informada for atendida. <name> deve ser substituído pelo nome de uma coluna da tabela borrowers. A condição é atendida quando o conteúdo do campo é igual a <value>.

• –where <conditions> Atualiza se a cláusula SQL <where> for atendida.

• -v|–verbose Modo detalhado: sem este sinalizador, somente erros fatais serão informados.

• -c|–confirm Confirma as alterações no banco de dados. Nenhuma alteração será feita se esse argumento não for adicionado ao comando.

• -b|–branch <branchcode> Atualiza se a biblioteca de origem do usuário corresponder ao <branchcode> informado.

• -f|–form <categorycode> Atualiza se o usuário pertencer atualmente a essa categoria.

• -t|–to <categorycode> Atualiza para esta categoria os usuários que atendem aos critérios.

EXEMPLOS DE USO

“update_patrons_category.pl”

“update_patrons_category.pl” -b=<branchcode> -f=<categorycode> -t=<categorycode> -c” (Processa uma única biblioteca e atualiza as categorias de usuários de uma categoria para outra)

“update_patrons_category.pl” -f=<categorycode> -t=<categorycode> -v” (Processa todas as bibliotecas, mostra todas as mensagens e informa os usuários que seriam afetados. Não realiza nenhuma ação no banco de dados)

Atualizar as preferências de mensagens dos usuários

Caminho do script: misc/maintenance/borrowers-force-messaging-defaults.pl

Função: atualiza as preferências de mensagens dos usuários para os valores padrão definidos nas categorias de usuários.

Os padrões das preferências de mensagens são definidos automaticamente ao adicionar um novo usuário ou importar usuários com a ferramenta de importação. Entretanto, se os usuários forem importados diretamente no banco de dados, essas preferências não serão definidas.

Não há frequência sugerida. Esta é uma ferramenta para ser usada quando necessário, embora possa ser adicionada ao crontab se você importar usuários diretamente no banco de dados com regularidade (por exemplo, por meio de terceiros).

DESCRIÇÃO

Se a preferência do sistema EnhancedMessagingPreferences for habilitada depois que os usuários já tiverem sido criados no banco de dados, eles não terão os valores padrão das preferências de transporte de mensagens definidos para suas categorias. Portanto, seria necessário alterar cada usuário individualmente para, por exemplo, enviar o aviso ‘Reserva atendida’.

Este script cria ou substitui as preferências de mensagens de todos os usuários e as define com os valores padrão da categoria a que pertencem (a menos que você use as opções -not-expired ou -no-overwrite para atualizar um subconjunto).

PARÂMETROS

• --help

  • Exibe a mensagem de ajuda.

• --doit

  • Atualiza os usuários. Sem esta opção, o script não atualizará as preferências de mensagens; apenas relacionará os usuários que seriam atualizados.

• --not-expired

  • Atualiza somente usuários ainda ativos (cujos cadastros não expiraram).

• --no-overwrite

  • Atualiza somente usuários sem preferências de mensagens. Esta opção ignorará os usuários que já definiram suas preferências.

• --category

  • Atualiza somente usuários da categoria especificada.

  Aviso

  Esta opção não pode ser repetida.

  Por exemplo:

  borrowers-force-messaging-defaults.pl --doit --category PT --category B
  

  atualizará somente usuários da categoria B (a última categoria especificada).

• --library

  • Atualizará somente usuários cuja biblioteca de origem corresponda ao branchcode informado.

• --message-name

  • Atualizará somente as preferências da mensagem especificada.

  • A lista de valores pode ser encontrada em installer/data/mysql/mandatory/sample_notices_message_attributes.sql, em message_attributes.message_name no banco de dados ou na ferramenta Avisos e comprovantes.

• --since

  • Atualiza somente usuários inscritos desde a data especificada.

  Nota

  Esta opção pode usar datas específicas ou relativas.

  Por exemplo:

  borrowers-force-messaging-defaults.pl --doit --since "2022-07-12"
  

  atualizará somente usuários inscritos desde 12 de julho de 2022.

  E:

  borrowers-force-messaging-defaults.pl --doit --since `date -d "1 day ago" '+%Y-%m-%d'
  

  atualizará somente usuários inscritos desde ontem.

EXEMPLOS DE USO

borrowers-force-messaging-defaults.pl --doit

Atualiza todos os usuários para atribuir os valores padrão das preferências de mensagens de suas respectivas categorias.

borrowers-force-messaging-defaults.pl --doit --not-expired

Atualiza todos os usuários cujas associações não expiraram para atribuir os valores padrão das preferências de mensagens de suas respectivas categorias.

borrowers-force-messaging-defaults.pl --doit --category PT

Atualiza todos os usuários da categoria PT para atribuir os padrões de preferências de mensagens dessa categoria.

borrowers-force-messaging-defaults.pl --doit --no-overwrite --since "2022-03-01"

Atualiza os usuários que não possuem preferências de mensagens definidas e que estão inscritos desde 1º de março de 2022.

borrowers-force-messaging-defaults.pl --doit --no-overwrite --since `date -d "1 day ago" '+%Y-%m-%d'

Atualiza os usuários que não possuem preferências de mensagens definidas e que estão inscritos desde ontem.

borrowers-force-messaging-defaults.pl --doit --library CPL

Atualiza os usuários cuja biblioteca de origem é CPL.

borrowers-force-messaging-defaults.pl --doit --message-name Item_due

Atualiza somente as preferências da mensagem “Devolução do exemplar”.

Correspondências

Fila de mensagens

Caminho do script: misc/cronjobs/process_message_queue.pl

Função: processa a fila de mensagens para enviar e-mails e mensagens SMS aos usuários. As mensagens são colocadas na fila por outros scripts, como advance_notices.pl, overdue_notices.pl e holds_reminder.pl.

Frequência sugerida: de 1 a 4 horas

DESCRIÇÃO

Este script processa a fila de mensagens na tabela message_queue do banco de dados. Ele envia as mensagens da fila e as marca adequadamente para indicar sucesso ou falha. Recomenda-se executá-lo regularmente pelo cron, especialmente se você usa o script advance_notices.pl.

PARÂMETROS

• -u | –username

  • Nome de usuário da conta de e-mail usada para enviar os avisos.

• -p | –password

  • Senha da conta de e-mail usada para enviar os avisos.

• -t | –type

  • Se informado, processa somente este tipo de mensagem. Os valores possíveis são

    • e-mail

    • sms

  • Pode ser repetido

• -c | –code

  • Se informado, processa somente mensagens com este código de mensagem.

  • Pode ser repetido.

• -l | –limit

  • Quantidade máxima de mensagens a processar nesta execução.

• -m | –method

  • Método de autenticação exigido pelo servidor SMTP (consulte perldoc Sendmail.pm para ver os tipos de autenticação compatíveis).

• -h | –help

  • Mensagem de ajuda.

• -v | –verbose

  • Fornece uma saída detalhada para STDOUT.

• -w | –where

  • Filtra as mensagens a serem enviadas com condições adicionais em uma cláusula where.

Avisos antecipados

Caminho do script: misc/cronjobs/advance_notices.pl

Função: prepara avisos de “proximidade da data de devolução” e “data de devolução do exemplar” para os usuários que os solicitaram; prepara avisos para usuários sobre exemplares cuja devolução acaba de vencer ou vencerá em breve; exige que EnhancedMessagingPreferences esteja definida como ‘Permitir’

Frequência sugerida: todas as noites

Nota

Este script não envia efetivamente os avisos. Ele os coloca na fila de mensagens para envio posterior.

Aviso de atraso

Caminho do script: misc/cronjobs/overdue_notices.pl

Função: prepara mensagens para alertar os usuários sobre empréstimos em atraso (por e-mail e impressão)

Frequência sugerida: todas as noites

DESCRIÇÃO

Este script cria e coloca na fila os avisos de atraso de acordo com os parâmetros definidos na ferramenta de gatilhos de avisos/status de atraso.

PARÂMETROS

• -n | –nomail

  • Não envia nenhum e-mail. Os avisos de atraso que seriam enviados aos usuários ou ao administrador são impressos na saída padrão. Os dados CSV (se o sinalizador –csv estiver definido) são gravados na saída padrão ou no nome de arquivo CSV informado.

• –max <days>

  • Quantidade máxima de dias de atraso a processar.

  • Presume-se que os exemplares com atraso superior ao máximo de dias sejam tratados em outro lugar, provavelmente pelo script longoverdues. Portanto, eles são ignorados por este script. Nenhum aviso é enviado e eles não são adicionados a arquivos CSV.

  • O padrão é 90 dias.

• –library <branchcode>

  • Processa somente atrasos desta biblioteca.

  • Use o valor da tabela branches.branchcode.

  • Este parâmetro pode ser repetido para processar atrasos de um grupo de bibliotecas.

• –csv <filename>

  • Produz um arquivo CSV.

  • Se o sinalizador -n (sem e-mail) estiver definido, esses dados CSV serão enviados à saída padrão ou ao arquivo informado. Caso contrário, somente os atrasos que não puderam ser enviados por e-mail serão encaminhados ao administrador no formato CSV.

• –html <directory>

  • Grava a saída HTML em um arquivo no diretório informado.

  • Se um usuário não tiver endereço de e-mail ou se o sinalizador -n (sem e-mail) estiver definido, será gerado um arquivo HTML no diretório especificado. Ele poderá ser baixado ou processado posteriormente pelos funcionários da biblioteca.

  • O arquivo será denominado notices-YYYY-MM-DD.html e colocado no diretório especificado.

• –text <directory>

  • Grava a saída em texto simples em um arquivo no diretório informado.

  • Se um usuário não tiver endereço de e-mail ou se o sinalizador -n (sem e-mail) estiver definido, será gerado um arquivo de texto no diretório especificado. Ele poderá ser baixado ou processado posteriormente pelos funcionários da biblioteca.

  • O arquivo será denominado notices-YYYY-MM-DD.txt e colocado no diretório especificado.

• –itemscontent <list of fields>

  • Informações dos exemplares nos modelos.

  • Recebe uma lista de campos separados por vírgulas que substituem o marcador de posição <<items.content>> nos modelos.

  • O padrão é due date,title,barcode,author

  • Outros valores possíveis vêm de campos das tabelas biblio, items e issues.

• –borcat <categorycode>

  • Prepara avisos de atraso somente para as categorias de usuários especificadas.

  • Este parâmetro pode ser repetido para incluir várias categorias de usuários.

  • Use o valor de categories.categorycode.

• –borcatout <categorycode>

  • Não prepara avisos de atraso para as categorias de usuários especificadas.

  • Este parâmetro pode ser repetido para excluir várias categorias de usuários.

  • Use o valor de categories.categorycode.

• • t | –triggered

  • Esta opção faz com que um aviso seja gerado se, e somente se, um exemplar estiver atrasado pela quantidade de dias definida no gatilho de aviso de atraso.

  • Por padrão, um aviso é enviado sempre que o script é executado, o que é adequado para uma execução cron menos frequente, mas exige sincronizar os gatilhos de avisos com o agendamento cron para garantir o comportamento correto.

  • Adicione a opção –triggered à execução cron diária, sob o risco de nenhum aviso ser gerado se o cron não for executado no momento previsto.

• –test

  • Esta opção executa o script no modo de teste.

  • No modo de teste, o script não faz alterações no banco de dados. Isso é útil para depurar a configuração.

• –list-all

  • Por padrão, <<items.content>> relaciona somente os exemplares que se enquadram no intervalo do aviso em processamento.

  • Escolha –list-all para incluir todos os exemplares atrasados na lista (limitados pela configuração –max).

• –date <yyyy-mm-dd>

  • Simula a execução de atrasos para esta data.

• –email <email_type>

  • Especifica o tipo de e-mail que será usado.

  • Pode ser ‘email’, ‘emailpro’ ou ‘B_email’.

  • Este parâmetro pode ser repetido.

• –frombranch

  • Organiza e envia avisos de atraso por biblioteca de origem (item-homebranch) ou biblioteca de empréstimo (item-issuebranch).

  • O padrão é item-issuebranch.

  Nota

  Esta opção é usada somente se a preferência do sistema OverdueNoticeFrom estiver definida como ‘opção de linha de comando’.

EXEMPLOS DE USO

“overdue_notices.pl”

(Todas as bibliotecas são processadas individualmente, e são preparados avisos para todos os usuários com exemplares atrasados cujos endereços de e-mail estão cadastrados. As mensagens destinadas aos usuários sem endereço de e-mail são enviadas em um único anexo ao endereço do administrador da biblioteca ou ao endereço definido na preferência do sistema KohaAdminEmailAddress.)

“overdue_notices.pl -n –csv /tmp/overdues.csv”

(Não envia e-mail e preenche /tmp/overdues.csv com informações sobre todos os exemplares atrasados.)

“overdue_notices.pl –library MAIN max 14

(Prepara avisos dos atrasos das últimas 2 semanas para a biblioteca MAIN.)

Nota

Este script não envia efetivamente os avisos. Ele os coloca na fila de mensagens para envio posterior ou gera o HTML para impressão.

Nota

Ver também:

O script misc/cronjobs/advance_notices.pl permite enviar mensagens aos usuários antes da data de devolução dos exemplares ou alertá-los sobre exemplares cuja devolução acaba de vencer.

O script misc/cronjobs/process_message_queue.pl envia os e-mails.

Lembrete de reserva

Caminho do script: misc/cronjobs/holds/holds_reminder.pl

Função: prepara mensagens de lembrete para serem enviadas aos usuários com reservas aguardando retirada.

EnhancedMessagingPreferences deve estar definida como ‘Permitir’, e os usuários devem ter solicitado esse aviso (pela aba Mensagens da conta on-line no OPAC, se EnhancedMessagingPreferencesOPAC estiver definida como ‘Exibir’, ou pelas preferências de mensagens na interface administrativa).

Frequência sugerida: todas as noites

PARÂMETROS

• -c | –confirm

  • Sinalizador de confirmação; nenhum e-mail será gerado se este parâmetro não estiver definido

• -date <YYYY-MM-DD>

  • Envia os avisos que teriam sido enviados em uma data específica

• -days <number of days>

  • Quantidade de dias que a reserva está aguardando

  • Se este parâmetro não estiver definido, um aviso será enviado a todos os usuários com reservas aguardando

  • Parâmetro opcional

• -holidays

  • Usa o calendário para excluir os feriados da contagem de dias de espera

• -lettercode <lettercode>

  • Código do aviso predefinido a ser usado

  • Parâmetro opcional; o padrão é HOLD_REMINDER

• -library <branchcode>

  • Processa somente reservas desta biblioteca

  • Este sinalizador pode ser repetido para selecionar avisos de um grupo de bibliotecas

• -mtt <message_transport_type>

  • Tipo de mensagem a enviar (e-mail, SMS, impressão)

    • ‘e-mail’ e ‘SMS’ recorrerão a ‘impressão’ se o usuário não tiver endereço de e-mail/número de telefone

  • O padrão é usar as preferências de mensagens dos usuários para o aviso ‘Lembrete de reserva’

  • Informar este parâmetro forçará o envio mesmo que o usuário não tenha optado por receber lembretes de reserva

  • Ele pode ser repetido para enviar vários avisos

• -t | –triggered

  • Inclui somente reservas aguardando há <days> dias, e não por mais tempo

  • Se esta opção não estiver definida, o script enviará mensagens para todas as reservas aguardando por uma quantidade igual ou superior a <days> dias

  • Esta opção é útil quando o cron é executado diariamente, para evitar o envio excessivo de mensagens aos usuários

  • Parâmetro opcional

• -v

  • Detalhado

  • Sem este sinalizador, somente erros fatais serão informados.

  • Se o modo detalhado estiver definido, mas a confirmação não, uma lista dos avisos que seriam enviados aos usuários será impressa na saída padrão

• -help

  • Mensagem breve de ajuda

• -man

  • Documentação completa

  EXEMPLOS

  A seguir estão exemplos deste script:

  holds_reminder.pl -library MAIN -days 14
  

  prepara avisos de reservas aguardando há 2 semanas para a biblioteca MAIN

  holds_reminder.pl -lettercode LATE_HOLDS -library MAIN -days 14
  

prepara avisos de reservas aguardando há 2 semanas para a biblioteca MAIN, usando o modelo de aviso ‘LATE_HOLDS’

Imprimir atrasos

Caminho do script: misc/cronjobs/printoverdues.sh

Função: gera arquivos PDF a partir de arquivos HTML em diretórios e os imprime

Imprimir avisos de reserva

Caminho do script: misc/cronjobs/gather_print_notices.pl

Função: pesquisa na fila de mensagens avisos de reserva que não foram enviados porque o usuário não tinha endereço de e-mail e gera um aviso para impressão

Frequência sugerida: todas as noites

Talking Tech

Para saber mais sobre a configuração deste produto de terceiros, consulte o capítulo Talking Tech.

Envio do arquivo de avisos

Caminho do script: misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl

Função: gera o arquivo de notificações de saída Spec C para o sistema de notificações telefônicas Talking Tech i-tiva.

Exigido por: TalkingTechItivaPhoneNotification

Frequência sugerida: todas as noites

Recebimento do arquivo de avisos

Caminho do script: misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl

Função: processa os arquivos de resultados recebidos do sistema de notificações telefônicas Talking Tech i-tiva.

Exigido por: TalkingTechItivaPhoneNotification

Frequência sugerida: todas as noites

Notificar os usuários sobre a expiração

Caminho do script: misc/cronjobs/membership_expiry.pl

Função: envia à tarefa cron da fila de mensagens mensagens para alertar os usuários sobre a expiração da carteirinha. Opcionalmente, também pode renovar as contas dos usuários.

Exige: MembershipExpiryDaysNotice

Frequência: todas as noites

PARÂMETROS

• --man

  • Imprime a página do manual e encerra o script.

• --help

  • Imprime uma mensagem breve de ajuda e encerra o script.

• -v

  • Detalhado.

  • Sem este sinalizador, somente erros fatais serão informados.

• -n

  • Não envia nenhum e-mail. Os avisos de expiração da associação que seriam enviados aos usuários são impressos na saída padrão.

• -c

  • Sinalizador de confirmação: adicione esta opção. Caso contrário, o script apenas imprimirá uma instrução de uso.

• -branch

  • branchcode opcional para restringir a tarefa cron a essa biblioteca.

• -before

  • Parâmetro opcional para ampliar a seleção por uma quantidade de dias ANTES da data definida pela preferência do sistema MembershipExpiryDaysNotice.

• -after

  • Parâmetro opcional para ampliar a seleção por uma quantidade de dias DEPOIS da data definida pela preferência do sistema MembershipExpiryDaysNotice.

  • Por exemplo, --before 100 --after 100 notificará os usuários cujas contas expiram em um intervalo entre 100 dias antes e 100 dias depois da preferência do sistema MembershipExpiryDaysNotice.

• -where

  • Use esta opção para especificar uma condição. Adicione “me” (alias) seguido do nome da coluna da tabela borrowers.

  • Os espaços, se necessários, devem ser escapados com uma barra invertida.

  • Aspas simples ou duplas devem ser escapadas com uma barra invertida.

  • Por exemplo:

    • --where="me.categorycode!='YA'" notificará usuários de categorias diferentes de ‘YA’

    • --where="me.categorycode='S'" notificará somente usuários da categoria ‘S’

    • --where 'me.lastseenISNOTNULL' notificará somente usuários que já tiveram atividade.

• -letter

  • Parâmetro opcional para usar um aviso diferente do padrão: MEMBERSHIP_EXPIRY

• -letter_renew

  • Parâmetro opcional para usar um aviso de renovação diferente do padrão: MEMBERSHIP_RENEWED

• -active

  • Seguido de uma quantidade de meses.

  • Parâmetro opcional para incluir somente usuários ativos (ativos dentro da quantidade de meses informada).

  • Este parâmetro exige a preferência do sistema TrackLastPatronActivityTriggers.

  • Não pode ser usado com -inactive abaixo; os dois parâmetros são mutuamente exclusivos

• -inactive

  • Seguido de uma quantidade de meses.

  • Parâmetro opcional para incluir somente usuários inativos (inativos há pelo menos a quantidade de meses informada).

  • Este parâmetro exige a preferência do sistema TrackLastPatronActivityTriggers.

  • Não pode ser usado com -active acima; os dois parâmetros são mutuamente exclusivos

• -renew

  • Parâmetro opcional para renovar automaticamente os usuários em vez de enviar um aviso de expiração.

  • Eles serão informados por um aviso de renovação da associação (o padrão MEMBERSHIP_RENEWED ou um personalizado especificado por -letter_renew)

EXEMPLOS DE USO

membership_expiry.pl -c

Gerará avisos MEMBERSHIP_EXPIRY para os usuários cuja associação expira dentro da quantidade de dias definida em MembershipExpiryDaysNotice.

membership_expiry.pl -c -renew

Renovará os usuários cuja associação expira dentro da quantidade de dias definida em MembershipExpiryDaysNotice e gerará avisos MEMBERSHIP_RENEWED para eles.

membership_expiry.pl -c -renew -letter_renew PATRON_RENEWAL

Renovará os usuários cuja associação expira dentro da quantidade de dias definida em MembershipExpiryDaysNotice e gerará avisos personalizados “PATRON_RENEWAL”. Um aviso “PATRON_RENEWAL” deve ter sido criado previamente na ferramenta Avisos e comprovantes.

membership\_expiry.pl -c -before 30

Gerará avisos MEMBERSHIP_EXPIRY para os usuários cuja associação expira 30 dias antes da quantidade de dias definida em MembershipExpiryDaysNotice.

membership_expiry.pl -c -renew -active 3

Renovará os usuários cuja associação expira dentro da quantidade de dias definida em MembershipExpiryDaysNotice e que estiveram ativos nos últimos três meses (a “atividade” é determinada pela preferência do sistema TrackLastPatronActivityTriggers), e gerará avisos MEMBERSHIP_RENEWED.

membership_expiry.pl -c -inactive 6 -letter INACTIVE_PATRON

Gerará avisos personalizados “INACTIVE_PATRON” para os usuários cuja associação expira dentro da quantidade de dias definida em MembershipExpiryDaysNotice e que estiveram inativos nos últimos seis meses (a “atividade” é determinada pela preferência do sistema TrackLastPatronActivityTriggers). Um aviso “INACTIVE_PATRON” deve ter sido criado previamente na ferramenta Avisos e comprovantes.

Em processamento/carrinho de livros

Caminho do script: misc/cronjobs/cart_to_shelf.pl

Função: atualiza todos os exemplares com localização CART para sua localização permanente.

Exigido pelas preferências do sistema NewItemsDefaultLocation, UpdateItemLocationOnCheckin e UpdateItemLocationOnCheckout.

Frequência sugerida: a cada hora

Catálogo

Importar lote de serviço web

Caminho do script: misc/cronjobs/import_webservice_batch.pl

Função: processa filas de lotes de importação do tipo ‘webservice’. Os lotes também podem ser processados pela interface.

Nota

Este script é usado para o OCLC Connexion

Lote de coleta OAI-PMH

Versão

Este script foi introduzido na versão 24.11 do Koha.

Caminho do script: misc/cronjobs/harvest_oai.pl

Função: processa a coleta de registros dos repositórios OAI descritos em Administração.

Frequência sugerida: semanal; embora dependa da frequência com que os registros são criados ou atualizados nos repositórios coletados.

PARÂMETROS

• -h ou --help

  • Imprime uma mensagem breve de ajuda.

• -l ou --list

  • Relaciona os repositórios.

• -r ou --repository

  • ID do repositório que deseja coletar. Essa informação pode ser encontrada em Administração > Repositórios OAI.

• -d ou -–days

  • Quantidade de dias a coletar. Por exemplo: coletar registros atualizados ou criados no repositório remoto nos últimos 10 dias).

• -v ou -–verbose

  • Modo detalhado.

• -f ou -–force

  • Força a coleta sem considerar o datestamp dos registros (a data em que foram criados ou atualizados pela última vez).

Dica

Ao coletar registros de um repositório pela primeira vez, execute o script uma vez com o parâmetro -–force para coletar todos os registros existentes.

Exclusão de exemplares em lote

Caminho do script: misc/cronjobs/delete_items.pl

Função: gera uma consulta no banco de dados de exemplares e exclui os exemplares que atendem aos critérios especificados nos argumentos da linha de comando. É uma ferramenta leve para exclusão de exemplares em lote, adequada para execução como tarefa cron.

PARÂMETROS

• --help

  • Imprime uma mensagem breve de ajuda.

• --man

  • Imprime o manual, com exemplos.

• --verbose

  • Imprime na saída padrão a cláusula “WHERE” gerada pelos argumentos --where coletados, bem como os exemplares afetados.

  • As informações do exemplar impressas são

    • itemnumber

    • código de barras

    • Título

• --where

  • O argumento seguinte deve ser uma instrução SQL sintaticamente válida que faça parte da cláusula WHERE da consulta à tabela items.

  • Pode ser repetido. Se houver vários parâmetros --where, eles serão unidos por AND.

• --del_bibs

  • Quando este parâmetro estiver definido, se o script excluir o último exemplar vinculado a um registro bibliográfico, o registro bibliográfico vazio também será excluído.

  Versão

  O parâmetro --del_bibs foi adicionado na versão 25.11 do Koha.

• --commit

  • Nenhum exemplar será excluído se este parâmetro não estiver presente.

EXEMPLOS DE USO

delete_items.pl --where "items.withdrawn != 0" --where "items.withdrawn_on < $(date --date="13 month ago" --rfc-3339=date)" --commit

Isso excluirá os exemplares cujo status de retirado seja diferente de zero E cuja data de retirada seja anterior a 13 meses.

delete_items.pl --where "itemlost >= '1'" --where "itemlost <='4'" --where "itemlost_on < '2014-04-28'" --commit

Isso excluirá os exemplares cujo status de perdido esteja entre 1 e 4 (inclusive) E que tenham sido perdidos antes de 28/04/2014.

Verificação rápida de URLs

Caminho do script: misc/cronjobs/check-url-quick.pl

Nota

Este script substitui o script obsoleto check-url.pl

Função: verifica URLs dos registros bibliográficos; por padrão, examina todas as URLs encontradas em 856$u e informa se os recursos estão disponíveis.

PARÂMETROS

• –host=http://default.tld Host do servidor usado quando a URL não contém um, isto é, não começa com ‘http:’. Por exemplo, se –host=mylib.com e 856$u contiver ‘img/image.jpg’, a URL verificada será: http://www.mylib.com/image.jpg.

• –tags Campos que contêm URLs nos subcampos $u. Se não for informado, o campo 856 será verificado. Vários campos podem ser especificados, por exemplo:

  check-url-quick.pl –tags 310 410 856

• –verbose|v Exibe URLs bem-sucedidas e com falha.

• –html Formata a saída em HTML. O resultado pode ser redirecionado para um arquivo acessível por HTTP. Assim, é possível criar um link direto para o registro bibliográfico no modo de edição. Com este parâmetro, –host-intranet é obrigatório.

• –host-intranet=http://koha-pro.tld Host do servidor usado para criar um link para a página de edição do registro bibliográfico na interface administrativa do Koha.

• –timeout=10 Tempo limite para obter URLs. O padrão é 10 segundos.

• –maxconn=1000 Quantidade de solicitações HTTP simultâneas. O padrão é 200 conexões.

Excluir registros pelo líder

Caminho do script: misc/cronjobs/delete_records_via_leader.pl

Função: tenta excluir todos os registros MARC em que o caractere 5 do líder seja igual a ‘d’.

PARÂMETROS

• -c|–confirm O script não fará nada sem este parâmetro

• -v|–verbose Modo detalhado

• -t|–test Modo de teste; não exclui registros. O modo de teste não consegue determinar se um registro/exemplar será excluído com sucesso; apenas informa quais registros e exemplares o script tentará excluir.

• -i|–delete-items Tenta excluir os exemplares antes de excluir o registro. Registros com exemplares não podem ser excluídos.

Atualizar autoridades

Caminho do script: misc/cronjobs/merge_authorities.pl

Função: atualiza os dados bibliográficos com as alterações feitas nos registros de autoridade

Nota

O nome deste script é enganoso. Ele não mescla autoridades entre si; em vez disso, mescla dados de autoridade com registros bibliográficos vinculados. As alterações nos registros de autoridade serão aplicadas aos registros bibliográficos que usam essa autoridade quando o script for executado.

Exigido pela preferência do sistema AuthorityMergeLimit

Frequência sugerida: todas as noites

Atualização de periódicos

Caminho do script: misc/cronjobs/serialsUpdate.pl

Função: verifica se há um fascículo “atrasado” em assinaturas ativas; se houver, o script o marcará como atrasado e adicionará o próximo como esperado.

Frequência sugerida: todas as noites

Atualização automática de exemplares

Caminho do script: misc/cronjobs/automatic_item_modification_by_age.pl

Função: atualiza exemplares com base na lista de regras definida na ferramenta Modificações automáticas de exemplares por idade

Exigido por: Modificações automáticas de exemplares por idade

Frequência sugerida: todas as noites

Rotação de acervo

Caminho do script: misc/cronjobs/stockrotation.pl

Função: move exemplares de uma etapa de rotação de acervo para a próxima, se estiverem disponíveis para processamento.

Cada biblioteca receberá um relatório com seus “exemplares de interesse” para as verificações da rota do dia. Cada exemplar deverá, segundo o Koha, estar nas estantes dessa biblioteca e deverá ser recolhido e ter sua devolução registrada.

Nota

O e-mail enviado é baseado no modelo SR_SLIP. Ele pode ser personalizado na ferramenta Avisos e comprovantes.

O exemplar poderá:

• ter sido colocado em trânsito para a biblioteca de sua nova etapa;

• ter sido colocado em trânsito para retornar à biblioteca da etapa atual;

• ter acabado de ser adicionado a uma rota e já estar na biblioteca correta;

Ao registrar a devolução,

• os exemplares que precisarem ser transferidos para outro local serão colocados em trânsito, e uma mensagem pop-up solicitará que sejam enviados para a nova biblioteca.

• os exemplares que já estiverem na biblioteca correta terão a devolução registrada, e nenhuma mensagem pop-up será exibida.

Exigido pela ferramenta Rotação de acervo

Frequência sugerida: todas as noites

PARÂMETROS

• -a|–admin-email

  • Um endereço para o qual os relatórios por e-mail também deverão ser enviados

  • Este é um endereço de e-mail adicional para o qual todos os relatórios serão enviados, além dos endereços das bibliotecas.

• -b|–branchcode

  • Seleciona a biblioteca do relatório por ‘e-mail’ (padrão: todas)

  • Se o relatório por ‘e-mail’ estiver selecionado, você poderá usar o parâmetro ‘branchcode’ para especificar o relatório de qual biblioteca deseja ver.

  • O padrão é ‘todas’.

• -x|–execute

  • Executa efetivamente a manutenção da rotação de acervo

  • Por padrão, este script apenas informa o status atual do subsistema de rotação de acervo. Para colocar efetivamente os exemplares em trânsito, o script deve ser executado com o argumento ‘execute’.

• -r|–report

  • Seleciona ‘full’ ou ‘email’

  • O argumento ‘report’ permite selecionar o tipo de relatório que será produzido.

  • O padrão é ‘full’.

  • Se o relatório por ‘e-mail’ estiver selecionado, você poderá usar o parâmetro ‘branchcode’ para especificar o relatório de qual biblioteca deseja ver.

• -S|–Send-all

  • Envia relatórios por e-mail mesmo que o corpo esteja vazio

  • Este argumento faz com que até relatórios com corpo vazio sejam enviados.

• -s|–send-email

  • Envia relatórios por e-mail

  • Este argumento faz com que o script envie relatórios por e-mail.

• -h|–help

  • Exibe a mensagem de ajuda

OPAC

Feeds RSS

Caminho do script: misc/cronjobs/rss/rss.pl

Função: produz um documento XML RSS para qualquer consulta SQL (não é usado para o feed RSS de resultados da pesquisa). Saiba mais.

Frequência sugerida: a cada hora

Navegador de autoridades

Caminho do script: misc/cronjobs/build_browser_and_cloud.pl

Função: gera conteúdo para navegação por autoridades no OPAC

Exigido pela preferência do sistema OpacBrowser

Importante

Esta preferência e tarefa cron devem ser usadas somente em sistemas franceses.

Nuvens de assuntos/autores

Caminho do script: misc/cronjobs/cloud-kw.pl

Função: gera nuvens de palavras-chave em HTML a partir dos índices Zebra do Koha. misc/cronjobs/cloud-sample.conf contém um exemplo do funcionamento deste script.

Frequência: este tipo de script pode ser executado aproximadamente uma vez por mês, pois o conteúdo gerado não mudará muito ao longo do tempo.

administração do sistema

Limitador de serviços

Caminho do script: misc/cronjobs/services_throttle.pl

Função: redefine o limitador dos serviços xISBN

Frequência sugerida: todas as noites

Limpar banco de dados

Caminho do script: misc/cronjobs/cleanup_database.pl

Função: trunca tabelas do banco de dados do Koha, removendo entradas e arquivos antigos. Consulte a estrutura do banco de dados do Koha para obter detalhes de cada tabela mencionada nos parâmetros do script.

Frequência sugerida: todas as noites

PARÂMETROS

• -h ou --help

  • Imprime uma mensagem breve de ajuda e encerra o script, ignorando todas as outras opções.

• -v ou --verbose

  • Modo detalhado.

• --confirm

  • Sinalizador de confirmação: adicione esta opção depois dos demais parâmetros. Caso contrário, o script apenas imprimirá uma instrução de uso.

• --cards

  • Seguido de uma quantidade de dias.

  • Remove da tabela creator_batches todos os lotes do criador de carteirinhas de usuários adicionados antes da quantidade de dias especificada.

• --del-exp-selfreg

  • Exclui da tabela borrowers as contas de autorregistro expiradas (contas que não foram promovidas da categoria ‘temporária’).

  • A quantidade de dias para expiração é definida na preferência do sistema PatronSelfRegistrationExpireTemporaryAccountsDelay.

  • A categoria temporária de usuário é definida na preferência do sistema PatronSelfRegistrationDefaultCategory.

• --del-unv-selfreg

  • Seguido de uma quantidade de dias.

  • Exclui de borrower_modifications todos os autorregistros não verificados anteriores à quantidade de dias especificada.

• --deleted-catalog

  • Seguido de uma quantidade de dias.

  • Remove das tabelas deletedbiblio, deletedbiblio_metadata, deletedbiblioitems e deleteditems todos os registros bibliográficos excluídos antes da quantidade de dias especificada.

• --deleted-patrons

  • Seguido de uma quantidade de dias.

  • Remove da tabela deletedborrowers todos os usuários excluídos antes da quantidade de dias especificada.

• --edifact-messages

  • Seguido de uma quantidade de dias.

  • Remove da tabela edifact_messages todas as mensagens EDIFACT anteriores à quantidade de dias especificada. Mensagens com o status ‘new’ são isentas e não serão excluídas.

  • O padrão é 365 dias se nenhuma quantidade for especificada.

• --fees

  • Seguido de uma quantidade de dias.

  • Remove da tabela accountlines as entradas anteriores à quantidade de dias especificada nas quais amountoutstanding seja 0 ou NULL.

  • Para este parâmetro, a quantidade de dias especificada deve ser maior ou igual a 1.

• import

  • Seguido de uma quantidade de dias.

  • Remove das tabelas import_batches, import_biblios, import_items, import_record_matches e import_records todas as entradas anteriores à quantidade de dias especificada.

  • Em import_batches, os lotes resultantes de pesquisas Z39.50 são removidos com o parâmetro --z3950 (consulte adiante).

  • O padrão é 60 dias se nenhuma quantidade for especificada.

• --jobs-days

  • Seguido de uma quantidade de dias.

  • Remove todas as tarefas em segundo plano concluídas anteriores à quantidade de dias especificada.

  • O padrão é 1 dia se nenhuma quantidade for especificada.

• --jobs-type

  • Seguido de um tipo de tarefa.

  • Especifica quais tipos de tarefas em segundo plano serão removidos conforme --jobs-days.

  • Usar --jobs-type all removerá todos os tipos.

  • Este parâmetro pode ser repetido.

  • O padrão é o tipo update_elastic_index se omitido.

• --labels

  • Seguido de uma quantidade de dias.

  • Remove da tabela creator_batches todos os lotes de etiquetas de exemplares adicionados antes da quantidade de dias especificada.

• --list-invites

  • Seguido de uma quantidade de dias.

  • Remove da tabela virtualshelfshares os convites (não aceitos) para compartilhamento de listas anteriores à quantidade de dias especificada.

  • O padrão é 14 dias se nenhuma quantidade for especificada.

• --logs

  • Seguido de uma quantidade de dias.

  • Remove da tabela action_logs as entradas anteriores à quantidade de dias especificada.

  • O padrão é 180 dias se nenhuma quantidade for especificada.

• --log-module

  • Especifica quais módulos de action_log serão removidos.

  • Esta opção pode ser repetida.

  • Consulte módulos e ações dos registros de atividades para conhecer os nomes dos módulos.

• --log-action

  • Especifica quais ações serão removidas dos registros.

  • Esta opção pode ser repetida.

  • Consulte módulos e ações dos registros de atividades para conhecer os nomes das ações.

  • Este parâmetro pode ser usado junto com --log-module. Por exemplo, --logs 30 --log-module=MEMBERS --log-action=CREATE removerá da tabela action_logs as entradas da ação CREATE relacionadas ao módulo MEMBERS e anteriores a 30 dias.

• --preserve-log

  • Especifica quais módulos de action_log serão excluídos da remoção.

  • Esta opção pode ser repetida.

  • Consulte módulos e ações dos registros de atividades para conhecer os nomes dos módulos.

• -m ou --mail

  • Seguido de uma quantidade de dias.

  • Remove da tabela message_queue as entradas anteriores à quantidade de dias especificada.

  • O padrão é 30 dias se nenhuma quantidade for especificada.

• --merged

  • Remove as entradas concluídas da tabela need_merge_authorities.

• --messages

  • Seguido de uma quantidade de dias.

  • Remove da tabela messages todas as entradas anteriores à quantidade de dias especificada.

  • O padrão é 365 dias se nenhuma quantidade for especificada.

• --oauth-tokens

  • Exclui tokens OAuth2 expirados.

• --old-issues

  • Seguido de uma quantidade de dias.

  • Remove da tabela old_issues todos os empréstimos de exemplares devolvidos antes da quantidade de dias especificada.

• --old-reserves

  • Seguido de uma quantidade de dias.

  • Remove da tabela old_reserves todas as reservas anteriores à quantidade de dias especificada.

• --pseudo-transactions

  • Remove entradas das tabelas pseudonymized_transactions e pseudonymized_borrower_attributes.

  • Este parâmetro pode ser usado de várias maneiras:

    • com uma quantidade de dias. Por exemplo, --pseudo-transactions 750 removerá entradas anteriores a 750 dias.

    • com --pseudo-transactions-from e/ou --pseudo-transactions-to

      seguido de uma data no formato YYYY-MM-DD. Por exemplo, --pseudo-transactions-from 2023-01-01 --pseudo-transactions-to 2023-12-31 removerá as entradas datadas de 1º de janeiro de 2023 a 31 de dezembro de 2023.

• --reports

  • Seguido de uma quantidade de dias.

  • Remove da tabela saved_reports todos os dados salvos antes da quantidade de dias especificada. Isso se refere aos dados criados ao executar runreport.pl com a opção --store-results.

• --restrictions

  • Seguido de uma quantidade de dias.

  • Remove da tabela borrower_debarments todas as restrições de usuários expiradas há mais tempo que a quantidade de dias especificada.

  • O padrão é 30 dias se nenhuma quantidade for especificada.

• --all-restrictions

  • Remove da tabela borrower_debarments todas as restrições de usuários expiradas.

• --return-claims

  • Remove todas as reclamações de devolução resolvidas anteriores à quantidade de dias definida na preferência do sistema CleanUpDatabaseReturnClaims.

• --searchhistory

  • Seguido de uma quantidade de dias.

  • Remove da tabela search_history as entradas anteriores à quantidade de dias especificada.

  • O padrão é 30 dias se nenhuma quantidade for especificada.

• --sessions

  • Limpa a tabela sessions.

  • Se esta opção for usada enquanto houver usuários autenticados no Koha, eles precisarão entrar novamente.

• --sessdays

  • Seguido de uma quantidade de dias.

  • Remove somente as sessões anteriores à quantidade de dias especificada.

• --statistics

  • Seguido de uma quantidade de dias.

  • Remove das tabelas de estatísticas as entradas anteriores à quantidade de dias especificada.

  Nota

  A tabela statistics é frequentemente usada em relatórios. Certifique-se de compreender as consequências antes de usar este parâmetro.

• --statistics-type

  • Especifica quais tipos de estatísticas serão removidos, por exemplo, localuse, issue, return, renew, writeoff e payment. Isso corresponde aos valores armazenados na coluna statistics.type do banco de dados do Koha <https://schema.koha-community.org/> .

  • Esta opção pode ser repetida.

  • Este parâmetro deve ser usado com --statistics. Por exemplo, --statistics 365 --statistics-type writeoff --statistics-type payment removerá da tabela statistics todas as entradas do tipo writeoff ou payment anteriores a um ano.

  • Se --statistics for usado sem --statistics-type, todos os tipos de estatísticas serão removidos.

  Versão

  O parâmetro --statistics-type foi introduzido na versão 25.05 do Koha.

• --statistics-type-pseudo

  • Remove da tabela statistics todas as entradas com tipos de estatísticas armazenados como transações pseudonimizadas.

  • Quando a pseudonimização está em uso, as transações são armazenadas tanto na tabela statistics quanto em pseudonymized_transactions. Este parâmetro permite remover da tabela statistics as entradas que podem ser consultadas em pseudonymized_transactions.

  • Este parâmetro deve ser usado com --statistics. Por exemplo, --statistics 365 --statistics-type-pseudo removerá das tabelas de estatísticas todas as entradas anteriores a um ano cujo tipo esteja sendo armazenado em pseudonymized_transactions.

  • Este parâmetro pode ser usado junto com --statistics-type. Por exemplo, --statistics 365 --statistics-type-pseudo --statistics-type payment removerá das tabelas de estatísticas todas as entradas anteriores a um ano cujo tipo esteja armazenado em pseudonymized_transactions ou seja payment.

  • Consulte também o parâmetro --pseudo-transactions.

  Versão

  O parâmetro --statistics-type-pseudo foi introduzido na versão 25.05 do Koha.

  Atualmente, a tabela pseudonymized_transactions armazena somente estatísticas dos tipos issue, localuse, return e renew; portanto, somente esses tipos seriam removidos da tabela statistics.

• --temp-uploads

  • Exclui da tabela uploaded_files os envios temporários anteriores à quantidade de dias definida na preferência do sistema UploadPurgeTemporaryFilesDays.

• --temp-uploads-days

  • Seguido de uma quantidade de dias.

  • Substitui o valor da preferência do sistema UploadPurgeTemporaryFilesDays.

• --transfers

  • Seguido de uma quantidade de dias.

  • Remove da tabela branchtransfers todas as transferências concluídas antes da quantidade de dias especificada .

• --unique-holidays

  • Seguido de uma quantidade de dias.

  • Exclui da tabela special_holidays todos os feriados únicos anteriores à quantidade de dias especificada.

• --uploads-missing

  • Seguido de um sinalizador.

  • Exclui os registros de envio de arquivos ausentes quando o sinalizador especificado for verdadeiro; caso contrário, apenas os conta.

• --zebraqueue

  • Seguido de uma quantidade de dias.

  • Remove as entradas concluídas de zebraqueue anteriores à quantidade de dias especificada.

  • O padrão é 30 dias se nenhuma quantidade for especificada.

• --z3950

  • Remove das tabelas de importação os registros resultantes de pesquisas Z39.50.

  • Para remover todas as outras informações de importação, consulte o parâmetro --import acima.

EXEMPLO DE USO

cleanup_database.pl --sessdays 7 --zebraqueue --list-invites --temp-uploads --mail 375
--import 375 --logs 200 --searchhistory 60 --del-exp-selfreg --statistics 731
--pseudo-transactions 1827 --deleted-patrons 1 --restrictions 90 --unique-holidays 180 --confirm

Este script:

• excluirá as sessões do OPAC de usuários cujo último acesso ao site ocorreu há mais de 7 dias;

• manterá por 30 dias o registro das reindexações do Zebra;

• expirará convites para visualizar uma lista compartilhada há mais de 14 dias;

• limpará os envios temporários conforme a preferência do sistema UploadPurgeTemporaryFilesDays;

• removerá os registros de avisos enviados aos usuários há mais de 375 dias;

• excluirá os arquivos enviados para importação em lote depois de 375 dias (embora os registros bibliográficos e de exemplares importados no processo permaneçam);

• limpará os registros de todas as ações realizadas há mais de 200 dias;

• removerá os históricos de pesquisa de usuários e funcionários anteriores a 60 dias;

• excluirá as solicitações de autorregistro de usuários conforme a preferência do sistema PatronSelfRegistrationExpireTemporaryAccountsDelay.

• excluirá as transações armazenadas na tabela statistics com mais de 731 dias;

• limpará os dados de transações pseudonimizadas com mais de 5 anos;

• excluirá completamente os usuários no dia seguinte à exclusão manual na interface administrativa do Koha;

• limpará os registros de restrições expiradas dos usuários quando a restrição tiver sido suspensa há mais de 90 dias;

• removerá do calendário os dias fechados anteriores a 180 dias.

Compartilhar estatísticas de uso

Caminho do script: misc/cronjobs/share_usage_with_koha_community.pl

Função: envia suas informações ao site da comunidade Koha Hea se você estiver compartilhando informações pelo recurso UsageStats

Frequência: mensalmente

Pesquisar inconsistências nos dados

Caminho do script: misc/maintenance/search_for_data_inconsistencies.pl

Função: revela problemas nos dados, como

• exemplares sem biblioteca de origem ou atual

• exemplares sem tipo de material ou com tipo de material inválido

• registros bibliográficos sem tipo de material ou com tipo de material inválido

• registros bibliográficos com MARCXML inválido

• registros bibliográficos sem biblionumber ou biblioitemnumber no MARCXML

• registros bibliográficos sem título

• valores inválidos em campos nos quais a planilha limita a uma categoria de valores autorizados

• registros de autoridade sem tipo de autoridade ou com tipo de autoridade inválido

• usuários com idade superior ou inferior à permitida pela categoria

• ciclos nas relações responsável/assistido (por exemplo, o usuário A é responsável pelo usuário B, que é responsável pelo usuário A)

  Versão

  Esta verificação foi adicionada ao Koha na versão 24.05.

• campos de data (tipos timestamp, datetime e date) que contêm o valor ‘0000-00-00’

  Nota

  O script misc/maintenance/fix_invalid_dates.pl pode ser usado para alterar essas datas inválidas para ‘NULL’.

  Versão

  Esta verificação foi adicionada ao Koha na versão 24.11.

Alguns desses problemas podem causar falhas na circulação ou na pesquisa do catálogo; portanto, é importante corrigi-los.

Não há frequência sugerida. Esta ferramenta deve ser usada quando necessário.

Corrigir datas inválidas

Versão

Este script foi adicionado na versão 24.11 do Koha.

Caminho do script: misc/maintenance/fix_invalid_dates.pl

Função: altera datas ‘0000-00-00’ para ‘NULL’

Podem surgir problemas quando os campos de data contêm ‘0000-00-00’. Este script pode ser usado para alterar essas datas para ‘NULL’.

Nota

Você pode usar o script search_for_data_inconsistencies.pl para encontrar as datas problemáticas.

PARÂMETROS

• -v | --verbose

  • Imprime as colunas que contêm datas inválidas

• -c | --confirm

  • Este parâmetro é necessário para que o script altere qualquer coisa

EXEMPLOS DE USO

./misc/maintenance/fix_invalid_dates.pl --verbose

Isso mostrará quais colunas contêm datas inválidas e a quantidade de ocorrências.

Também alertará que o sinalizador --confirm é necessário para realizar qualquer ação.

./misc/maintenance/fix_invalid_dates.pl --confirm

Isso substituirá as datas ‘0000-00-00’ por ‘NULL’ e informará quantas ocorrências foram corrigidas em cada coluna.

Aquisições

Limpar sugestões antigas

Caminho do script: misc/cronjobs/purge_suggestions.pl

Função: remove sugestões antigas da área de gerenciamento de sugestões.

PARÂMETROS

• help|?

  Exibe a mensagem de ajuda

• days

  Define a idade das sugestões que serão excluídas com base na data ‘gerenciada em’

  Nota

  A preferência do sistema PurgeSuggestionsOlderThan também pode ser usada para definir a quantidade de dias utilizada no script. Ao usar a preferência, não use o parâmetro ‘days’.

  Nota

  A quantidade de dias é baseada na data ‘gerenciada em’ da sugestão.

• confirm

  Este parâmetro é obrigatório para que o script seja executado.

Enviar por e-mail as sugestões a processar

Caminho do script: misc/cronjobs/notice_unprocessed_suggestions.pl

Função: gera um aviso ao proprietário do fundo de que há sugestões que precisam ser processadas

Processamento de mensagens EDI

Caminho do script: misc/cronjobs/edi_cron.pl

Função: envia e recebe mensagens EDI

Frequência: a cada 15 minutos

Remover arquivos EDI temporários

Caminho do script: misc/cronjobs/remove_temporary_edifiles.pl

Função: remove arquivos EDI temporários com mais de 5 dias

Gerenciamento de recursos eletrônicos (ERM)

Tarefa cron de coleta

Caminho do script: /misc/cronjobs/erm_run_harvester.pl

Função: este script executará a coleta SUSHI para todos os provedores ativos de dados de uso configurados no módulo de gerenciamento de recursos eletrônicos.

Frequência: recomenda-se configurá-lo para execução em intervalos regulares (por exemplo, mensalmente, pois os provedores geralmente produzem dados estatísticos todos os meses).

PARÂMETROS

• --help or -h

  • Imprime uma mensagem de ajuda

• --begin-date

  • Define a data inicial da coleta no formato yyyy-mm-dd (por exemplo: ‘2023-08-21’)

• --end-date

  • Define a data final da coleta no formato yyyy-mm-dd (por exemplo: ‘2023-08-21’)

• --dry-run

  • Produz um relatório de execução sem realizar nenhuma ação permanente

• --debug

  • Imprime informações adicionais de depuração durante a execução

EXEMPLO DE USO

erm_run_harvester.pl --begin-date 2023-06-21 --debug

Executará a coleta SUSHI para provedores ativos de dados de uso no período de 21 de junho de 2023 até a data atual (ou até a data para a qual houver dados disponíveis). Serão exibidas informações adicionais de depuração sobre a execução da coleta.

Relatórios

Executar relatório

Caminho do script: misc/cronjobs/runreport.pl

Função: executa relatórios salvos preexistentes e, opcionalmente, envia os resultados por e-mail.

PARÂMETROS

• -h | --help

  • Exibe a mensagem de ajuda

• -m | --man

  • Exibe a documentação completa

  • Equivale a --help --verbose

• -v | --verbose

  • Saída detalhada

  • Sem este parâmetro, somente erros fatais serão informados

• --format=s

  • Seleciona o formato de saída

  • Valores possíveis:

    • texto

    • html

    • csv

    • tsv

  • No momento, ‘text’ e ‘tsv’ produzem saída separada por tabulações

  • O padrão é ‘text’

• -e | --email

  • Envia a saída por e-mail (implícito por --to ou --from)

• --send_empty

  • Envia o e-mail mesmo que o relatório não retorne resultados

• -a | --attachment

  • Anexa o relatório como um arquivo

  • Não pode ser usado com o formato HTML

• --username

  • Nome de usuário a enviar ao servidor SMTP para autenticação

• --password

  • Senha a enviar ao servidor SMTP para autenticação

• --method

  • O tipo de autenticação, isto é, LOGIN, DIGEST-MD5 etc.

• --to=s

  • Endereço de e-mail para o qual os resultados do relatório serão enviados

  • Se --email for especificado, mas --to não, será usado o endereço definido em KohaAdminEmailAddress

• --from=s

  • Endereço de e-mail do remetente do relatório

  • Se --email for especificado, mas --from não, será usado o endereço definido em KohaAdminEmailAddress

• --subject=s

  • Assunto do e-mail

• --param=s

  • Fornece um valor para o parâmetro de tempo de execução

  • Pode ser repetido

  • Forneça um --param para cada parâmetro de tempo de execução solicitado pelo relatório. Os parâmetros não são combinados como na interface administrativa; portanto, talvez seja necessário repeti-los.

• --separator=s

  • Caractere separador

  • Somente para o formato CSV

  • O padrão é vírgula

• --quote=s

  • Caractere de aspas

  • Somente para o formato CSV

  • O padrão é aspas duplas

  • Uma string vazia é permitida

• --store-results

  • Armazena o resultado do relatório na tabela saved_reports do banco de dados.

  • Para acessar os resultados, vá para Relatórios > Relatórios guiados > Relatório salvo.

• --csv-header

  • Adiciona os nomes das colunas como primeira linha da saída CSV

ARGUMENTOS

• reportID

  • Número de ID do relatório em saved_sql.id

  • Vários IDs podem ser especificados

  • Obrigatório

EXEMPLOS DE USO

runreport.pl 1

Exibirá os resultados do relatório 1 no terminal (STDOUT).

runreport.pl 1 5

Exibirá os resultados dos relatórios 1 e 5 no terminal (STDOUT).

runreport.pl --format html --to admin@myDNSname.org 1

Enviará os resultados do relatório 1 para admin@myDNSname.org no formato HTML.

runreport.pl --format html --to admin@myDNSname.org --param CPL --param FICTION 1

Enviará os resultados do relatório 1 para admin@myDNSname.org no formato HTML. ‘CPL’ será fornecido ao primeiro parâmetro de tempo de execução, e ‘FICTION’, ao segundo.

runreport.pl --store-results 1

Salvará os resultados do relatório na tabela saved_reports do banco de dados, e eles ficarão disponíveis na interface administrativa em Relatórios > Relatórios guiados > Relatório salvo.

Dados sociais

Obter relatório de dados sociais

Caminho do script: misc/cronjobs/social_data/get_report_social_data.pl

Função: baixa dados do Babelthèque para adicioná-los aos registros do OPAC

Frequência sugerida: todas as noites

Atualizar dados sociais

Caminho do script: misc/cronjobs/social_data/update_social_data.pl

Função: atualiza os registros do OPAC com dados sociais do Babelthèque

Daemons

Daemons são tarefas executadas continuamente que auxiliam o funcionamento do Koha. O banco de dados e o servidor web são executados como daemons.

Daemons iniciados automaticamente

As versões mais recentes do Koha iniciam dois daemons diferentes para a maioria das instâncias:

• zebra — este é o servidor de índices

• koha-indexer — este daemon atualiza o servidor de índices com dados novos e modificados (registros bibliográficos e autoridades)

Esses daemons são iniciados pelo script /etc/init.d/koha-common.

Daemon de indexação do Zebra

Caminho do script: /usr/sbin/koha-indexer (invocado por /etc/init.d/koha-common)

O script koha-indexer invoca rebuild_zebra.pl no modo daemon. Nesse modo, o script é executado continuamente e verifica o banco de dados a cada 30 segundos em busca de dados novos ou modificados. Registros novos ou alterados são enviados ao Zebra para indexação, o que leva apenas cerca de um segundo. A vantagem dessa abordagem é um sistema de pesquisa que responde muito mais rapidamente às alterações, em comparação com a abordagem por tarefa cron.

Outros daemons

Eles não são iniciados automaticamente pelo Koha. Você pode executá-los manualmente ou criar sua própria unidade systemd para mantê-los em execução.

Daemon de importação do OCLC Connexion

Caminho do script: misc/bin/connexion_import_daemon.pl

Função: escuta solicitações de clientes OCLC Connexion e está em conformidade com a especificação OCLC Gateway.

Consulte Configuração do daemon OCLC Connexion para obter mais detalhes.

Scripts obsoletos

Eles não devem ser executados sem modificações:

Caminho do script: misc/cronjobs/update_items.pl

Caminho do script:misc/cronjobs/smsoverdues.pl

Caminho do script:misc/cronjobs/notifyMailsOp.pl

Caminho do script:misc/cronjobs/reservefix.pl

Caminho do script:misc/cronjobs/zebraqueue_start.pl