Package {rsei}

rsei: Client for the 'SEI' Electronic Information System Web Services

Description

Toolkit to interact with the 'SOAP' web services of the 'SEI' (Sistema Eletronico de Informacoes), the electronic system for document and process management widely used by Brazilian public administration bodies. Provides functions to build the 'SOAP' envelopes, perform the requests, handle 'SOAP' faults, and parse the 'XML' responses into data frames. Covers process and document queries, listing services, write operations (creating processes and documents, sending and signing off processes, blocks, deadlines and markers) and the permission services of the companion 'SIP' system. Note that access to the web services is restricted by the server to previously authorized network addresses. For more information about the 'SEI' system and its web services see https://www.gov.br/gestao/pt-br/assuntos/processo-eletronico-nacional.

Acesso restrito por IP

Os Web Services do SEI são protegidos por firewall e só respondem a requisições vindas de IPs/servidores previamente autorizados no cadastro do serviço no SEI. As funções deste pacote (consultas, listagens, escrita e SIP) só retornam dados quando executadas a partir de um host autorizado; de um IP não autorizado as chamadas falham por timeout ou conexão recusada. A autenticação adicional é feita por SiglaSistema + chave de acesso (IdentificacaoServico) — ver sei_config().

Author(s)

Maintainer: Andre Leite leite@castlab.org

Authors:

• Andre Leite leite@castlab.org

• Marcos Wasilew marcos.wasilew@gmail.com

• Hugo Vasconcelos hugo.vasconcelos@ufpe.br

• Carlos Amorin carlos.agaf@ufpe.br

• Diogo Bezerra diogo.bezerra@ufpe.br

• Júlia Nascimento Barreto juliabarreto@gd.seplag.pe.gov.br

See Also

Useful links:

• https://github.com/StrategicProjects/rsei

• https://strategicprojects.github.io/rsei/

• Report bugs at https://github.com/StrategicProjects/rsei/issues

Pipe operator

Description

Veja magrittr::%>% para detalhes.

Usage

lhs %>% rhs

Arguments

Value

O resultado de chamar rhs(lhs).

Andamento

Description

Represents the "Andamento" structure in SEI, which tracks process events.

Usage

Andamento(
  IdAndamento = NULL,
  IdTarefa = NULL,
  IdTarefaModulo = NULL,
  Descricao = NULL,
  DataHora = NULL,
  Unidade = NULL,
  Usuario = NULL,
  Atributos = list()
)

Arguments

Value

An S3 object of class "Andamento".

AndamentoMarcador

Description

Represents the "AndamentoMarcador" structure in SEI (marker events).

Usage

AndamentoMarcador(
  IdAndamentoMarcador = NULL,
  Texto = NULL,
  DataHora = NULL,
  Usuario = NULL,
  Marcador = NULL
)

Arguments

Value

An S3 object of class "AndamentoMarcador".

ArquivoExtensao

Description

Represents a file extension allowed in SEI (e.g., pdf, doc).

Usage

ArquivoExtensao(IdArquivoExtensao, Extensao, Descricao)

Arguments

Value

An S3 object of class "ArquivoExtensao".

Assinatura

Description

Represents the "Assinatura" structure (signature information).

Usage

Assinatura(
  Nome = NULL,
  CargoFuncao = NULL,
  DataHora = NULL,
  IdUsuario = NULL,
  IdOrigem = NULL,
  IdOrgao = NULL,
  Sigla = NULL
)

Arguments

Value

An S3 object of class "Assinatura".

Assunto

Description

Represents the "Assunto" structure in SEI (subject classification).

Usage

Assunto(CodigoEstruturado = NULL, Descricao = NULL)

Arguments

Value

An S3 object of class "Assunto".

AtributoAndamento

Description

Represents the "AtributoAndamento" structure (key-value attributes).

Usage

AtributoAndamento(Nome = NULL, Valor = NULL, IdOrigem = NULL)

Arguments

Value

An S3 object of class "AtributoAndamento".

AtributoOuvidoria

Description

Represents the "AtributoOuvidoria" structure (attributes in an ouvidoria context).

Usage

AtributoOuvidoria(Id = NULL, Nome = NULL, Titulo = NULL, Valor = NULL)

Arguments

Value

An S3 object of class "AtributoOuvidoria".

Cargo

Description

Represents a "Cargo" (position) in SEI, with expressions for treatment and vocative.

Usage

Cargo(
  IdCargo = NULL,
  ExpressaoCargo = NULL,
  ExpressaoTratamento = NULL,
  ExpressaoVocativo = NULL
)

Arguments

Value

An S3 object of class "Cargo".

Cidade

Description

Represents the "Cidade" structure in SEI.

Usage

Cidade(
  IdCidade,
  IdEstado,
  IdPais,
  Nome,
  CodigoIbge = NULL,
  SinCapital = NULL,
  Latitude = NULL,
  Longitude = NULL
)

Arguments

Value

An S3 object of class "Cidade".

Contato

Description

Represents the "Contato" structure in SEI, storing personal or organizational contact data.

Usage

Contato(
  StaOperacao = NULL,
  IdContato,
  IdTipoContato = NULL,
  Nome = NULL,
  NomeSocial = NULL,
  StaNatureza = NULL,
  Endereco = NULL,
  Bairro = NULL,
  Cep = NULL,
  Cpf = NULL,
  Cnpj = NULL,
  Rg = NULL,
  OrgaoExpedidor = NULL,
  TelefoneFixo = NULL,
  TelefoneCelular = NULL,
  Email = NULL,
  ...
)

Arguments

Value

An S3 object of class "Contato".

DefinicaoControlePrazo

Description

Represents the "DefinicaoControlePrazo" structure for deadline control.

Usage

DefinicaoControlePrazo(
  ProtocoloProcedimento,
  DataPrazo = NULL,
  Dias = NULL,
  SinDiasUteis = NULL
)

Arguments

Value

An S3 object of class "DefinicaoControlePrazo".

DefinicaoMarcador

Description

Represents the "DefinicaoMarcador" structure for applying markers to a process.

Usage

DefinicaoMarcador(ProtocoloProcedimento, IdMarcador, Texto = NULL)

Arguments

Value

An S3 object of class "DefinicaoMarcador".

Destinatario

Description

Represents the "Destinatario" structure in SEI.

Usage

Destinatario(Sigla = NULL, Nome = NULL)

Arguments

Value

An S3 object of class "Destinatario".

Documento

Description

Represents the "Documento" structure in SEI, for generated or external documents.

Usage

Documento(
  Tipo,
  IdProcedimento = NULL,
  ProtocoloProcedimento = NULL,
  IdSerie,
  Numero = NULL,
  NomeArvore = NULL,
  Data = NULL,
  Descricao = NULL,
  IdTipoConferencia = NULL,
  SinArquivamento = NULL,
  Remetente = NULL,
  Interessados = list(),
  Destinatarios = list(),
  Observacao = NULL,
  NomeArquivo = NULL,
  NivelAcesso = NULL,
  IdHipoteseLegal = NULL,
  Conteudo = NULL,
  ConteudoMTOM = NULL,
  IdArquivo = NULL,
  Campos = list(),
  SinBloqueado = NULL
)

Arguments

Value

An S3 object of class "Documento".

Estado

Description

Represents the "Estado" structure in SEI (state info).

Usage

Estado(IdEstado, IdPais, Sigla, Nome, CodigoIbge = NULL)

Arguments

Value

An S3 object of class "Estado".

Feriado

Description

Represents the "Feriado" structure (holiday).

Usage

Feriado(Data, Descricao)

Arguments

Value

An S3 object of class "Feriado".

HipoteseLegal

Description

Represents the "HipoteseLegal" structure (legal hypothesis for restricted/sigilo).

Usage

HipoteseLegal(IdHipoteseLegal, Nome, BaseLegal, NivelAcesso)

Arguments

Value

An S3 object of class "HipoteseLegal".

Interessado

Description

Represents the "Interessado" structure in SEI (interested party in a process or document).

Usage

Interessado(Sigla = NULL, Nome = NULL)

Arguments

Value

An S3 object of class "Interessado".

Marcador

Description

Represents the "Marcador" structure (markers associated with a process).

Usage

Marcador(IdMarcador, Nome, Icone = NULL, SinAtivo = NULL)

Arguments

Value

An S3 object of class "Marcador".

Observacao

Description

Represents the "Observacao" structure in SEI (unit notes).

Usage

Observacao(Descricao = NULL, Unidade = NULL)

Arguments

Value

An S3 object of class "Observacao".

Pais

Description

Represents the "Pais" structure in SEI (country).

Usage

Pais(IdPais, Nome)

Arguments

Value

An S3 object of class "Pais".

Procedimento

Description

Represents the "Procedimento" structure in SEI (process definition).

Usage

Procedimento(
  IdTipoProcedimento,
  NumeroProtocolo = NULL,
  DataAutuacao = NULL,
  Especificacao = NULL,
  Assuntos = list(),
  Interessados = list(),
  Observacao = NULL,
  NivelAcesso = NULL,
  IdHipoteseLegal = NULL
)

Arguments

Value

An S3 object of class "Procedimento".

ProcedimentoResumido

Description

Represents a "ProcedimentoResumido" structure (summary of a process).

Usage

ProcedimentoResumido(
  IdTipoProcedimento,
  ProcedimentoFormatado,
  TipoProcedimento = NULL
)

Arguments

Value

An S3 object of class "ProcedimentoResumido".

ProtocoloBloco

Description

Represents a "ProtocoloBloco" structure (process/document in a block).

Usage

ProtocoloBloco(ProtocoloFormatado, Identificacao, Assinaturas = list())

Arguments

Value

An S3 object of class "ProtocoloBloco".

Publicacao

Description

Represents the "Publicacao" structure in SEI (publication data).

Usage

Publicacao(
  IdPublicacao = NULL,
  IdDocumento = NULL,
  StaMotivo = NULL,
  Resumo = NULL,
  IdVeiculoPublicacao = NULL,
  NomeVeiculo = NULL,
  StaTipoVeiculo = NULL,
  Numero = NULL,
  DataDisponibilizacao = NULL,
  DataPublicacao = NULL,
  Estado = NULL,
  ImprensaNacional = NULL
)

Arguments

Value

An S3 object of class "Publicacao".

PublicacaoImprensaNacional

Description

Represents the "PublicacaoImprensaNacional" structure in SEI.

Usage

PublicacaoImprensaNacional(
  IdVeiculo = NULL,
  SiglaVeiculo = NULL,
  DescricaoVeiculo = NULL,
  Pagina = NULL,
  IdSecao = NULL,
  Secao = NULL,
  Data = NULL
)

Arguments

Value

An S3 object of class "PublicacaoImprensaNacional".

Remetente

Description

Represents the "Remetente" structure in SEI (sender info).

Usage

Remetente(Sigla = NULL, Nome = NULL)

Arguments

Value

An S3 object of class "Remetente".

Serie

Description

Represents the "Serie" structure in SEI (document type).

Usage

Serie(IdSerie, Nome, Aplicabilidade = NULL)

Arguments

Value

An S3 object of class "Serie".

TipoConferencia

Description

Represents the "TipoConferencia" structure in SEI (conference type info).

Usage

TipoConferencia(IdTipoConferencia, Descricao)

Arguments

Value

An S3 object of class "TipoConferencia".

TipoProcedimento

Description

Represents the "TipoProcedimento" structure in SEI (process type info).

Usage

TipoProcedimento(IdTipoProcedimento, Nome)

Arguments

Value

An S3 object of class "TipoProcedimento".

Unidade

Description

Represents the "Unidade" structure in SEI (organizational unit).

Usage

Unidade(
  IdUnidade,
  Sigla,
  Descricao,
  SinProtocolo = NULL,
  SinArquivamento = NULL,
  SinOuvidoria = NULL
)

Arguments

Value

An S3 object of class "Unidade".

UnidadeProcedimentoAberto

Description

Represents the "UnidadeProcedimentoAberto" structure (where a process is open).

Usage

UnidadeProcedimentoAberto(Unidade, UsuarioAtribuicao = NULL)

Arguments

Value

An S3 object of class "UnidadeProcedimentoAberto".

Usuario

Description

Represents the "Usuario" structure in SEI (user info).

Usage

Usuario(IdUsuario, Sigla, Nome)

Arguments

Value

An S3 object of class "Usuario".

anexar_processo

Description

Anexa um processo a outro (anexarProcesso).

Usage

