ScriptsGuia

Visão geral e uso

Nem todo mundo que executa um script precisa ver o código. A página Visão geral é a página do script para quem o opera: o formulário de entradas, a saída e os logs da execução, as execuções ao vivo com o que iniciou cada uma, o estado e os gatilhos — sobre a versão publicada. E como os scripts se importam, se chamam e se iniciam, o Waiso sempre sabe o que usa um script: a aba Usado por lista, a página Code marca os scripts que nada usa, e uma exclusão que quebraria algo pergunta antes.

6 min de leituraAntes: Escrevendo código, Publique a versão testadaAbrir no Waiso
O que você vai aprender
  • Abrir a Visão geral de um script e executar a versão publicada ali
  • Ler a lista de execuções ao vivo e o que iniciou cada uma
  • Ver quem usa um script em Usado por e achar scripts sem uso
  • Apagar um script com segurança — ou de propósito, forçando

Uma página para executar, não editar

Abra pelo editor: a engrenagem Configuração → Visão geral (Execute e acompanhe as execuções, sem o código). O endereço é o caminho do script com /overview no fim — /projects/acme/scripts/reports/daily/overview — então dá para guardar nos favoritos ou mandar para um colega. Nada na página edita código; Abrir editor no topo leva de volta.

docs-demoCódigohelloVisão geralAbrir editor
helloAs execuções daqui usam a versão publicada.
EntradasVisualJSON
Pronto para rodar · 1 entradaRodar script
ExecuçõesLive
GatilhosEditar no editor →
APIAbrir na página da API
Outro sistema inicia este script com uma requisição HTTP — copie a URL ou o curl abaixo.
POST/exec/p_58e3011e/hello
ModoSyncAuthBearerLimite60/minStatus
AgendamentosAbrir em Agendamentos
morning_helloDias úteis às 08:00Ativo
Adicionar agendamento
Eventos
Rode este script quando algo acontecer em outro lugar: chega um e-mail, uma linha do banco muda, chega uma mensagem MQTT.Adicionar gatilho de evento
O formulário de entradas e a lista de execuções ao vivo à esquerda, os gatilhos à direita.
ParteO que faz
EntradasO mesmo formulário tipado do editor, para as entradas da versão publicada; Rodar inicia uma execução dessa versão
Saída e LogsO resultado e as linhas de log da execução que você iniciou ou escolheu
ExecuçõesAs execuções deste script, atualizadas Ao vivo: Status, Execução, Gatilho, Início, Duração; Todas as execuções abre a página Execuções filtrada nele
EstadoOs valores que as execuções guardam — veja Estado
GatilhosO endpoint da API, os agendamentos e os gatilhos de evento, só leitura, com Editar no editor

Execute e acompanhe as execuções

  1. Preencha as entradas e execute

    Preencha o formulário e clique em Rodar. A execução aparece no topo da lista como Manual, e a saída e os logs preenchem os cartões enquanto ela anda.

  2. Veja quem iniciou cada execução

    A coluna Gatilho traz um chip por execução: Manual, API com o nome do token, Agendamento com o nome, Flow, E-mail, Mudança no banco, MQTT.

  3. Abra uma execução anterior

    Clique numa linha para ver a saída e os logs daquela execução; Fechar esta execução volta ao formulário.

Quem usa um script

A aba lateral Usado por do editor — com a contagem ao lado do nome — responde “o que quebra se eu mudar isto?”. Ela agrupa cada lugar que usa o script, marcados como Rascunho ou Publicado:

  • Importado por — scripts que o importam como biblioteca.
  • Chamado pelo SDK — scripts que o executam pela chamada de execução do SDK.
  • Passos de flow — passos de flow que o executam.
  • Iniciam este script — os agendamentos, o endpoint da API e os gatilhos de evento dele.

A introdução diz quantos lugares o usam, e um lembrete: Mudar este script muda os rascunhos deles; as versões publicadas continuam com a cópia de quando foram publicadas. Um script que nada usa diz Nada importa, chama ou inicia este script.

Ache o que nada usa

Na página Code, um script que nada importa, chama, roda como passo de flow, agenda ou inicia pela API ou por um evento tem a marca Sem uso. O painel da página Code conta esses scripts na linha Sem uso — clique para listar só eles — e o menu de filtros tem o mesmo filtro Not used. É uma pista para faxina, não um veredito: um script que você roda à mão pelo editor continua “sem uso”.

Apagando um script em uso

Apagar um script que algo usa é recusado de início. A página Code mostra uma confirmação — Isso vai afetar outros itens — listando cada uso com o tipo e se um rascunho ou a versão publicada depende dele, e avisa A próxima verificação ou execução deles falha com um import quebrado. Apagar assim mesmo apaga; Cancelar mantém, para você apontar quem usa para outro lugar antes. Apagar uma pasta confere cada script dentro dela do mesmo jeito.

Pela API vale a mesma regra: uma exclusão responde 409 com o código script_in_use e a lista usages, e só ?force=true apaga mesmo assim.

Shelldelete-script.sh
# Refused while something uses the script: 409 with the list
curl -X DELETE "$WAISO_URL/api/projects/$PROJECT_ID/scripts/$SCRIPT_ID" \
  -H "Authorization: Bearer $TOKEN"

# Deletes it anyway; whatever used it breaks on its next check or run
curl -X DELETE "$WAISO_URL/api/projects/$PROJECT_ID/scripts/$SCRIPT_ID?force=true" \
  -H "Authorization: Bearer $TOKEN"
Saída esperadaSucessoA primeira chamada, enquanto dois itens usam o script
{
  "error": "this script is used by 2 item(s); use force=true to delete anyway",
  "code": "script_in_use",
  "usages": [
    "…"
  ]
}

Limites

  • A página Visão geral sempre executa a versão publicada; para testar um rascunho, use o editor.
  • Executar por ela exige permissão para executar o script; sem isso, o Rodar diz Você não pode executar este script.
  • O Usado por é calculado quando você abre a aba, a partir do projeto como ele está agora.

Assuntos relacionados