Ir para o conteúdo principal

Convenções

Atualizado em 05/12/2016 Link permanente Índice

Para uniformizar o entendimento das informações contidas em toda a documentação do eDok, utilizamos algumas convenções quanto a terminologia e as formas de apresentação de blocos de texto especiais. Utilize essas referências para a correta compreensão de todos os manuais do eDok.

Glossário

API: Application Programming Interface, ou interface de programação para aplicações. Uma camada de software que implementa métodos para a troca de informações entre aplicações distintas.

Automação: qualquer processo executado de forma autônoma e sem a necessidade de intervenção humana.

Balanceador de Carga: um equipamento ou software que distribui tráfego de rede a diferentes equipamentos com base em regras de disponibilidade pré-definidas.

Cloud/Nuvem: um termo genérico que descreve inúmeras tecnologias para comunicação, processamento e armazenamento de dados em infraestrutura disponibilizada na internet.

Concentrador: um equipamento de processamento de dados destinado a centralizar funções semelhantes realizadas de modo distribuído por outros equipamentos.

Digitalização: o processo que converte informações do domínio analógico para o digital.

DNS: Domain Name System, um sistrema distribuído para conversão de nomes para endereços IP definido pelo RFC1035.

eDok Core: é o componente principal do serviço eDok composto pela interface web, o banco de dados e a infraestrutura para executá-los.

FTP: File transfer protocol, um protocolo para transmissão de arquivos definido pelo RFC959.

FTPS: FTP sobre TLS, definido pelo RFC4217.

HTTP: Hypertext Transfer Protocol, um protocolo para aplicações distribuídas e baseadas em hipertexto definido pelo RFC2616 e atualizado pelos RFCs 7230, 7231, 7232, 7233, 7234 e 7235.

HTTPS: HTTP sobre TLS.

JSON: JavaScript Object Notation, ou notação de objetos baseada em JavaScript. Um formato para intercâmbio de dados especificado pelo RFC7159/ECMA-404.

Metadado: uma informação que descreve dados, ou ‘dado sobre dados’.

REST: Representational State Transfer, uma arquitetura restritiva para serviços web escaláveis. A adesão a todas as restrições arquitetônicas de REST formam um serviço RESTful.

Scanner: o equipamento dedicado ou multifuncional (acoplado a uma impressora) que executa a digitalização.

SDN: Software Defined Network, ou rede definida por software. Uma camada de software que é aplicada, geralmente sob demanda, a equipamentos de rede para definir redes privadas ou públicas.

SLA: Service Level Agreeement, ou acordo de nível de serviço. Define uma promessa de nível de serviço mínimo ofertado pelo prestador ao contratante e estipulada em contrato.

TLS: Transport Layer Security, implementa protocolos de criptografia para comunicação segura e é definido pelo RFC5246.

VPC: Virtual Private Cloud, ou nuvem privada virtual. Um ambiente SDN que isola recursos de comunicação, processamento e armazenamento de dados.

VPN: Virtual Private Network, ou rede privada virtual. O método de interconexão de redes distintas por meio de túneis de comunicação segura.

Avisos

Ao longo do documento, diversos avisos são utilizados para evidenciar tópicos importantes. Os avisos apresentados são:

DICA: texto em uma caixa verde representa uma recomendação não obrigatória, mas que poderá trazer benefícios se observada.
AVISO: texto em uma caixa amarela representa algo que deve ser observado com cautela, uma vez que poderá trazer consequências negativas ou não funcionar como o previsto caso seja negligenciado.
PERIGO!!! Texto em uma caixa vermelha representa procedimentos perigosos, cuja aplicação equivocada gerará impactos potencialmente danosos (indisponibilidade, perda de dados etc) e que não estarão cobertos pelo suporte.

Sistema Operacional

Todos os comandos, listagens e saídas de código apresentados neste documento têm como referência sistemas operacionais baseados em Linux. Apesar de suportados pelo eDok, exemplos de código referentes a Windows, Mac OS X e outros, incluindo os móveis, não fazem parte da documentação do eDok.

Comandos, Códigos e Saídas

Comandos e listagem de códigos, bem como suas respectivas saídas (quando se aplicar) serão apresentados de dois modos: em linha ou em bloco. Os exemplos abaixo demonstram como cada uma deles é apresentado.

Exemplo de saída em linha: Content-Type: text/html

Exemplo de comando com saída em bloco:

Exemplo de listagem de código em bloco: