Conceitos e arquitetura
O Riversoft® STCP Gemini é o produto de transferência gerenciada de arquivos (MFT) da Riversoft para o protocolo OFTP, usado na troca de arquivos entre empresas, como no setor automotivo e em bancos:
- Versões: OFTP 1.x e OFTP 2.0, com TLS também no OFTP 1.x.
- Papéis: servidor, recebendo as conexões dos parceiros, e cliente, conectando aos parceiros por agendamento.
- Entrega confirmada: confirmação por EERP e retomada de transferências interrompidas.
Para portal web, API REST, SFTP, AS2, Webhook, WhatsApp e armazenamento em nuvem, use o Riversoft STCP DirectLink. Os dois produtos podem ser usados juntos ou separadamente e compartilham a gestão pelo Riversoft Console Portal e as caixas postais.
Arquitetura
O Riversoft STCP Gemini e o Riversoft STCP DirectLink são produtos independentes, que podem ser usados juntos ou separadamente. Os dois são configurados e monitorados pelo Riversoft Console Portal e pela Riversoft STCP Gemini API, e a configuração, os registros e o histórico das transferências ficam no banco de dados da sua empresa.
flowchart LR
ADM[Administrador] -->|HTTPS| PORTAL[Riversoft Console Portal]
SIS[Sistemas externos] -->|HTTPS / REST| API[Riversoft STCP Gemini API]
PORTAL --> API
API --> DB[(Banco de configuração<br/>e banco de log)]
SRV[Riversoft STCP Gemini Server] --> DB
DL[Riversoft STCP DirectLink] --> DB
REN[Riversoft STCP Gemini Rename] --> DB
SRV <-->|OFTP| PARC[Parceiros]
DL <-->|SFTP, AS2, HTTPS, Webhook,<br/>S3, Azure Blob, GCS, OCI| PARC
SRV -->|eventos| REN
| Parte | Papel |
|---|---|
| Transferência | O Riversoft STCP Gemini Server troca arquivos com os parceiros pelo OFTP; o Riversoft STCP DirectLink, pelos demais protocolos e conectores. |
| Gestão | O Riversoft Console Portal e a Riversoft STCP Gemini API criam e alteram instâncias, usuários, serviços de rede e agendamentos, e acompanham as transferências. |
| Banco de dados | Guarda a configuração (banco de configuração) e o histórico das transferências (banco de log). |
| Caixas postais | Diretórios de cada usuário, onde ficam os arquivos a enviar e os recebidos. Veja Caixa postal e diretórios. |
| Automação | O Riversoft STCP Gemini Rename e o roteamento interno do Riversoft STCP DirectLink encaminham os arquivos de acordo com as regras. |
Componentes
| Componente | Função | Pacote |
|---|---|---|
| Riversoft STCP Gemini Server | Transfere arquivos pelo protocolo OFTP, como servidor e cliente. Também oferece um cliente SFTP legado, mas para SFTP recomenda-se o Riversoft STCP DirectLink. | stcpgemini-server |
| Riversoft Console Portal | Interface web de configuração e monitoramento do Riversoft STCP Gemini e do Riversoft STCP DirectLink. É servida pela própria Riversoft STCP Gemini API, sem servidor web adicional. | stcpgemini-portal |
| Riversoft STCP Gemini API | API REST de gestão do Riversoft STCP Gemini e do Riversoft STCP DirectLink: instâncias, usuários, serviços de rede, agendamentos, tipos de arquivo e relatórios. Veja Riversoft STCP Gemini API. | stcpgemini-api |
| Riversoft STCP Gemini Rename (opcional) | Roteamento e automação de arquivos, por regras configuradas no Riversoft Console Portal. Instalado no mesmo servidor do Riversoft STCP Gemini Server. | stcpren |
| Riversoft STCP DirectLink (opcional) | Transfere arquivos por todos os protocolos e conectores além do OFTP. Veja Riversoft STCP DirectLink. | stcpdirectlink |
Protocolos e conectores
O Riversoft STCP Gemini transfere arquivos somente pelo OFTP, como servidor e como cliente. A tabela mostra qual produto atende cada protocolo ou conector:
| Conector / protocolo | Servidor | Cliente | Produto |
|---|---|---|---|
| OFTP 1.x e OFTP 2.0 | ✓ | ✓ | Riversoft STCP Gemini |
| SFTP | ✓ | ✓ | Riversoft STCP DirectLink (cliente legado também no Riversoft STCP Gemini Server) |
| AS2 | ✓ | ✓ | Riversoft STCP DirectLink |
| HTTPS (portal web e API REST) | ✓ | — | Riversoft STCP DirectLink |
| Webhook | ✓ | ✓ | Riversoft STCP DirectLink |
| — | ✓ | Riversoft STCP DirectLink | |
| FTPS / FTP | — | ✓ | Riversoft STCP DirectLink |
| Amazon S3, Azure Blob Storage, Google Cloud Storage, Oracle Cloud Object Storage | — | ✓ | Riversoft STCP DirectLink |
Nota
Outros conectores podem estar disponíveis conforme a versão e a configuração. Veja Protocolos e conectores do Riversoft STCP DirectLink.
Como funciona uma transferência
Sessão OFTP
No OFTP, os dois lados de uma conexão podem enviar e receber arquivos na mesma sessão. Cada arquivo recebido é confirmado ao remetente, e uma transferência interrompida é retomada do ponto em que parou.
sequenceDiagram
autonumber
participant P as Parceiro
participant G as Riversoft STCP Gemini Server
P->>G: Abre a conexão (TLS, quando configurado)
P->>G: Identifica-se com as credenciais OFTP
G-->>P: Aceita a sessão (credenciais e regras do usuário válidas)
P->>G: Envia o arquivo
Note over P,G: Se a conexão cair, a próxima sessão retoma do ponto de parada
G-->>P: Confirma com EERP (ou recusa com NERP, informando o motivo)
G->>P: Envia os arquivos de saída do usuário
P-->>G: Confirma com EERP
P->>G: Encerra a sessão
Note over G: Sessão, arquivos e confirmações ficam registrados no banco de log
| Etapa | O que acontece |
|---|---|
| Conexão | O parceiro se identifica com as credenciais OFTP cadastradas para o usuário. A sessão é recusada se as credenciais, o modo de autenticação ou o modo de conexão não corresponderem à configuração. |
| Transmissão | O arquivo é enviado em blocos. No OFTP 2.0, ele pode ser cifrado, assinado e comprimido. |
| Retomada | Se a conexão cair, as informações de retomada são guardadas e a próxima sessão continua do ponto em que parou, sem reenviar o arquivo inteiro. |
| Confirmação | O recebedor confirma o arquivo com EERP (End-to-End Response) ou o recusa com NERP (Negative End Response), informando o motivo. A confirmação pode ser enviada na mesma sessão ou em uma sessão posterior. |
| Registro | A sessão, os arquivos, as confirmações e o resultado ficam no banco de log. Veja Registro e monitoramento. |
Conexões de entrada e de saída
| Conexão | Quem inicia | Quando |
|---|---|---|
| Entrada | O parceiro conecta ao serviço de rede da instância. | Quando o parceiro decidir, dentro das regras do usuário. |
| Saída | O Riversoft STCP Gemini Server conecta ao parceiro. | Por agendamento, nas datas ou intervalos definidos. Pelo Riversoft Console Portal, o operador também pode executar uma agenda na hora ou iniciar uma conexão de saída com um usuário. Veja Supervisão. |
| Supervisão | A Riversoft STCP Gemini API conecta ao serviço Supervisão (gemini) do Riversoft STCP Gemini Server (porta padrão 33050). | Sempre que o Riversoft Console Portal acompanha ou opera a instância. Veja Serviços de supervisão. |
Caixa postal e diretórios
Cada usuário tem uma caixa postal no diretório de dados (DataDirectory, por padrão /usr/local/stcp/data), no caminho <DataDirectory>/<instância>/<usuário>/. O Riversoft STCP Gemini e o Riversoft STCP DirectLink usam exatamente a mesma estrutura de caixas postais:
<DataDirectory>/<instância>/<usuário>/
├── entrada/
│ └── restart/
├── saida/
│ ├── backup/
│ ├── pendente/
│ └── link/
├── controle/
├── formato/
└── temp/
flowchart LR
SIS[Sistema da empresa] -->|grava| SAI[saida]
SAI -->|transmitido ou baixado| BKP[saida/backup]
BKP -.->|retransmissão| SAI
PARC[Parceiro ou usuário] -->|envia| ENT[entrada]
ENT -->|lido por| SIS
| Diretório | No Riversoft STCP Gemini | No Riversoft STCP DirectLink |
|---|---|---|
entrada | Arquivos recebidos do parceiro pelo OFTP. | Arquivos recebidos por upload no portal ou na API e pelos protocolos e conectores. |
entrada/restart | Informações de retomada das transferências interrompidas. | Informações de retomada das transferências interrompidas. |
saida | Arquivos a transmitir ao parceiro. | Arquivos disponíveis para download (área de download) e a transmitir pelos conectores. |
saida/backup | Arquivos já transmitidos. Um arquivo pode voltar para saida para ser retransmitido. | Arquivos já baixados (área de backup). |
saida/pendente | Controle de EERP: confirmações de recepção aguardando envio. | — |
saida/link | — | Arquivos disponíveis por link seguro para destinatários externos. |
controle | Arquivos de controle das transferências, como EERP, NERP e locks. | Arquivos de controle das transferências. |
formato e temp | Definições de formato e arquivos temporários. | Definições de formato e arquivos temporários. |
Os nomes dos diretórios são configuráveis na instância. Veja Diretórios de dados.
Regras aplicadas a cada transferência
Em qualquer direção, a conexão e cada arquivo são validados contra as regras do usuário e da instância:
| Regra | Efeito |
|---|---|
| Bloqueio do usuário | Um usuário bloqueado não troca arquivos. |
| Autenticação e modo de conexão | A sessão só é aceita se as credenciais, o modo de autenticação e o modo de conexão corresponderem à configuração. |
| Limite de conexões | Limita as conexões simultâneas do usuário. |
| Tempo de sessão | Encerra sessões que passam do tempo máximo. |
| Limite de sessões da instância | Limita o total de sessões simultâneas da instância. |
| Filtros de arquivo | Nome e tamanho do arquivo precisam atender aos filtros do usuário. |
| Janela de horário | As transferências só são aceitas nos dias e horários permitidos. |
Cada recusa é registrada com o motivo. Veja Segurança.
Roteamento e automação
O Riversoft STCP Gemini Server gera um evento a cada transferência. Com o Riversoft STCP Gemini Rename instalado, esses eventos acionam as regras de roteamento configuradas no Riversoft Console Portal, que renomeiam, copiam, movem e distribuem os arquivos entre as caixas postais e outros diretórios, sem intervenção manual.
Registro e monitoramento
| Recurso | Descrição |
|---|---|
| Banco de log | Cada sessão e cada transferência são registradas com usuário, direção, arquivo, tamanho, tempo, hash e resultado. |
| Eventos e mensagens | Cada ocorrência gera um evento e uma mensagem com código (MSGnnnn), nos idiomas português, inglês e espanhol. Veja Códigos. |
| Spool de contingência | Se o banco de log estiver indisponível, os eventos são gravados em um arquivo local de contingência. Veja Spool de contingência. |
| Supervisão | O Riversoft Console Portal acompanha a instância, os usuários e os serviços, e pode iniciar agendas, parar e reiniciar a instância e alterar o nível de debug. Veja Supervisão. |
Conceitos-chave
| Conceito | Descrição |
|---|---|
| Instância | Conjunto de configurações executado por um Riversoft STCP Gemini Server, identificado por ApplName. É criada no Riversoft Console Portal. |
| Usuário | Parceiro ou sistema que troca arquivos com a instância. Cada usuário tem uma única caixa postal, que guarda os arquivos e os dados das suas transferências. |
| Serviço de rede | Configuração de protocolo, endereço, porta e segurança usada nas conexões. |
| Agendamento | Execução de conexões de saída ou tarefas em datas ou intervalos definidos. A agenda também pode ser executada na hora pelo Riversoft Console Portal. |
| Tipo de arquivo | Regras e tags aplicadas aos arquivos transferidos. |
| EERP e NERP | Confirmação (EERP) ou recusa (NERP) de um arquivo pelo recebedor, no protocolo OFTP. |
| Retomada | Continuação de uma transferência interrompida a partir do ponto em que parou. |
| Evento e mensagem | Cada ocorrência da transferência gera um evento e uma mensagem com código (MSGnnnn). |
| Roteamento e regra | Definições do Riversoft STCP Gemini Rename para renomear, copiar, mover e distribuir arquivos. |
Outros termos estão no Glossário.