Árvore de páginas

CONTEÚDO

  1. Descrição
  2. Localização
  3. Programa Fonte
  4. Instruções
  5. Parâmetros
  6. Retorno
  7. Exemplo de utilização

01. DESCRIÇÃO

O ponto de entrada A410GRDW é chamado ao informar produtos com controle de grade em diversas rotinas do sistema, ao informar o conteúdo de campos numéricos diversos, antes de apresentar a tela de grade de produtos. Ele permite a manipulação das informações a serem apresentadas na tela, sendo possível trazer informações pré-carregadas ao usuário.

02. LOCALIZAÇÃO

O Ponto de entrada A410GRDW está localizado no método Show da classe MsMatGrade, após a montagem das informações e antes de apresentar a tela de grade do produto.

03. PROGRAMA FONTE

MATGRADE.PRX

04. Instruções

O Ponto de entrada A410GRDW trabalha com informações contidas em variáveis do tipo Private disponibilizadas para a customização, que devem ser acessadas e manipuladas conforme a necessidade. Por se tratar de um ponto de entrada complexo, sugere-se que o processo de desenvolvimento seja feito por pessoa capacitada. Os exemplos abaixo são apenas sugestões de implementação, devendo cada caso ser análisado conforme regra de negócio da empresa.

Para maiores informações a respeito da grade de produtos, acesse Grades de Produtos (MATA550 - SIGAEST)

Por se tratar de ponto de entrada de uso geral, recomenda-se que as regras de negócio sejam tratadas por rotina, separando-as com a verificação da função FWIsInCallStack.

Por ser acionada por vários campos de dentro das rotinas, recomenda-se a verificação do campo que acionou utilizando a função READVAR().

05. Parâmetros

Os parâmetros a seguir são informados pela variável Private PARAMIXB, e devem apenas ser lidos e não alterados pela customização.

NomeTipoDescrição
aHeadAux - ParamIXB[1]Array

aHeadAux - Em rotinas com grid (Pedido de compras, pedido de vendas, etc.), vem preenchido com o aHeader da rotina em questão, pois a variável aHeader passará a conter o cabeçalho da tela de grade.

Estrutura do array:

aHeadAux: Array contendo os campos cabeçalho
aHeadAux[n]: Contém os dados do campo
aHeadAux[n][1]: Título do campo, Ex: "Quantidade"
aHeadAux[n][2]: Nome do campo. Ex: "C7_QUANT"
aHeadAux[n][3]: Máscara do campo. Ex: "@E 99,999,999,999.99"
aHeadAux[n][4]: Tamanho do campo. Ex: 14
aHeadAux[n][5]: Decimal do campo. Ex: 2
aHeadAux[n][6]: Valid do campo. Ex: "MatVldGGrd() .And. aVldGr220()"
aHeadAux[n][7]: Usado do campo. Ex: "û"
aHeadAux[n][8]: Tipo do campo. Ex: "N"
aHeadAux[n][9]: F3 do campo. Ex: "SB1"
aHeadAux[n][10]: Contexto do campo - Real (R) ou Virtual (V)
aColsAux - ParamIXB[2]Array

aColsAux - Em rotinas com grid (Pedido de compras, pedido de vendas, etc.), vem preenchido com o aCols da rotina em questão, pois a variável aCols passará a conter o conteúdo da tela de grade.

Estrutura do array:

aColsAux: Contém os arrays de cada linha do grid da tela anterior
aColsAux[n]: Linha do grid
aColsAux[n][nPos]: Conteúdo do campo, conforme ordenação do aHeadAux. Ex: "PRODUTO000001"

Obs.: a última coluna de cada linha é do tipo lógico, que indica se a linha está deletada (.T.) ou não (.F.)

nLinO    - ParamIXB[3]Numérico

nLinO    - Em rotinas com grid (Pedido de compras, pedido de vendas, etc.), vem preenchido com a linha posicionada no aCols da rotina em questão. Em rotinas sem grid (Saldo inicial, etc.), sempre vem preenchido com o conteúdo 1.

Os parâmetros a seguir são disponibilizados por variáveis Private e podem ser lidos e alterados, entretanto, deve-se alterá-los com cautela para não comprometer o funcionamento da rotina. A alteração da estrutura dos arrays abaixo (seja excluindo ou adicionando novas posições) poderá acarretar em comportamentos imprevisíveis.

NomeTipoDescrição
aHeadGradeArray

aHeadGrade - Array contendo os cabeçalhos das telas de grade, uma posição por linha do grid original (tamanho do aColsAux). Acessar sempre pelo índice nLinO. Produtos diferentes podem possuir tabelas de grade diferentes. Este array é de uso interno, e não é referente ao exibido na tela para o usuário.

Estrutura do array:

aHeadGradeContém um ou mais cabeçalhos de grade, a depender de quantos produtos com controle de grade foram informados na rotina principal.
aHeadGrade[nLinO]Contém 1+j posições, dependendo da quantidade de colunas de grade (tabela SBV)
aHeadGrade[nLinO,1]Indica se é uma Referência (R) ou não (N)
aHeadGrade[nLinO,j]A partir da segunda posição, contém as colunas da grade do produto, até o número diponível. Ex: Grade de 3 colunas, aHeadGrade[nLinO][2] a aHeadGrade[nLinO][4], j vai de 2 a 4. Contém arrays de 10 posições no mesmo padrão do aHeader do MsGetDados
aHeadGrade[nLinO,j,1]Título do campo, Ex: "[01] PEDRA"
aHeadGrade[nLinO,j,2]Nome do campo (controle interno). Ex: "_01"
aHeadGrade[nLinO,j,3]Máscara do campo. Ex: "@E 99,999,999,999.99                         "
aHeadGrade[nLinO,j,4]Tamanho do campo. Ex: 14
aHeadGrade[nLinO,j,5]Decimal do campo. Ex: 2
aHeadGrade[nLinO,j,6]Valid do campo. Ex: "MatVldGGrd() .And. aVldGr220()"
aHeadGrade[nLinO,j,7]Usado do campo. Ex: "û"
aHeadGrade[nLinO,j,8]Tipo do campo. Ex: "N"
aHeadGrade[nLinO,j,9]F3 do campo. Não utilizado
aHeadGrade[nLinO,j,10]Contexto do campo - Real (R) ou Virtual (V)

Recomenda-se que esta variável seja somente acessada para leitura.

oGrade:aCposCtrlGrdArray

Array com a lista de campos da rotina principal que acionam a interface de grade. Deverá ser usado apenas para consultar a posição no array aColsGrade. Veja a seguir e no exemplo. Não alterar este array.

aColsGradeArray

Array contendo os grids das tabelas de grade, uma posição por linha do grid original (tamanho do aColsAux). Acessar sempre pelo índice nLinO. Produtos diferentes podem possuir tabelas de grade diferentes. Este array é de uso interno, e não é referente ao exibido na tela para o usuário.

Estrutura do Array:

aColsGradeContém um ou mais grids da grade de produtos, a depender de quantos produtos com controle de grade foram informados na rotina principal.
aColsGrade[nLinO]Contém i posições, dependendo da quantidade de linhas de grade (tabela SBV)
aColsGrade[nLinO,i]Contém 1+j posições, dependendo da quantidade de colunas de grade (ver aHeadGrade)
aColsGrade[nLinO,i,1]Contém o título da linha. Ex: "[01] 10   "
aColsGrade[nLinO,i,j]A partir da segunda posição, contém as colunas da grade do produto, até o número diponível. Ex: Grade de 3 colunas, aColsGrade[nLinO][i][2] a aColsGrade[nLinO][i][4], j vai de 2 a 4. Contém array de k posições, a depender da quantidade de campos na rotina que permitem o controle de grade. Por exemplo, o Saldo inicial MATA220 possui 13 campos que permitem o preenchimento de grade, logo, este array terá 13 posições. Ver exemplo abaixo.
aColsGrade[nLinO,i,j,k]Contém o valor gravado na linha/coluna/campo da grade.

Caso necessário, este array poderá ser alterado.

oGrade:aSumCpos

Array

Contém os totalizadores da interface de grade. Não está disponível para todos os campos. Verificar se o array existe e procurar em qual posição está o campo que está sendo alterado.

aHeader

Array

Array de cabeçalho da tela de grade a ser exibida, no padrão de array aHeader da MsGetDados. Ver a estrutura do aHeadAux acima. Contém os mesmos dados da aHeadGrade[nLinO], mas este array é específico da tela a ser exibida.

aCols

Array

Array com os dados da tela de grade a ser exibida, no padrão de array aCols da MsGetDados. Ver a estrutura do aColsAux acima. Contém os dados exibidos em tela para o usuário, e deve ser manipulado caso se deseje alterar as informações ao usuário.

