Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | crmapi\apiCrmLayoutImptdor.p |
Objetivo
Efetuar tratamento sobre os dados dos registros que serão importados.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttlayout |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Campo | Char |
| Campo |
|
Valor | Char |
| Valor |
|
ttlayout01 |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Campo | Char |
| Campo |
|
Valor | Char |
| Valor |
|
i-line | Int |
| Linha |
|
ttlayoutImptdor |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Tabela | Char |
| Tabela |
|
tipoCampo | Char |
| Tipo do campo |
|
campoArq | Char |
| Coluna arquivo |
|
campoCRM | Char |
| Campo no formulario |
|
campoDicCRM | Char |
| Campo tabela |
|
valDef | Char |
| Valor default |
|
valArq | Char |
| Valor célula arquivo |
|
Linha | Int |
| Linha |
|
ttcampos |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Ordem | Int |
| Ordem |
|
Nome | Char |
| Nome |
|
ttgrid |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
campoArq | Char |
| Coluna arquivo |
|
campoCRM | Char |
| Campo no formulário |
|
valDef | Char |
| Valor default |
|
Tipo | Char |
| Tipo |
|
ttgrid02 |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
campoArq | Char |
| Coluna arquivo |
|
campoCRM | Char |
| Campo no formulário |
|
valDef | Char |
| Valor default |
|
Tipo | Char |
| Tipo |
|
ttCampoCRM |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Selected | Log |
| Selecionado |
|
Tabela | Char |
| Tabela |
|
Legend | Char |
| Lista de opções |
|
Campos | Char |
| Campos |
|
Tipo | Char |
| Tipo |
|
tabRef | Char |
| Tabela referencia |
|
ttError01 |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Erro | Char |
| Descrição erro |
|
numId | Int |
| Id do registro |
|
ttError02 |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Erro | Char |
| Descrição erro |
|
Campo | Char |
| Campo formulário |
|
Valor | Char |
| Valor |
|
ttObrig |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Campo | Char |
| Campo dicionario |
|
ttCrmLayoutAtribRowid |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
r-rowid | Rowid |
| rowid |
|
ttCrmLayoutImptdor
Tabela definida conforme tabela crm_layout_imptdor, porém com as diferenças abaixo.
Atributo | Tipo | Formato | Descrição | Obr. |
r-rowid | Rowid |
| rowid |
|
ttCrmLayoutAtrib
Tabela definida conforme tabela crm_layout_atrib, porém com as diferenças abaixo.
Atributo | Tipo | Formato | Descrição | Obr. |
r-rowid | Rowid |
| rowid |
|
ttCrmErroLead
Tabela definida conforme tabela crm_erro_lead, porém com as diferenças abaixo.
Atributo | Tipo | Formato | Descrição | Obr. |
r-rowid | Rowid |
| rowid |
|
Parâmetros de input e output da api
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Métodos
Métodos básicos
Método: loadLayout
Descrição: retorna os dados de um layout já adicionado.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pc-numIdLayout | Char |
| X |
|
| Id layout |
ttCampoCRM | Tt |
| X |
|
| Relação de campos do formulário |
pc-delimiter | Char |
|
| X |
| Delimitador |
Ttgrid | Tt |
|
| X |
| dados já adicionados ao layout |
Método: loadLayout
Descrição: separa o valor de uma linha em campo a campo de acordo com a coluna.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-valor | Char |
| X |
|
| Valor |
Ttlayout | Tt |
|
| X |
| Relação dos registros de todas as colunas |
Método: loadValueFile
Descrição: retorna os valores dos registros armazenados no arquivo.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Opção | Int |
| X |
|
| Opção |
c-arquivo | Char |
| X |
|
| Endereço do arquivo |
c-delimiter | Char |
| X |
|
| Delimitador |
campoArq | Char |
| X |
|
| Coluna arquivo |
ttlayout01 | Tt |
|
| X |
| Relação dos registros de todas as colunas |
Método: loadLegendFile
Descrição: retorna os valores dos registros e o provider dos legend.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-arquivo | Char |
| X |
|
| Endereço do arquivo |
c-delimiter | Char |
| X |
|
| Delimitador |
c-providerCBX | Char |
|
| X |
| Provider lengend |
ttlayout | Tt |
|
| X |
| Relação dos registros de todas as colunas |
Método: loadLayout
Descrição: retorna os dados de um layout já adicionado.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pc-numIdLayout | Char |
| X |
|
| Id layout |
ttCampoCRM | Tt |
| X |
|
| Relação de campos do formulário |
pc-delimiter | Char |
|
| X |
| Delimitador |
Ttgrid | Tt |
|
| X |
| dados já adicionados ao layout |
Método: UpdateGridLayout
Descrição: atualiza o dados que serão disponibilizados na grade.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Opção | Int |
| X |
|
| Opção |
c-arquivo | Char |
| X |
|
| Endereço arquivo |
c-delimiter | Char |
| X |
|
| Delimitador |
Legend | Char |
| X |
|
| Lista dos itens |
Campos | Char |
| X |
|
| Campos |
Tabela | Char |
| X |
|
| Tabela |
Ttgrid | Tt |
| X |
|
| Registros da grid |
ttlayoutImptdor | Tt |
|
| X |
| Dados do layout |
Método: RemoveField
Descrição: remove registros da grade.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Ttgrid | Tt |
|
|
| X | Registros na grid |
ttgrid02 | Tt |
|
| X |
| Registros na grid |
Ttgrid | Tt |
|
| X |
| dados já adicionados ao layout |
Método: findTypeFieldTabRefer
Descrição: retorna o tipo do campo e tabela de referencia e efetua validaçao antes de executa o comando de entry.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
tipoCampo | Char |
|
|
| X | Tipo do campo |
tabRefer | Char |
|
|
| X | Tabela referencia |
Idx | Int |
| X |
|
| indice |
Método: saveLayout
Descrição: salva o layout e os atributos do layout.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-numIdLayout | Int |
| X |
|
| Id do layout |
pc-delimit | Char |
| X |
|
| Delimitador |
pi-tabela | Int |
| X |
|
| Identificador para tabela |
pc-nome | Char |
| X |
|
| Nome |
Ttgrid | Tt |
| X |
|
| Registros na grade |
ttError01 | Tt |
|
| X |
| Erros do processo |
Método: CrmCheckQTDRequired
Descrição: verifica a quantidade de registros obrigatórios.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttObrig | Tt |
| X |
|
| Campos obrigatórios |
ttgrid | Tt |
| X |
|
| Registros na grid |
i-count | Int |
|
| X |
| contador |
Método: CrmValidFieldRequiredImptdor
Descrição: verifica registros obrigatórios.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Idx | Int |
| X |
|
| Índice |
ttObrig | Tt |
| X |
|
| Campos obrigatórios |
Ttgrid | Tt |
| X |
|
| Registros na grade |
l-obrigOk | Log |
|
| X |
| obrigatório |
Método: checkIndiceNameTable
Descrição: retorna a descrição da tabela de acordo com o indice.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Idx | Int |
| X |
|
| Índice |
Tabela | Char |
|
| X |
| Descrição tabela |
Método: ImportData
Descrição: importa os dados do arquivo, método principal.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-arquivo | Char |
| X |
|
| Endereço do arquivo |
c-delimiter | Char |
| X |
|
| Delimitador |
Legend | Char |
| X |
|
| Lista dos campos |
Campos | Char |
| X |
|
| Campos |
Tabela | Char |
| X |
|
| Tabela |
l-atualiza | Log |
| X |
|
| Atualiza |
pi-totRegAdd | Int |
|
| X |
| Total de registros |
Método: TableError
Descrição: adiciona erros a tabela de erros.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
ttError02 | Tt |
| X |
|
| Erros |
Método: CleanTableLogError
Descrição: limpa tabela de erros.
Requisitos: Nenhum
Parâmetros: Nenhum
Método: FindMessageError
Descrição: busca e retorna a mensagem de erro.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-numMsg | Int |
| X |
|
| Id da mensagem |
msgError | Char |
|
| X |
| Descrição da mensagem |
Método: destroyHandle
Descrição: elimina da memória os handles.
Requisitos: Nenhum
Parâmetros: Nenhum
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas