DOCSLIB.ORG

Integrations &

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Integrations & Integrations & API Version 7.18 This documentation is provided under restrictions on use and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this documentation, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. © 2021 Creatio. All rights reserved. Table of Contents | 3 Table of Contents Integration options 6 Compare integration methods 6 Integration with DataService 7 Integration with OData 8 Integration with custom configuration web service 8 Authentication 8 Disabling the CSRF protection 9 Implement authentication using C# 9 Example implementation algorithm 10 AuthService.svc web-service 11 Request string 12 Request headers 12 Request body 12 HTTP status code 13 Response headers 13 Response body 13 OData 14 OData 4 protocol 14 OData 3 protocol 14 The limitations of OData protocol 16 OData integration examples 17 Stream data type request examples 17 Retrieve data 17 Add data 19 Modify data 24 Delete data 26 Batch request examples 27 Batch request (Content-Type: application/json) 28 Batch request (Content-Type: application/json and Prefer: continue-on-error) 31 Batch request (Content-Type: multipart/mixed) 33 Batch request (Content-Type: multipart/mixed and different sets of requests) 36 WCF client request examples 38 Retrieve a contact collection via a LINQ request. 39 Retrieve a contact collection via an implicit request 40 Retrieve a contact collection via an explicit request 40 CRUD operation examples 41 © 2021 Creatio. All rights reserved. Table of Contents | 4 Odata web service (OData 4) 43 Request string 44 Request headers 46 Request body 46 HTTP status code 47 Response body 48 EntityDataService.svc web service (OData 3) 49 Request string 50 Request headers 52 Request body 53 HTTP status code 53 Response body 54 DataService 55 Resctrictions when using DataService 55 Add a button to create a new record in the [Contacts] section 56 Example implementation algorithm 56 Add a button to read records in the [Contacts] section 58 Example implementation algorithm 58 Filter records in the [Contacts] section 61 Example implementation algorithm 61 Filter records in the [Contacts] section using a macro 65 Example implementation algorithm 66 Update a record in the [Contacts] section 69 Example implementation algorithm 69 Delete a record in the [Contacts] section 73 Example implementation algorithm 73 Add and update a record in the [Contacts] section 77 Example implementation algorithm 77 InsertQuery class 81 Properties 82 The ColumnValues class 83 The Parameter class 84 SelectQuery class 85 Properties 87 The SelectQueryColumns class 89 The ColumnExpression class 89 The Parameter class 92 The ServerESQCacheParameters class 93 Filters class 94 © 2021 Creatio. All rights reserved. Table of Contents | 5 The Filters class 94 The BaseExpression class 97 EntitySchemaQueryMacrosType enumeration 100 UpdateQuery class 101 Properties 102 The ColumnValues class 103 The Parameter class 104 The Filters class 105 DeleteQuery class 105 Properties 106 The Filters class 107 Batch queries 107 Business process service 108 Run business process via web-service 108 Example implementation algorithm 108 Launch the process from a client module 117 Case description 118 Source code 118 Case implementation algorithm 118 ProcessEngineService.svc web-service 123 Request string 124 Request headers 125 Response body 125 Executing a separate element of the business process 126 Using Postman 126 Working with requests in Postman 127 Adding a request 127 Setting up the request 129 Executing the request 131 Saving the request 131 Working with request collections in Postman 132 Adding a collection of requests 132 Adding requests to the collection 134 Setting up variables for the request collection 135 Executing the collection of requests 136 © 2021 Creatio. All rights reserved. Integration options | 6 Integration options Medium Creatio enables a range of methods for integration with third-party software products. Choosing the integration method depends on the client's needs, the type and architecture of third-party software products, and the developer's skills. Compare integration methods A comparison of the main characteristics of the supported methods of integration with Creatio is given in the table. © 2021 Creatio. All rights reserved. Integration options | 7 Comparison of main methods of integration with Creatio Feature DataService OData ProcessEngineService Custom configuration service Supported XML, JSON, XML, JSON XML, JSON XML, JSON formats of JSV, CSV the data exchange Tasks are CRUD CRUD-operations with Launch business All user tasks being solved operations objects, adding and removing processes, pass and that can be with Creatio links, obtaining metadata, return the parameters of solved within objects, data collections, object fields, the launched business the open filtering, and sorting, etc. process, launch Creatio API use of built-in individual elements of a Creatio business process macros Complexity High Medium Low Medium Ways of Forms Forms Forms Anonymous, authentication Forms — depends on service implementation Availability of Creatio .dll Enabled No need No need auxiliary libraries can http://www.odata.org/libraries custom be used only libraries for .NET applications Developer Creatio Microsoft Creatio Creatio A brief description and the main advantages of each of the methods are given below. Integration with DataService The DataService web service is the main link between the Creatio client and server parts. It helps to transfer the data entered by user via user interface to the server-side of the application to further process and save to the database. Key benefits and integration options: Data exchange with XML, JSON, JSV, CSV. © 2021 Creatio. All rights reserved. Authentication | 8 Available operations of creating, reading, updating, and deleting the Creatio objects (CRUD operations). You can use built-in macros and data filtering. User authorization is required for access. Integration with OData Open Data (OData) protocol is an open web protocol for data requests and updates based on the REST architectural approach using Atom/XML and JSON standards. Any third-party application that supports HTTP messaging and can process XML or JSON data can have access to the Creatio data and objects. Data is available as resources addressed through a URI. Access to the data and modification are performed by standard HTTP commands (GET, PUT/PATCH, POST, and DELETE). Key benefits and integration options: Data exchange with XML, JSON. A lot of operations with Creatio objects, including CRUD operations. Convenient functions for working with strings, dates, and time. A large number of custom libraries for working with OData for popular application and mobile platforms. User authorization is required for access. Integration with custom configuration web service Creatio enables to create of custom web services in the configuration that can implement specific integration tasks. Configuration web service is a RESTful service implemented based on WCF technology. Key benefits and integration options: Developer implements data exchange in any convenient way. Developer can implement any operation with Creatio objects, including CRUD operations. User authorization is not required for access. Authentication Medium All external requests to Creatio web services must be authenticated. We have the following authentication types in Creatio: Anonymous authentication. Basic authentication. Forms authentication (Cookie based). Authentication based on the OAuth 2.0 open authorization protocol. The “Forms authentication” is a best practice for integration with the application. To perform the “Forms authentication”, Creatio uses a separate AuthService.svc web service. © 2021 Creatio. All rights reserved. Implement authentication using C%23 | 9 Starting with version 7.10, authentication is protected from CSRF attacks. Note. CSRF (Cross Site Request Forgery) – is a type of attacks for web site visitors based on possible HTTP problems. You need to perform authentication using the AuthService.svc service when integrating with third party applications. After you successfully authenticate, AuthService.svc returns the authentic cookie that must be added to your request. It also returns a cookie containing the CSRF token. This token must be placed in the request header. You can find examples of an authentic cookie below and in the OData and DataService data services. Disabling the CSRF protection Attention.We recommend disabling the CSRF protection only if you use basic authentication. In Creatio, you can disable the CSRF protection both for the whole application or for separate services and methods. 1. Disabling the CSRF protection for all application services In the .\Web.Config and .\Terrasoft.WebApp\Web.Config files, disable the UseCsrfToken setting: <add value="false" key="UseCsrfToken" /> 2. Disabling the CSRF protection for one application service. Use the DisableCsrfTokenValidationForPaths setting in the .\Web.Config file: <add key="DisableCsrfTokenValidationForPaths" value="/ServiceModel/ MsgUtilService.svc" />
Load more

Recommended publications
  • Odata Services Company
    PUBLIC 2021-03-09 OData Services company. All rights reserved. All rights company. affiliate THE BEST RUN 2021 SAP SE or an SAP SE or an SAP SAP 2021 © Content 1 SAP Cloud for Customer OData API..............................................4 2 New Features.............................................................. 13 2.1 What's New in OData API v2 Reference.............................................13 2.2 Add Public Solution Model (PSM) Fields to Standard OData Services........................15 2.3 Transport Custom OData Services with Transport Management............................16 2.4 Compatibility Mode for READ Operations........................................... 16 2.5 Support for User-Friendly IDs in Standard OData Services................................16 2.6 Constant Values to Function Imports...............................................17 3 OData API Reference.........................................................18 3.1 OData API v2 Reference........................................................18 3.2 OData API v1 Reference (Deprecated)..............................................20 Account Contact Relationship.................................................21 Account EntityType........................................................22 Appointment Entity Type....................................................40 BusinessPartner Entity Type..................................................46 CodeList Entity Type....................................................... 47 Contextual CodeList Entity Type...............................................48
    [Show full text]
  • Pyslet Documentation Release 0.6.20160201
    Pyslet Documentation Release 0.6.20160201 Steve Lay February 02, 2016 Contents 1 What’s New? 1 2 Compatibility 7 3 IMS Global Learning Consortium Specifications 13 4 The Open Data Protocol (OData) 101 5 Hypertext Transfer Protocol (RFC2616) 207 6 Other Supporting Standards 247 7 Welcome to Pyslet 357 Python Module Index 359 i ii CHAPTER 1 What’s New? As part of moving towards PEP-8 compliance a number of name changes are being made to methods and class at- tributes with each release. There is a module, pyslet.pep8, which contains a compatibility class for remapping missing class attribute names to their new forms and generating deprecation warnings, run your code with “python -Wd” to force these warnings to appear. As Pyslet makes the transition to Python 3 some of the old names will go away completely. It is still possible that some previously documented names could now fail (module level functions, function arguments, etc.) but I’ve tried to include wrappers or aliases so please raise an issue on Github if you discover a bug caused by the renaming. I’ll restore any missing old-style names to improve backwards compatibility on request. Finally, in some cases you are encouraged to derive classes from those defined by Pyslet and to override default method implementations. If you have done this using old-style names you will have to update your method names to prevent ambiguity. I have added code to automatically detect most problems and force fatal errors at runtime on construction, the error messages should explain which methods need to be renamed.
    [Show full text]
  • ISO/IEC JTC 1 Information Technology
    ISO/IEC JTC 1 Information technology Big data Preliminary Report 2014 Our vision Our process To be the world’s leading provider of high Our standards are developed by experts quality, globally relevant International all over the world who work on a Standards through its members and volunteer or part-time basis. We sell stakeholders. International Standards to recover the costs of organizing this process and Our mission making standards widely available. ISO develops high quality voluntary Please respect our licensing terms and International Standards that facilitate copyright to ensure this system remains international exchange of goods and independent. services, support sustainable and equitable economic growth, promote If you would like to contribute to the innovation and protect health, safety development of ISO standards, please and the environment. contact the ISO Member Body in your country: www.iso.org/iso/home/about/iso_ members.htm This document has been prepared by: Copyright protected document ISO/IEC JTC 1, Information technology All rights reserved. Unless otherwise Cover photo credit: ISO/CS, 2015 be reproduced or utilized otherwise in specified,any form noor partby anyof this means, publication electronic may or mechanical, including photocopy, or posting on the internet or intranet, without prior permission. Permission can be requested from either ISO at the address below or ISO’s member body in the country of the requester: © ISO 2015, Published in Switzerland Case postale 56 • CH-1211 Geneva 20 Tel.ISO copyright+41 22
    [Show full text]
  • Haris Kurtagic, SL-King Jason Birch, City of Nanaimo Geoff Zeiss, Autodesk Tim Berners-Lee, in Government Data Design Issues, Proposes
    Haris Kurtagic, SL-King Jason Birch, City of Nanaimo Geoff Zeiss, Autodesk Tim Berners-Lee, in Government Data Design Issues, proposes ○ Geodata on the web in raw form. ○ Raw geodata must be searchable How do you find raw geospatial data ? Data Catalogs Wouldn’t it be nice if… And see.. Searchable Raw Geospatial Data www.georest.org Open Data Protocol “The Open Data Protocol (OData) is a Web protocol for querying and updating data that provides a way to unlock your data and free it from silos that exist in applications today.” www.odata.org ODATA HTTP Atom AtomPUB JSON HTTP://.../vancouver/libraries <feed xmlns=http://www.w3.org/2005/Atom … > <title type="text">libraries</title> <id>http://…/vancouver/libraries(10)</id> <title type="text"></title> <entry> <content type="application/xml"> <m:properties> <d:library_name>Britannia</d:library_name> <d:latitude m:type="Edm.Double">49.2756486</d:latitude> <d:longitude m:type="Edm.Double">-123.0737717</d:longitude> <d:address>1661 Napier St</d:address> </m:properties> …..</entry> <entry>…</entry></feed> HTTP://.../vancouver/libraries ?$format=JSON {"d":[{"library_name":"Britannia","latitude":" 49.2756486","longitude":"- 123.0737717","address":"1661 Napier St"} , {..}] } HTTP Header accept: application/json OData Example Live OData Service from Vancouver OData Producers SharePoint 2010, SQL Azure, IBM WebSphere, … GeoREST OData Live Services Netflix, Open Goverment Data Initiative (OGDI), Stack Overflow, Vancouver, Edmonton, … City of Nanaimo OData Consumers Browsers, Odata Explorer, Excel 2010,…
    [Show full text]
  • SAP Analytics Cloud, Analytics Designer Developer Handbook
    SAP Analytics Cloud, analytics designer Developer Handbook Document Version: 5.1 – 2020-04-06 Table of Contents 1 Table of Contents Table of Contents ......................................................................................................................... 1 Figures .......................................................................................................................................... 7 1 About Analytics Designer .............................................................................................10 1.1 What Is an Analytic Application? .....................................................................................10 1.2 What Is Analytics Designer? ............................................................................................10 1.3 What Can You Do with Analytic Applications That You Can’t Do with Stories? ..............10 1.4 How Are Stories and Analytic Applications Related to Each Other? ...............................10 1.5 Why Do We Need Both Stories and Analytic Applications? ............................................11 1.6 What Is the Typical Workflow in Creating an Analytic Application? .................................11 1.7 What Are Typical Analytic Applications? .........................................................................12 1.8 How Does Scripting Work in Analytic Applications? ........................................................12 1.9 What’s the Scripting Language for Analytic Applications? ..............................................13 2 Getting
    [Show full text]
  • Catalogue Open Data Protocol (Odata API) User Guide
    Catalogue Open Data Protocol (OData API) User Guide Content 1. Introduction .......................................................................................................................................... 3 1.1. Purpose......................................................................................................................... 3 1.2. Change register ............................................................................................................. 3 1.3. Structure of the document ............................................................................................. 3 1.4. Acronyms ...................................................................................................................... 4 1.5. Reference Documents ................................................................................................... 4 2. Open Data Protocol overview ............................................................................................................. 6 2.1. Entity Data Model concept ............................................................................................ 6 Entity Type ..................................................................................................................... 7 Entity Set ....................................................................................................................... 7 3. ONDA OData Entity Data Model ......................................................................................................... 8 3.1. ONDA Entity
    [Show full text]
  • Deliverable D7.5: Standards and Methodologies Big Data Guidance
    Project acronym: BYTE Project title: Big data roadmap and cross-disciplinarY community for addressing socieTal Externalities Grant number: 619551 Programme: Seventh Framework Programme for ICT Objective: ICT-2013.4.2 Scalable data analytics Contract type: Co-ordination and Support Action Start date of project: 01 March 2014 Duration: 36 months Website: www.byte-project.eu Deliverable D7.5: Standards and methodologies big data guidance Author(s): Jarl Magnusson, DNV GL AS Erik Stensrud, DNV GL AS Tore Hartvigsen, DNV GL AS Lorenzo Bigagli, National Research Council of Italy Dissemination level: Public Deliverable type: Final Version: 1.1 Submission date: 26 July 2017 Table of Contents Preface ......................................................................................................................................... 3 Task 7.5 Description ............................................................................................................... 3 Executive summary ..................................................................................................................... 4 1 Introduction ......................................................................................................................... 5 2 Big Data Standards Organizations ...................................................................................... 6 3 Big Data Standards ............................................................................................................. 8 4 Big Data Quality Standards .............................................................................................
    [Show full text]
  • Blackbaud CRM Query and Export Guide
    Query and Export Guide 03/23/2016 Blackbaud CRM 4.0 Query and Export US ©2016 Blackbaud, Inc. This publication, or any part thereof, may not be reproduced or transmitted in any form or by any means, electronic, or mechanical, including photocopying, recording, storage in an information retrieval system, or otherwise, without the prior written permission of Blackbaud, Inc. The information in this manual has been carefully checked and is believed to be accurate. Blackbaud, Inc., assumes no responsibility for any inaccuracies, errors, or omissions in this manual. In no event will Blackbaud, Inc., be liable for direct, indirect, special, incidental, or consequential damages resulting from any defect or omission in this manual, even if advised of the possibility of damages. In the interest of continuing product development, Blackbaud, Inc., reserves the right to make improvements in this manual and the products it describes at any time, without notice or obligation. All Blackbaud product names appearing herein are trademarks or registered trademarks of Blackbaud, Inc. All other products and company names mentioned herein are trademarks of their respective holder. QueryExport-2016 Contents Getting Started with Query 4 Query: A Guided Tour 4 Common Query Fields 20 Common Query Filters 22 Query 25 Information Library 27 Ad-Hoc Queries 27 Smart Queries 58 Selections 71 Copy an Existing Query 74 Export Queries 74 Browse Query Results 75 View Query Results 75 Organize Queries 75 Open Data Protocol (OData) 79 Export 82 Exports 82 Export Definitions 86 Export Process Status Page 100 Import Selections 106 Import Selections 106 Import Selection Process Status Page 110 chapter 1 Getting Started with Query Query: A Guided Tour 4 Common Query Fields 20 Constituent Query Fields 20 Revenue Query Fields 21 Registrant Query Fields 22 Common Query Filters 22 Constituent Query Filters 22 Revenue Query Filters 23 Registrant Query Filters 23 Query is a powerful tool you can use to help filter and group records.
    [Show full text]
  • Denodo Odata 2.0 Service User Manual
    Denodo OData 2.0 Service User Manual Revision 20200508 NOTE This document is confidential and proprietary of Denodo Technologies. No part of this document may be reproduced in any form by any means without prior written authorization of Denodo Technologies. Copyright © 2021 Denodo Technologies Proprietary and Confidential Denodo OData 2.0 Service User Manual 20200508 2 of 34 CONTENTS 1 OVERVIEW........................................................................5 2 INSTALLATION..................................................................6 2.1 DEPLOYING INTO THE DENODO EMBEDDED WEB CONTAINER............8 2.2 CONFIGURING JNDI RESOURCES IN APACHE TOMCAT......................10 3 VIRTUAL DATAPORT PRIVILEGE REQUIREMENTS.................12 4 FEATURES.......................................................................13 5 SERVING METADATA........................................................14 6 QUERYING DATA: THE BASICS..........................................16 6.1 QUERYING COLLECTIONS..............................................................16 6.2 OBTAINING ITEMS BY PRIMARY KEY..............................................16 6.3 ACCESSING INDIVIDUAL PROPERTIES............................................16 6.4 ACCESSING INDIVIDUAL PROPERTY VALUES...................................17 6.5 ACCESSING COMPLEX PROPERTIES...............................................17 6.6 COUNTING ELEMENTS IN A COLLECTION: $COUNT..........................18 6.7 ESTABLISHING RESPONSE FORMAT...............................................18 7 NAVIGATING
    [Show full text]
  • Information Technology — Open Data Protocol (Odata) V4.0
    BS ISO/IEC 20802-2:2016 BSI Standards Publication Information technology — Open data protocol (OData) v4.0 Part 2: OData JSON Format WB11885_BSI_StandardCovs_2013_AW.indd 1 15/05/2013 15:06 BS ISO/IEC 20802-2:2016 BRITISH STANDARD National foreword This British Standard is the UK implementation of ISO/IEC 20802-2:2016. The UK participation in its preparation was entrusted to Technical Committee ICT/-/1, Information systems co-ordination. A list of organizations represented on this committee can be obtained on request to its secretary. This publication does not purport to include all the necessary provisions of a contract. Users are responsible for its correct application. © The British Standards Institution 2017. Published by BSI Standards Limited 2017 ISBN 978 0 580 90961 0 ICS 35.100.70 Compliance with a British Standard cannot confer immunity from legal obligations. This British Standard was published under the authority of the Standards Policy and Strategy Committee on 31 March 2017. Amendments/corrigenda issued since publication Date Text affected BS ISO/IEC 20802-2:2016 INTERNATIONAL ISO/IEC STANDARD 20802-2 First edition 2016-12-15 Information technology — Open data protocol (OData) v4.0 Part 2: OData JSON Format Technologies de l'information — Protocole de données ouvertes (OData) v4.0 — Partie 2: Format OData JSON Reference number ISO/IEC 20802-2:2016(E) © ISO/IEC 2016 BS ISO/IEC 20802-2:2016 ISO/IEC 20802-2:2016(E) COPYRIGHT PROTECTED DOCUMENT © ISO/IEC 2016 All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission.
    [Show full text]
  • Supplement for Adapters DP Bridge, Hive, HTTP, JDBC, JMS, Mongodb, Odata, Salesforce.Com, Shapefile, and Successfactors Company
    PUBLIC SAP Data Services Document Version: 4.2 Support Package 12 (14.2.12.0) – 2020-02-06 Supplement for Adapters DP Bridge, Hive, HTTP, JDBC, JMS, MongoDB, OData, Salesforce.com, Shapefile, and SuccessFactors company. All rights reserved. All rights company. affiliate THE BEST RUN 2020 SAP SE or an SAP SE or an SAP SAP 2020 © Content 1 Naming Conventions......................................................... 5 2 Data Services adapters....................................................... 9 2.1 Adapter required knowledge and expertise...........................................11 3 Adapter installation and configuration...........................................12 3.1 Adding an adapter instance.....................................................13 3.2 Adapter Configuration options ...................................................14 JDBC adapter-specific configuration settings......................................19 DP Bridge runtime configuration options.........................................23 HTTP adapter specific configuration settings......................................24 JMS adapter-specific configuration settings.......................................25 3.3 Starting and stopping the adapter instance..........................................27 3.4 Monitoring the adapter instances and operations..................................... 28 3.5 Viewing adapter instance statistics................................................29 4 Creating an adapter datastore................................................. 31 5 Adapter datastore
    [Show full text]
  • Introducing Odata Data Access for the Web, the Cloud, Mobile Devices, and More
    David Chappell May 2011 INTRODUCING ODATA DATA ACCESS FOR THE WEB, THE CLOUD, MOBILE DEVICES, AND MORE Sponsored by Microsoft Corporation Copyright © 2011 Chappell & Associates Contents Describing OData ................................................................................................................................................ 3 The Problem: Accessing Diverse Data in a Common Way ......................................................................................3 The Solution: What OData Provides .......................................................................................................................3 How OData Works: Technology Basics ...................................................................................................................5 Using OData: Example Scenarios ......................................................................................................................... 6 Accessing Application Data from Mobile Phones and Web Browsers ....................................................................6 Exposing Data from a Cloud Application ................................................................................................................8 Using Diverse Data Sources with Different BI Tools ...............................................................................................9 Examining OData: A Closer Look at the Technology and Its Implementation .................................................... 10 The OData Data Model .........................................................................................................................................10
    [Show full text]