anexar_processo(
  protocolo_principal,
  protocolo_anexado,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

atribuir_processo

Description

Atribui um processo a um usuário na unidade (atribuirProcesso).

Usage

atribuir_processo(
  protocolo_procedimento,
  id_usuario,
  config = sei_config(),
  sin_reabrir = "N",
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

atualizar_contatos

Description

Atualiza (cadastra/altera) um conjunto de contatos (atualizarContatos).

Usage

atualizar_contatos(contatos, config = sei_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

bloquear_processo

Description

Bloqueia um processo (bloquearProcesso).

Usage

bloquear_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

Build XML for SOAP Parameters (compatibilidade)

Description

Converte uma lista nomeada em XML dos parâmetros para o corpo SOAP, no formato do SEI (com xsi:type="xsd:string" em escalares, estruturas aninhadas e arrays <item>). Delega para o renderizador canônico do pacote.

Usage

build_parameters_xml(params_list)

Arguments

Value

Uma string XML dos parâmetros.

See Also

sei_build_envelope

Examples

build_parameters_xml(list(SiglaSistema = "X", IdUnidade = "123"))

Build a SOAP Envelope (compatibilidade)

Description

Cria um envelope SOAP 1.1 no formato do SEI com method como elemento raiz dentro de <soapenv:Body>. body_content deve ser a string XML já renderizada dos parâmetros (ver build_parameters_xml).

Para novo código, prefira sei_build_envelope, que monta os parâmetros a partir de uma lista R.

Usage

build_soap_envelope(method, body_content)

Arguments

Value

Uma string com o envelope SOAP completo.

See Also

sei_build_envelope

Examples

build_soap_envelope("listarUnidades",
  build_parameters_xml(list(SiglaSistema = "X")))

Generic SEI SOAP Call (compatibilidade)

Description

Envia uma requisição SOAP para um Web Service do SEI. Mantida por compatibilidade; internamente delega para sei_call, que monta o envelope no formato correto e trata erros HTTP e SOAP Fault.

Usage

call_sei_api(sei_url, method, params = list(), verbose = FALSE)

Arguments

Value

Um xml_document (de xml2) com a resposta SOAP.

See Also

sei_call

Examples

## Not run: 
  resp_xml <- call_sei_api(
    sei_url = "https://sei.exemplo.gov.br/sei/ws/SeiWS.php",
    method  = "listarUnidades",
    params  = list(SiglaSistema = "HORTENSIAS", IdentificacaoServico = "chave")
  )

## End(Not run)

cancelar_disponibilizacao_bloco

Description

Cancela a disponibilização de um bloco (cancelarDisponibilizacaoBloco).

Usage

cancelar_disponibilizacao_bloco(
  id_bloco,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

cancelar_documento

Description

Cancela um documento (cancelarDocumento).

Usage

cancelar_documento(
  protocolo_documento,
  motivo,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

concluir_controle_prazo

Description

Conclui o controle de prazo de processos (concluirControlePrazo).

Usage

concluir_controle_prazo(
  protocolos_procedimentos,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

concluir_processo

Description

Conclui um processo na unidade (concluirProcesso).

Usage

concluir_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

consultar_bloco

Description

Chama a operação consultarBloco do SEI. O bloco deve ser da unidade (config$id_unidade) ou estar disponibilizado para ela.

Usage

consultar_bloco(
  id_bloco,
  config = sei_config(),
  sin_retornar_protocolos = "N",
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (ou xml_document se raw = TRUE).

consultar_documento

Description

Chama a operação consultarDocumento do SEI. Por padrão devolve o resultado parseado como tibble (use raw = TRUE para o xml_document).

Usage

consultar_documento(
  protocolo_documento,
  config = sei_config(),
  sin_retornar_andamento_geracao = "S",
  sin_retornar_assinaturas = "S",
  sin_retornar_publicacao = "S",
  sin_retornar_campos = "S",
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (ou xml_document se raw = TRUE).

consultar_documentos

Description

Consulta vários documentos de uma vez e empilha os resultados em um único tibble. Cada documento é consultado com consultar_documento() e o resultado recebe uma coluna protocolo (o número consultado) e uma coluna erro (NA em sucesso; a mensagem caso a consulta falhe). Por padrão um documento com erro não interrompe o lote.

Usage

consultar_documentos(
  protocolos,
  config = sei_config(),
  parar_em_erro = FALSE,
  verbose = FALSE,
  ...
)

Arguments

Value

Um tibble com uma linha por documento (colunas protocolo e erro além das de consultar_documento()).

Examples

## Not run: 
  consultar_documentos(c("0000001", "0003934"), config = sei_config())

## End(Not run)

consultar_procedimento

Description

Chama a operação consultarProcedimento do SEI para recuperar os dados de um processo. Internamente usa sei_call e, por padrão, devolve o resultado já parseado como tibble.

Usage

consultar_procedimento(
  protocolo_procedimento,
  config = sei_config(),
  sin_retornar_assuntos = "S",
  sin_retornar_interessados = "S",
  sin_retornar_observacoes = "S",
  sin_retornar_andamento_geracao = "S",
  sin_retornar_andamento_conclusao = "S",
  sin_retornar_ultimo_andamento = "S",
  sin_retornar_unidades_procedimento_aberto = "S",
  sin_retornar_procedimentos_relacionados = "S",
  sin_retornar_procedimentos_anexados = "S",
  raw = FALSE,
  sei_url = NULL,
  sigla_sistema = NULL,
  identificacao_servico = NULL,
  id_unidade = NULL,
  verbose = FALSE
)

Arguments

Value

Um tibble com os dados do processo (ou um xml_document se raw = TRUE).

Examples

## Not run: 
  consultar_procedimento(
    "0000000000.000001/2020-11",
    config = sei_config(sigla_sistema = "HORTENSIAS",
                        identificacao_servico = "chave")
  )

## End(Not run)

consultar_procedimento_individual

Description

Chama a operação consultarProcedimentoIndividual do SEI, que retorna o processo individual mais recente do tipo informado onde o usuário é interessado (ou NA se nenhum for encontrado).

Usage

consultar_procedimento_individual(
  id_orgao_procedimento,
  id_tipo_procedimento,
  id_orgao_usuario,
  sigla_usuario,
  config = sei_config(),
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (ou xml_document se raw = TRUE).

consultar_procedimentos

Description

Consulta vários processos de uma vez e empilha os resultados em um único tibble. Cada protocolo é consultado com consultar_procedimento() e o resultado recebe uma coluna protocolo (o número consultado) e uma coluna erro (NA em caso de sucesso; a mensagem do erro caso a consulta falhe). Por padrão um protocolo com erro não interrompe o lote.

Usage

consultar_procedimentos(
  protocolos,
  config = sei_config(),
  parar_em_erro = FALSE,
  verbose = FALSE,
  ...
)

Arguments

Value

Um tibble com uma linha por processo (colunas protocolo e erro além das de consultar_procedimento()). Linhas com erro têm NA nas demais colunas.

Examples

## Not run: 
  protos <- c("0000000000.000001/2020-11", "0000000000.000003/2020-33")
  tudo <- consultar_procedimentos(protos, config = sei_config())
  tudo[, c("protocolo", "Especificacao", "NivelAcessoGlobal", "erro")]

## End(Not run)

consultar_publicacao

Description

Chama a operação consultarPublicacao do SEI. Informe ao menos um filtro: id_publicacao, id_documento ou protocolo_documento.

Usage

consultar_publicacao(
  id_publicacao = NULL,
  id_documento = NULL,
  protocolo_documento = NULL,
  config = sei_config(),
  sin_retornar_andamento = "S",
  sin_retornar_assinaturas = "S",
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (ou xml_document se raw = TRUE).

consultar_publicacoes

Description

Consulta várias publicações de uma vez e empilha os resultados em um único tibble. Cada item é consultado com consultar_publicacao() usando o tipo de identificador indicado em por. O resultado recebe uma coluna id (o valor consultado) e uma coluna erro (NA em sucesso). Um item com erro não interrompe o lote (salvo parar_em_erro = TRUE).

Usage

consultar_publicacoes(
  ids,
  config = sei_config(),
  por = c("id_documento", "protocolo_documento", "id_publicacao"),
  parar_em_erro = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble com uma linha por item (colunas id e erro além das de consultar_publicacao()).

Examples

## Not run: 
  consultar_publicacoes(c("20000002", "67640000"), por = "id_documento")

## End(Not run)

definir_controle_prazo

Description

Define controle de prazo para processos (definirControlePrazo).

Usage

definir_controle_prazo(definicoes, config = sei_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

definir_marcador

Description

Define marcadores em processos (definirMarcador).

Usage

definir_marcador(definicoes, config = sei_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

desanexar_processo

Description

Desanexa um processo (desanexarProcesso).

Usage

desanexar_processo(
  protocolo_principal,
  protocolo_anexado,
  motivo,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

desbloquear_processo

Description

Desbloqueia um processo (desbloquearProcesso).

Usage

desbloquear_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

disponibilizar_bloco

Description

Disponibiliza um bloco (disponibilizarBloco).

Usage

disponibilizar_bloco(id_bloco, config = sei_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

enviar_email

Description

Envia um e-mail vinculado a um processo (enviarEmail).

Usage

enviar_email(
  protocolo_procedimento,
  de,
  para,
  assunto,
  mensagem,
  cco = NULL,
  id_documentos = NULL,
  config = sei_config(),
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (parse_retorno_envio_email).

enviar_processo

Description

Envia (tramita) um processo para outras unidades (enviarProcesso).

Usage

enviar_processo(
  protocolo_procedimento,
  unidades_destino,
  config = sei_config(),
  sin_manter_aberto_unidade = "N",
  sin_remover_anotacao = "N",
  sin_enviar_email_notificacao = "N",
  data_retorno_programado = NULL,
  dias_retorno_programado = NULL,
  sin_dias_uteis_retorno_programado = "N",
  sin_reabrir = "N",
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

excluir_bloco

Description

Exclui um bloco (excluirBloco).

Usage

excluir_bloco(id_bloco, config = sei_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

excluir_documento

Description

Exclui um documento (excluirDocumento).

Usage

excluir_documento(protocolo_documento, config = sei_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

excluir_processo

Description

Exclui um processo (excluirProcesso). Irreversível.

Usage

excluir_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

gerar_bloco

Description

Gera um bloco (gerarBloco). Retorna o número do bloco.

Usage

gerar_bloco(
  tipo,
  descricao,
  config = sei_config(),
  unidades_disponibilizacao = NULL,
  documentos = NULL,
  sin_disponibilizar = "N",
  verbose = FALSE
)

Arguments

Value

Character com o IdBloco gerado.

gerar_procedimento

Description

Gera um novo processo (gerarProcedimento). Operação de escrita.

Usage

gerar_procedimento(
  procedimento,
  config = sei_config(),
  documentos = list(),
  procedimentos_relacionados = NULL,
  unidades_envio = NULL,
  sin_manter_aberto_unidade = "S",
  sin_enviar_email_notificacao = "N",
  data_retorno_programado = NULL,
  dias_retorno_programado = NULL,
  sin_dias_uteis_retorno_programado = "N",
  id_marcador = NULL,
  texto_marcador = NULL,
  data_controle_prazo = NULL,
  dias_controle_prazo = NULL,
  sin_dias_uteis_controle_prazo = "N",
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (parse_retorno_geracao_procedimento) ou xml_document se raw=TRUE.

Retrieve SEI Credentials from Keyring

Description

Retrieves the stored SEI credentials for a given service_name from the keyring. If the keyring package is missing or if retrieval fails, the function displays a message instead of throwing an error, and returns NULL.

Usage

get_sei_credentials(service_name)

Arguments

Value

A list containing:

• username: The stored username (if any).

• password: The stored password or SEI access key (if any).

• extras: A list of additional parameters (if any).

Returns NULL if no credentials are found or if an error occurred.

Examples

## Not run: 
creds <- get_sei_credentials("SEI_WS")
if (!is.null(creds)) {
  cat("Username:", creds$username, "\n")
  cat("Password:", creds$password, "\n")
  cat("Extras:", "\n")
  print(creds$extras)
}

## End(Not run)

get_text: texto de um descendente por local-name

Description

Encontra o primeiro descendente de parent com o local-name informado (ignorando namespaces) e devolve seu texto, ou "" se ausente / xsi:nil="true". Mantido por compatibilidade; para extração ancorada em filho direto use o helper interno get_text_child.

Usage

get_text(parent, child_name)

Arguments

Value

Uma string (possivelmente vazia).

incluir_documento

Description

Inclui um documento em um processo (incluirDocumento). Escrita.

Usage

incluir_documento(
  documento,
  config = sei_config(),
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble (parse_retorno_inclusao_documento) ou xml_document.

incluir_documento_bloco

Description

Inclui um documento em um bloco (incluirDocumentoBloco).

Usage

incluir_documento_bloco(
  id_bloco,
  protocolo_documento,
  anotacao = NULL,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

incluir_processo_bloco

Description

Inclui um processo em um bloco (incluirProcessoBloco).

Usage

incluir_processo_bloco(
  id_bloco,
  protocolo_procedimento,
  anotacao = NULL,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

lancar_andamento

Description

Lança um andamento em um processo (lancarAndamento). Escrita.

Usage

lancar_andamento(
  protocolo_procedimento,
  config = sei_config(),
  id_tarefa = NULL,
  id_tarefa_modulo = NULL,
  atributos = list(),
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble do andamento gerado (parse_andamento_response).

listar_andamentos

Description

Lista andamentos de um processo (listarAndamentos). É preciso informar ao menos um filtro: andamentos, tarefas ou tarefas_modulos.

Usage

listar_andamentos(
  protocolo_procedimento,
  config = sei_config(),
  sin_retornar_atributos = "N",
  andamentos = NULL,
  tarefas = NULL,
  tarefas_modulos = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de andamentos (Atributos como coluna-lista).

listar_andamentos_completo

Description

Conveniência sobre listar_andamentos() que recupera a linha do tempo completa de um processo e a ordena cronologicamente. Como a operação listarAndamentos do SEI exige um filtro de tarefas, esta função usa por padrão um intervalo amplo de identificadores de tarefa (que cobre as tarefas internas do SEI: geração, documentos, assinaturas, envio, recebimento, conclusão, blocos, etc.).

Usage

listar_andamentos_completo(
  protocolo_procedimento,
  config = sei_config(),
  tarefas = 1:200,
  sin_retornar_atributos = "N",
  ordenar = TRUE,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de andamentos ordenado por data/hora (ver parse_andamento_item).

Examples

## Not run: 
  linha <- listar_andamentos_completo("12.1.000000077-4", config = sei_config())
  linha[, c("DataHora", "Descricao", "SiglaUnidade", "NomeUsuario")]

## End(Not run)

listar_andamentos_marcadores

Description

Lista os eventos de marcador de um processo (listarAndamentosMarcadores): cada item traz o texto do marcador, a data/hora, o usuário responsável e o marcador associado.

Usage

listar_andamentos_marcadores(
  protocolo_procedimento,
  config = sei_config(),
  marcadores = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble com uma linha por evento de marcador.

listar_cargos

Description

Lista os cargos.

Usage

listar_cargos(
  config = sei_config(),
  id_cargo = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de cargos.

listar_cidades

Description

Lista as cidades.

Usage

listar_cidades(
  config = sei_config(),
  id_pais = NULL,
  id_estado = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de cidades.

listar_contatos

Description

Lista contatos (paginado).

Usage

listar_contatos(
  config = sei_config(),
  id_tipo_contato = NULL,
  pagina_registros = NULL,
  pagina_atual = NULL,
  sigla = NULL,
  nome = NULL,
  cpf = NULL,
  cnpj = NULL,
  matricula = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de contatos.

listar_documentos_processo

Description

Reconstrói a lista de documentos de um processo a partir dos seus andamentos.

O Web Service do SEI não possui uma operação nativa para listar os documentos de um processo; portanto esta função recupera a linha do tempo com listar_andamentos_completo() e extrai os números de documento mencionados nas descrições (ex.: "Gerado documento ... 84230597"). É uma heurística: o resultado depende do texto dos andamentos e pode não captar 100% dos casos.

Usage

listar_documentos_processo(
  protocolo_procedimento,
  config = sei_config(),
  consultar = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble com uma linha por documento: documento (número), DataHora/SiglaUnidade/SiglaUsuario/NomeUsuario/Andamento da primeira menção (a geração). Com consultar = TRUE, inclui também as colunas de consultar_documento().

Examples

## Not run: 
  docs <- listar_documentos_processo("12.1.000000077-4", config = sei_config())
  docs[, c("documento", "DataHora", "SiglaUnidade", "NomeUsuario")]

  # com detalhes (série, data, etc.)
  listar_documentos_processo("12.1.000000077-4", consultar = TRUE)

## End(Not run)

listar_estados

Description

Lista os estados (UF).

Usage

listar_estados(
  config = sei_config(),
  id_pais = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de estados.

listar_extensoes_permitidas

Description

Lista as extensões de arquivo permitidas.

Usage

listar_extensoes_permitidas(
  config = sei_config(),
  id_arquivo_extensao = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de extensões.

listar_feriados

Description

Lista os feriados.

Usage

listar_feriados(
  config = sei_config(),
  id_orgao = NULL,
  data_inicial = NULL,
  data_final = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de feriados.

listar_hipoteses_legais

Description

Lista as hipóteses legais.

Usage

listar_hipoteses_legais(
  config = sei_config(),
  nivel_acesso = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de hipóteses legais.

listar_marcadores_unidade

Description

Lista os marcadores da unidade.

Usage

listar_marcadores_unidade(config = sei_config(), raw = FALSE, verbose = FALSE)

Arguments

Value

Um tibble de marcadores.

listar_paises

Description

Lista os países.

Usage

listar_paises(config = sei_config(), raw = FALSE, verbose = FALSE)

Arguments

Value

Um tibble de países.

listar_permissao

Description

Lista permissões no SIP (listarPermissao).

Usage

listar_permissao(
  config = sip_config(),
  id_orgao_usuario = NULL,
  id_usuario = NULL,
  id_origem_usuario = NULL,
  id_orgao_unidade = NULL,
  id_unidade = NULL,
  id_origem_unidade = NULL,
  id_perfil = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de permissões (ou xml_document se raw = TRUE).

listar_publicacoes_processo

Description

Lista as publicações de um processo. Como o Web Service do SEI não expõe isso diretamente, a função descobre os documentos do processo com listar_documentos_processo() e consulta a publicação de cada um (consultar_publicacoes()), mantendo apenas os documentos que de fato possuem publicação.

Usage

listar_publicacoes_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

Um tibble com uma linha por publicação (coluna id = número do documento, mais as colunas de consultar_publicacao()). Vazio se o processo não tiver publicações.

Examples

## Not run: 
  listar_publicacoes_processo("12.1.000000077-4", config = sei_config())

## End(Not run)

listar_series

Description

Lista os tipos de documento (séries) liberados ao serviço.

Usage

listar_series(
  config = sei_config(),
  id_unidade = NULL,
  id_tipo_procedimento = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de séries.

listar_tipos_conferencia

Description

Lista os tipos de conferência.

Usage

listar_tipos_conferencia(
  config = sei_config(),
  id_unidade = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de tipos de conferência.

listar_tipos_procedimento

Description

Lista os tipos de processo liberados ao serviço.

Usage

listar_tipos_procedimento(
  config = sei_config(),
  id_unidade = NULL,
  id_serie = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de tipos de processo.

listar_tipos_procedimento_ouvidoria

Description

Lista os tipos de processo sinalizados como de Ouvidoria.

Usage

listar_tipos_procedimento_ouvidoria(
  config = sei_config(),
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de tipos de processo.

listar_unidades

Description

Lista as unidades acessíveis ao serviço (listarUnidades).

Usage

listar_unidades(
  config = sei_config(),
  id_tipo_procedimento = NULL,
  id_serie = NULL,
  raw = FALSE,
  verbose = FALSE,
  sei_url = NULL,
  sigla_sistema = NULL,
  identificacao_servico = NULL
)

Arguments

Value

Um tibble de unidades (ou xml_document se raw = TRUE).

listar_usuarios

Description

Lista os usuários com perfil "Básico" na unidade.

Usage

listar_usuarios(
  config = sei_config(),
  id_usuario = NULL,
  raw = FALSE,
  verbose = FALSE
)

Arguments

Value

Um tibble de usuários.

parse_andamento: Parse a <Andamento> Node

Description

Parseia um nó <Andamento> (Descricao, DataHora, e as subestruturas Unidade e Usuario) num tibble de 1 linha. Se o nó for ausente ou xsi:nil="true", devolve uma linha de NA.

Usage

parse_andamento(node_and)

Arguments

Value

Um tibble de 1 linha com Descricao, DataHora, IdUnidade, SiglaUnidade, DescricaoUnidade, IdUsuario, SiglaUsuario, NomeUsuario.

parse_andamento_item

Description

Parseia um ⁠<item>⁠ de Andamento no contexto de listarAndamentos (inclui IdAndamento/IdTarefa e Atributos).

Usage

parse_andamento_item(node)

Arguments

Value

Um tibble de 1 linha; Atributos é uma coluna-lista.

parse_andamento_marcador_item

Description

Parseia um ⁠<item>⁠ de AndamentoMarcador no contexto de listarAndamentosMarcadores (texto do marcador, data/hora, usuário e marcador associado).

Usage

parse_andamento_marcador_item(node)

Arguments

Value

Um tibble de 1 linha.

parse_andamento_response

Description

Parseia o retorno de lancarAndamento (um Andamento).

Usage

parse_andamento_response(doc)

Arguments

Value

Um tibble de 1 linha (ver parse_andamento_item).

parse_arquivo_extensao

Description

Parseia uma estrutura ArquivoExtensao.

Usage

parse_arquivo_extensao(node)

Arguments

Value

Um tibble de 1 linha.

parse_assinatura

Description

Parseia uma estrutura Assinatura.

Usage

parse_assinatura(node)

Arguments

Value

Um tibble de 1 linha com os campos da assinatura.

parse_assunto

Description

Parseia um <item> de <Assuntos>.

Usage

parse_assunto(node_ass)

Arguments

Value

Um tibble de 1 linha com CodigoEstruturado e Descricao.

parse_campo

Description

Parseia uma estrutura Campo (formulário).

Usage

parse_campo(node)

Arguments

Value

Um tibble de 1 linha com Nome e Valor.

parse_cargo

Description

Parseia uma estrutura Cargo.

Usage

parse_cargo(node)

Arguments

Value

Um tibble de 1 linha.

parse_cidade

Description

Parseia uma estrutura Cidade.

Usage

parse_cidade(node)

Arguments

Value

Um tibble de 1 linha.

parse_consultar_bloco_response

Description

Parseia a resposta de consultarBloco (RetornoConsultaBloco).

Usage

parse_consultar_bloco_response(doc)

Arguments

Value

Um tibble de 1 linha. Unidade, Usuario e UsuarioAtribuicao viram colunas com prefixo; UnidadesDisponibilizacao e Protocolos ficam como colunas-lista.

parse_consultar_documento_response

Description

Parseia a resposta de consultarDocumento (RetornoConsultaDocumento).

Usage

parse_consultar_documento_response(doc)

Arguments

Value

Um tibble de 1 linha. Serie, UnidadeElaboradora e AndamentoGeracao viram colunas com prefixo; Publicacao, Assinaturas e Campos ficam como colunas-lista.

parse_consultar_procedimento_individual_response

Description

Parseia a resposta de consultarProcedimentoIndividual (ProcedimentoResumido). Retorna linha de NA se nenhum processo for encontrado (parametros nulo).

Usage

parse_consultar_procedimento_individual_response(doc)

Arguments

Value

Um tibble de 1 linha.

parse_consultar_procedimento_response

Description

Parser principal de consultarProcedimento: localiza o nó <parametros>, extrai os campos escalares, recodifica NivelAcessoLocal/NivelAcessoGlobal e parseia as subestruturas (TipoProcedimento, andamentos, e os arrays Assuntos, Interessados, etc.).

Usage

parse_consultar_procedimento_response(doc)

Arguments

Value

Um tibble de 1 linha. Campos escalares e subestruturas 1:1 (TipoProcedimento e andamentos) viram colunas com prefixo; arrays (Assuntos, Interessados, Observacoes, UnidadesProcedimentoAberto, ProcedimentosRelacionados, ProcedimentosAnexados) ficam como colunas-lista de tibbles.

Examples

## Not run: 
  doc <- consultar_procedimento("0000000000.000001/2020-11", raw = TRUE)
  parse_consultar_procedimento_response(doc)

## End(Not run)

parse_consultar_publicacao_response

Description

Parseia a resposta de consultarPublicacao (RetornoConsultaPublicacao).

Usage

parse_consultar_publicacao_response(doc)

Arguments

Value

Um tibble de 1 linha. Publicacao e Andamento viram colunas com prefixo; Assinaturas fica como coluna-lista.

parse_contato

Description

Parseia uma estrutura Contato (subconjunto dos campos úteis).

Usage

parse_contato(node)

Arguments

Value

Um tibble de 1 linha.

parse_estado

Description

Parseia uma estrutura Estado.

Usage

parse_estado(node)

Arguments

Value

Um tibble de 1 linha.

parse_feriado

Description

Parseia uma estrutura Feriado.

Usage

parse_feriado(node)

Arguments

Value

Um tibble de 1 linha.

parse_hipotese_legal

Description

Parseia uma estrutura HipoteseLegal.

Usage

parse_hipotese_legal(node)

Arguments

Value

Um tibble de 1 linha.

parse_imprensa_nacional

Description

Parseia uma estrutura PublicacaoImprensaNacional.

Usage

parse_imprensa_nacional(node)

Arguments

Value

Um tibble de 1 linha.

parse_interessado

Description

Parseia um <item> de <Interessados>.

Usage

parse_interessado(nd_int)

Arguments

Value

Um tibble de 1 linha com Sigla e Nome.

parse_list_response

Description

Parser genérico para respostas ⁠listar*⁠: encontra ⁠<parametros>⁠ (que é um array) e aplica item_parser a cada ⁠<item>⁠ filho direto. Para estruturas planas prefira o caminho vetorizado interno (via mapas de campo), bem mais rápido em listas grandes.

Usage

parse_list_response(doc, response_name, item_parser)

Arguments

Value

Um tibble com uma linha por item (vazio se não houver itens).

parse_marcador

Description

Parseia uma estrutura Marcador (sem Icone, que é Base64).

Usage

parse_marcador(node)

Arguments

Value

Um tibble de 1 linha.

parse_observacao

Description

Parseia um <item> de <Observacoes>.

Usage

parse_observacao(nd_obs)

Arguments

Value

Um tibble de 1 linha com Descricao.

parse_pais

Description

Parseia uma estrutura Pais.

Usage

parse_pais(node)

Arguments

Value

Um tibble de 1 linha.

parse_permissao

Description

Parseia uma estrutura Permissao do SIP.

Usage

parse_permissao(node)

Arguments

Value

Um tibble de 1 linha.

parse_procedimento_resumido

Description

Parseia um <item> de <ProcedimentosRelacionados> ou <ProcedimentosAnexados>.

Usage

parse_procedimento_resumido(nd_pr)

Arguments

Value

Um tibble de 1 linha com IdProcedimento e ProcedimentoFormatado.

parse_protocolo_bloco

Description

Parseia uma estrutura ProtocoloBloco.

Usage

parse_protocolo_bloco(node)

Arguments

Value

Um tibble de 1 linha com ProtocoloFormatado, Identificacao e Assinaturas (coluna-lista).

parse_publicacao

Description

Parseia uma estrutura Publicacao, com a ImprensaNacional aninhada como coluna-lista.

Usage

parse_publicacao(node)

Arguments

Value

Um tibble de 1 linha.

parse_retorno_envio_email

Description

Parseia o retorno de enviarEmail (RetornoEnvioEmail).

Usage

parse_retorno_envio_email(doc)

Arguments

Value

Um tibble de 1 linha com IdDocumento, DocumentoFormatado, LinkAcesso.

parse_retorno_geracao_procedimento

Description

Parseia o retorno de gerarProcedimento (RetornoGeracaoProcedimento).

Usage

parse_retorno_geracao_procedimento(doc)

Arguments

Value

Um tibble de 1 linha com IdProcedimento, ProcedimentoFormatado, LinkAcesso e RetornoInclusaoDocumentos (coluna-lista).

parse_retorno_inclusao_documento

Description

Parseia o retorno de incluirDocumento (RetornoInclusaoDocumento).

Usage

parse_retorno_inclusao_documento(doc)

Arguments

Value

Um tibble de 1 linha com IdDocumento, DocumentoFormatado, LinkAcesso.

parse_serie

Description

Parseia uma estrutura Serie.

Usage

parse_serie(node)

Arguments

Value

Um tibble de 1 linha com IdSerie, Nome, Aplicabilidade.

parse_tipo_conferencia

Description

Parseia uma estrutura TipoConferencia.

Usage

parse_tipo_conferencia(node)

Arguments

Value

Um tibble de 1 linha.

parse_tipo_procedimento

Description

Parseia uma estrutura TipoProcedimento.

Usage

parse_tipo_procedimento(node)

Arguments

Value

Um tibble de 1 linha.

parse_unidade

Description

Parseia uma estrutura Unidade (filho direto ou ⁠<item>⁠).

Usage

parse_unidade(node)

Arguments

Value

Um tibble de 1 linha com os campos da unidade.

parse_unidade_procedimento_aberto

Description

Parseia um <item> de <UnidadesProcedimentoAberto>, extraindo as subestruturas Unidade e UsuarioAtribuicao.

Usage

parse_unidade_procedimento_aberto(node_upa)

Arguments

Value

Um tibble de 1 linha com os campos da unidade e do usuário de atribuição.

parse_usuario

Description

Parseia uma estrutura Usuario.

Usage

parse_usuario(node)

Arguments

Value

Um tibble de 1 linha.

reabrir_processo

Description

Reabre um processo na unidade (reabrirProcesso).

Usage

reabrir_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

Recodify SEI Access Level

Description

Converte os códigos numéricos de nível de acesso do SEI em texto: "0" -> "público", "1" -> "restrito", "2" -> "sigiloso". Valores ausentes, vazios ou fora de c("0","1","2") são devolvidos inalterados.

Usage

recodify_access_level(val)

Arguments

Value

"público", "restrito", "sigiloso", ou o valor original.

Examples

recodify_access_level("0")  # "público"
recodify_access_level("2")  # "sigiloso"

relacionar_processo

Description

Relaciona dois processos (relacionarProcesso). Bilateral.

Usage

relacionar_processo(
  protocolo1,
  protocolo2,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

remover_controle_prazo

Description

Remove o controle de prazo de processos (removerControlePrazo).

Usage

remover_controle_prazo(
  protocolos_procedimentos,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

remover_relacionamento_processo

Description

Remove o relacionamento entre dois processos.

Usage

remover_relacionamento_processo(
  protocolo1,
  protocolo2,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

remover_sobrestamento_processo

Description

Remove o sobrestamento de um processo.

Usage

remover_sobrestamento_processo(
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

replicar_permissao

Description

Replica (cadastra/altera/exclui) permissões no SIP (replicarPermissao).

Usage

replicar_permissao(permissoes, config = sip_config(), verbose = FALSE)

Arguments

Value

TRUE em caso de sucesso.

replicar_usuario

Description

Replica (cadastra/altera/desativa/reativa) usuários no SIP (replicarUsuario).

Usage

replicar_usuario(
  usuarios,
  config = sip_config(),
  sin_considerar_orgao = "N",
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

retirar_documento_bloco

Description

Retira um documento de um bloco (retirarDocumentoBloco).

Usage

retirar_documento_bloco(
  id_bloco,
  protocolo_documento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

retirar_processo_bloco

Description

Retira um processo de um bloco (retirarProcessoBloco).

Usage

retirar_processo_bloco(
  id_bloco,
  protocolo_procedimento,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

Monta o Envelope SOAP do SEI

Description

Constrói o envelope SOAP 1.1 no formato esperado pelos Web Services do SEI, com os namespaces xsi/xsd/soapenv/sei e o atributo soapenv:encodingStyle na operação. Suporta parâmetros escalares, estruturas aninhadas (listas nomeadas) e arrays (listas não nomeadas, cada elemento renderizado como <item>).

Usage

sei_build_envelope(
  operation,
  params = list(),
  ns_prefix = "sei",
  ns_uri = "Sei"
)

Arguments

Value

Uma string com o envelope SOAP completo.

Examples

cat(sei_build_envelope("listarUnidades",
  list(SiglaSistema = "HORTENSIAS", IdentificacaoServico = "chave")))

Chamada Genérica a um Web Service do SEI

Description

Monta o envelope SOAP para operation com params, envia via httr2 e devolve a resposta como xml_document. Trata erros HTTP e SOAP Fault (o SEI retorna falhas em HTTP 500 com faultstring).

Usage

sei_call(
  operation,
  params = list(),
  config = sei_config(),
  soap_action = "SeiAction",
  ns_prefix = "sei",
  ns_uri = "Sei",
  timeout = 60,
  verbose = FALSE
)

Arguments

Value

Um xml2::xml_document com a resposta SOAP.

Examples

## Not run: 
  doc <- sei_call("listarUnidades",
    params = list(SiglaSistema = "HORTENSIAS",
                  IdentificacaoServico = "chave"),
    config = sei_config())

## End(Not run)

SEI Connection Configuration

Description

Builds a configuration object holding the values that every SEI Web Service call needs: the endpoint URL, the system sigla (SiglaSistema), the service access key (IdentificacaoServico) and the default unit id (IdUnidade). Values are resolved, in order, from the arguments, options(rsei.*) and environment variables (RSEI_*).

The package is not tied to any particular SEI installation: set sei_url to the Web Service endpoint of your own SEI server, e.g. "https://sei.<your-org>.gov.br/sei/ws/SeiWS.php" (or the controlador_ws.php?servico=sei form).

Usage

sei_config(
  sei_url = NULL,
  sigla_sistema = NULL,
  identificacao_servico = NULL,
  id_unidade = NULL
)

Arguments

Value

An object of class "sei_config": a named list with sei_url, sigla_sistema, identificacao_servico and id_unidade.

Examples

cfg <- sei_config(
  sei_url = "https://sei.exemplo.gov.br/sei/ws/SeiWS.php",
  sigla_sistema = "MEU_SISTEMA",
  identificacao_servico = "minha-chave"
)
cfg$sei_url

Localiza o nó <parametros> da Resposta

Description

Helper interno que encontra o nó parametros dentro de uma resposta <...Response>, ignorando namespaces. Base para os parsers.

Usage

sei_find_parametros(doc, response = NULL)

Arguments

Value

O nó parametros, ou NULL se não encontrado.

Generate a New Procedure (gerarProcedimento)

Description

Wrapper de exemplo para a operação gerarProcedimento do SEI. Monta a lista de parâmetros e chama sei_call. Operação de escrita: use preferencialmente em servidor de homologação/treino.

Usage

sei_generate_procedure(
  sei_url,
  sigla_sistema,
  identificacao_servico,
  id_unidade,
  procedimento = list(),
  verbose = FALSE
)

Arguments

Value

Um xml_document com a resposta SOAP (a ser parseada).

Examples

## Not run: 
  resp <- sei_generate_procedure(
    sei_url = "https://sei.exemplo.gov.br/sei/controlador_ws.php?servico=sei",
    sigla_sistema = "HORTENSIAS",
    identificacao_servico = "chave",
    id_unidade = "100000969",
    procedimento = list(IdTipoProcedimento = "100000368",
                        Especificacao = "Teste")
  )

## End(Not run)

Set Default SEI Configuration for the Session

Description

Stores the given configuration values as options(rsei.*) so subsequent calls to sei_config (and therefore every operation) pick them up without having to pass config explicitly.

Usage

sei_set_default_config(
  sei_url = NULL,
  sigla_sistema = NULL,
  identificacao_servico = NULL,
  id_unidade = NULL
)

Arguments

Value

Invisibly, the previous options (as returned by options()).

Examples

## Not run: 
sei_set_default_config(
  sigla_sistema = "HORTENSIAS",
  identificacao_servico = Sys.getenv("RSEI_IDENTIFICACAO_SERVICO")
)

## End(Not run)

Escape de texto para XML

Description

Escapa os cinco caracteres reservados de XML (&, <, >, as aspas duplas e o apóstrofo) em um valor escalar. Usado internamente ao montar os parâmetros do envelope SOAP.

Usage

sei_xml_escape(x)

Arguments

Value

Uma string com os caracteres reservados escapados.

Chamada genérica a um Web Service do SIP

Description

Envia uma operação SIP usando o namespace "sipns" e a SOAPAction "sipnsAction". Delega para sei_call().

Usage

sip_call(operation, params = list(), config = sip_config(), verbose = FALSE)

Arguments

Value

Um xml2::xml_document.

Configuração de conexão SIP

Description

Objeto com os dados das chamadas SIP: URL do Web Service, Chave de Acesso e IdSistema. Valores resolvem de argumentos, ⁠options(rsei.sip_*)⁠ e variáveis ⁠RSEI_SIP_*⁠. Sem URL embutida — serve a qualquer instalação do SIP.

Usage

sip_config(sip_url = NULL, chave_acesso = NULL, id_sistema = NULL)

Arguments

Value

Um objeto de classe sip_config.

sobrestar_processo

Description

Sobresta um processo (sobrestarProcesso).

Usage

sobrestar_processo(
  protocolo_procedimento,
  motivo,
  protocolo_vinculado = NULL,
  config = sei_config(),
  verbose = FALSE
)

Arguments

Value

TRUE em caso de sucesso.

Store SEI Credentials in Keyring

Description

Stores (or updates) credentials for the SEI web service in the keyring. If the keyring package is not installed or if the store operation fails, it simply displays a message instead of throwing an error.

Usage

store_sei_credentials(service_name, username = NULL, password, ...)

Arguments

Value

Invisibly returns a logical value: TRUE if credentials were stored successfully, or FALSE otherwise.

Examples

## Not run: 
store_sei_credentials(
  service_name = "SEI_WS",
  username = "MySystemSigla",
  password = "MySEIAccessKey",
  url = "https://myserver/sei/controlador_ws.php?servico=sei",
  unit_id = "100000969"
)

## End(Not run)