Histórico da Página
Produto: | Microsiga Protheus | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Versões: | Esta classe está disponível na versão 12 do Microsiga Protheus com release igual ou superior a 12.1.14. É fundamental a correta configuração do parâmetro MV_TECATF para o funcionamento da classe. Recomenda-se a execução da função TecDestroy sempre que esta classe for instanciada. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ocorrência: | A Classe TecProvider tem como finalidade gerenciar a integração entre os módulos de Gestão de Serviços (SIGATEC) e Ativo Fixo (SIGAATF) por meio de um objeto AdvPL que concentra a maioria das informações relativas a Base de Atendimento (Base de Locação de Equipamentos) e o Ativo Fixo, como: Nome, Tipo, Saldos Bloqueados, Saldos Reservados, Saldos em Manutenção, entre outros. Esta classe facilita a manipulação e consulta das informações de maneira unificada sem a necessidade de execução de múltiplas consultas em diferentes tabelas. Seu formato também facilita o trabalho das equipes de campo e de customizações evitando redundâncias na escrita de funções AdvPL de contexto desta integração. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Passo a passo: | Métodos:
Método Construtor da Classe AdvPL Parâmetros: cNumSer
cFil
lLoadAll
Retorno: oTecProvider
Apresenta uma mensagem com a lista de eventuais erros encontrados durante o instanciamento do objeto a partir dos dados informados como parâmetro; exceto se as informações passadas como parâmetro, por meio do método New(), estiverem coerentes. Parâmetros: Nil
Retorno: Nil
Permite relacionar um novo ativo imobilizado a base de atendimento instanciada no objeto através do método New. Para isto, cria um novo registro na tabela TWH - Relação Base x Ativo. Parâmetros: cFilAtivo
cAtivo
cItem
Retorno: lRet
Permite que sejam inseridos novos bloqueios de saldos na tabela TWU - Saldos Bloqueados. Sempre que necessário, um equipamento do tipo granel pode ter uma parte de seu saldo (quantidade de exemplares) passível de bloqueio em razão de algum motivo qualquer, como por exemplo "Reserva", "Manutenção", etc. Parâmetros: cCodTEW
Retorno: Nil
Método responsável por atualizar uma quantidade liberada referente ao bloqueio de um registro já existente na tabela TWU - Bloqueio de Saldos. Neste caso o valor total liberado sera corresponde a quantidade ja liberada em momentos anteriores somada ao novo valor informado. O posicionamento na tabela TWU para atualização do saldo liberado pode ser realizado através de duas formas: Por meio do código de movimentação (Tabela TEW) ou através do código da OS relacionada. Observação: Embora os parâmetros cIDReg e cChaveOs sejam opcionais, ao menos um deles deve ser corretamente preenchido.
Parâmetros: cIdReg
nQtd
cChaveOS
Retorno: lRet
Método responsável por apagar um registro ja existente na tabela TWU - Bloqueio de Saldos. O posicionamento na tabela TWU para exclusão pode ser realizado através de duas formas: Por meio do código de movimentação (Tabela TEW) ou através do código da OS relacionada. Observação: Embora os parâmetros cIDReg e cChaveOs sejam opcionais, ao menos um deles deve ser corretamente preenchido. Parâmetros: cIdReg
cChaveOS
Retorno: lRet
Permite bloquear a utilização da base de atendimento definida no método construtor desta classe, de forma que a mesma não esteja mais apta para movimentações e utilização nas funcionalidades de Locação de Equipamentos do modulo Gestão de Serviços. Parâmetros: Nil Retorno: Nil
Permite desbloquear a utilização da base de atendimento definida no método construtor desta classe, de forma que a mesma esteja apta para movimentações e utilização nas funcionalidades de Locação de Equipamentos do modulo Gestão de Serviços. Parâmetros: Nil Retorno: Nil
Permite obter o saldo disponível do equipamento para locação partir de um período previamente informado. Parâmetros: dDtAlvo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tipo: | Date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Obrigatório: | Não | Descrição: | Data alvo para consulta do saldo no contexto "A partir de:"
Tipo: | Numérico |
Descrição: | Quantidade de itens disponíveis para utilização na Locação de Equipamentos |
- SaldoTotal
Realiza o calculo da quantidade total dos Ativos Imobilizados associados a Base de Atendimento considerando as informações registradas na tabela TWH e o período inicial e final indicado como parâmetro.
Parâmetros:
dDtIni
Tipo: | Date |
Obrigatório: | Sim |
Descrição: | Período inicio de pesquisa do Saldo. Considerado para filtrar a data "A partir de" utilizada na consulta dos ativos imobilizados. |
dDtFim
Tipo: | Date |
Obrigatório: | Sim |
Descrição: | Período final de pesquisa do Saldo. Considerado para filtrar a data "Ate" utilizada na consulta dos ativos imobilizados. |
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Quantidade de itens adquiridos, cadastrados como ativo imobilizado e relacionados a Base de Atendimento para utilização na Locação de Equipamentos dentro do período especificado. |
- SaldoAdquirido
Realiza o calculo da quantidade total de itens do Ativo Imobilizado associados a uma determinada base de atendimento, independente de um período de tempo. ("Fotografia Atual")
Parâmetros:
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Soma das quantidades de itens encontrados no Ativo Imobilizado relacionados a base de atendimento |
- SaldoLocado
Obtém o saldo locado de uma determinada base de atendimento, podendo ainda se obter este valor a partir de uma determinada data.
Parâmetros:
dDtAlvo
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Saldo Locado do Equipamento em questão na data pesquisada. |
- SaldoReservado
Obtém o saldo total reservado do equipamento em questão.
Parâmetros:
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Saldo Reservado do Equipamento em questão |
- SaldoManutencao
Obtém o saldo total do equipamento que encontra-se bloqueado na tabela TWU por conta do motivo 2 - OS do SIGAMNT
Parâmetros:
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Saldo Bloqueado do Equipamento em questão pelo motivo 2 - Ordem de Serviço do SIGAMNT |
- SaldoTravado
Obtém o saldo total do equipamento que encontra-se bloqueado na tabela TWU por conta do motivo 3 - Outros
Parâmetros:
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Saldo Bloqueado do Equipamento em questão pelo motivo 3 - Ordem de Serviço do SIGAMNT |
- SaldoBloqueado
Soma de todo o saldo bloqueado do equipamento na tabela TWU, independente do tipo de bloqueio
Parâmetros:
Nil
Retorno:
nQtd
Tipo: | Numérico |
Descrição: | Saldo Bloqueado do Equipamento em questão |
Principais Atributos (Propriedades):
Listados em ordem não-alfabética.
Nome | Tipo | Descrição/Finalidade | Observação |
---|---|---|---|
cNumSer | Caractere | Armazena o número de série do equipamento na base de atendimento. Equivalente ao campo AA3_NUMSER da tabela AA3. | Alimentado automaticamente durante a execução do método New. |
cFil | Caractere | Armazena a filial do equipamento (base de atendimento) em pesquisa. | Alimentado automaticamente durante a execução do método New. |
cProd | Caractere | Armazena o código do produto (SB1) presente no campo AA3_CODPRO. | Alimentado automaticamente durante a execução do método New. |
lIdUnico | Lógico | Determina se o equipamento foi definido como ID único na tabela de Complemento de Produtos - SB5, Campo B5_ISIDUNI. | Alimentado automaticamente durante a execução do método New. |
lAtivoFixo | Lógico | Determina se o equipamento possui um ou mais vínculos com um item do Ativo Fixo - Tabela SN1, por meio do relacionamento com a tabela TWH. | |
lValido | Lógico | Determina se o código de base de atendimento utilizado no instanciamento da classe é válido e se os dados foram carregados com êxito. | Se o parâmetro MV_TECATF estiver configurado com N ou não esteja presente no ambiente, a classe não é iniciada corretamente e o conteúdo desta propriedade é automaticamente definido como .F. |
lEquipLoc | Lógico | Indica se o equipamento, quando igual a ID único, encontra-se locado com algum cliente. | |
lBaseBloq | Lógico | Indica se o equipamento está bloqueado. Equivalente ao campo AA3_MSBLQL. | |
cDesc | Caractere | Descrição do equipamento de locação. | |
cProdGrp | Caractere | Armazena o código do grupo de produtos em que o equipamento está associado. | |
cProdTipo | Caractere | Armazena o código do tipo de produto em que o equipamento está associado. | |
cProdUm | Caractere | Armazena a unidade de medida do equipamento de locação. | |
nPrcVen | Numérico | Armazena o valor do equipamento para uso no documento de remessa. | |
nPeso | Numérico | Peso do equipamento. | |
cProdConta | Caractere | Conta contábil associada ao produto relacionado ao equipamento de locação. | |
cProdCC | Caractere | Centro de custo associado ao produto relacionado ao equipamento de locação. | |
cProdItem | Caractere | Item contábil associado ao produto relacionado ao equipamento de locação. | |
aAtivos | Array | Armazena um ou mais códigos de ativos imobilizados (tabela SN1) associados ao equipamento por meio da tabela TWH (relação base X ativo). | Layout: aAtivos[x,1] - Filial Origem (Dona do Equipamento) aAtivos[x,2] - Código do Ativo Imobilizado (N1_CBASE da Tabela SN1) aAtivos[x,3] - Código do Item do Ativo Imobilizado (N1_ITEM da Tabela SN1) aAtivos[x,4] - Quantidade de unidades do Ativo Imobilizado (N1_QUANTD da Tabela SN1) |
aError | Array | Armazena, de forma unidimensional uma ou mais mensagens de observação em caso de falhas durante o instanciamento da classe. | aError[1] - Mensagem 001 aError[2] - Mensagem 002 |
nQtdATF | Numérico | Armazena a soma dos itens do ativo imobilizado. | |
nRecNoAA3 | Numérico | Número do registro (Recno) relativo ao cadastro da base de atendimento na tabela AA3. | |
nRecNoTWH | Numérico | Número do registro (Recno) relativo ao equipamento na tabela TWH (Relação Base x Ativo). |