Resco CRM Server Guide. How to integrate Resco CRM with other back-end systems using web services

Transcription

1 Resco CRM Server Guide How to integrate Resco CRM with other back-end systems using web services

2 Integrating Resco CRM with other back-end systems using web services (Data, Metadata) This document consists of three major parts. The first one briefly describes Resco CRM Server; the second one talks about the integration of the server with other CRM or ERP systems. The last one is a detailed description of the web services that are used for the synchronization of the Resco CRM Server with your back-end system. Meet Resco CRM Server Resco CRM provides you with a data storage with customizable data scheme; it can be cloud-based or on premise. You can connect Resco CRM to other CRM or non-crm servers, or use it independently. You can use Resco CRM web client (that comes with the server) to view the data stored on the server. An important part of the server is also a configuration and administration console. This admin tool allows you to manage all the devices and users related to your CRM organization created on the server, and the configuration tool allows you to configure the data scheme, layout and business logic of the CRM system.

3 Resco CRM integration Basic scenario: YOUR SYSTEM Resco CRM Connector SYNC Resco CRM Server SYNC Resco CRM Client YOUR BACKEND SYSTEM Any CRM/ERP System Resco CRM Connector Synchronization module between ERP System and Resco CRM Server. Resco CRM Server Fully customizable back end for Mobile CRM Client application. Resco CRM Client End-user CRM application customized for Resco CRM server. Resco CRM Server and Client are provided by Resco. Resco CRM Server allows defining schema and stores the data for Mobile CRM Client, which is used to display the data. You can now build your own Resco CRM Connector to enable the synchronization between your back-end system and the Resco CRM Server. Resco CRM Server acts like a passive module it does not initiate any synchronization. Mobile CRM Client must initiate the synchronization process to download/upload data. This also applies for Resco CRM Connector. It must determine when/whether to synchronize ERP System data with data stored on the Resco CRM Server. For example, every hour, every day, etc., depends on how current the data must be on the clients. To check whether there are new/updated data on the Resco CRM Server use GetMaxRowVersion web service method to get the current row version. If the current row version changed from the last stored row version, there are new changes available on the Resco CRM Server.

4 Resco CRM Connector Consist of a set of REST Web Service methods divided into Metadata Service and Data service. Data Types UniqueIdentifier String Integer Float Decimal DateTime Picklist PicklistMap Boolean Money Binary Lookup RowVersion PartyList

5 Resco CRM Connector Data Service Data Service helps you access and manipulate data on Resco CRM Server.The web service URL depends on server settings; whether the server uses domain organization selection or simple URL organization selection. URL organization base web service URL is: Domain organization base web service URL is: Resco s Mobile CRM Cloud server uses domain organization selection: Web Request requirements: Method: GET/POST Content-Type: application/xml; charset=utf-8 Authorization: Basic BASE64(login:password) Methods: 1. POST WhoAmI 2. POST GetMaxRowVersion 3. GET Select 4. POST Fetch 5. POST Create 6. POST CreateMultiple 7. POST Update 8. POST UpdateMultiple 9. POST Delete 10. POST DeleteMultiple 11. POST Execute 12. POST ExecuteMultiple 1. POST WhoAmI Return organization ID and user ID. No parameters. Sample URL: Response: <?xml version="1.0" encoding="utf-8"?> <WhoAmI xmlns:xsd=" xmlns:xsi=" <OrganizationId>87ddc2f8-d0d1-4ad6-a a7a46edd</OrganizationId> <UserId>601d9d17-89b4-e111-9c9a-00155d0b710a</UserId> </WhoAmI>

6 2. POST GetMaxRowVersion Return max row version for the database. Row version is counter of every change in database. It helps to determine changes from last synchronization. Each entity has system attribute rowversion which determine the version (or timestamp) of last change for the specified row. No parameters. Sample URL: Response: <?xml version="1.0" encoding="utf-8"?> <string>3665</string>

7 3. GET Select Template URL: /{entity}?$select={select}&$filter={filter}&$orderby={orderby} &$skip={skip}&$top={top} Returns list of entities. Parameters: {entity} {select} {filter} - determine the entity to retrieve, optionally, you can specify entity id to retrieve in following format: account(guid'300a4f0b-99dc-4ba5-95bd-d41abf61dc10') - determine attributes to retrieve, separated by comma - determine entity filter. Condition is defined like: {left identifier} {comparison statement} {right identifier} {and/or} The left identifier is always the attribute name. Comparison statements can by any of following: eq, =, == equal ne,!=, <> not equal gt, > greater than ge, >= greater than equal lt, < less than le, <= less than equal like, not-like like or not like Right identifier can be any of following: string value string, or string integer value 0, 1, 2,. null, not-null Conditions can be joined using: and, && or, {orderby} {skip} {top} - determine sort, optionally include desc keyword. Separated by comma. - determine number of entities to skip - determine number of entities to return Sample URL: &$filter=name%20like%20'c%'&$orderby=address1_city&$skip=2&$top=5

8 Response: <?xml version="1.0" encoding="utf-8"?> <EntitySet xmlns=" <Metadata PrimaryEntity="account"> <Attributes> <Attribute EntityName="account" AttributeName="name" Name="name" Type="String"/> <Attribute EntityName="account" AttributeName="address1_city" Name="address1_city" Type="String"/> <Attribute EntityName="account" AttributeName=" address1" Name=" address1" Type="String"/> <Attribute EntityName="account" AttributeName="id" Name="id" Type="UniqueIdentifier"/> </Attributes> </Metadata> <Entities> <name>cash and Carry Bikes</name> <address1_city>dallas</address1_city> <id>b9ca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>convenient Bike Shop</name> <address1_city>everett</address1_city> <id>bdca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>cheap n Best bikes</name> <address1_city>redmond</address1_city> < address1>someone@example.com</ address1> <id>bbca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>cool Ride Store</name> <address1_city>seattle</address1_city> < address1>someone@example.com</ address1> <id>beca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>certified Bicycle Supply</name> <address1_city>west Covina</address1_city> < address1>someone@example.com</ address1> <id>baca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> </Entities> </EntitySet>

9 4. POST Fetch Fetch query. Return list of entities defined by fetch. Sample URL: Request: <fetch page="2" count="5" paging-cookie="optional PagingCookie from previous fetch"> <entity name="account"> <attribute name="id" /> <attribute name="name" /> <order attribute="name" descending="true" /> <filter> <condition attribute="name" operator="like" value="b%" /> </filter> </entity> </fetch> Response: <?xml version="1.0" encoding="utf-8"?> <EntitySet xmlns=" <Metadata PrimaryEntity="account"> <Attributes> <Attribute EntityName="account" AttributeName="id" Name="id" Type="UniqueIdentifier"/> <Attribute EntityName="account" AttributeName="name" Name="name" Type="String"/> </Attributes> </Metadata> <Entities> <id>b3ca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>bikes unlimited</name> <id>b2ca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>bike-o-maniac store</name> <id>b1ca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>bike Universe</name> <id>b0ca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>bike Products and Accessories</name> <id>afca6c78-4e0b-df11-a3d5-0003ff9c98bb</id> <name>bike Experts</name> </Entities> <MoreRecords>true</MoreRecords> <PagingCookie><cookie page="2"><name last="bike Experts" descending="1" /><id last="afca6c78-4e0b-df11-a3d5-0003ff9c98bb" /></cookie></pagingcookie> </EntitySet>

10 5. POST Create Create entity and return entity ID. Optional, primary key can be specified by PrimaryKey attribute. Default PrimaryKey is id. Sample URL: Request: <Entity EntityName='account' [PrimaryKey='name;address1_city']> <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> <name>my Name</name> <address1_city>bratislava</address1_city> <revenue> </revenue> Response: <?xml version="1.0" encoding="utf-8"?> <guid>1607a7f7-c16f-4e19-849c-bad37ff59f5c</guid>

11 6. POST CreateMultiple Create multiple entities. The entity is defined same as for Create method. Sample URL: Request: <Entities xmlns=' <Entity EntityName='account'> <id>fe400d92-efd a0b4-94c63212d5c8</id> <name>my Name 1</name> <address1_city>bratislava</address1_city> <revenue> </revenue> <Entity EntityName='account'> <id>d008549e-842f-46ec-9f76-ecc5f20a550d</id> <name>my Name 2</name> <address1_city>bratislava</address1_city> <revenue> </revenue> </Entities>

12 7. POST Update?$create={create} Update entity. Optional, the primary key can be specified by PrimaryKey attribute. Default PrimaryKey is id. Parameter: {create} (optional) Determine whether the entity should be created if it does not exist. Sample URL: Optional URL: Request: <Entity EntityName='account' [PrimaryKey='name;address1_city']> <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> <name>my Name 2</name> <address1_city>bratislava</address1_city> <revenue> </revenue>

13 8. POST UpdateMultiple?$create={create} Update multiple entities. The entity is defined the same way as for Update method. Parameter: {create} (optional) Determine whether the entity should be created if it does not exist. Sample URL: Optional URL: Request: <Entities xmlns=' <Entity EntityName='account'> <id>fe400d92-efd a0b4-94c63212d5c8</id> <name>my Name 1</name> <address1_city>bratislava</address1_city> <revenue> </revenue> <Entity EntityName='account'> <id>d008549e-842f-46ec-9f76-ecc5f20a550d</id> <name>my Name 2</name> <address1_city>bratislava</address1_city> <revenue> </revenue> </Entities>

14 9. POST Delete Delete entity. Optional, the primary key can be specified by PrimaryKey attribute. Default PrimaryKey is id. Sample URL: Request: <Entity EntityName='account'> <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> With PrimaryKey: <Entity EntityName='account' PrimaryKey='name;address1_city'> <name>my Name 3</name> <address1_city>bratislava</address1_city>

15 10. POST DeleteMultiple Delete multiple entities. The entity is defined the same way as for Delete method. Sample URL: Request: <Entities xmlns=' <Entity EntityName='account'> <id>fe400d92-efd a0b4-94c63212d5c8</id> <Entity EntityName='account'> <id>d008549e-842f-46ec-9f76-ecc5f20a550d</id> </Entities>

16 11. POST Execute Allow to execute specified operation on entity, such as Create, Update, Upsert and Delete. Action: Create Create entity Update Update entity Upsert If exist, Update entity; otherwise Create entity Delete Delete entity Sample URL: Request: <Entity EntityName='account' Action='Create' [PrimaryKey='name;address1_city'] xmlns=' <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> <name>my Name</name> <address1_city>bratislava</address1_city> <revenue> </revenue> Response: <Response Action="Create" xmlns=" <Result Type="guid">1607a7f7-c16f-4e19-849c-bad37ff59f5c</Result> </Response>

17 12. POST ExecuteMultiple Allow to execute specified operation on multiple entities, such as Create, Update, Upsert and Delete. ContinueOnError Determine whether to continue executing operation on error. TransactionType Determine transaction operation: None - execute multiple will not run in transaction RollbackOnError - execute multiple transaction will roll back on error CommitOnError - execute multiple transaction will commit on error Action: Create Create entity Update Update entity Upsert If exist, Update entity; otherwise Create entity Delete Delete entity Sample URL: Request: <ExecuteMultiple TransactionType='RollbackOnError' ContinueOnError='false' xmlns=' <Entity EntityName='account' Action='Create'> <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> <name>my Name</name> <address1_city>bratislava</address1_city> <revenue> </revenue> <Entity EntityName='account' Action='Update'> <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> <name>my Name 2</name> <Entity EntityName='account' Action='Upsert'> <id>2607a7f7-c16f-4e19-849c-bad37ff59f5c</id> <name>my Name 3</name> <revenue2> </revenue2> <Entity EntityName='account' Action='Delete'> <id>1607a7f7-c16f-4e19-849c-bad37ff59f5c</id> </ExecuteMultiple> Response: <?xml version="1.0" encoding="utxrmf-8"?> <MultipleResponse xmlns=" <Response Action="Create"> <Result Type="guid">1607a7f7-c16f-4e19-849c-bad37ff59f5c</Result> </Response> <Response Action="Update"> <Result Type="bool">true</Result> </Response> <Response Action="Upsert"> <Fault xmlns=" <Code>500</Code> <Reason>KeyNotFoundException</Reason> <Detail>The given attribute 'revenue2' was not present in the entity metadata.</detail> <StackTrace> </StackTrace> </Fault> </Response>

18 <Response Action="Delete"> <Result Type="bool">true</Result> </Response> </MultipleResponse>