Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | crmbo/boCrmVincPortal.p |
Considerações Gerais
Objetivo
Realizar a manutenção de vínculo.
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/boCrmVincPortal.p. |
A sintaxe para executar a API/BO em modo persistente é:
run crmbo/boCrmVincPortal.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 |
Vinculo | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obriga tório | Evolução |
num_id | integer | 99999999 | Código idenficador sequencial | Sim | |
num_id_pessoa | integer | >>>>,>>9 | Pessoa | Sim | |
num_id_depto | integer | 999999999 | Departamento | Sim | |
num_id_contat | integer | >>>>,>>9 | Contato | Sim | |
log_suspenso | logical | Sim/Não | Suspenso | Sim | |
log_pto_focal_depto | logical | Sim/Não | Ponto Focal Departamento | Não | |
num_reporte_a | integer | >>>>,>>9 | Reportase | Não | |
dat_timestamp | date | 99/99/9999 | Data de Alteração do Registro | Sim | |
cdd_version | decimal | >>>,>>>,>>>,>>9 | Versão | Não | |
num_id_tip_vinc | integer | 999999999 | Tipo de Vinculo | Não | |
num_id_niv_decis | integer | 999999999 | Nivel Decisão | Não | |
num_seq_contat_emit | integer | >>9 | Sequencia Contato | Não | |
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 | |
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 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: OK (execução correta) e NOK (execução com problemas). |
afterCreateRecord |
Requisito | N/A |
Sintaxe | afterCreateRecord |
Descrição | Realiza validações/integrações 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: OK (execução correta) e NOK (execução com problemas). |
afterDeleteRecord |
Requisito | N/A |
Sintaxe | afterDeleteRecord |
Descrição | Realiza validações/integrações após 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). |
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). |
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). |
deleteContatoEmitente |
Requisito | N/A |
Sintaxe | deleteContatoEmitente |
Descrição | Realiza a exclusão do contato no EMS2. |
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). |
afterUpdateCreateVinculo |
Requisito | N/A |
Sintaxe | afterUpdateCreateVinculo |
Descrição | Realiza a validações/integrações após criar ou atualizar o vínculo. |
Parâmetros | Descrição |
i-num-conta i-num-contato tt-bo-erro | Código identificador sequencial Código identificador do contato Tabela temporária de erro |
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). |
DefineDepartmentFocalPoint |
Requisito | N/A |
Sintaxe | DefineDepartmentFocalPoint |
Descrição | Define o ponto focal da conta. |
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). |
ValidateBondAssotiation |
Requisito | N/A |
Sintaxe | ValidateBondAssotiation |
Descrição | Realiza validações se já existe o vínculo associado. |
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). |
ValidateDeleteFocalPoint |
Requisito | N/A |
Sintaxe | ValidateDeleteFocalPoint |
Descrição | Realiza validações ao excluir o ponto focal. |
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). |
UpdateVinc |
Requisito | N/A |
Sintaxe | UpdateVinc |
Descrição | Realiza alterações ao alterar vínculo. |
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). |
DeleteVinc |
Requisito | N/A |
Sintaxe | DeleteVinc |
Descrição | Realiza alterações ao excluir vínculo. |
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). |
createContactLink |
Requisito | N/A |
Sintaxe | createContactLink |
Descrição | Realiza criação de link de contato como ponto focal da conta, caso seja o primeiro contato da conta. |
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). |
DefaultLink |
Requisito | N/A |
Sintaxe | DefaultLink |
Descrição | Realiza alteração do campo log_pto_focal_depto para TRUE, para que o primeiro contato seja ponto focal. |
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). |
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. |
checkTypeContact |
Requisito | N/A |
Sintaxe | checkTypeContact |
Descrição | Realiza alteração do tipo do contato. |
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 | |
verifySendUpdateSimul |
Requisito | N/A |
Sintaxe | verifySendUpdateSimul |
Descrição | Realiza a verificação de necessidade de envio para o módulo de GP |
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). |
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))