MANUAL DE INTEGRAÇÃO DO CRIVO WORKFLOW

Transcrição

MANUAL DE INTEGRAÇÃO DO
CRIVO WORKFLOW
API RESTful
Versão Mínima do Crivo Workflow: 1.0.1034
Versão do Manual: 1.3
Data: 03.10.2013
Crivo TransUnion
Rua Vergueiro, 2016 | 11º andar | Vila Mariana | CEP 04102-000 | São Paulo | SP |
Tel.: 11 5904-7830 –www.crivotransunion.com.br – Email: [email protected]
MANUAL DE INTEGRAÇÃO CRIVO WORKFLOW
API RESTFUL
PÁGINA 1
ÍNDICE
INTRODUÇÃO .................................................................................................................................................................... 2
CONCEITOS DO CRIVO WORKFLOW .......................................................................................................................... 2
PRINCIPAIS CONCEITOS ..............................................................................................................................................................3
CONCEITOS DA API RESTFUL....................................................................................................................................... 4
MÉTODOS UTILIZADOS NA INTEGRAÇÃO ............................................................................................................... 5
LOGIN ....................................................................................................................................................................................5
LOGOUT .................................................................................................................................................................................5
SYNCSTARTBUSINESSPROCESS .....................................................................................................................................................6
SYNCINVOKEBUSINESSPROCESSINSTANCE ......................................................................................................................................9
SYNCSTARTBUSINESSPROCESSWITHRETURNSTATE ........................................................................................................................ 13
SYNCINVOKEBUSINESSPROCESSINSTANCEWITHRETURNSTATE .......................................................................................................... 18
STARTBUSINESSPROCESSBYNAME.............................................................................................................................................. 24
INVOKEBUSINESSPROCESS ........................................................................................................................................................ 25
GETCURRENTBUSINESSPROCESSINSTANCEINFO ............................................................................................................................. 26
GETCURRENTFIELDVALUES ....................................................................................................................................................... 29
GETCURRENTFIELDVALUE......................................................................................................................................................... 30
GETINSTANCESBYFIELDVALUE ................................................................................................................................................... 31
ANEXO ............................................................................................................................................................................... 34
ANEXO 1: TABELA DE-PARA DA PROPRIEDADE "FIELDTYPE" .......................................................................................................... 34
ANEXO 2: TABELA DE-PARA DA PROPRIEDADE “STATELIFECYCLE” ................................................................................................... 35
Documento de uso Confidencial entre a Crivo TransUnion e seus destinatários.
A sua utilização é exclusivamente para os membros autorizados destas partes – Não Reproduzir
Crivo TransUnion - Todos os Direitos Reservados®
API RESTFUL
PÁGINA 2
INTRODUÇÃO
O “Crivo” permite a automação e o aperfeiçoamento do processo de análise de crédito, fraude e riscos de pessoas físicas e jurídicas e
ao mesmo tempo proporciona inúmeras vantagens competitivas que geram economia de tempo, redução de custos, além de decisões
ágeis, flexíveis e seguras.
Hoje, o “Crivo” já é considerado uma das ferramentas mais completas do mercado. E com o objetivo de estender o fornecimento de
®
tecnologia para toda a esteira de crédito, o “Crivo Workflow” passa a compor a linha de produtos e serviços da Crivo .
Com foco neste objetivo, o “Crivo Workflow” oferece aos usuários que não têm conhecimento técnico, o poder de automatizar seus
processos de negócios através de recursos amigáveis e fáceis de utilizar, permitindo a administração de filas de tarefas baseadas em
interações manuais e automatizadas.
O “Crivo Workflow” é compatível com os maiores sistemas de gerenciamento de banco de dados: Oracle e SQL Server. E, devido à
utilização de padrões internacionais de comunicação, como WebServices, seus módulos podem ser usados e integrados a outros
sistemas, aproveitando todo o seu poder e eficiência, como por exemplo, ao “Crivo”, facilitando a utilização das políticas de decisões.
A
B
C
Figura 1: Crivo Workflow
A) O Front é a interface de entrada dos dados onde o usuário inicia e interage com os fluxos de crédito e
risco. B) O Broker faz a orquestração e automatização de processos de negócios e integração de
sistemas. C) O Workflow faz a integração entre o processo de negócio e as pessoas através de
formulários para interação com os usuários participantes de um fluxo.
Neste manual, você conhecerá o conceito dos principais recursos do Sistema, bem como todas as informações e procedimentos necessários
para realizar o processo de integração de um Sistema ao Crivo Workflow.
API RESTFUL
PÁGINA 3
CONCEITOS DO CRIVO WORKFLOW
PRINCIPAIS CONCEITOS
Processo de Negócio
Representa um conjunto de passos a serem executados em uma tomada de decisão dentro do contexto do
negócio da empresa. Um Processo de Negócio é composto por Campos e Estados. E, cada Processo de
Negócio pode ter quantos Estados e Campos forem necessários.
Exemplos: Processo de Venda, Processo de Concessão de Crédito, Processo de Averbação, etc.
Para que um Processo de Negócio possa ser executado é necessário que ele já esteja criado com seus
respectivos Campos e Estados e já tenha sido ‘Publicado’, publicar um Processo de Negócio é tornar vigente
uma determinada versão. Um Processo de Negócio é controlado por versionamento. Assim, a cada alteração
de Campo, Estado, Fluxo ou no próprio Processo de Negócio o número de versão é incrementado.
Campos
São informações pertinentes a um Processo de Negócio que podem ser fornecidas por Sistemas integrados ou
calculadas durante a execução do Processo de Negócio.
Exemplos: Nome, CPF, endereço, etc.
Estados
Possíveis condições pelas quais determinado Processo de Negócio pode passar, desde seu Estado Inicial
obrigatório até um Estado final opcional. Pense em um Estado como uma etapa, estágio ou mesmo um status
bem conhecido dentro de um Processo de Negócio.
Exemplos: Inicial, Em Análise, Concluído, etc.
Fluxos
São atributos especiais de um Estado e representam o conjunto de atividades que são executadas quando um
Processo de Negócio transiciona de um Estado para outro. Os Fluxos podem se relacionar entre si (definição
de próximos Estados). E, todos os campos devem ser referenciados em todos os Fluxos, por isso, são
automaticamente adicionados, atualizados e removidos dos Fluxos durante a edição dos Processos de
Negócios.
Exemplos: Fluxo de Decisão.
Autenticação
A autenticação no Sistema é feita através de ‘Usuário’ e ‘Senha’. O Usuário pode estar associado a um Grupo,
e deve ter um Perfil de acesso.
Obrigatoriamente cada ‘Usuário’ e ‘Grupo’ possui 01 (um) único ‘Perfil’;
Um ‘Usuário’ pode estar contido em vários Grupos;
Um ‘Grupo’ pode conter vários Usuários.
API RESTFUL
PÁGINA 4
CONCEITOS DA API RESTFUL
O processo de integração com o Crivo Workflow – ‘API RESTful’ tem as seguintes características:

Utiliza formato ‘JSON’

O Protocolo é ‘HTTP’

O método de requisição é ‘POST’

O cabeçalho de requisição é padrão e obrigatório para todas as chamadas:
Content-Type "application/json; charset=utf-8"

A requisição deve conter um objeto ‘JSON’, onde suas propriedades são os parâmetros de entrada, conforme abaixo:
{"parâmetro1":"valor 1","parâmetro2":"valor 2"}

A resposta sempre é retornada em um objeto ‘JSON’ dentro de uma propriedade "d", conforme abaixo:
{"d":"valor retornado"}
Considerando que os acessos e permissões já estão configurados no Sistema, os cadastros do Processo de Negócio, Campos, Estados e
Fluxos já foram parametrizados e o Processo de Negócio está publicado, as chamadas ao Crivo Workflow através da ‘API RESTful’
devem acontecer da seguinte forma:

A autenticação no Crivo Workflow deve ser feito por meio do método LOGIN

A seção pode ser fechada a qualquer momento pela chamada do método LOGOUT

O Processo de Negócio pode ser iniciado de forma:


Assíncrona: Por meio do método STARTBUSINESSPROCESSBYNAME

Síncrona: Por meio do método SYNCSTARTBUSINESSPROCESS
A interação nas instâncias de Processo de Negócio pode ser feita de forma:

Assíncrona: Por meio do método INVOKEBUSINESSPROCESS

Síncrona: Por meio do método SYNCINVOKEBUSINESSPROCESSINSTANCE

Os valores dos campos de um Processo de Negócio podem ser obtidos pelo método GETCURRENTFIELDVALUES

O valor de um campo específico pode ser obtido pelo método GETCURRENTFIELDVALUE

O Estado de um determinado Processo de Negócio é obtido pelo método GETCURRENTBUSINESSPROCESSINSTANCEINFO
A seguir, descrevemos os métodos para as chamadas da ‘API RESTful’ com seus respectivos parâmetros e tipos.
API RESTFUL
MÉTODOS UTILIZADOS NA INTEGRAÇÃO
LOGIN
Realiza a autenticação no serviço de segurança do Crivo Workflow (SecurityService)
Caminho:
http://[Servidor]:[Porta]/WorkflowAPIService/SecurityService/WebHttp/Login
PARÂMETRO
TIPO
DESCRIÇÃO
user
String
Usuário
password
String
Senha
Retorno:
Identificação da sessão autenticada
Exemplo:
Requisição
{
"password": "admin",
"user": "admin"
}
Resposta
{
"d": {
"__type": "LoginHandle:#Crivo.Workflow.Models.DataTransferObjects.Security",
"value": "b5d2e9d4a78c4b4f8624f668db6af089"
}
}
LOGOUT
Encerra o uso do serviço de segurança do Crivo Workflow (SecurityService)
Caminho:
http://[Servidor]:[Porta]/WorkflowAPIService/SecurityService/WebHttp/Logout
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
Identificação da sessão autenticada
Retorno:
Identificação da sessão encerrada
PÁGINA 5
API RESTFUL
PÁGINA 6
Exemplo:
Requisição
{
"loginHandle": {
}
}
Resposta
{
"d": null
}
SYNCSTARTBUSINESSPROCESS
Chamada Síncrona para Iniciar a Execução do Processo de Negócio no Crivo Workflow (RuntimeService)
Caminho:
http://[Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/SyncStartBusinessProcess
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
Retorno do método LOGIN do SecurityService
businessProcess
long
Id do Processo de Negócio a ser iniciado
fieldValuesDTO
IList<FieldValueDTO>
Lista de Valores de Campos do Processo de Negócio
timeOut
Retorno:
Tempo limite de espera para execução da instância
- timeOut: Quando o tempo de execução ultrapassa o timeout definido é retornado true, caso contrário false.
- ResultBusinessProcessInstance: Retorna todas as informações da instância do Processo de Negócio.
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcess": {
"Name": "SyncAPIStress"
},
"fieldValuesDTO": [
{
"FieldName": "Status",
"FieldType": 3,
API RESTFUL
"Value": "ok"
}
],
"timeOut": 10000
}
Resposta
{
"d": {
"IsTimedOut": false,
"ResultBusinessProcessInstance": {
"BatchId": null,
"BusinessProcess": {
"BusinessProcessId": 2,
"CreationDate": "/Date(1324919887650-0200)/",
"Description": "",
"IsValid": true,
"ModifiedBy": "admin",
"ModifiedDate": "/Date(1324919891287-0200)/",
"Name": "SyncAPIStress",
"ValidationDescription": "",
"Version": 4,
"__type": "BusinessProcessDTO:#Crivo.Workflow.Models.DataTransferObjects.Design"
},
"BusinessProcessInstanceHistoryId": 2007,
"BusinessProcessInstanceId": 1002,
"CrivoExecutionStatus": 0,
"ErrorDetail": null,
"ErrorSummary": null,
"FieldValueHistory": [
{
"FieldDTO": {
"Description": "",
"DisplayName": "",
"Domain": null,
"FieldId": 2,
"IsEditable": false,
"IsRequired": false,
"Length": 0,
"Name": "Counter",
"Type": 1,
PÁGINA 7
API RESTFUL
"Validator": 0,
"Version": 1,
"__type": "FieldDTO:#Crivo.Workflow.Models.DataTransferObjects.Design"
},
"FieldValueHistoryId": 2006,
"FieldValueId": 1003,
"ModifyingDate": "/Date(1324921590303-0200)/",
"SearchValue": "1",
"Value": 1,
"__type": "FieldValueHistoryDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime"
},
{
CreationDate": "/Date(1324921590303-0200)/",
"FieldDTO": {
"Description": "",
"DisplayName": "",
"Domain": null,
"FieldId": 3,
"Length": 10,
"Name": "Status",
"Type": 3,
"Validator": 0,
"Version": 1,
},
"SearchValue": "ok",
"Value": "ok",
}
],
"RuntimeHostMacAddress": "0023AEB9A2C7",
"RuntimeHostName": "CRV556",
"ScheduledDateTime": null,
"StateInfo": {
"Description": "",
"DisplayName": "Inicial",
PÁGINA 8
API RESTFUL
PÁGINA 9
"FieldIdsLayout": [],
"HasContinuousHumanInteraction": false,
"HasInteractionTimeout": false,
"InteractionTimeout": 0,
"InteractionTimeoutStateId": null,
"IsInitial": true,
"IsValid": true,
"MaxAttachments": 0,
"MaxSizePerAttachment": 0,
"Name": "Inicial",
"NextHumanInteractionTimeOut": null,
"StateId": 2,
"Version": 1,
"__type": "StateInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Design"
},
"StateLifeCycle": 4,
"StateLifeCycleModifyingDate": "/Date(1324921590483-0200)/",
"StateModifyingDate": "/Date(1324921590303-0200)/",
"__type": "BusinessProcessInstanceHistoryInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime"
},
"__type": "SyncResultInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime"
}
}
SYNCINVOKEBUSINESSPROCESSINSTANCE
Chamada Síncrona para Interagir na Instância de Processo de Negócio no Crivo Workflow (RuntimeService) através do ID do
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/SyncInvokeBusinessProcessInstance
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
Retorno do método LOGIN do SecurityServices
businessProcessInstanceId
long
ID da Instância do Processo de Negócio
stateId
long
ID do Estado do Processo de Negócio
fieldValuesDTO
Lista de Valores dos Campos do Processo de Negócio iniciado
timeOut
Retorno:
API RESTFUL
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcessInstanceId": "1002",
"stateId": 3,
"fieldValuesDTO": [
{
"FieldType": 3,
"Value": "nok"
}
],
"timeOut": 10000
}
Resposta
{
"d": {
"IsTimedOut": false,
"ResultBusinessProcessInstance": {
"BatchId": null,
"Description": "",
"IsValid": true,
"Version": 4,
},
PÁGINA 10
API RESTFUL
{
"FieldDTO": {
"Description": "",
"DisplayName": "",
"Domain": null,
"FieldId": 2,
"Length": 0,
"Name": "Counter",
"Type": 1,
"Validator": 0,
"Version": 1,
},
"SearchValue": "2",
"Value": 2,
},
{
"FieldDTO": {
"Description": "",
"DisplayName": "",
"Domain": null,
"FieldId": 3,
"Length": 10,
"Name": "Status",
"Type": 3,
"Validator": 0,
"Version": 1,
},
PÁGINA 11
API RESTFUL
"SearchValue": "nok",
"Value": "nok",
}
],
"StateInfo": {
"Description": "",
"DisplayName": "Final",
"IsInitial": false,
"IsValid": true,
"Name": "Final",
"StateId": 3,
"Version": 1,
},
},
"__type": "SyncResultInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime"
}
}
PÁGINA 12
API RESTFUL
PÁGINA 13
SYNCSTARTBUSINESSPROCESSWITHRETURNSTATE
Chamada Síncrona para Iniciar a Execução do Processo de Negócio no Crivo Workflow com Estado de Retorno
(RuntimeService)
Caminho:
http://[Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/SyncStartBusinessProcessWithReturnState
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
Retorno do método LOGIN do SecurityService
businessProcess
long
Id do Processo de Negócio a ser iniciado
fieldValuesDTO
Lista de Valores de Campos do Processo de Negócio
returnStateId
long
ID do Estado de retorno
timeOut
Retorno:
Exemplo:
Requisição
{
"loginHandle":{
"value":"ebcd23edba494e3c88e0536a77177193"
},
"businessProcess":
{"Name":"START SINCRONO AGUARDANDO RESPOSTA"},
"fieldValuesDTO":[
{
"FieldName":"texto",
"Value":"texto 1",
"FieldType":3}],
"returnStateId":229,
"timeOut":10000}
Retorno
{
: "d":
: {
: : "__type":"SyncResultInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : "IsTimedOut":false,
: : "ResultBusinessProcessInstance":
: : {
: : : "__type":"BusinessProcessInstanceHistoryInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : : "BatchId":null,
API RESTFUL
: : : "BusinessProcess":
: : : {
: : : : "__type":"BusinessProcessDTO:#Crivo.Workflow.Models.DataTransferObjects.Design",
: : : : "BusinessProcessId":53,
: : : : "CreationDate":"\/Date(1330961842880-0300)\/",
: : : : "Description":"Teste",
: : : : "IsValid":true,
: : : : "ModifiedBy":"admin",
: : : : "ModifiedDate":"\/Date(1331254192509-0300)\/",
: : : : "Name":"START SINCRONO AGUARDANDO RESPOSTA",
: : : : "StatesExecutionTimeout":null,
: : : : "ValidationDescription":null,
: : : : "Version":21
: : : },
: : : "BusinessProcessInstanceHistoryId":112165,
: : : "BusinessProcessInstanceId":39044,
: : : "CreationDate":"\/Date(1331311693633-0300)\/",
: : : "CrivoExecutionStatus":0,
: : : "ErrorDetail":null,
: : : "ErrorSummary":null,
: : : "FieldValueHistory":
: : : [
: : : : {
: : : : : "__type":"FieldValueHistoryDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : : : : "CreationDate":"\/Date(1331311693633-0300)\/",
: : : : : "FieldDTO":
: : : : : {
: : : : : : "__type":"FieldDTO:#Crivo.Workflow.Models.DataTransferObjects.Design",
: : : : : : "CreationDate":"\/Date(1330961843005-0300)\/",
: : : : : : "Description":null,
: : : : : : "DisplayName":"texto",
: : : : : : "Domain":null,
: : : : : : "FieldId":447,
: : : : : : "IsEditable":true,
: : : : : : "IsRequired":false,
: : : : : : "Length":55,
: : : : : : "ModifiedBy":"admin",
: : : : : : "ModifiedDate":"\/Date(1330961843005-0300)\/",
: : : : : : "Name":"texto",
: : : : : : "Type":3,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueHistoryId":332365,
: : : : : "FieldValueId":164192,
: : : : : "ModifyingDate":"\/Date(1331311693633-0300)\/",
PÁGINA 14
API RESTFUL
: : : : : "SearchValue":"texto 1",
: : : : : "Value":"texto 1"
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"inteiro",
: : : : : : "Domain":null,
: : : : : : "FieldId":448,
: : : : : : "IsEditable":false,
: : : : : : "Length":0,
: : : : : : "Name":"inteiro",
: : : : : : "Type":1,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164193,
: : : : : "SearchValue":null,
: : : : : "Value":null
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"float2",
: : : : : : "Domain":null,
: : : : : : "FieldId":449,
: : : : : : "Length":0,
PÁGINA 15
API RESTFUL
: : : : : : "Name":"float2",
: : : : : : "Type":4,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164194,
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"confirma",
: : : : : : "Domain":null,
: : : : : : "FieldId":450,
: : : : : : "Length":0,
: : : : : : "Name":"confirma",
: : : : : : "Type":5,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164195,
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
PÁGINA 16
API RESTFUL
: : : : : : "DisplayName":"data2",
: : : : : : "Domain":null,
: : : : : : "FieldId":451,
: : : : : : "Length":0,
: : : : : : "Name":"data2",
: : : : : : "Type":2,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164196,
: : : : }
: : : ],
: : : "ModifiedBy":"admin",
: : : "RelatedGroup":null,
: : : "RuntimeHostMacAddress":"005056050DD9",
: : : "RuntimeHostName":"NOVACONFIG",
: : : "ScheduledDateTime":null,
: : : "StateInfo":
: : : {
: : : : "__type":"StateInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Design",
: : : : "Description":null,
: : : : "DisplayName":"estado3",
: : : : "ExecutionTimeout":null,
: : : : "FieldIdsLayout":
: : : : [
: : : : ],
: : : : "HasContinuousHumanInteraction":false,
: : : : "HasInteractionTimeout":false,
: : : : "InteractionTimeout":0,
: : : : "InteractionTimeoutStateId":null,
: : : : "IsInitial":false,
: : : : "MaxAttachments":0,
: : : : "MaxSizePerAttachment":0,
: : : : "Name":"estado3",
PÁGINA 17
API RESTFUL
PÁGINA 18
: : : : "NextHumanInteractionTimeOut":null,
: : : : "StateId":230,
: : : : "Version":5
: : : },
: : : "StateLifeCycle":1,
: : : "StateLifeCycleModifyingDate":"\/Date(1331311694101-0300)\/",
: : : "StateModifyingDate":"\/Date(1331311694101-0300)\/",
: : : "WarningMessage":null
: : }
: }
}
SYNCINVOKEBUSINESSPROCESSINSTANCEWITHRETURNSTATE
Chamada Síncrona para Interagir na Instância de Processo de Negócio no Crivo Workflow (RuntimeService) através do ID do
Processo de Negócio com Estado de retorno
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/SyncInvokeBusinessProcessInstanceWithReturnState
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
long
ID da Instância do Processo de Negócio
stateId
long
ID do Estado do Processo de Negócio
returnStateId
long
ID do Estado de retorno
fieldValuesDTO
Lista de Valores dos Campos do Processo de Negócio iniciado
timeOut
Retorno:
Exemplo:
Requisição
{
"loginHandle":
{"value":"70cc47add2904f4f9efc8940cbf78ceb"
},
"businessProcessInstanceId":"39047 ",
"stateId":351,
"fieldValuesDTO":
API RESTFUL
[
{
"FieldName":"texto",
"Value":"invok e1",
"FieldType":3
}
],
"returnStateId":351,
"timeOut":10000
}
Retorno
{
: "d":
: {
: : "__type":"SyncResultInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : "IsTimedOut":true,
: : "ResultBusinessProcessInstance":
: : {
: : : "__type":"BusinessProcessInstanceHistoryInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : : "BatchId":null,
: : : "BusinessProcess":
: : : {
: : : : "__type":"BusinessProcessDTO:#Crivo.Workflow.Models.DataTransferObjects.Design",
: : : : "BusinessProcessId":57,
: : : : "Description":"Teste",
: : : : "Name":"INVOKE SINCRONO AGUARDANDO RESPOSTA",
: : : : "StatesExecutionTimeout":null,
: : : : "Version":15
: : : },
: : : "BusinessProcessInstanceHistoryId":112203,
: : : "CreationDate":"\/Date(1331312191570-0300)\/",
: : : "CrivoExecutionStatus":0,
: : : "ErrorDetail":null,
: : : "ErrorSummary":null,
: : : "FieldValueHistory":
: : : [
: : : : {
PÁGINA 19
API RESTFUL
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"confirma",
: : : : : : "Domain":null,
: : : : : : "FieldId":471,
: : : : : : "Length":0,
: : : : : : "Name":"confirma",
: : : : : : "Type":5,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164216,
: : : : : "SearchValue":"Falso",
: : : : : "Value":false
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"texto",
: : : : : : "Domain":null,
: : : : : : "FieldId":468,
: : : : : : "Length":55,
: : : : : : "Name":"texto",
: : : : : : "Type":3,
: : : : : : "Validator":0,
: : : : : : "Version":1
PÁGINA 20
API RESTFUL
: : : : : },
: : : : : "FieldValueId":164213,
: : : : : "SearchValue":"invok e1",
: : : : : "Value":"invok e1"
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"inteiro",
: : : : : : "Domain":null,
: : : : : : "FieldId":469,
: : : : : : "IsEditable":false,
: : : : : : "Length":0,
: : : : : : "Name":"inteiro",
: : : : : : "Type":1,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164214,
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"float2",
: : : : : : "Domain":null,
: : : : : : "FieldId":470,
PÁGINA 21
API RESTFUL
: : : : : : "Length":0,
: : : : : : "Name":"float2",
: : : : : : "Type":4,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164215,
: : : : },
: : : : {
: : : : : "FieldDTO":
: : : : : {
: : : : : : "DisplayName":"data2",
: : : : : : "Domain":null,
: : : : : : "FieldId":472,
: : : : : : "Length":0,
: : : : : : "Name":"data2",
: : : : : : "Type":2,
: : : : : : "Validator":0,
: : : : : : "Version":1
: : : : : },
: : : : : "FieldValueId":164217,
: : : : }
: : : ],
: : : "ModifiedBy":"admin",
: : : "RelatedGroup":null,
: : : "RuntimeHostMacAddress":"005056050DD9",
PÁGINA 22
API RESTFUL
: : : "RuntimeHostName":"NOVACONFIG",
: : : "ScheduledDateTime":null,
: : : "StateInfo":
: : : {
: : : : "__type":"StateInfoDTO:#Crivo.Workflow.Models.DataTransferObjects.Design",
: : : : "Description":null,
: : : : "DisplayName":"estado4",
: : : : "ExecutionTimeout":null,
: : : : "FieldIdsLayout":
: : : : [
: : : : ],
: : : : "HasContinuousHumanInteraction":false,
: : : : "HasInteractionTimeout":false,
: : : : "InteractionTimeout":0,
: : : : "InteractionTimeoutStateId":null,
: : : : "IsInitial":false,
: : : : "MaxAttachments":0,
: : : : "MaxSizePerAttachment":0,
: : : : "Name":"estado4",
: : : : "NextHumanInteractionTimeOut":null,
: : : : "StateId":251,
: : : : "Version":4
: : : },
: : : "StateLifeCycleModifyingDate":"\/Date(1331312346133-0300)\/",
: : : "StateModifyingDate":"\/Date(1331312346133-0300)\/",
: : : "WarningMessage":null
: : }
: }
}
PÁGINA 23
API RESTFUL
PÁGINA 24
STARTBUSINESSPROCESSBYNAME
Chamada Assíncrona para Iniciar a Execução do Processo de Negócio no Crivo Workflow (RuntimeService) através do Nome
do Processo de Negócio
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/ StartBusinessProcessByName
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
businessProcessName
String
Nome do Processo de Negócio a ser iniciado
fieldValuesDTO
Lista de Valores dos Campos do Processo de Negócio a ser iniciado
Retorno:
Identificação da Instância do Processo de Negócio
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcessName": "SyncAPIStress",
"fieldValuesDTO": [
{
"FieldType": 3,
"Value": "ok"
}
]
}
Resposta
{
"d": 1003
}
API RESTFUL
PÁGINA 25
INVOKEBUSINESSPROCESS
Chamada Assíncrona para Interagir na Instância de Processo de Negócio no Crivo Workflow (RuntimeService) através do ID do
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/InvokeBusinessProcess
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
long
Id da Instância do Processo de Negócio
stateId
long
Id do Estado do Processo de Negócio
fieldValuesDTO
Lista de Valores dos Campos do Processo de Negócio
Retorno:
Identificação da Instância do Processo de Negócio
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcessInstanceId": 1003,
"stateId": 3,
"fieldValuesDTO": [
{
"FieldType": 3,
"Value": "nok"
}
]
}
Resposta
{
"d": null
}
API RESTFUL
PÁGINA 26
GETCURRENTBUSINESSPROCESSINSTANCEINFO
Obtém Informações de Determinada Instância do Processo de Negócio no Crivo Workflow (RuntimeService)
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/GetCurrentBusinessProcessInstanceInfo
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
long
Id da Instância do Processo de Negócio a ser consultada
Retorno:
Informações da Instância de Processo de Negócio
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcessInstanceId": 1003
}
Resposta
{
"d": {
"BatchId": null,
"Description": "",
"IsValid": true,
"Version": 4,
},
{
API RESTFUL
"FieldDTO": {
"Description": "",
"DisplayName": "",
"Domain": null,
"FieldId": 2,
"Length": 0,
"Name": "Counter",
"Type": 1,
"Validator": 0,
"Version": 1,
},
"SearchValue": "2",
"Value": 2,
},
{
"FieldDTO": {
"Description": "",
"DisplayName": "",
"Domain": null,
"FieldId": 3,
"Length": 10,
"Name": "Status",
"Type": 3,
"Validator": 0,
"Version": 1,
},
PÁGINA 27
API RESTFUL
"Value": "nok",
}
],
"StateInfo": {
"Description": "",
"DisplayName": "Final",
"IsInitial": false,
"IsValid": true,
"Name": "Final",
"StateId": 3,
"Version": 1,
},
}
}
PÁGINA 28
API RESTFUL
PÁGINA 29
GETCURRENTFIELDVALUES
Obtém o Valor dos Campos da Instância do Processo de Negócio no Crivo Workflow (RuntimeService)
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/GetCurrentFieldValues
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
long
Id da Instância do Processo de Negócio a ser consultada
Retorno:
Valores dos Campos da Instância do Processo de Negócio
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcessInstanceId": 1003
}
Resposta
{
"d": [
{
"FieldDisplayName": "",
"FieldId": 2,
"FieldName": "Counter",
"FieldType": 1,
"SearchValue": "2",
"Value": 2,
"__type": "FieldValueDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime"
},
{
"FieldId": 3,
"FieldType": 3,
"Value": "nok",
}
]
}
API RESTFUL
PÁGINA 30
GETCURRENTFIELDVALUE
Obtém o Valor de Determinado Campo da Instância do Processo de Negócio no Crivo Workflow (RuntimeService)
Caminho:
http:// [Servidor]:[Porta]/WorkflowAPIService/RuntimeService/WebHttp/GetCurrentFieldValue
PARÂMETRO
TIPO
DESCRIÇÃO
loginHandle
LoginHandle
long
ID da Instância do Processo de Negócio a ser consultada
fieldId
long
ID do campo do Processo de Negócio a ser consultado
Retorno:
Valor de determinado Campo da Instância do Processo de Negócio
Exemplo:
Requisição
{
"loginHandle": {
},
"businessProcessInstanceId": 1003,
"fieldId": 2
}
Resposta
{
"d": {
"FieldId": 2,
"FieldName": "Counter",
"FieldType": 1,
"SearchValue": "2",
"Value": 2,
}
}
API RESTFUL
PÁGINA 31
GETINSTANCESBYFIELDVALUE
Realiza a busca de instâncias de processos de negócio, a partir do valor exato de um campo
Caminho:
/WorkflowAPIService/RuntimeService/WebHttp/GetInstancesByFieldValue
PARÂMETRO
TIPO
loginHandle
LoginHandle
businessProcessNames
IList<string>
Lista com os nomes dos processos de negócio1
fieldName
string
Nome do campo do processo de negócio2
fieldValue
string
Valor do campo do processo de negócio
returnedFieldNames
IList<string>
Lista com os nomes dos campos que serão retornados
maxResults
int
Quantidade máxima de respostas que serão retornadas
orderDirection
OrderDirection
DOMÍNIO
None =0
Ascending = 1
DESCRIÇÃO
Ordem dos elementos que serão retornados após a consulta, com base na
última data de modificação do Ciclo de Vida
Descending=2
Retorno:
•
Lista com os valores contidos nos campos solicitados;
•
Nome do processo de negócio;
•
Versão do processo de negócio;
•
ID da instância;
•
Ciclo de vida atual da instância;
•
Nome do Estado atual da instância;
•
Data e hora da última modificação do Ciclo de Vida.
Exemplo:
Requisição
{"loginHandle": {
"value": "e6716a1b98154899a92397b95684339c"
},
"businessProcessNames": [“PROCESSO_REGRESSAO_15_NOVO_ALTERADO”,”Fabiana1”],
"fieldName": "cnpj",
"fieldValue": "00000000000191",
"returnedFieldNames": ["cnpj"],
1
2
Caso este parâmetro não fora informado o resultado da busca retornará os dados solicitados com base em todos os processos de negócio.
Para a correta aplicação do método GetInstancesByFieldValue, os parâmetros fieldname, fieldvalue e maxresults sempre deverão ser informados.
API RESTFUL
"maxResults": 5,
"orderDirection": 2
}
Resposta
{
: "d":
: [
: : {
: : : "__type":"InstancesByFieldValueResultDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : : "BusinessProcessName":"PROCESSO_REGRESSAO_15_NOVO_ALTERADO",
: : : "BusinessProcessVersion":42,
: : : "Fields":
: : : [
: : : : {
: : : : : "__type":"InstanceFieldValueDTO:#Crivo.Workflow.Models.DataTransferObjects.Runtime",
: : : : : "Name":"cnpj",
: : : : : "Type":3,
: : : : : "Value":"00000000000191"
: : : : }
: : : ],
: : : "StateLifeCycleModifyDate":"\/Date(1374508276520-0300)\/",
: : : "StateName":"(Interação) - Análise da proposta"
: : },
: : {
: : : "BusinessProcessName":"Fabiana1",
: : : "Fields":
: : : [
: : : : {
: : : : : "Name":"CNPJ",
: : : : : "Type":3,
: : : : : "Value":"00000000000191"
: : : : }
PÁGINA 32
API RESTFUL
: : : ],
: : },
: : {
: : : "Fields":
: : : [
: : : : {
: : : : : "Name":"CNPJ",
: : : : : "Type":3,
: : : : : "Value":"00000000000191"
: : : : }
: : : ],
: : },
: : {
: : : "Fields":
: : : [
: : : : {
: : : : : "Name":"CNPJ",
: : : : : "Type":3,
: : : : : "Value":"00000000000191"
: : : : }
: : : ],
PÁGINA 33
API RESTFUL
: : },
: : {
: : : "BusinessProcessName":"Fabiana1",
: : : "Fields":
: : : [
: : : : {
: : : : : "Name":"CNPJ",
: : : : : "Type":3,
: : : : : "Value":"00000000000191"
: : : : }
: : : ],
: : }
: ]
}
Tabela 1- Método GetInstancesByFieldValue
ANEXO
ANEXO 1: TABELA DE-PARA DA PROPRIEDADE "FIELDTYPE"
Valor
Valor Correspondente na
Interface do Crivo Workflow
1
Inteiro
2
Data
3
Texto
4
Ponto Flutuante
5
Booleano
6
Chave de Correlação
Tabela 2: DE-PARA da propriedade "FIELDTYPE"
PÁGINA 34
API RESTFUL
ANEXO 2: TABELA DE-PARA DA PROPRIEDADE “STATELIFECYCLE”
Valor
Valor Correspondente na
Interface do Crivo Workflow
0
Desconhecido
1
Pendente
2
Executando
3
Finalizado
4
Aguardando Resposta
5
Erro
6
Expirado
7
Aguardando Interação Humana
8
Alocado
9
Execução Agendada
10
Imposição de Estado
11
Interagindo
12
Imposição por limite de tempo
13
Cancelado
14
Atenção
Tabela 3: DE-PARA da Propriedade “STATELIFECYCLE”
PÁGINA 35

MANUAL DE INTEGRAÇÃO DO CRIVO WORKFLOW

Transcrição

Documentos relacionados

válvula de pé com crivo

new App. 2013 GEL MM

Crivo de Eratóstenes

Declaração de Entrada

I authorize PASB to add to the next month`s tuition bill the amount

Page 1 of 1 Semana Informática 13-09

E-PORTALS

new GCPU - Junho:2013

Escola Superior de Tecnologia e Gestão do I. P. Portalegre

CONCENTRAÇÃO EM JIGUES TIPOS DE EQUIPAMENTOS Q

Manual de Integração do Crivo