Fluxo de trabalho - com escopo

A API de fluxo de trabalho com escopo fornece métodos que podem ser usados em um script de definição de atividade.

Não há construtores para criar uma instância de um objeto de fluxo de trabalho com escopo. Em vez disso, use o objeto de fluxo de trabalho global disponível em scripts de atividade. Este objeto de fluxo de trabalho está disponível em qualquer local de script dentro de um fluxo de trabalho.

Fluxo de trabalho com escopo - debug(cadeia de caracteres "mensagem", "argumentos do objeto")

Adiciona uma mensagem de depuração ao log.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	A mensagem a ser adicionada ao log.
args	Objeto	Argumentos a serem adicionados à mensagem.

Tabela 2. Retorna

Tipo	Descrição
Cadeia de caracteres	A mensagem adicionada ao log.

var loggedMessage = workflow.debug("All is well");

Fluxo de trabalho com escopo - erro (cadeia de caracteres mensagem, argumentos de objeto)

Adiciona uma mensagem de erro ao log.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	A mensagem a ser adicionada ao log.
args	Objeto	Argumentos a serem adicionados à mensagem.

Tabela 4. Retorna

Tipo	Descrição
Cadeia de caracteres	A mensagem registrada

var loggedMessage = workflow.error("An error has occurred. ");

Fluxo de trabalho com escopo - getVariable(String name)

Retorna o valor da variável especificada.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	O nome da variável

Tabela 6. Retorna

Tipo	Descrição
Objeto	O valor da variável

var value = workflow.getVariable("task");

Fluxo de trabalho com escopo - info(cadeia de caracteres "mensagem", "argumentos do objeto")

Adiciona uma mensagem informativa ao log.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	A mensagem a ser adicionada ao log.
args	Objeto	Argumentos a serem adicionados à mensagem.

Tabela 8. Retorna

Tipo	Descrição
Cadeia de caracteres	A mensagem registrada em log.

var loggedMessage = workflow.info("All is well");

Fluxo de trabalho com escopo - entradas

Objeto que contém as variáveis de fluxo de trabalho.

Este não é um método, mas uma maneira de fazer referência a variáveis em um objeto de fluxo de trabalho, como o usuário. As variáveis de fluxo de trabalho são definidas nas propriedades do fluxo de trabalho ou por atividades com script.

Tabela 9. Campo

Nome	Tipo	Descrição
entradas	Objeto	Variáveis de fluxo de trabalho como pares de valor de nome. As variáveis de um objeto de fluxo de trabalho são personalizadas para a implementação de um integrador.

var user = workflow.inputs.u_user;

Fluxo de trabalho com escopo - name()

Retorna o nome do fluxo de trabalho.

Tabela 10. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 11. Retorna

Tipo	Descrição
Cadeia de caracteres	O nome do fluxo de trabalho

var name = workflow.name();

Fluxo de trabalho com escopo - removeVariable(String name)

Remove a variável especificada do fluxo de trabalho.

Tabela 12. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	O nome da variável

Tabela 13. Retorna

Tipo	Descrição
vazio

var value = workflow.removeVariable("task");

Fluxo de trabalho com escopo - resultado

Elemento do objeto de fluxo de trabalho que contém os resultados do fluxo de trabalho.

Este não é um método, mas sim o elemento no objeto de fluxo de trabalho que contém os resultados de um fluxo de trabalho.

Tabela 14. Campo

Nome	Tipo	Descrição
resultado	Cadeia de caracteres	Resultados do fluxo de trabalho.

var wfResult = workflow.result;

Fluxo de trabalho com escopo - bloco de anotações ()

Retorna o objeto de bloco de anotações do fluxo de trabalho.

Tabela 15. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 16. Retorna

Tipo	Descrição
Objeto	O objeto de bloco de anotações.

var scratchpad = workflow.scratchpad();

Fluxo de trabalho com escopo - setResult(String result)

Define o resultado do fluxo de trabalho.

Tabela 17. Parâmetros

Nome	Tipo	Descrição
resultado	Cadeia de caracteres	O resultado do fluxo de trabalho

Tabela 18. Retorna

Tipo	Descrição
vazio

workflow.setResult("Success");

Fluxo de trabalho com escopo - setVariable(cadeia de caracteres name, Object value)

Define a variável especificada para o valor especificado.

Tabela 19. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	O nome da variável
valor	Objeto	O valor a ser atribuído à variável.

Tabela 20. Retorna

Tipo	Descrição
vazio

workflow.setVariable("task", "terrible");

Fluxo de trabalho com escopo - aviso (cadeia de caracteres "mensagem", "argumentos do objeto")

Adiciona uma mensagem de aviso ao log.

Tabela 21. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	A mensagem a ser adicionada ao log.
args	Objeto	Argumentos a serem adicionados à mensagem.

Tabela 22. Retorna

Tipo	Descrição
Cadeia de caracteres	A mensagem registrada

var loggedMessage = workflow.warn("Check your permissions.");