Por via de regra, deve-se alterar os arrays aCols, aColsGrade e oGrade:aSumCpos na mesma operação, para garantir a consistência dos dados. O preenchimento dos dados não dispara nenhuma validação ou regra da rotina, sendo necessário validar os dados a serem inseridos manualmente (por exemplo, no pedido de compras, ao preencher manualmente os arrays, não será disparada pergunta para criação automática do armazém do produto - SB2).

06. RETORNO

O ponto de entrada não espera retorno. A manipulação dos dados deve ocorrer nas variáveis descritas no item 05. Parâmetros, salvo restrições.


07. EXEMPLO DE UTILIZAÇÃO

Exemplo
/*/{Protheus.doc} User Function A410GRDW
    Permite manipular a grade de produtos em diversas rotinas do sistema.
    É possível aplicar tratamento pontual utilizando a função FWIsInCallStack
    para verificar a rotina que chamou o ponto de entrada
    Também é possível verificar qual campo está sendo preenchido pelo usuário
    com a função ReadVar()

    Verificar a documentação completa no TDN
    @type  Function
    @author Totvs
    /*/
User Function A410GRDW()
    Local aHeadAux := ParamIXB[1]
    Local aColsAux := ParamIXB[2]
    Local nLinO    := ParamIXB[3]
    Local aArea    := GetArea()
    Local aAreaSB4 := SB4->(GetArea())
    Local aAreaSBV := SBV->(GetArea())
    Local aAreaSB1 := SB1->(GetArea())
    Local aAreas   := {aAreaSB4, aAreaSBV, aAreaSB1, aArea}
    Local aCposTel := oGrade:aCposCtrlGrd
    Local cCampo   := StrTran(ReadVar(), 'M->', '')
    Local cMask    := SuperGetMV('MV_MASCGRD', .F., '')
    Local aMask    := StrTokArr(cMask, ',')
    Local nTamProd := 0
    Local nTamLin  := 0
    Local nTamCol  := 0
    Local nQtdIni  := 0
    Local nVIni1   := 0
    Local nColGrd  := 0
    Local nLinGrd  := 0
    Local nPQINI   := 0
    Local nPVINI1  := 0
    Local nVal     := 0
    Local nPSum    := 0
    Local nPProd   := 0
    Local cProduto := ''
    Local nPQuant  := 0
    Local nQuant   := 0
    Local nPQntC7  := 0
    Local lUsaGrad := .F.
    Local cTabLin  := ''
    Local cTabCol  := ''
    Local aChvLin  := {}
    Local aChvCol  := {}
    Local cChvLin  := ''
    Local aProd    := {}
    Local nProd    := 0

    If Len(aMask) < 3
        Return
    EndIf 
    nTamProd := Val(aMask[1])
    nTamLin  := Val(aMask[2])
    nTamCol  := Val(aMask[3])

    //Exemplo: Tratamento para o saldo inicial
    If FWIsInCallStack('MATA220')
        //Distribui o valor inicial na mesma proporção da quantidade inicial
        If AllTrim(cCampo) == 'B9_VINI1'
            nQtdIni := M->B9_QINI
            nVIni1  := M->B9_VINI1
            nPQINI  := ASCan(aCposTel, {|x| AllTrim(x[1]) == 'B9_QINI'})
            nPVINI1 := ASCan(aCposTel, {|x| AllTrim(x[1]) == 'B9_VINI1'})
            If Len(oGrade:aSumCpos) > 0
                nPSum   := ASCan(oGrade:aSumCpos, {|x| AllTrim(x[1]) == 'B9_VINI1'})
            EndIf
            If nPSum > 0
                oGrade:aSumCpos[nPSum, 2] := 0
            EndIf
            If nQtdIni > 0 .And. nVIni1 > 0 .And. nPQINI > 0 .And. nPVINI1 > 0
                For nLinGrd := 1 To Len(aColsGrade[nLinO])
                    For nColGrd := 2 To Len(aColsGrade[nLinO, nLinGrd])
                        nVal := nVINI1 * aColsGrade[nLinO, nLinGrd, nColGrd, nPQINI] / nQtdIni
                        //Manipular o aColsGrade para futura gravação no banco de dados
                        aColsGrade[nLinO, nLinGrd, nColGrd, nPVINI1] := nVal
                        //Manipular o aCols para que o usuário visualize os valores pré-carregados
                        aCols[nLinGrd, nColGrd] := nVal
                        //Manipular o totalizador, se houver
                        If nPSum > 0
                            oGrade:aSumCpos[nPSum, 2] += nVal
                        EndIf
                    Next nColGrd
                Next nLinGrd
            EndIf
        EndIf
    EndIf

    //Exemplo: Tratamento para o pedido de compras
    If FWIsInCallStack('MATA121') .And. AllTrim(cCampo) == 'C7_QUANT'
        //Distribui o saldo somente na primeira coluna
        nPProd   := ASCan(aHeadAux, {|x| AllTrim(x[2]) == 'C7_PRODUTO'})
        nPQuant  := ASCan(aHeadAux, {|x| AllTrim(x[2]) == 'C7_QUANT'})
        nPQntC7  := ASCan(aCposTel, {|x| AllTrim(x[1]) == 'C7_QUANT'})
        If Len(oGrade:aSumCpos) > 0
            nPSum   := ASCan(oGrade:aSumCpos, {|x| AllTrim(x[1]) == 'C7_QUANT'})
        EndIf
        If nPSum > 0
            oGrade:aSumCpos[nPSum, 2] := 0
        EndIf

        If nPPRod > 0 .And. nPQuant > 0 .And. nPQntC7 > 0
            cProduto := SubStr(aColsAux[nLinO, nPProd], 1, nTamProd) //Código da grade
            nQuant   := M->C7_QUANT //Quantidade digitada no pedido
        EndIf

        If !Empty(cProduto)
            SB4->(DbSetOrder(1)) //B4_FILIAL+B4_COD
            lUsaGrad := SB4->(DbSeek(FWXFilial('SB4')+cProduto))
        EndIf

        If lUsaGrad .And. nPQuant > 0
            cTabLin := SB4->B4_LINHA
            cTabCol := SB4->B4_COLUNA

            //Encontra as chaves das tabelas
            SBV->(DbSetOrder(1)) //BV_FILIAL+BV_TABELA+BV_CHAVE
            If SBV->(DbSeek(FWXFilial('SBV')+cTabLin))
                While !SBV->(EoF()) .And. SBV->(BV_FILIAL+BV_TABELA) == FWXFilial('SBV')+cTabLin
                    AAdd(aChvLin, SubStr(SBV->BV_CHAVE, 1, nTamLin))
                    SBV->(DbSkip())
                EndDo
            EndIf
            If SBV->(DbSeek(FWXFilial('SBV')+cTabCol))
                While !SBV->(EoF()) .And. SBV->(BV_FILIAL+BV_TABELA) == FWXFilial('SBV')+cTabCol
                    AAdd(aChvCol, SubStr(SBV->BV_CHAVE, 1, nTamCol))
                    SBV->(DbSkip())
                EndDo
            EndIf

            //Verifica quais produtos foram cadastrados
            SB1->(DbSetOrder(1)) //B1_FILIAL+B1_COD
            aProd := {}
            nColGrd := 1 //Verifica somente a primeira coluna
            For nLinGrd := 1 To Len(aChvLin)
                If SB1->(DbSeek(FWXFilial('SB1')+cProduto+aChvLin[nLinGrd]+aChvCol[nColGrd]))
                    AAdd(aProd, {SB1->B1_COD, aChvLin[nLinGrd], aChvCol[nColGrd]})
                EndIf
            Next nLinGrd
            nVal := nQuant / Len(aProd) //Valor distribuido em cada linha da 1a coluna
            //Encontra a posição na grade da primeira coluna. Os campos no aHeader são _+chave da coluna
            nColGrd := ASCan(aHeadGrade[nLinO], {|x| ValType(x)=='A' .And. AllTrim(x[2]) == '_'+aChvCol[1]})
            If nColGrd > 0
                For nLinGrd := 1 To Len(aColsGrade[nLinO])
                    //Verifica se o produto existe para a linha
                    cChvLin := aColsGrade[nLinO, nLinGrd, 1] //<- coluna 1 fixa, contem a chave da linha
                    cChvLin := SubStr(cChvLin, At('[', cChvLin)+1, nTamLin)
                    nProd   := AScan(aProd, {|x| x[2] == cChvLin})
                    If nProd > 0
                        //Manipular o aColsGrade para futura gravação no banco de dados
                        aColsGrade[nLinO, nLinGrd, nColGrd, nPQntC7] := nVal
                        //Manipular o aCols para que o usuário visualize os valores pré-carregados
                        aCols[nLinGrd, nColGrd] := nVal
                        //Manipular o totalizador, se houver
                        If nPSum > 0
                            oGrade:aSumCpos[nPSum, 2] += nVal
                        EndIf
                    EndIf
                Next nLinGrd
            EndIf
        EndIf
    EndIf

    //Restaura a área das tabelas
    AEval(aAreas, {|x| RestArea(x)})
Return