Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | crmbo/boCrmEnderPortal.p |
Considerações Gerais
Objetivo
Realizar a manutenção de endereço.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A sintaxe para a chamada da API/BO é:
run crmbo/boCrmEnderPortal.p. |
A sintaxe para executar a API/BO em modo persistente é:
run crmbo/boCrmEnderPortal.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 de entrada e saída:
RowObject | Entrada/Saída | ||||
Endereco | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num_lograd_ender | integer | >>>>,>>9 | Nr. Logradouro Endereco | Não |
|
num_id | integer | 99999999 | Código idenficador sequêncial | Sim |
|
num_id_uf | integer | >>>>,>>9 | Unidade federacao | Sim |
|
num_id_transport | integer | >>>>,>>9 | Transportadora | Não |
|
num_id_pessoa | integer | >>>>,>>9 | Pessoa | Não |
|
num_id_pais | integer | >>>>,>>9 | Pais | Sim |
|
num_id_cidad | integer | >>>>,>>9 | Cidade | Sim |
|
num_id_cep | integer | >>>>,>>9 | CEP | Não |
|
num_id_bairro | integer | >>>>,>>9 | Bairro | Sim |
|
nom_refer | character | x(30) | Referência | Não |
|
nom_lograd_ender | character | x(40) | Logradouro Endereco | Sim |
|
nom_compl_ender | character | x(2000) | Complemento Endereço | Não |
|
log_suspenso | logical | Sim/Não | Suspenso | Sim |
|
log_sem_inscr_estad | logical | Sim/Não | Sem IE | Sim |
|
idi_tip_ender | integer | 9 | Tipo Endereco | Sim |
|
log_integrad_erp | logical | Sim/Não | Integrado do ERP | Sim |
|
dat_timestamp | date | 99/99/9999 | Data de Alteração do Registro | Sim |
|
cdd_version | decimal | >>>,>>>,>>>,>>9 | Versão | Sim |
|
nom_cnpj | character | x(19) | CNPJ | Não |
|
cod_cep | character | x(20) | CEP | Não |
|
nom_inscr_estad | character | x(30) | Inscrição Estadual | Não |
|
log_ender_erp | logical | Sim/Não | Endereco ERP | Sim |
|
num_livre_1 | integer | >>>>>9 | Livre 1 | Não |
|
val_livre_1 | decimal | zzz,zzz,zz9.9999 | Livre 1 | Não |
|
val_livre_2 | decimal | zzz,zzz,zz9.9999 | Livre 2 | Não |
|
num_livre_2 | integer | >>>>>9 | Livre 2 | Não |
|
cod_livre_1 | character | x(100) | Livre 1 | Não |
|
cod_livre_2 | character | x(100) | Livre 2 | Não |
|
dat_livre_1 | date | 99/99/9999 | Livre 1 | Não |
|
dat_livre_2 | date | 99/99/9999 | Livre 2 | Não |
|
log_livre_1 | logical | Sim/Não | Livre 1 | Não |
|
log_livre_2 | logical | Sim/Não | Livre 2 | Não |
|
cod_cx_post | character | x(20) | Caixa Postal | Não |
|
cod_ender_gpl | character | x(10) | Endereco Gestão Planos | Não |
|
cod_latitud | character | x(50) | codigo latitude | Não |
|
cod_longit | character | x(50) | codigo longitude | Nã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 | N/A | |
Sintaxe | goToKey (input num_id) | |
Descrição | Reposiciona registro com base no índice | |
Parâmetros | Descrição | |
Num_id | Código identificador sequencial | |
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). |
getKey | ||
Requisito | N/A | |
Sintaxe | getKey (output num_id) | |
Descrição | Retorna valores dos campos do índice | |
Parâmetros | Descrição | |
Num_id | Código identificador sequencial | |
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). |
getCharField |
| ||
Requisito | N/A |
| |
Sintaxe | getCharField (input pFieldName, output pFieldValue) |
| |
Descrição | Retorna valor de campos do tipo caracter. |
| |
Parâmetros | Descrição |
| |
pFieldName | Nome do Campo |
| |
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). |
|
getDateField |
| ||
Requisito | N/A |
| |
Sintaxe | getDateField (input pFieldName, output pFieldValue) |
| |
Descrição | Retorna valor de campos do tipo data. |
| |
Parâmetros | Descrição |
| |
pFieldName | Nome do Campo |
| |
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). |
|
getDecField |
| ||
Requisito | N/A |
| |
Sintaxe | getDecField (input pFieldName, output pFieldValue) |
| |
Descrição | Retorna valor de campos do tipo decimal. |
| |
Parâmetros | Descrição |
| |
pFieldName | Nome do Campo |
| |
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). |
|
getLogField |
| ||
Requisito | N/A |
| |
Sintaxe | getLogField (input pFieldName, output pFieldValue) |
| |
Descrição | Retorna valor de campos do tipo lógico. |
| |
Parâmetros | Descrição |
| |
pFieldName | Nome do Campo |
| |
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). |
|
getRawField |
| ||
Requisito | N/A |
| |
Sintaxe | getRawField (input pFieldName, output pFieldValue) |
| |
Descrição | Retorna valor de campos do tipo raw. |
| |
Parâmetros | Descrição |
| |
pFieldName | Nome do Campo |
| |
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). |
|
getRecidField |
| ||
Requisito | N/A |
| |
Sintaxe | getRecidField (input pFieldName, output pFieldValue) |
| |
Descrição | Retorna valor de campos do tipo recid. |
| |
Parâmetros | Descrição |
| |
pFieldName | Nome do Campo |
| |
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). |
|
validateRecord | ||
Requisito | N/A | |
Sintaxe | validateRecord (input pType) | |
Descrição | Recebe o tipo de validação (Create, Delete, Update) | |
Parâmetros | Descrição | |
pType | Tipo de validação | |
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). |
afterUpdateRecord | ||
Requisito | N/A | |
Sintaxe | afterUpdateRecord | |
Descrição | Realiza validações/integrações depois de alterar o registro | |
Parâmetros | Descrição | |
N/A |
| |
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). |
afterCreateRecord | ||
Requisito | N/A | |
Sintaxe | afterCreateRecord | |
Descrição | Realiza validações/integrações depois de criar o registro | |
Parâmetros | Descrição | |
N/A |
| |
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). |
afterDeleteRecord | ||
Requisito | N/A | |
Sintaxe | afterDeleteRecord | |
Descrição | Realiza validações/integrações depois de excluir o registro | |
Parâmetros | Descrição | |
N/A |
| |
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). |
Método Negócio
checkParamIntegraGP | ||
Requisito | N/A | |
Sintaxe | checkParamIntegraGP | |
Descrição | Verifica se há integração com GP | |
Parâmetros | Descrição | |
lIntegraGP | Valor lógico para verificar se há integração | |
Retorno | Retorna TRUE caso exista a integração. 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). |
validChangeDataProspectGP | ||
Requisito | N/A | |
Sintaxe | validChangeDataProspectGP | |
Descrição | Realizada a validação para enviar alteração para simulação do módulo de GP. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | A variável l-sendDataToSimul é preenchida com TRUE caso o envio for validado/permitido e FALSE caso não possa ser enviado para simulação. |
validChangeDataIntegraGP | ||
Requisito | N/A | |
Sintaxe | validChangeDataIntegraGP | |
Descrição | Realizada a validação para enviar alteração para o módulo de GP. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | A variável l-sendOk é preenchida com TRUE caso o envio for validado/permitido e FALSE caso não possa ser enviado para o GP. |
integraCRMToGP | ||
Requisito | N/A | |
Sintaxe | integraCRMToGP | |
Descrição | Realiza a integração com GP, enviando os dados. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | Envia os dados para integração com GP (método sendToGP). 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). |
ValidateCreateCep | ||
Requisito | N/A | |
Sintaxe | ValidateCreateCep | |
Descrição | Valida se o cep já existe na tabela crm_cep, se não, cria o registro. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
beforeCreateRecordAdress | ||
Requisito | N/A | |
Sintaxe | beforeCreateRecordAdress | |
Descrição | Verifica o tipo de endereço antes de criar o registro. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
beforeUpdateRecordAdress | ||
Requisito | N/A | |
Sintaxe | beforeUpdateRecordAdress | |
Descrição | Verifica o tipo de endereço antes de alterar o registro. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
checkParamIntegr | ||
Requisito | N/A | |
Sintaxe | checkParamIntegr | |
Descrição | Realiza a verificação se está integrado ao ERP. | |
Parâmetros | Descrição | |
N/A |
| |
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: NOK (execução com problemas). |
setOrigemERP | ||
Requisito | N/A | |
Sintaxe | setOrigemERP | |
Descrição | Realiza a alteração da variável que indica que a origem do dado é o ERP. | |
Parâmetros | Descrição | |
pl-origem-erp | Valor lógico para alterar variável de origem ERP | |
Retorno | Altera a variável l-origem-erp para TRUE. |
setOrigemGP | ||
Requisito | N/A | |
Sintaxe | setOrigemGP | |
Descrição | Realiza a alteração da variável que indica que a origem do dado é o GP. | |
Parâmetros | Descrição | |
pl-origem-gp | Valor lógico para alterar variável de origem GP | |
Retorno | Altera a variável l-origem-gp para TRUE. |
ValidateChangeAddressERP | ||
Requisito | N/A | |
Sintaxe | ValidateChangeAddressERP | |
Descrição | Verifica se o endereço deve ser alterado no ERP. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
ValidateDeleteAdress | ||
Requisito | N/A | |
Sintaxe | ValidateDeleteAdress | |
Descrição | Valida se o endereço possui vínculo com outro registro. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
ERPAddress | ||
Requisito | N/A | |
Sintaxe | ERPAddress | |
Descrição | Realiza validações pertinentes a integração com o ERP. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
validateZipCodeSuspended | ||
Requisito | N/A | |
Sintaxe | validateZipCodeSuspended | |
Descrição | Realiza validação para verificar se o CEP está suspenso. | |
Parâmetros | Descrição | |
N/A |
| |
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). |
integraCRMToEMS2 | ||
Requisito | N/A | |
Sintaxe | integraCRMToEMS2 | |
Descrição | Realiza a integração com EMS2, enviando os dados. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno |
|
assignCnpjInscEstadual | ||
Requisito | N/A | |
Sintaxe | assignCnpjInscEstadual | |
Descrição | Realiza atualização de cnpj e inscrição estadual. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno |
|