Guia de Deploy — Controle Marítimo
Este guia descreve como instalar a solução Controle Marítimo num tenant Fluig, do zero até o smoke-test: o widget e todos os artefatos que ele depende (datasets, listas, formulário, workflows, templates, integração RM, datasources e grupos).
É destinado ao operador técnico/administrador que faz a instalação e a manutenção. Para o uso do dia a dia (usuário final), veja o Guia de Uso.
:::warning Ambiente e segredos
O tenant configurado no .env.local do repositório é de desenvolvimento/homologação. Para produção, troque URL e credenciais e redobre o cuidado. Em toda a doc, valores sensíveis aparecem como placeholders (<TENANT_URL>, <ADMIN_USER>…); nunca versione tokens reais. Os tokens OAuth1 hoje embutidos no deploy.py devem ser rotacionados e mantidos fora do versionamento.
:::
O que compõe a solução
A solução não é só o widget — são 9 grupos de artefatos que precisam coexistir no tenant:
| # | Artefato | Onde está no repo |
|---|---|---|
| 1 | Widget wd_controle_maritimo.war | wcm/widget/wd_controle_maritimo |
| 2 | 15 datasets CUSTOM | datasets/*.js |
| 3 | 4 listas (metaLists) | lists/<nome>/structure.json |
| 4 | Formulário Processar Folha | forms/Controle Marítimo - Processar Folha/ |
| 5 | 2 workflows (BPM) | workflow/ |
| 6 | 2 templates de e-mail | templates/tmpl_email_*.html |
| 7 | Sentenças RM (SOAP) | xml_rm/LOAX*.xml |
| 8 | Datasources (MySQL + RM) | configuração do tenant |
| 9 | Grupos de segurança | configuração do tenant |
Ordem de instalação (tenant novo)
As páginas deste guia estão na ordem de leitura/explicação, mas a ordem operacional de instalação segue as dependências entre artefatos:
- Infra — datasources MySQL/RM + grupos (
controle_maritimo_view/_edit) → ver Pré-requisitos e Segurança e grupos. - Listas e formulário — as 4 listas e o form Processar Folha → ver Listas e formulário.
- Sentenças RM — LOAX no RM, para os datasets
*_rmfuncionarem → ver Integração RM. - Datasets — os 15 datasets CUSTOM → ver Datasets.
- Workflows e templates — processos
processar_folha/controle_maritimo_alertas+ e-mails → ver Workflows e templates. - Widget — build e upload do
.war→ ver Widget. - Smoke-test — validação ponta a ponta → ver Pós-deploy.
:::tip Por que essa ordem O widget depende dos datasets; os datasets de consulta dependem das listas e das sentenças RM; os datasets de escrita dependem dos grupos (gate de permissão). Instalar de baixo para cima evita erros de "dataset não encontrado" ou listas vazias durante a validação. :::
Por onde seguir
- Pré-requisitos e ambiente — ferramentas, datasources, credenciais e
.env.local. - Widget —
mvn clean install+deploy.py. - Datasets — os 15 datasets via
deploy_dataset.cjs. - Listas e formulário — metaLists e o form Processar Folha.
- Workflows e templates — processos BPM e e-mails.
- Integração RM — sentenças LOAX e o contrato de datas Oracle.
- Segurança e grupos — os dois grupos de acesso.
- Pós-deploy — smoke-test e troubleshooting.