nginstack

Class: ProcessManager

@nginstack/web-framework/lib/process/ProcessManager~ ProcessManager

new ProcessManager()

Objeto responsável por gerenciar todos os processos do Web Framework abertos em uma sessão de usuário.

Uma instância global do ProcessManager é publicada por meio da propriedade session.runProcess para garantir a compatibilidade com scripts legados da Virtual File System.

Members

<static> restrictAllowedProcesses

Define quais processos podem ser executados pelo usuário. Uma vez definidos, os processos permitidos não podem ser alterados, apenas complementados por uma nova chamada a este método.

iClass :DataSet

Type:

iVfs :DataSet

Type:

onAfterRun :Adapter

Evento disparado após a execução de cada interação ou atividade de um processo. Essa função recebe a instância do processo como parâmetro.

Type:
  • Adapter
Deprecated:
  • Use this.on('afterRunInteraction', listener);

onBeforeRun :Adapter

Evento disparado antes de cada execução de interação ou atividade de um processo. Essa função recebe a instância do processo como parâmetro.

Type:
  • Adapter
Deprecated:
  • Use this.on('beforeRunInteraction', listener);

publishedFileIds

Tabela que mapeia os ids a arquivos. Apenas arquivos nesta lista podem ser requisitados por "handleGetFileRequest()"

Methods

<static> getInstance()

Obtém o gerenciador de processos do Web Framework associado à sessão corrente.

Returns:
Type
ProcessManager

closeProcess(id)

Fecha o processo informado.

Parameters:
Name Type Description
id number

O identificador do processo.

findProcess(id)

Pesquisa um processo aberto pelo seu id.

Parameters:
Name Type Description
id string

Identificador único do processo.
Returns:

Processo encontrado ou null caso não exista um com o id informado.

Type
Process

getCurrentProcess()

Processo que está sendo executado no instante em que este método é chamado.

Returns:
Type
Process

getProcessById(id)

Obtém a instância de um processo a partir do seu id.

Parameters:
Name Type Description
id string

Identificador único do processo do Web Framework.
Returns:
Type
Process

notifyUsage( [lastUse])

Notifica que o sistema foi utilizado pelo usuário.

Parameters:
Name Type Argument Description
lastUse number <optional>

Timestamp da última utilização conhecida do sistema. Caso não seja informado, será utilizado Date.now().

verifySessionTimeouts()

Verifica por quanto tempo a sessão do usuário ainda pode ficar inativa ou com a tela travada.

Returns:

Tempo remanescente de inatividade e de vida da sessão com a tela bloqueada.

Type
SessionTimeoutsInfo

Events

afterCreateProcess

Evento emitido após a criação de um novo processo no Web Framework. Seu uso é recomendado para customizações que devem ser aplicadas a todos os processos do sistema.

O processo recém criado estará disponível na propriedade process do evento.

Por ser um evento global que afetará todos os processos, é recomendado que ele seja definido em um script de inicialização do Web Framework (/Configuração/Inicialização do Web Framework).

Type: ProcessCreateEvent
See:
  • module:@nginstack/web-framework/lib/process/ProcessCreationEvent
Example
const ProcessManager = require('@nginstack/web-framework/lib/process/ProcessManager');

const processManager = ProcessManager.getInstance();
processManager.on('afterCreateProcess', function (event) {
  event.process.help += '\nAdiciona uma ajuda padrão aos processos.';
});

afterRunInteraction

Evento disparado após cada execução de interação ou atividade de um processo. Uma referência para o processo pode ser acessado através da propriedade process.

Type: ProcessInteractionEvent
See:

beforeRunInteraction

Evento disparado antes de cada execução de interação ou atividade de um processo. Uma referência para o processo pode ser acessado através da propriedade process.

Type: ProcessInteractionEvent
See:

processError

Evento emitido quando um erro é disparado durante a execução de um processo. Seu uso é recomendado para customizações sobre o diálogo de erro que será exibido ou sobre o próprio erro.

O erro estará disponível na propriedade error do evento.

Por ser um evento global que afetará todos os processos, é recomendado que ele seja definido em um script de inicialização do Web Framework (/Configuração/Inicialização do Web Framework).

Type: ProcessErrorEvent
See:
  • module:@nginstack/web-framework/lib/process/ProcessErrorEvent
Example
const ProcessManager = require('@nginstack/web-framework/lib/process/ProcessManager');

const processManager = ProcessManager.getInstance();
processManager.on('processError', function (event) {
  if (event.error instanceof DetailedError) {
    event.dialogTitle = 'Erro detalhado';
  }

  if (event.error.solution) {
    event.error.solution += (!event.error.solution.endsWith('.') ? '. ' : ' ') +
        'Abra um ticket.';
  } else {
    event.error.solution += 'Abra um ticket.';
  }
});