O Workiva Scripting está incluído no Customize Workiva. Para usar o Scripting, seu espaço de trabalho deve ter a opção “Personalizar Workiva/Scripting” ativada, e os usuários precisarão das funções de Scripting adequadas e das permissões de arquivo necessárias.
Visão geral e configuração de scripts
Como os scripts são normalmente usados?
O Workiva Scripting pode automatizar muitas tarefas repetitivas e demoradas que, de outra forma, seriam realizadas manualmente. Alguns casos de uso comuns incluem supressão de linha zero, layouts de relatórios e a aplicação de formatação personalizada a vários documentos.
De maneira mais ampla, os scripts podem ser adaptados às necessidades específicas da sua empresa — permitindo que você personalize e dimensione os fluxos de trabalho de acordo com a forma como sua organização funciona, com uma execução controlada na qual você pode confiar. O código é seu; o que você faz com ele depende muito do desenvolvedor do script, da configuração do espaço de trabalho e do número atual de processos manuais em sua empresa. E à medida que mais tarefas passam a contar com o auxílio da IA, o Scripting oferece a essas tarefas uma base confiável e repetível sobre a qual agir.
Existem limites para a criação de scripts?
Sim, a Workiva impõe uma série de limites tanto para o Workiva Scripting quanto para a API de script.
Saiba mais sobre os limites de script do Workiva no .
Como aciono scripts de cadeias?
Para isso, você precisa do conector Workiva Scripting.
Consulte os artigos abaixo para saber mais:
O Workiva Scripting está em conformidade com o FedRAMP?
Sim. Os scripts são executados em uma infraestrutura gerenciada pela Workiva e em conformidade com o FedRAMP, com as mesmas permissões de plataforma e controles de governança que o restante do conteúdo da Workiva.
Como posso proteger o acesso aos scripts?
Há várias maneiras de você proteger seu código contra o acesso de usuários não autorizados:
- Crie um espaço de trabalho ou uma organização dedicada para usuários autorizados: Criar um espaço de trabalho, ou mesmo uma organização inteira, somente para usuários autorizados é a opção mais segura. Por exemplo, os parceiros podem criar um espaço de trabalho para o Workiva Scripting em sua organização e fazer com que os clientes executem scripts de sua própria organização.
- Use as funções : As funções de script do Workiva — Editor de Scripts, Visualizador de Scripts e Executor de Scripts — são organizadas em níveis, de modo que os usuários possam acessar apenas os scripts necessários para seu trabalho. A função “Script Runner” permite que os usuários executem scripts sem precisar visualizar o código.
- Permissões de uso: Os arquivos de script podem ser restritos no nível do arquivo para que somente usuários específicos possam editar ou visualizar o código.
Saiba mais sobre as funções e permissões de script do Workiva no site .
Você tem uma lista de IPs permitidos para a criação de scripts?
Sim, os IPs permitidos para o programa de script estão incluídos aqui.
Você tem uma biblioteca de scripts disponível?
Sim. Reunimos vários scripts de amostra para você usar. Você também pode criar o seu próprio script usando os artigos com instruções na seção “ : Criar e gerenciar scripts” do Centro de Suporte.
Usando o editor de scripts
Como faço para gerenciar versões de scripts?
No momento, a Workiva armazena apenas a versão mais recente de um script.
Você pode criar cópias dos seus arquivos de script no Workiva e organizá-las em pastas, mas recomendamos o uso de um sistema de controle de versão separado — especialmente se você tiver um sistema de controle de versão corporativo; consulte Workiva Scripting: Melhores práticas do processo de desenvolvimento .
Como sincronizar o código da Workiva com um sistema de controle de versão corporativo (por exemplo, GitHub)?
A API de scripts da Workiva “ ” ( ) oferece pontos de conexão de gerenciamento de código-fonte para recuperar e atualizar arquivos-fonte de scripts. Para recuperar fontes, é necessário o script :read ; para criar, atualizar, enviar ou sincronizar fontes, é necessário o script :write . O Workiva não sincroniza automaticamente os scripts com sistemas externos de controle de versão, como GitHub, GitLab ou SVN.
Para obter instruções sobre como criar ou atualizar uma autorização de API, consulte Configuração da API da Workiva .
Como faço para acessar as credenciais dos sistemas Workiva e não Workiva a partir de um script?
Há duas maneiras de acessar as credenciais dos sistemas Workiva e não Workiva:
- Enviar credenciais como entradas de tempo de execução (preferencial)
- Codifique as credenciais no código
Por que os valores das entradas de tempo de execução do script não são exibidos na saída do log durante a execução?
Essa é uma precaução de segurança. Como os parâmetros de entrada podem conter dados confidenciais, nós os removemos dos logs voltados para o usuário.
Como posso armazenar dados temporários durante a execução de scripts?
Os scripts do Workiva podem usar a função `Open` do Python ( ) para ler e gravar arquivos temporariamente na pasta /tmp . Outros caminhos são restritos.
Toda vez que um script é executado, um contêiner é criado na infraestrutura de nuvem da Workiva. Esse contêiner tem o Linux instalado, e todos os caminhos estão restritos, exceto , /tmp e (que está vazio). Os dados podem ser gravados e lidos temporariamente nesse caminho. Quando a execução termina, o contêiner é descartado.
Posso definir variáveis globais para usar em vários scripts, à la Chains?
No momento, não. No entanto, se o seu script for executado como parte de um fluxo de trabalho do Chains, você pode usar variáveis do Chains e passar seus valores para o script como entradas em tempo de execução.
Posso enviar arquivos como parâmetros?
Os binários podem ser enviados como parâmetros, desde que não excedam 128 KB e sejam codificados como texto (ou seja, binary to text encoding).
Posso acessar o ID da organização, o ID do espaço de trabalho e a região nos meus scripts?
Sim, o ID da organização, o ID do espaço de trabalho e a região (EUA, APAC, CA, UE) estão disponíveis para o seu script por meio de variáveis de ambiente. Por exemplo, os.getenv("WORKIVA_ORGANIZATION_ID").
| Variável | Descrição |
|---|---|
| WORKIVA_ORGANIZATION_ID | O ID exclusivo da organização Workiva na qual o script está hospedado. |
| WORKIVA_ACCOUNT_ID | O ID exclusivo do espaço de trabalho do Workiva onde o script está hospedado. |
| DOMÍNIO DO CLUSTER DA WORKIVA | A região da Workiva (EUA, APAC, Canadá ou UE) do ambiente de produção onde o script está hospedado. |
| WORKIVA_SCRIPTING_SCRIPT_ID | O ID exclusivo do script de Scripting que está sendo executado. |
| WORKIVA_SCRIPTING_RUN_ID | O ID exclusivo da execução atual do script. |
| WORKIVA_SCRIPTING_MEMORY_LIMIT | A quantidade máxima de RAM disponível para o script durante uma única execução. |
| WORKIVA_SCRIPTING_DISK_LIMIT | O espaço máximo em disco que o script pode utilizar no diretório /tmp durante uma única execução.
|
Posso usar o código de um script da Workiva em outro script da Workiva?
Não é possível importar ou chamar diretamente um script do Workiva a partir de outro. No caso de um pequeno trecho de código reutilizável, você pode copiá-lo e colá-lo em cada script que precisar dele.
Para códigos que você reutiliza em vários scripts, uma abordagem melhor é agrupá-los como uma dependência compartilhada. Você pode criar um pacote em dependencies.zip que inclua suas bibliotecas compartilhadas — e até mesmo o código cliente gerado a partir da especificação da API pública da Workiva — e, em seguida, enviar esse mesmo pacote para cada script que precisar dele. Isso permite que você mantenha o código comum em um único lugar e o reutilize em vários scripts, em vez de copiá-lo para cada um deles.
Para obter instruções sobre como criar e enviar dependências, consulte Bibliotecas de scripts e dependências compatíveis .
Usando scripts de automações
Posso executar um script hospedado em outro espaço de trabalho, organização ou região (APAC, CA, UE ou EUA)?
As automações do Workiva podem executar apenas scripts localizados no mesmo espaço de trabalho que o arquivo. Para executar um script em outro espaço de trabalho, organização ou região, use o conector de script do Workiva “ ” ou a API de script do Workiva “ ” .
Ao usar a API de Scripting, crie a autorização da API no espaço de trabalho que hospeda o script de destino. A concessão exige o script :execute ; caso a integração recupere o status da execução, os registros ou a saída, também é necessário o script :read . Para obter instruções sobre como criar ou atualizar uma autorização de API, consulte Configuração da API da Workiva .
Posso enviar entradas/parâmetros de tempo de execução na execução do script?
No momento, o recurso de automação não permite entradas em tempo de execução que são enviadas ao script quando ele é executado.
Quais metadados são enviados para a execução de um script a partir de uma automação?O ID do espaço de trabalho é enviado?
Quando um script é executado a partir de uma automação, os seguintes parâmetros são enviados:
- DOCUMENT_ID: A ID do documento em que a automação é executada.
- INPUT_SHEET_ID: O WURL da planilha usada para gerenciar os parâmetros de entrada da automação.
- INPUT_RESOURCE_ID : O WURL da seção na planilha “input”.
- INPUT_SPREADSHEET_ID : O ID da planilha de “entrada”.
- INPUT_SPREADSHEET_SHEET_ID : O ID da seção na planilha de “entrada”.
Para obter mais informações, consulte a página de suporte do Workiva Execute scripts com automações .
Como faço para acessar as credenciais dos sistemas Workiva e não Workiva a partir da execução do script?
Quando um script é executado a partir de uma automação, a única opção é codificar as credenciais no próprio código.
O mesmo script pode ser executado simultaneamente a partir de dois ou mais arquivos?
Sim, um script pode ser executado simultaneamente a partir do mesmo arquivo ou de vários arquivos.
Usando scripts de cadeias
Posso executar um script hospedado em outro espaço de trabalho, organização ou região (APAC, Canadá, EMEA, EUA)?
Sim, um script hospedado em um espaço de trabalho pode ser executado por uma cadeia hospedada em um espaço de trabalho, organização ou ambiente diferente.
Para fazer isso, o conector Workiva Scripting usado na cadeia deve ser configurado com uma concessão de API criada no espaço de trabalho do host, e os URLs de script/IAM usados devem corresponder ao espaço de trabalho correto.
Consulte os artigos a seguir para saber mais:
Você pode executar o mesmo script simultaneamente a partir de dois nós?
O mesmo script pode ser executado simultaneamente a partir de vários nós em uma mesma cadeia ou em várias cadeias.
Como posso usar a saída de um script em outro nó de cadeia?
O comando “ ” do Run Script permite que você insira uma carga de exemplo para cada saída que gere JSON. Essa saída pode, então, ser utilizada em outros nós.
É possível passar um arquivo temporário para um script a partir de uma cadeia?
Você pode definir binários como parâmetros, desde que eles não excedam 128 KB.
APIs e bibliotecas
Quais APIs e bibliotecas são compatíveis?
Atualmente, o Workiva Scripting é compatível com:
- APIs públicas do Workiva
- APIs que não são da Workiva
- Biblioteca padrão do Python
- Índice de pacotes Python (PyPI)
No momento, o Workiva Scripting oferece suporte apenas ao Python.
Para saber mais, consulte a página de suporte da Workiva Bibliotecas de scripts e dependências compatíveis com a Workiva .
Qual versão do Python é usada no Workiva Scripting?
Os novos scripts são executados no Python 3.13. O Workiva Scripting ainda oferece suporte aos scripts existentes em Python 3.9, mas o suporte ao Python 3.9 será encerrado em outubro de 2027 — portanto, você deve migrar todos os scripts em Python 3.9 para o Python 3.13 o mais rápido possível.
Para saber mais, consulte a página de suporte do Workiva: . Migração de scripts para o Python 3.13 no Workiva: .
A Workiva fornece clientes de API com linguagens populares como Python ou Java?
Atualmente, não fornecemos SDKs públicos para Python ou Java.
No entanto, fornecemos especificações de API abertas para as APIs da Workiva para que você mesmo possa gerar essas bibliotecas. Por exemplo, você pode obter o arquivo OAS da API da Workiva Platform e gerar uma biblioteca de cliente.
Você tem APIs específicas de script disponíveis?
Sim. A API de script pública está disponível a partir da versão 2026-01-01 da API da Workiva. Envie “X-Version: 2026-01-01” em todas as solicitações.
Consulte o guia da API de scripts do para conhecer as operações compatíveis, os escopos e os requisitos.
Como faço para criar e visualizar concessões de API para as APIs públicas da Workiva?
Você precisará obter um ID e um segredo de cliente seguindo as instruções de aqui.
Como faço para autorizar as APIs públicas da Workiva usando Python?
O exemplo a seguir obtém um token de acesso e recupera os scripts acessíveis à concessão da API em seu espaço de trabalho. A concessão da API exige o escopo script:read . Para obter instruções sobre como criar ou atualizar uma autorização de API, consulte Configuração da API da Workiva .
import os import requests AUTH_URL = "https://api.app.wdesk.com/oauth2/token" SCRIPTING_API_URL = "https://api.app.wdesk.com/scripts" API_VERSION = "2026-01-01" CLIENT_ID = os.environ["CLIENT_ID"] CLIENT_SECRET = os.environ["CLIENT_SECRET"] token_response = requests.post( AUTH_URL, headers={ "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8", "X-Version": API_VERSION, }, data={ "client_id": CLIENT_ID, "client_secret": CLIENT_SECRET, "grant_type": "client_credentials", }, timeout=30, ) token_response.raise_for_status() headers = { "Authorization": f"Bearer {token_response.json()['access_token']}", "X-Version": API_VERSION, } scripts_response = requests.get( SCRIPTING_API_URL, headers=headers, timeout=30, ) scripts_response.raise_for_status() print(scripts_response.json())Como faço para atualizar o formato das células usando Python?
É possível atualizar a formatação das células a partir de um script chamando o endpoint “ ” da API da Plataforma Workiva para atualizar o conteúdo da planilha ( POST /spreadsheets/{spreadsheetId}/sheets/{sheetId}/update ).
- Use o campo `
applyFormats ` para aplicar formatos como negrito, formatação de números e moedas e sombreamento, e `applyBorders `para aplicar bordas. - Recomendamos que você agrupe várias operações de formatação em uma única solicitação — cada campo aceita uma matriz de operações, e o endpoint tem limitação de taxa — em vez de enviar uma solicitação por intervalo.
Para obter mais informações, consulte as seguintes páginas do Workiva para desenvolvedores:
Posso ler/gravar ou carregar arquivos que não sejam da Workiva armazenados na Workiva?
Sim. Usando as APIs de gerenciamento de arquivos da Workiva, você pode enviar arquivos que não sejam da Workiva — como PDFs, imagens ou outros tipos de arquivos — para a plataforma como Documentos de Apoio , que preservam o arquivo original tal como está. Para fazer o upload de um arquivo, use o endpoint de importação de arquivos com ` `, tipo ` ` definido como ` `, e `SupportingDocument` como ` `. Os documentos de apoio aparecem junto com seus outros arquivos do Workiva e podem ser listados, movidos, copiados, exportados (baixados) e enviados para a lixeira, como qualquer outro arquivo.
Saiba mais: Introdução às APIs de gerenciamento de arquivos
Posso criar e gerenciar automações de forma programática?
No momento, não há pontos de extremidade disponíveis para criar ou gerenciar automações de forma programática.