Documento de API

Considerações Gerais

Objetivo

Realizar a manutenção de ocorrências.

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/bocrmOcor.p (input-output table tt-...,

input table tt-...,

...,

...).

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

run crmbo/bocrmOcor.p persistent set h-handle (input-output table tt-...,

input table tt-...,

...,

...).

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

insertUser
Requisito
Sintaxe	Run insertUser in h-handle (input cUserLog, output iNumIdUser)
Descrição	Adiciona usuário logado no CRM
	Parâmetros	Descrição
	cUserLog	Código usuário logado
Retorno	iNumIdUser - integer

returnAcessUserComl
Requisito
Sintaxe	Run returnAcessUserComl in h-handle (input pCodUsuario, output pIdiNivAces)
Descrição	Retorna o nível de acesso do usuário comercial (distribuição)
	Parâmetros	Descrição
	pCodUsuario	Código usuário
Retorno	pIdiNivAces – integer

modifyUserCRM
Requisito
Sintaxe	Run modifyUserCRM in h-handle (input cUserLog)
Descrição	Modifica dados do usuário, caso se refira ao mesmo usuário, atualizando o usuário do CRM com os dados de email e nome do usuário do foundation.
	Parâmetros	Descrição
	cUserLog	Código usuário logado
Retorno

checkProcessCRM
Requisito
Sintaxe	Run checkProcessCRM in h-handle (input numIdUsuar)
Descrição	Verifica se o usuário informado possuí processos (oportunidades, tarefas, ocorrências) pendentes de fechamento no CRM.
	Parâmetros	Descrição
	numIdUsuar	ID do Usuário CRM
Retorno

getPreference
Requisito	Temp-tables DEF TEMP-TABLE RowErrors NO-UNDO FIELD ErrorSequence AS INTEGER FIELD ErrorNumber AS INTEGER FIELD ErrorDescription AS CHARACTER FIELD ErrorParameters AS CHARACTER FIELD ErrorType AS CHARACTER FIELD ErrorHelp AS CHARACTER FIELD ErrorSubType AS CHARACTER INDEX idxSequence IS PRIMARY ErrorSequence.
Sintaxe	Run getPreference in h-handle (input prefId, input userLogin, output out, output table RowErrors)
Descrição	Retorna a preferencia de configuração do usuário com base na tabela de configuração do Foundation e configuração {&PREFERENCE_GROUP}.
	Parâmetros	Descrição
	prefId	Nome configuração
	userLogin	Código do Usuário (foundation)
Retorno	out – character RowErrors – temp-table

setPreference
Requisito	Temp-tables DEF TEMP-TABLE RowErrors NO-UNDO FIELD ErrorSequence AS INTEGER FIELD ErrorNumber AS INTEGER FIELD ErrorDescription AS CHARACTER FIELD ErrorParameters AS CHARACTER FIELD ErrorType AS CHARACTER FIELD ErrorHelp AS CHARACTER FIELD ErrorSubType AS CHARACTER INDEX idxSequence IS PRIMARY ErrorSequence.
Sintaxe	Run setPreference in h-handle (input prefId, input prefValue, input userLogin, output table RowErrors)
Descrição	Adiciona uma preferencia de configuração para o usuário com base na tabela de configuração do Foundation configuração {&PREFERENCE_GROUP}.
	Parâmetros	Descrição
	prefId	Nome configuração
	prefValue	Valor da preferencia
	userLogin	Código do Usuário (foundation)
Retorno	RowErrors – temp-table