Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | crmapi/apiCrm00379.p |
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.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
<Temp-Table> | Entrada/Saída | ||||
[Descrição] | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evoluçã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:
Método Negócio
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
getLastIdiTipCalc | ||
Requisito |
| |
Sintaxe | Run getLastIdiTipCalc in h-handle (output idiTipCalc). | |
Descrição | Retorna o ID de controle que está valendo. | |
Parâmetros | Descrição | |
|
| |
Retorno | iTipCalc – integer | |
UseHierarchy | ||
Requisito |
| |
Sintaxe | Run UseHierarchy in h-handle (output plUseHierarchy). | |
Descrição | Retorna se a regra de time está ativa na empresa. | |
Parâmetros | Descrição | |
|
| |
Retorno | plUseHierarchy - logical | |
applyTeamContact | ||
Requisito |
| |
Sintaxe | Run applyTeamContact in h-handle (output plApplyTeamContact). | |
Descrição | Considera contato na regra de time? | |
Parâmetros | Descrição | |
|
| |
Retorno | plApplyTeamContact – logical | |
GenerateHierarchyFull | ||
Requisito | 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 GenerateHierarchyFull in h-handle (output table RowErrors, input iControl). | |
Descrição | Calcula a hierarquia completa, considera todos os usuários e todas as contas. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno | RowErrors – temp-table | |
AddAccounts | ||
Requisito |
| |
Sintaxe | Run AddAccounts in h-handle (input iControl). | |
Descrição | Calcula e adicionas as contas conforme regra de time. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
AddAccountsUserIsResponsible | ||
Requisito |
| |
Sintaxe | Run AddAccountsUserIsResponsible in h-handle (input iControl). | |
Descrição | Calcula e adiciona na tabela de acesso as contas que o usuário é responsável. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
AddRestrictAccountsUserGeneral | ||
Requisito |
| |
Sintaxe | Run AddRestrictAccountsUserGeneral in h-handle (input iControl). | |
Descrição | Calcula e adiciona na tabela de acesso as contas específicas dos usuários gerais. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
AddAccountsSubordinateUsers | ||
Requisito |
| |
Sintaxe | Run AddAccountsSubordinateUsers in h-handle (input iControl). | |
Descrição | Calcula e adiciona na tabela de acesso as contas específicas dos usuários subordinados. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
AddGeneralAccounts | ||
Requisito |
| |
Sintaxe | Run AddGeneralAccounts in h-handle (input iControl). | |
Descrição | Calcula e adiciona na tabela de acesso as contas gerais. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
AddAccountsExceptionsAccounts | ||
Requisito |
| |
Sintaxe | Run AddAccountsExceptionsAccounts in h-handle (input iControl). | |
Descrição | Calcula e adiciona na tabela de acesso as contas pela excessão de contas do usuário. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
AddAccountsExceptionsUser | ||
Requisito |
| |
Sintaxe | Run AddAccountsExceptionsUser in h-handle (input iControl). | |
Descrição | Calcula e adiciona na tabela de acesso as contas pela excessão da carteira de outro usuário. | |
Parâmetros | Descrição | |
iControl | ID controle | |
Retorno |
| |
Retorno | RowErrors – temp-table | |
addNewAccountPermission | ||
Requisito |
| |
Sintaxe | Run addNewAccountPermission in h-handle (input accountId, output table RowErrors). | |
Descrição | Calcula e atualiza a tabela de acesso com os acessos a conta passada como parâmetro. | |
Parâmetros | Descrição | |
accountId | ID Conta | |
AddAccountPermissionForAllUsers | ||
Requisito |
| |
Sintaxe | Run AddAccountPermissionForAllUsers in h-handle (input iControl, input accountId, input codeERP, input responsId). | |
Descrição | Adiciona permissão a todos os usuários para a conta passada como parâmetro. | |
Parâmetros | Descrição | |
iControl | ID controle | |
| accountId | ID Conta |
| codeERP | Código Emitente |
| responsId | ID responsável |
executePermission | ||
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.
DEFINE TEMP-TABLE ttParamHier NO-UNDO FIELD destino AS INTEGER FIELD arquivo AS CHARACTER FIELD usuario AS CHARACTER FIELD data-exec AS DATE FIELD hora-exec AS CHARACTER FIELD progRp AS CHARACTE FIELD programa AS CHARACTER FIELD versao AS CHARACTER FIELD accountId AS INTEGER.
| |
Sintaxe | Run executePermission in h-handle (input iTipcalc, input table ttParamHier, output table RowErrors) | |
Descrição | Método principal para calcular a regra de times, atualiza a lista de contas que os usuários tem acesso. O calculo pode levar muito tempo, por isso, esse processo roda em um servidor RPW. | |
Parâmetros | Descrição | |
iTipcalc | Id de controle | |
| ttParamHier | Parâmetros para calcular a hierarquia – temp-table |
Retorno | RowErrors – temp-table | |
executePermission | ||
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.
DEFINE TEMP-TABLE ttParamHier NO-UNDO FIELD destino AS INTEGER FIELD arquivo AS CHARACTER FIELD usuario AS CHARACTER FIELD data-exec AS DATE FIELD hora-exec AS CHARACTER FIELD progRp AS CHARACTE FIELD programa AS CHARACTER FIELD versao AS CHARACTER FIELD accountId AS INTEGER.
| |
Sintaxe | Run executePermission in h-handle (input iTipcalc, input table ttParamHier, output table RowErrors) | |
Descrição | Método principal para calcular a regra de times, atualiza a lista de contas que os usuários tem acesso. O calculo pode levar muito tempo, por isso, esse processo roda em um servidor RPW. | |
Parâmetros | Descrição | |
iTipcalc | Código do Formulário | |
| ttParamHier | Parâmetros para calcular a hierarquia – temp-table |
Retorno | RowErrors – temp-table | |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas