Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoinbo/boin318.p


RecordSet  


tt-pl-prod


tt-pl-prod 

Atributo

Tipo

Formato

Descrição

Obr.

 cd-plano       

inte 

    >>9            

 Plano                

Sim

 descricao      

char 

    x(30)

 Descrição            

Sim

 tipo-plano     

char 

    !!             

 Tipo Plano           

Sim

 cd-tipo         

inte 

    >9             

 Tipo Período         

Sim

 ano-per-ini    

inte 

    9999           

 Ano Período Inicial  

Sim 

 nr-per-ini     

inte 

    >>9            

 Período Inicial      

Sim

 ano-per-fim    

inte 

    9999            

 Ano Período Final    

Sim

 nr-per-fim     

inte 

    >>9            

 Período Final        

Sim

 dt-validade    

inte 

    >9             

 Data Validade Estrutur

Sim

 tp-rep-comp    

inte 

    >9             

 Reprogramação Comprado

Sim  

 tp-seg-comp    

logi 

    Sim/Não        

 Considera Estoq Segur

Sim

 saldo-comp     

logi 

    Sim/Não        

 Considera Saldo Estq 

Sim

 ordens-comp    

logi 

    Sim/Não        

 Considera Ordens Compr

Sim

 res-comp       

logi 

    Sim/Não        

 Considera Reservas   

Sim

 pedidos-comp   

logi

     Sim/Não        

 Cart Ped             

Sim 

 tp-rep-fabr    

inte

     >9             

 Reprogramação Fabricad

Sim

 tp-seg-fabr    

logi

     Sim/Não        

 Considera Estoq Segur

Sim

 saldo-fabr     

logi

     Sim/Não        

 Considera Saldo Estq 

Sim

 ordens-fabr    

logi

     Sim/Não        

 Considera Ordens Produ

Sim

 res-fabr       

logi

     Sim/Não        

 Considera Reservas   

Sim 

 pedidos-fabr   

logi

     Sim/Não        

 Cart Ped             

Sim

 rastreamento   

logi

     Sim/Não        

 Gera Rastreamento    

Sim

 calculo        

inte

     >9             

 Status do Cálculo    

Sim

 regera-plano   

logi

     Sim/Não         

 Regera Plano         

Sim

 usuario        

char

     x(12)

 Usuario                

Sim 

 data-inicio    

date

     99/99/9999     

 Data Início          

Sim

 hora-inicio    

char

     x(8)

 Hora Início          

Sim

 data-termino    

date

     99/99/9999     

 Data Término         

Sim

 hora-termino   

char

     x(8)

 Hora Término         

Sim

 it-dem-ind     

inte

     >>>,>>9        

 Itens Demanda Independ

Sim 

 it-dem-dep     

inte

     >>>,>>9        

 Itens Demanda Dependen

Sim

 nr-ord-comp    

inte

     >>>,>>9        

 Ordens Compra        

Sim

 nr-ord-fabr    

inte

     >>>,>>9        

 Ordens Fabricação    

Sim

 nr-ord-rep     

inte

     >>>,>>9        

 Ordens Reprogramadas 

Sim

 it-fabr         

inte

     >>>,>>9        

 Itens Fabricados     

Sim 

 nr-res-comp    

inte

     >>>,>>9        

 Reservas Comprometidas

Sim

 nr-item-pedi   

inte

     >>>>>,>>9      

 Itens Pedido         

Sim

 nr-ord-plan    

inte

     >>>,>>9         

 Ordens Planejadas    

Sim

 nr-res-plan    

inte

     >>>,>>9        

 Reservas Planejadas  

Sim

 pl-estado      

inte

     >9             

 Estado Plano         

Sim 

 dt-ini-net     

date

     99/99/9999     

 Data Início Net-Change

         

 dt-fim-net     

date

     99/99/9999     

 Data Término Net-Chang

         

 h-ini-net      

char

     x(8)

 Hora Inicio Net-Change

         

 h-fim-net      

char

     x(8)

 Hora Termino Net-Chang

         

 nr-it-net      

inte

     >>>,>>9        

 Itens Net-Change     

Sim

 horiz-fixo     

