Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr019 

 

Objetivo

Validação, Manutenção e acesso rápido a tabela “mab-param”. 

 

Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-param”.

...

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.

 

 

Tabelas Temporárias

Nos atributos das tabelas temporárias:

...

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cdn-param

int

>>>>9

Código - Numérico Parâmetro

Sim

 

des-param

char

x(100)

Descrição do Parâmetro

Sim

 

des-label-param

char

x(35)

Label

Sim

 

des-valor

char

x(20)

Valor do Parâmetro

Sim

 

cod-livre-1

char

X(100)

Livre 1

 

 

cod-livre-2

char

X(100)

Livre 2

 

 

log-livre-1

Log

Sim/Não

Livre 1

 

 

log-livre-2

Log

Sim/Não

Livre 2

 

 

num-livre-1

Int

->>>>>>>>>9

Livre 1

 

 

num-livre-2

Int

->>>>>>>>>9

Livre 2

 

 

val-livre-1

Dec

->>>>>>>>>>>9.9999

Livre 1

 

 

val-livre-2

Dec

->>>>>>>>>>>9.9999

Livre 2

 

 

dat-livre-1

date

99/99/9999

Livre 1

 

 

dat-livre-2

date

99/99/9999

Livre 2

 

 

num-max-eqpto

Integer

>>>,>>>,>>9

Número Máximo Equipamentos Controlados no Sistema

 

 

 

 

Tabela Temporária

Descrição

Entrada/Saída

RowErrors

Contém os erros ocorridos na BO.

Saída

...

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

codModulo

Integer

Padrão

Código do Módulo

Não

 

cdFuncao

Char

Padrão

Código da Função

Não

 

desModulo

Char

Padrão

Descrição do Módulo

Não

 

logAtivo

Logical

Padrão

Status (Ativo ou Inativo)

Não

 

logAtivoToVisualization

Char

padrão

Status (Ativo ou Inativo)

 Não 

 

 

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

...

Requisito

Nenhum

Sintaxe

run validaParametros in this-procedure (input <integer>,

                                        input <character>).

Descrição

Recebe o código e o valor do parâmetro para realizar a validação contra outras tabelas do sistema se existe o tipo de parâmetro informado.

 

Parâmetros

Descrição

 

pParam

Código do parâmetro

pValor

Valor do parâmetro

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

...

loadParamsMetadados

Requisito

Nenhum

Sintaxe

run loadParamsMetadados in hDBOParam (output <temp-table>,

                                      output <temp-table>,

                                      output <character>).

Descrição

Retorna os registros existentes dos parâmetros de frotas e dos módulos de frotas implantados, assim como a quantidade de equipamentos cadastrados.

 

Parâmetros

Descrição

 

ttParamFrotas

Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento)

ttModulosMD

Temp-table dos Módulos de Frotas Implantados (Ver definição de Temp-table no início desse documento)

cNrEqptoRela

Numero de Equipamentos Cadastrados

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro.

...

getFieldType

Requisito

Nenhum

Sintaxe

run getFieldType in hDBOParam (input <integer>,

                               output <integer>.

Descrição

Retorna o tipo do parâmetro, pode esse ser: “1-Decimal”, “2-Valores em combo Box”, “3-Inteiro”, “4-Character”, “5-Zoom UM”, “6-Zoom Eventos”, “7-Zoom de sub-sistema”, “8-Zoom de Tipo Manutenção”, “9-Zoom Tipo Empresa”, “10-Zoom de Motorista”, “11-Zoom de Tipo Trajeto Padrão”, “12-Zoom de Causa Padrão”, “13-Zoom Catálogo Documento Características Componente, “14-check Box”.

 

Parâmetros

Descrição

 

pCdnParam

Código do Parâmetro

fieldType

Tipo do Parâmetro

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro.

 

atualizaValorMetadados

Requisito

Nenhum

Sintaxe

run atualizaValorMetadados in hDBOParam (input <temp-table>,

                                         output <temp-table>,

                                         output <temp-table>).

Descrição

Realiza as atualizações dos Parâmetros de Frotas alterados via Metadados.

 

Parâmetros

Descrição

 

ttParamFrotas

Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento)

ttParamFrotas

Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento)

rowErrors

Temp-table de Erros (Ver definição de Temp-table no início desse documento)

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro.

 

...

Requisito

Nenhum

Sintaxe

run updateModulosMetadados in hDBOParam (input <integer>,

                                         input <logical>,

                                         output <temp-table>).

Descrição

Altera e Retorna os Módulos de Frotas.

 

Parâmetros

Descrição

 

pModulo

Código do Módulo

pAtivo

Status (Ativo ou Inativo)

ttModulosMD

Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento)

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro.

 

getParamsFiltered

Requisito

Nenhum

Sintaxe

run getParamsFiltered in hDBOParam (input <character>,

                                    output <temp-table>).

Descrição

Retorna os Parâmetros de Frotas filtrados conforme Filtro recebimento por parâmetro.

 

Parâmetros

Descrição

 

pParam

Parâmetro referente ao Filtro

ttParamFrotas

Temp-table dos parâmetros de Frotas cadastrados (conforme Filtro) (Ver definição de Temp-table no início desse documento)

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro.