nginstack

Class: VisualizationSchedulerJob

@nginstack/web-framework/lib/dsv/VisualizationSchedulerJob~ VisualizationSchedulerJob

new VisualizationSchedulerJob()

Classe responsável pela manipulação de um relatório agendado.

Members

filters :Object.<string, *>

Filtros do relatório que será executado por este agendamento. Os filtros são representados por um mapa associando os nomes dos filtros aos seus valores.

Type:
  • Object.<string, *>

key :number

Chave do agendamento na tabela iSchedulerTask do banco de dados.

Type:
  • number

<readonly> name :string

Nome da tarefa.

Type:
  • string

recipients :Array.<{name: string, address: string}>

Destinatários do agendamento. Cada item deste array deverá ser um objeto contendo as propriedades name e address.

Type:
  • Array.<{name: string, address: string}>

report :number

Chave do relatório que deverá ser executado por este Job.

Type:
  • number

Methods

<static> formatParametersField(jobKey, dsvKey, filters, recipients)

Formata o valor do campo iParameters do Job que irá gravar esta tarefa.

Parameters:
Name Type Description
jobKey number

Chave do agendamento.
dsvKey number

Chave do datasource visualization.
filters Object

Mapa dos nomes dos filtros e os valores que deverão ser utilizados na execução DSV.
recipients Array.<{name: string, address: string}>

Array contendo objetos que indicam quais são os destinatários do relatório que será enviado por email. Cada objeto do array deverá ser um objeto contendo as propriedades name e address.
Returns:

Valor que deverá ser gravado no campo iParameters do Job.

Type
string

<static> getServer()

Obtém a chave do servidor responsável pela execução e envio dos relatório agendados. Caso não haja servidor configurado, será gerado um erro.

Returns:

Chave do servidor.

Type
number

<static> parseParametersField(Dados)

Restaura os valores serializados pelo método #formatParametersField.

Parameters:
Name Type Description
Dados string

serializados gerados pelo método #formatParametersField.
Returns:

Será retornado um objeto contendo as propriedades jobKey, dsvKey, filters e recipients, informados na execução do #formatParametersField.

Type
Object

<static> syncServerScheduler()

Sincroniza os jobs do scheduler do servidor de execução com os agendamentos gravados na tabela iSchedulerTask do banco de dados.

<static> tryGetServer()

Obtém a chave do servidor responsável pela execução e envio dos relatório agendados. Caso não haja servidor configurado, será retornado null.

Returns:

Chave do servidor.

Type
number

loadFromEnvironment()

Restaura um Job em execução pelo scheduler. Este método irá utilizar variáveis globais definidas na criação do Job no Scheduler. Ele deve ser utilizado apenas dentro do script que irá executar o Job.

loadFromKey(key)

Restaura um Job gravado previamente no banco de dados.

Parameters:
Name Type Description
key number

Chave do agendamento armazenado na tabela iSchedulerTask.

run()

Executa o relatório agendado e envia o resultado para todos os emails informados em #recipients.