Como criei um PS1 GUI Utility para facilitar operações no ServiceNow
Este artigo resume o contexto, o desenho e os resultados de um utilitário PowerShell com GUI para exportação padronizada de dados e definição de Database View no ServiceNow.
Introdução
Ao trabalhar continuamente com a operação e a manutenção do ServiceNow, a criação de Database Views tende a ficar dependente de pessoas específicas, pois exige conhecimentos básicos de bancos relacionais (RDB). Além disso, ao tentar aproveitar os dados pela GUI, volumes grandes podem ultrapassar os limites e inviabilizar a exportação, as colunas obtidas podem mudar conforme o estado da visualização em lista, e os anexos ficam espalhados pelos registros, tornando a coleta trabalhosa. Por isso criei um utilitário PowerShell com GUI para apoiar a exportação de dados brutos e a definição de Database View.
Este artigo apresenta o contexto, as decisões de implementação, o projeto e os efeitos na operação, com base na implementação disponível no repositório público.
- Nome da ferramenta: PS1 SNOW Utilities
- Repositório: https://github.com/arimagml-collab/PS1SOWUtilities
- Implementação: PowerShell 5.1 + WinForms (execução local no Windows)
- Referências: README, script principal e notas de projeto (
docs/)
Contexto 1: exportar dados é possível, mas a operação é trabalhosa
A interface padrão do ServiceNow permite exportar dados. Na operação real, porém, os seguintes problemas se acumulam.
- Mesmo quando se deseja sempre o mesmo conjunto de colunas, mudanças na visualização em lista podem afetar a saída.
- Quando é necessária uma extração padronizada com todas as colunas e seus nomes internos, o esforço para explicar o procedimento aumenta muito.
- Com grandes volumes, a própria exportação pela GUI fica pesada, e gerenciar execuções e reexecuções se torna difícil.
Como resultado, a equipe de manutenção gasta tempo explicando como retirar os dados, em vez de como utilizá-los. Mudei a abordagem e preparei um mecanismo para que cada departamento exporte sozinho um conjunto fixo de colunas por meio da API.
Contexto 2: criar Database View evidencia diferenças de conhecimento em RDB
Database View é útil, mas representa uma barreira para quem não é engenheiro ou tem pouca experiência com bancos relacionais.
- As operações em
sys_db_viewesys_db_view_tableficam em contextos separados, exigindo muitas trocas de tela. - É difícil consultar a lista de nomes internos das colunas na mesma tela.
- Em ambientes sem permissão de Admin, é necessário pesquisar os nomes internos em outro ambiente e trazê-los.
- Digitar cláusulas Where e definições de JOIN manualmente facilita erros de escrita e referências incorretas.
Por isso concluí que era necessário ajudar a montar as definições pela GUI, com as opções disponíveis à vista.
O que construí: PS1 SNOW Utilities
PS1 SNOW Utilities é uma ferramenta PowerShell que reúne em uma única GUI tarefas frequentes da operação do ServiceNow. As principais abas são as seguintes.
1. Aba Export
- Seleção da tabela de destino ou preenchimento manual
- Filtros: todos os registros ou um período de
sys_updated_on - Seleção do formato de saída: CSV / JSON / Excel
- Exportação dividida em vários CSVs para grandes quantidades de registros
- Definição da pasta de destino e consulta ao log de execução
O objetivo operacional é padronizar a extração e reduzir as diferenças de procedimento entre os responsáveis.
2. Aba Database View Editor
- Preenchimento do nome interno e do rótulo da view
- Configuração da tabela base e do Prefix
- Inclusão de JOIN: colunas esquerda e direita, Variable Prefix e opção LEFT JOIN
- Atualização das colunas disponíveis e seleção das que serão exibidas
- Criação da view e exibição do link para o resultado
Montar a definição consultando as opções disponíveis reduz o trabalho de alternar entre telas do ServiceNow para digitar cláusulas Where e condições de JOIN.
3. Aba Attachment Harvester
- Coleta em lote dos anexos relacionados, filtrando pelo período de atualização
- Uso de numeração sequencial para evitar colisões de nomes de arquivo
- Registro das operações de obtenção no log
A função facilita a coleta de anexos, comum em auditorias e investigações, por meio de um procedimento reproduzível.
4. Aba Truncate
- Exclusão de todos os registros de uma tabela para uso em desenvolvimento
- Preenchimento de um código de confirmação, exibição do alvo e configuração de novas tentativas
Como é uma operação perigosa, seu uso em produção não é recomendado. A função foi pensada para testes de recarga de dados em um ambiente de validação.
5. Aba de configurações
- Nome da instância
- Método de autenticação: ID de usuário e senha / chave de API
- Idioma: japonês / inglês
- Tema: Dark / Light
- Configuração de conexão por domínio personalizado:
instanceDomain
Os valores informados são salvos em settings.json. Os valores confidenciais são armazenados com criptografia do Windows DPAPI (CurrentUser).
Pontos centrais do projeto
Nesta implementação, priorizei um projeto que diminuísse o trabalho de manutenção durante a operação.
-
Concentrar a comunicação em funções comuns
Invoke-SnowRequestencapsula GET/POST/PATCH/DELETE e a obtenção de anexos, evitando dispersar a autenticação, o tratamento de exceções e a gravação de logs. -
Separar a construção da UI do controle de exibição
As funçõesBuild-*constroem os elementos da UI, enquantoApply-*LanguageeSet-Themecontrolam as mudanças de exibição. -
Tornar o salvamento das configurações mais confiável
Load-Settings/Save-SettingseRequest-SaveSettingsajudam a evitar tanto configurações não salvas quanto salvamentos em excesso. -
Exigir várias confirmações para operações perigosas
Truncate passa por um código de confirmação e pela exibição do alvo para reduzir o risco de uma operação incorreta. -
Projetar a implementação para permitir rastreamento pelos logs
A aba Logs eConvertTo-LogCompactJsonfacilitam acompanhar posteriormente os resultados de execução.
Uma escolha prática de implementação
No ambiente corporativo, distribuir instaladores ou introduzir aplicativos residentes pode ser difícil. Por isso, desta vez priorizei um script PowerShell capaz de funcionar mesmo quando distribuído como texto.
Essa escolha reduziu a barreira de adoção e encurtou o tempo até o início do uso no trabalho diário.
Efeitos da adoção
Após a adoção, pude observar os seguintes 4 efeitos.
- O procedimento de Export ficou definido na tela, reduzindo a necessidade de explicações a cada solicitação de extração.
- Na criação de Database View, diminuíram as situações que exigiam digitar cláusulas Where manualmente na UI do ServiceNow.
- A coleta de anexos em lote, com filtro por período, reduziu o trabalho repetitivo durante as investigações.
- O salvamento das configurações reduziu a quantidade de vezes em que era necessário informar novamente o nome da instância e os dados de autenticação.
Os efeitos não são chamativos, mas há um valor prático claro em reduzir, de forma consistente, o tempo gasto nas tarefas que a equipe de operação repete a cada vez.
Limitações e cuidados
- A lista de tabelas é obtida por consulta a
sys_db_object, portanto as ACLs podem impedir sua obtenção. O preenchimento manual permite contornar essa limitação. - Dependendo do ambiente, há restrições ao salvamento automático de cláusulas Where ou definições de JOIN, e pode ser necessário completá-las manualmente no ServiceNow.
- Esta ferramenta não tem vínculo com a ServiceNow e não conta com aprovação, garantia ou suporte da empresa.
Resumo
Criei PS1 SNOW Utilities para reduzir os obstáculos práticos da extração de dados e da definição de Database View.
Como impressão pessoal, eu já sabia que era possível criar uma GUI com PowerShell, mas não tinha tido a ideia de começar por conta própria. Conseguir chegar a esse resultado com a ajuda da IA generativa, dando instruções de uma forma quase no-code, me fez sentir com clareza a velocidade da evolução da IA. Ao mesmo tempo, acredito que as ferramentas tradicionais de low-code e no-code dificilmente escaparão de um período em que precisarão redefinir suas vantagens e enfrentar a pressão da obsolescência.