inte

     >>9            

 Horizonte Fixo       

Sim

 quant-confirm  

logi

     Sim/Não        

 Considera Qtde Conf  

Sim

 cod-estabel    

char

     x(3)

 Estabelecimento Padrão

Sim

 aprov-fabr     

logi

     Sim/Não        

 Apenas Pedidos Aprovad

Sim 

 aprov-comp     

logi

     Sim/Não        

 Apenas Pedidos Aprovad

Sim

 consig-comp    

logi

     Sim/Não        

 Considera Saldo Consig

Sim

 consig-fabr     

logi

     Sim/Não        

 Considera Saldo Consig

Sim

 tran-fabr      

logi

     Sim/Não        

 Considera Saldo Trânsi

Sim

 tran-comp      

logi

     Sim/Não        

 Considera Saldo Trânsi

Sim 

 benef-fabr     

logi

     Sim/Não         

 Considera Saldo em Ter

Sim

 benef-comp     

logi

     Sim/Não        

 Considera Saldo em Ter

Sim

 tp-res-comp    

logi

     Sim/Não        

 Considera Ressupr    

         

 tp-res-fabr    

logi

     Sim/Não        

 Considera Ressupr     

         

 nr-dias-seg    

inte

     >>>9           

 Horizonte Segurança  

         

 char-1         

char

     x(100)

 ?                    

         

 char-2         

char

     x(100)

 ?                   

         

 dec-1           

deci-2

     ->>>>>>>>>>>9.9

 ?                    


 dec-2          

deci- 2

     ->>>>>>>>>>>9.9

 ?                    


 int-1          

inte

     ->>>>>>>>>9    

 ?                    

         

 int-2          

inte

     ->>>>>>>>>9     

 ?                    

         

 log-1          

logi

     Sim/Não        

 ?                    

         

 log-2          

logi

     Sim/Não        

 ?                    

         

 data-1         

date

     99/99/9999     

 ?                     

         

 data-2         

date

     99/99/9999     

 ?                    

         

 calculo-plano  

inte

     >9             

 Cálculo Plano        

Sim

 check-sum      

char 

    x(20)

 Check-sum            

         


RecordSet  Related    


Temp-Tables adicionais utilizadas nos demais métodos de negócio para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.


 

Atributo

Tipo

Formato

Descrição

Obr.






                        

Métodos Básicos 


Métodos básicos de acesso ao banco de dados.



Método:

goToKey

 

Descrição: 

Reposiciona registro com base no índice CODIGO


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pcd-plano

int


X

 

 

Plano

 


Método:

goToKeyEstado

 

Descrição: 

Reposiciona registro com base no índice pl-estado


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-estado

int


X

 

 

Estado Plano

 


Método:

getKey

 

Descrição: 

Retorna valores dos campos do índice CODIGO


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pcd-plano

int


 

X

 

Plano

 


Método:

validateRecord

 

Descrição: 

Valida temptable RowObject


Requisitos:

Nenhum


Parâmetros:

Recebe o tipo de validação (Create, Delete, Update)

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pType

char


X

 

 

Recebe o tipo de validação

 


Método:

getCharField

 

Descrição: 

Retorna o valor de um campo character.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

char


 

X

 

Valor Campo



Método:

getDecField

 

Descrição: 

Retorna o valor de um campo decimal.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

decimal


 

X

 

Valor Campo



Método:

getIntField

 

Descrição: 

Retorna o valor de um campo inteiro.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

integer


 

X

 

Valor Campo



Método:

getDateField

 

Descrição:

Retorna o valor de um campo date.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

date


 

X

 

Valor Campo



Método:

getLogField

 

Descrição: 

Retorna o valor de um campo logical.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

logical


 

X

 

Valor Campo



Método:

getRawField

 

Descrição: 

Retorna valor de campos do tipo raw.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

raw


 

X

 

Valor Campo



Método:

getRecidField

 

Descrição: 

Retorna valor de campos do tipo recid.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char


X

 

 

Nome Campo

pFieldValue

Recid


 

X

 

Valor Campo


Queries e Constraints


Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura)  utilizadas para buscar grupos de registros da base de dados.



Método:

OpenQueryStatic ("Main")

 

