Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico: | mnbo/bomn157.p |
Objetivo
Incluir, atualizar, consultar e eliminar dados da tabela tecn-mi do aplicativo de manutenção industrial.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada da API/BO é:
run mnbo/bomn157.p. |
A sintaxe para executar a API/BO em modo persistente é:
run mnbo/bomn157.p persistent set h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias:
RowObject | Entrada/Saída | ||||
Tabela de comunicação entre interface e banco de dados da tabela tecn-mi. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
Cd-tecnico | Character | 99999-9 | Código do técnico | Sim |
|
Nome-compl | Character | X(30) | Nome completo | Sim |
|
cd-equipe | Character | X(8) | Equipe do técnico | Sim |
|
Ferias | Logical | Yes/No | Técnico está em férias | Não |
|
Cc-codigo | Character | X(20) | Centro de custo do técnico | Sim |
|
Valor-mob | Decimal | >>>>,>>>,>>9.9999 | Valor de mão de obra do técnico | Não |
|
Character | X(40) | E-mail do técnico | Não |
| |
Calendario | Character | X(8) | Calendário de manutenção utilizado pelo técnico | Sim |
|
Capacidade-dia | Decimal | >>>>,>>>,>>9.9999 | Capacidade diária do técnico | Não |
|
Cd-mob-dir | Character | X(5) | Código de mão de obra direta do técnico | Não |
|
Situacao | Integer | >9 | Situação do técnico | Não |
|
agenda-mail | Logical | Sim/Não | Técnico recebe agenda por e-mail | Não |
|
Log-tar-simul | Logical | Sim/Não | Permite tarefa simultânea | Sim |
|
Ep-codigo | Character | X(3) | Empresa do funcionário associado ao técnico | Não |
|
Cod-estabel | Character | X(5) | Estabelecimento do funcionário associado ao técnico | Não |
|
Cdn-func | Integer | 99999999 | Matrícula do funcionário associado ao técnico | Não |
|
Dat-ativac | Date | 99/99/9999 | Data de ativação do técnico | Não |
|
Dat-desativ | Date | 99/99/9999 | Data de inativação do técnico | Não |
|
Cod-livre-1 | Character | X(100) | Livre 1 | Não |
|
Cod-livre-2 | Character | X(100) | Livre 2 | Não |
|
Cod-livre-3 | Character | X(100) | Livre 3 | Não |
|
Cod-livre-4 | Character | X(100) | Livre 4 | Não |
|
Dat-livre-1 | Date | 99/99/9999 | Livre 1 | Não |
|
Dat-livre-2 | Date | 99/99/9999 | Livre 2 | Não |
|
Dat-livre-3 | Date | 99/99/9999 | Livre 3 | Não |
|
Dat-livre-4 | Date | 99/99/9999 | Livre 4 | Não |
|
Log-livre-1 | Logical | Sim/Não | Livre 1 | Não |
|
Log-livre-2 | Logical | Sim/Não | Livre 2 | Não |
|
Log-livre-3 | Logical | Sim/Não | Livre 3 | Não |
|
Log-livre-4 | Logical | Sim/Não | Livre 4 | Não |
|
Num-livre-1 | Integer | >>>>>>>>9 | Livre 1 | Não |
|
Num-livre-2 | Integer | >>>>>>>>9 | Livre 2 | Não |
|
Num-livre-3 | Integer | >>>>>>>>9 | Livre 3 | Não |
|
Num-livre-4 | Integer | >>>>>>>>9 | Livre 4 | Não |
|
Val-livre-1 | Decimal | ->>>>>>>>>>>9.99999999 | Livre 1 | Não |
|
Val-livre-2 | Decimal | ->>>>>>>>>>>9.99999999 | Livre 2 | Não |
|
Val-livre-3 | Decimal | ->>>>>>>>>>>9.99999999 | Livre 3 | Não |
|
Val-livre-4 | Decimal | ->>>>>>>>>>>9.99999999 | Livre 4 | Não |
|
RowErrors | Entrada/Saída | ||||
Contém os erros ocorridos na BO. | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Integer | Padrão | Sequência dos erros | Sim |
|
ErrorNumber | Integer | Padrão | Número do erro | Sim |
|
ErrorDescription | Char | Padrão | Descrição do erro | Sim |
|
ErrorParameters | Char | Padrão | Parâmetros passados para criar mensagem | Não |
|
ErrorType | Char | Padrão | Tipo do erro: WARNING: Aviso ERROR: Erro | Sim |
|
ErrorHelp | Char | Padrão | Texto de ajuda do erro | Sim |
|
ErrorSubType | Char | Padrão | Sub Tipo da mensagem de erro | Não |
|
Métodos
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução.
goToKey | ||
Requisito | Nenhum | |
Sintaxe | Run goToKey in h-handle (input <integer>, input <character>) | |
Descrição | Posiciona o registro da tecn-mi através do código do técnico. | |
Parâmetros | Descrição | |
pcd-tecnico | Código do técnico | |
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 RowErrors. |
getKey | ||
Requisito | Nenhum | |
Sintaxe | run getKey in h-handle (output <integer>, output <character>) | |
Descrição | Retorna os campos da chave primária do registro posicionado. | |
Parâmetros | Descrição | |
pcd-tecnico | Código do técnico | |
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 RowErrors. |
getCharField | ||
Requisito | Nenhum | |
Sintaxe | run getCharField in h-handle (input <character>, output <character>) | |
Descrição | Retorna os valores dos campos da tabela que são caracteres. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getDateField | ||
Requisito | Nenhum | |
Sintaxe | run getDateField in h-handle (input <character>, output <date>) | |
Descrição | Retorna os valores dos campos da tabela que são data. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getDecField | ||
Requisito | Nenhum | |
Sintaxe | run getDecField in h-handle (input <character>, output <decimal>) | |
Descrição | Retorna os valores dos campos da tabela que são decimais. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getIntField | ||
Requisito | Nenhum | |
Sintaxe | run getIntField in h-handle (input <character>, output <integer>) | |
Descrição | Retorna os valores dos campos da tabela que são inteiros. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getLogField | ||
Requisito | Nenhum | |
Sintaxe | run getLogField in h-handle (input <character>, output <logical>) | |
Descrição | Retorna os valores dos campos da tabela que são Lógicos. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getRawField | ||
Requisito | Nenhum | |
Sintaxe | run getRawField in h-handle (input <character>, output <raw>) | |
Descrição | Retorna os valores dos campos da tabela que são caracteres longos. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getRecidField | ||
Requisito | Nenhum | |
Sintaxe | run getRecidField in h-handle (input <character>, output <recid>) | |
Descrição | Retorna os valores dos campos da tabela que são numéricos e definem uma sequência única para a tabela dentro do database. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado | |
pFieldValue | Valor do campo | |
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 RowErrors. |
getRowid | ||
Requisito | Nenhum | |
Sintaxe | run getRowid in h-handle (output <rowid>) | |
Descrição | Retorna o ROWID do registro corrente da Query que está aberta na BO. Este método não aparece para ser manutenido. | |
Parâmetros | Descrição | |
pRowid | Rowid da tabela | |
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 RowErrors. |
OpenQuery / SetConstraint / LinkTo
openQueryDefault | ||
Requisito | Nenhum | |
Sintaxe | run openQueryDefault in h-handle | |
Descrição | Busca conjunto de registros da tabela tecn-mi. | |
Parâmetros | Descrição | |
Não Contém |
| |
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 RowErrors. |
Método Negócio
validateRecord | ||
Requisito | Executar alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO. | |
Sintaxe | run validateRecord in this-procedure (input <character>) | |
Descrição | Valida as ações feitas em cima do registro da tabela corrente da BO. Estas ações podem ser: “CREATE”, “UPDATE” e “DELETE”. | |
Parâmetros | Descrição | |
pType | Tipo de ação: “CREATE” “UPDATE” “DELETE” | |
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 RowErrors. |
piCarregaExcecaoRH | ||
Requisito | Não se aplica. | |
Sintaxe | run piCarregaExcecaoRH in h-handle (input <character>, output <integer>, output <character>) | |
Descrição | Importa os registros de afastamento do funcionário para a tabela de exceções do técnico. A importação será executada apenas se o técnico estiver associado a um funcionário e o parâmetro ‘Integra com RH’ estiver ativo. | |
Parâmetros | Descrição | |
pCdTecnico | Código do técnico | |
pErrorCode | Código do erro, se houver | |
pErrorHelp | Descrição do erro | |
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). |
piRetornaTTTecnico | ||
Requisito | Não se aplica. | |
Sintaxe | run piRetornaTTTecnico in h-handle (input <logical>, output <ttEspTecn1>) | |
Descrição | Retorna uma tabela temporária com os técnicos ativos ou inativos, conforme valor informado no primero parâmetro. | |
Parâmetros | Descrição | |
plTecnAtivos | Determina o tipo de pesquisa, podendo ser:
| |
ttEspTecn1 | Tabela temporária com os técnicos ativos ou inativos com suas devidas especialidade, conforme valor informado no primero 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). |
setConstraintTpEspecial | ||
Requisito | Não se aplica. | |
Sintaxe | run setConstraintTpEspecial in h-handle (input <character >, input <character >) | |
Descrição | Atualiza o valor da variável “Especialidade inicial” e “Especialidade Final”, utilizada na procedure “piRetornaTTEspTec”. | |
Parâmetros | Descrição | |
pEspecIni | Especialidade Inicial. | |
pEspecFim | Especialidade Final. | |
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). |
piRetornaTTEspTec: | ||
Requisito | Não se aplica. | |
Sintaxe | run piRetornaTTTecnico in h-handle (input <logical>, output <ttEspTecn2>) | |
Descrição | Retorna uma tabela temporária com os técnicos ativos ou inativos, conforme valor informado no primero parâmetro. | |
Parâmetros | Descrição | |
plSomentAtivos | Determina o tipo de pesquisa, podendo ser:
| |
ttEspTecn2 | Tabela temporária com os técnicos ativos ou inativos com suas devidas especialidade, conforme valor informado no primero 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). |
piTecnicoAtivo | ||
Requisito | Não se aplica. | |
Sintaxe | run piTecnicoAtivo in h-handle (input <logical>) | |
Descrição | Atualiza o valor da variável “lAtivos”, utilizada nos métodos de open query’s. | |
Parâmetros | Descrição | |
pSomenteAtivo | Determina o tipo de pesquisa, podendo ser:
| |
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). |