Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | crmbo/boCrmTelefPortal.p |
Considerações Gerais
Objetivo
Realizar a manutenção de telefone no portal CRM.
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/boCrmTelefPortal.p. |
A sintaxe para executar a API/BO em modo persistente é:
run crmbo/boCrmTelefPortal.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 | ||||
Telefone | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num_id | integer | 99999999 | Código idenficador sequêncial | Sim |
|
num_ramal | integer | zzz9 | Ramal | Não |
|
num_id_transport | integer | >>>>,>>9 | Transportadora | Não |
|
num_id_pessoa | integer | >>>>,>>9 | Pessoa | Sim |
|
num_tip_telef | integer | >>>>,>>9 | Tipo Telefone | Sim |
|
log_suspenso | logical | Sim/Não | Suspenso | 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_telefone | character | x(15) | Telefone | 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_telef_gpl | character | x(10) | Telefone Gestão Planos | 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). |
afterCreateRecord | ||
Requisito | N/A | |
Sintaxe | afterCreateRecord | |
Descrição | Realiza verificação após 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: NOK (execução com problemas). |
afterUpdateRecord | ||
Requisito | N/A | |
Sintaxe | afterUpdateRecord | |
Descrição | Realiza verificação após 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: NOK (execução com problemas). |
afterDeleteRecord | ||
Requisito | N/A | |
Sintaxe | afterDeleteRecord | |
Descrição | Realiza verificação após deletar 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: NOK (execução com problemas). |
Método Negócio
validChangeDataIntegraGP | ||
Requisito | N/A | |
Sintaxe | validChangeDataIntegraGP | |
Descrição | Realiza a validação para alterar ou não os dados quando selecionado integração com GP | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | Irá preencher a variável l-sendOk com TRUE, caso não encontre os mesmos dados na base, e FALSE caso já exista. |
checkParamIntegraGP | ||
Requisito | N/A | |
Sintaxe | checkParamIntegraGP | |
Descrição | Realiza a verificação se o parâmetro de integração com GP está ativo. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | Preenche a variável lIntegraGP com TRUE caso a integração esteja ativa. 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). |
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). |
verifySendToSimul | ||
Requisito | N/A | |
Sintaxe | verifySendToSimul | |
Descrição | Verifica o envio de dados para simulação GP. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | Envia os dados para simulação GP (método sendChangesProspectToSimul). |
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. |
ValidateChangePhoneERP | ||
Requisito | N/A | |
Sintaxe | ValidateChangePhoneERP | |
Descrição | Verifica se o telefone 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). |
validateTypePhoneSuspended | ||
Requisito | N/A | |
Sintaxe | validateTypePhoneSuspended | |
Descrição | Verifica se o tipo de telefone 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). |
validChangeDataProspectGP | ||
Requisito | N/A | |
Sintaxe | validChangeDataProspectGP | |
Descrição | Realiza a validação de envio de dados simulação GP. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno | Altera a variável l-sendDataToSimul para TRUE caso validado envio para simulação GP. |
ValidateChangeDescriptionPhone | ||
Requisito | N/A | |
Sintaxe | ValidateChangeDescriptionPhone | |
Descrição | Valida se o telefone já existe na base para a mesma pessoa. | |
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). |
ValidateDeletePhone | ||
Requisito | N/A | |
Sintaxe | ValidateDeletePhone | |
Descrição | Valida se o telefone 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). |
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 | |
N/A |
| |
Retorno | Altera a variável l-fonte-gp para TRUE. |
integraCRMToEMS2 | ||
Requisito | N/A | |
Sintaxe | integraCRMToEMS2 | |
Descrição | Realiza a integração com EMS2, enviando os dados. | |
Parâmetros | Descrição | |
N/A |
| |
Retorno |
|