Descrição:

Busca conjunto de registros da tabela pl-prod.



Método:

OpenQueryStatic ("CdPlano")

 

Descrição:

Busca conjunto de registros da tabela pl-prod conforme o código do plano.


Constraints Associados:

Executar o método setConstraintCdPlano.



Método:

OpenQueryStatic ("FiltroCdPlano")

 

Descrição:

Busca conjunto de registros da tabela pl-prod, dentro de uma faixa de código do plano inicial e código do plano final.


Constraints Associados:

Executar o método setConstraintFiltroCdPlano.


Método:

OpenQueryStatic ("FiltroDescricao")

 

Descrição:

Busca conjunto de registros da tabela pl-prod, dentro de uma faixa de descrição inicial e final, estado do plano inicial e final.



Método:

SetConstraintCdPlano

 

Descrição:

Seta as variáveis de controle para queries contendo o código do plano.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pcd_plano

int


X

 

 

Código Plano



Método:

SetConstraintFiltroCdPlano

 

Descrição:

Seta as variáveis de controle para queries contendo o código inicial e final do plano.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pinicial

char


X

 

 

Código Inicial

pfinal

char


X

 

 

Código Final


Métodos Negócio 


Métodos adicionais de atualização e acesso a base de dados.



Método:

CarregaValoresIniciais


Descrição:

Procura pelo primeiro Plano Ativo. Caso ache, retornará o Código do Plano (cd-plano), o Período Inicial (nr-per-ini), o Ano Inicial (ano-per-ini), e por fim o Estabelecimento (caso este possua algum).


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pit-codigo

char


X

 

 

Item

p-cod-refer

char


X

 

 

Referência

p-cd-plano

inte


 

X

 

Plano

p-nr-per-ini

inte


 

X

 

Período Inicial

p-ano-per-ini

inte


 

X

 

Ano Inicial

p-cod-estabel

char


 

X

 

Estabelecimento

 


Método:

copiaEspPlano

 

Descrição:

Faz uma cópia de um plano original para outro. Copia também os itens do plano.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cd-plano-orig

inte


X

 

 

Plano Original

i-cd-plano-dest

inte


X

 

 

Plano Destino

i-ano-ini

inte


X

 

 

Ano Inicial

i-per-ini

inte


X

 

 

Período Inicial

rw-plano

rowid


 

X

 

Rowid Plano criado



Método:

copiaEspQuantidade

 

Descrição:

Faz uma cópia especial dos itens do plano de um período para outro.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cd-plano

inte


X

 

 

Código Plano

i-ano-ini

inte


X

 

 

Ano Inicial

i-per-ini

inte


X

 

 

Período Inicial

i-ano-ini2

inte


X

 

 

Novo Ano

i-per-ini2

inte


X

 

 

Novo Período

l-resposta

logi


 

 

 

Atualiza Quantidade



Método:

deleteRelacionamentos

 

Descrição:

Elimina os relacionamentos do Plano de Produção.



Método:

eliminaItensPlano

 

Descrição:

Elimina os itens do plano.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cod-plano

inte


X

 

 

Código Plano

da-data-ini

date


X

 

 

Data Inicial

da-data-fim

date


X

 

 

Data Final



Método:

verificaItensFora

 

Descrição:

Verifica se existe itens fora do período informado.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cod-plano

inte


X

 

 

Código Plano

da-data

date


X

 

 

Data Témino

i-tipo

date


X

 

 

Verifica faixa com maior ou menor a data informada

l-it-fora

logi


 

X

 

Informa se encontrou itens fora da faixa

 


Método:

verificaNivelItens

 

Descrição:

Verifica o n¡vel mais baixo dos itens do plano.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cod-plano

inte


X

 

 

Código Plano

l-confirma

logi


 

X

 

Nível diferente de zero



Método:

verificaPeriodoItens

 

Descrição:

Verifica o per¡odo dos itens do plano.


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-cod-plano

inte


X

 

 

Código Plano

i-cod-tipo

inte


X

 

 

Tipo Período

dt-fim-per-i

date


X

 

 

Data Fim

l-todos

logi


 

X

 

Se não existe período ou a data de término está diferente da informada