Difference between revisions of "Invoking Integration Server Services from Business Rules"

From AgileApps Support Wiki
imported>Aeric
(Created page with "==Overview== This use case shows you how to invoke Integration Server services from AgileApps. You can link these Integration Server services to AgileApps objects using business ...")
 
imported>Aeric
Line 27: Line 27:
:10. Provide the details for '''Service Input Map''' and '''Service Output Map'''. This is an optional step as there can be services that do not require any input or do not produce an output.
:10. Provide the details for '''Service Input Map''' and '''Service Output Map'''. This is an optional step as there can be services that do not require any input or do not produce an output.
:11. After you select an Integration Server service, click '''Service Input Map'''. In the Data Mapper window, the '''Document Model''' lists the set of inputs required for the selected Integration Server service. Also, the '''Object Model''' includes the fields for the selected AgileApps object. For more information, see [[AgileApps and Integration Server field mapping table]].  
:11. After you select an Integration Server service, click '''Service Input Map'''. In the Data Mapper window, the '''Document Model''' lists the set of inputs required for the selected Integration Server service. Also, the '''Object Model''' includes the fields for the selected AgileApps object. For more information, see [[AgileApps and Integration Server field mapping table]].  
Perform the mapping of AgileApps object fields to the fields of the Integration Server service. The following table provides details on AgileApps to IS (Outgoing Map) field mapping:
Perform the mapping of AgileApps object fields to the fields of the Integration Server service. The following table provides details on AgileApps to Integration Server (Outgoing Map) field mapping:
:Table 1 - AgileApps to Integration Server (Outgoing Map)
:{| border="1" cellpadding="5" cellspacing="1"
! align="left" width="180em"| AgileApps Data Type  !! align="left"| Matching Integration Server Data Type
|-
| <tt><nowiki>String</nowiki></tt>
| <tt><nowiki>String</nowiki></tt>
|-
| <tt><nowiki>Boolean</nowiki></tt>
| <tt><nowiki>Object of Boolean Wrapper Type</nowiki></tt>
|-
| <tt><nowiki>Double</nowiki></tt>
| <tt><nowiki>Object of Double Wrapper Type</nowiki></tt>
|-
| <tt><nowiki>java.util.date</nowiki></tt>
| <tt><nowiki>Object of Date Wrapper Type</nowiki></tt>
|-
| <tt><nowiki>Integer</nowiki></tt>
| <tt><nowiki>Object of Integer/Long Wrapper Type</nowiki></tt>
|-
|}
12. After you finish mapping for the Service Input Map, click '''Service Output Map'''. In the Data Mapper window, the '''Document Model''' lists the result from the executed IS service. Also, the Object Model includes the AgileApps object fields to which you must map the result from the executed IS service.
Perform the mapping of the result from the Integration Server service to the AgileApps object fields using the '''Service Output Map'''. When the business rule invokes the Integration Server service, this mapping updates the results to the mapped object or case record fields.
The following table provides details on Integration Server to AgileApps (Incoming Map) field mapping:
 
 
:Table 2- Integration Server to AgileApps (Incoming Map)
:{| border="1" cellpadding="5" cellspacing="1"
! align="left" width="180em"| Integration Server Data Type  !! align="left"| Matching AgileApps Data Type !! align="left"| Comment
|-
| <tt><nowiki>String</nowiki></tt>
| <tt><nowiki>String</nowiki></tt>
|-
| <tt><nowiki>String List</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>String Table</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Doc</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Doc List</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Doc Ref</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Doc Ref List</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Obj</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Obj List</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Obj Wrapper Types</nowiki></tt>
| <tt><nowiki></nowiki></tt>
|-
| <tt><nowiki>Boolean</nowiki></tt>
| <tt><nowiki>Boolean</nowiki></tt>
|-
| <tt><nowiki>Byte</nowiki></tt>
| <tt><nowiki>Integer</nowiki></tt>
|-
| <tt><nowiki>Character</nowiki></tt>
| <tt><nowiki>String</nowiki></tt>
|-
| <tt><nowiki>Double</nowiki></tt>
| <tt><nowiki>Double</nowiki></tt>
|-
| <tt><nowiki>Float</nowiki></tt>
| <tt><nowiki>Double</nowiki></tt>
|-
| <tt><nowiki>Integer</nowiki></tt>
| <tt><nowiki>Integer</nowiki></tt>
|-
| <tt><nowiki>Long</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>Short</nowiki></tt>
| <tt><nowiki>Integer</nowiki></tt>
|-
| <tt><nowiki>Date</nowiki></tt>
| <tt><nowiki>Timestamp</nowiki></tt>
|-
| <tt><nowiki>XOPObject</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
| <tt><nowiki>ByteArray</nowiki></tt>
| <tt><nowiki>No Matching Type</nowiki></tt>
|-
|}

Revision as of 12:12, 29 August 2019

Overview

This use case shows you how to invoke Integration Server services from AgileApps. You can link these Integration Server services to AgileApps objects using business rules. AgileApps invokes these configured Integration Server services on execution of these business rules.

Actors

Any user who has the Manage Company Capabilities administrative permission can perform the required configurations to invoke the Integration Server services using business rules. For more information on permissions, see Administrative Permissions.

Before you begin

Ensure to configure the Integration Server username and password in Integration Server Configuration Settings. For more information about IS Configuration, see Integration Server Configuration.

Invoking the Integration Server services

To invoke the Integration Server services using business rules, perform the following actions:

1. Navigate to Settings new ui.png > Customization > Objects.
2. Select an object.
3. On the Object page, select Business Rules.
4. Under Event Rules, click New Rule. The following object events support invoking of Integration Server services through business rules:
  • Created
  • Updated
  • Deleted
  • Closed
  • Reopened
  • Owner Changed
5. Provide the details for the Basic Information section. For more information about setting these parameters, see Event Rules.
6. Set the Execution Criteria.
7. In the Actions to Perform section, select Invoke IS Service from the drop-down list. The application lists all the Integration Server packages available for this action.
8. Select any Integration Server package. The application lists all the services that are part of the selected Integration Server package in a folder structure.
9. Select an Integration Server service from the drop-down list.
10. Provide the details for Service Input Map and Service Output Map. This is an optional step as there can be services that do not require any input or do not produce an output.
11. After you select an Integration Server service, click Service Input Map. In the Data Mapper window, the Document Model lists the set of inputs required for the selected Integration Server service. Also, the Object Model includes the fields for the selected AgileApps object. For more information, see AgileApps and Integration Server field mapping table.

Perform the mapping of AgileApps object fields to the fields of the Integration Server service. The following table provides details on AgileApps to Integration Server (Outgoing Map) field mapping:

Table 1 - AgileApps to Integration Server (Outgoing Map)
AgileApps Data Type Matching Integration Server Data Type
String String
Boolean Object of Boolean Wrapper Type
Double Object of Double Wrapper Type
java.util.date Object of Date Wrapper Type
Integer Object of Integer/Long Wrapper Type

12. After you finish mapping for the Service Input Map, click Service Output Map. In the Data Mapper window, the Document Model lists the result from the executed IS service. Also, the Object Model includes the AgileApps object fields to which you must map the result from the executed IS service. Perform the mapping of the result from the Integration Server service to the AgileApps object fields using the Service Output Map. When the business rule invokes the Integration Server service, this mapping updates the results to the mapped object or case record fields. The following table provides details on Integration Server to AgileApps (Incoming Map) field mapping:


Table 2- Integration Server to AgileApps (Incoming Map)
Integration Server Data Type Matching AgileApps Data Type Comment
String String
String List No Matching Type
String Table No Matching Type
Doc No Matching Type
Doc List No Matching Type
Doc Ref No Matching Type
Doc Ref List No Matching Type
Obj No Matching Type
Obj List No Matching Type
Obj Wrapper Types
Boolean Boolean
Byte Integer
Character String
Double Double
Float Double
Integer Integer
Long No Matching Type
Short Integer
Date Timestamp
XOPObject No Matching Type
ByteArray No Matching Type