Installing and Using Talisma Iservices

Talisma 8.
5 iServices
Installation and Usage Guide

TAL-ISE-UG-0850
2009 Talisma Corporation. All rights reserved. This documentation, as well as the software described in it, is furnished under license and may only be used or copied in accordance with the terms of such license. The works of authorship contained in this document, including but not limited to all design, text, and images, and the software described herein, are owned, except as otherwise expressly stated, by Talisma Corporation or its licensors. The entire contents of this document are protected by United States and worldwide copyright laws and treaty provisions. In accordance with these terms, except as stated above, you may not copy, reproduce, modify, use, republish, upload, post, transmit, or distribute in any way material from the document. Talisma Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this documentation. Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, or any media whether electronic, mechanical, recording, or otherwise, without the prior written permission of Talisma Corporation and its licensors. The information in this documentation is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Talisma Corporation and its licensors. Trademarks: Microsoft SQL Server, Microsoft SQL Server Analysis Services, Microsoft Access, Microsoft Exchange, Microsoft Outlook, Microsoft Outlook Express, Microsoft Internet Explorer, Microsoft Word, Microsoft Excel, Windows Vista, Windows XP, Windows 2003, Windows Server 2003 R2, and Windows, are registered trademarks of Microsoft Corporation. DemoShield is a registered trademark of InstallShield Software Corporation. Talisma is a registered trademark of Talisma Corporation. All other brand and product names are trademarks or registered trademarks of their respective owners. Any and all artwork or images are protected by copyright, and the unauthorized incorporation of the same in any new image or any copying of the same in any media or by any means is a violation of the rights of the author and may not be carried out without the prior permission of such author. Copyright 1999 - 2009 Talisma Corporation. All rights reserved worldwide. Version Date: August, 2009.
Campus Management Corporation Boca Raton, Florida 777 Yamato Road Boca Raton, FL 33431 USA
Phone: (561) 923-2500 Visit our Web site at www.talisma.com
August 2009
Preface
Preface
Overview of Talisma
Talisma provides true Customer Lifecycle Management across sales, service, and marketing functions, and enables organizations to quickly, effectively, and accurately communicate with customers at any time. With Talisma, organizations have the means to accelerate and sustain growth by creating personalized experiences. Talisma offers a unified customer view through blended multi-channel support. Numerous productivity tools are available that increase response quality through automated functions, knowledge-enhanced solutions, and an organized, single window view. Management gains access to both in-depth tactical dashboards and big-picture strategic reports, driving consistent improvements. Vertical solutions give customers a choice of channels, allowing instant communication whenever and however they prefer. Talisma scales to meet the needs of large and small businesses with diverse customer bases, and reliably withstands stringent service level agreements (SLAs). Businesses gain real control, as Talisma measures, monitors, and forecasts critical information.
About Talisma iServices

Talisma enables you to create an integrated suite of applications using the Talisma iServices methods. Talisma iServices enable you to integrate Talisma with any Web-based application.Talisma iServices use Extensible Markup Language (XML) for communication between Talisma and the external application.
About This Guide

The Installing and Using Talisma iServices Guide provides detailed information about Installing Talisma iServices.
Who Should Read This Guide

The Talisma iServices Installation Guide is written for administrators who are responsible for installing Talisma iServices.
Installing and Using Talisma 8.5 iServices
Contacting Talisma for Technical Support

If you need additional information, you can reach us at our support Web site, by telephone, or through email. The following support is available to you: Self service tools including online chat with a support engineer on our support site at http://support.talisma.com E-mail support at support@talisma.com. Phone: Talk to a support engineer USA: 1-866-899-8534 from 6 A.M. to 7 P.M. PST, Monday through Friday, excluding public holidays. APAC: 91-80-2361-1932 or 91-80-2361-3728 from 6 A.M. to 8:30 P.M. IST, Monday through Friday excluding public holidays. Mainland Europe: +44 870 904 1121 from 6 A.M. to 6 P.M. GMT, Monday through Friday, excluding public holidays. UK: 0870 904 1121 from 6 A.M. to 6 P.M. GMT, Monday through Friday, excluding public holidays.
Consultancy and Outsourced services are available

If you do not have the required resources, or need support of any kind, you may purchase our consulting and outsourced services. Please contact us at:
Campus Management Corporation Boca Raton, Florida 777 Yamato Road Boca Raton, FL 33431 USA Phone: (561) 923-2500
Please visit our Web site at http://support.talisma.com Talisma Corporation reserves the rights to update the support policies with 30 days notice. Thank you for using Talisma. We welcome your comments and suggestions to help us improve our product documentation. Please send e-mail to support@talisma.com.
ii
Contents
Contents
Chapter 1: Whats New in Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Chapter 2: Installing Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Minimum System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Environments Tested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Installing Talisma 8.5 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Installing Talisma 8.5 Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Installing Microsoft WSE 3.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Obtaining Talisma iServices Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Setting Up Talisma 8.5 iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Reinstalling Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Adding a Talisma iService to the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Upgrading your Installation of Talisma iServices. . . . . . . . . . . . . . . . . . . . . . . . . . 28 Uninstalling a Talisma iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Uninstalling Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Publishing Talisma iServices Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 3: Talisma iServices - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

About Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Communication Between iServices and Talisma . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Talisma iServices Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Guidelines for Using Talisma iService Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Chapter 4: Integration Using Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Integrating your Application Using Talisma iServices . . . . . . . . . . . . . . . . . . . . . . 42 General Prerequisites for All Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Prerequisites for VB.NET and C# Using Visual Studio 2005 . . . . . . . . . . . . . . . . 43 Steps to Integrate Talisma iServices Using VB.NET or C# . . . . . . . . . . . . . . . . . . 43 Prerequisites for using Talisma iServices Methods in an ASP Page . . . . . . . . . . . 46 Steps to Integrate Talisma iServices Using ASP . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Sample Code for Creating a Contact Using VB.Net. . . . . . . . . . . . . . . . . . . . . . . . 47 Sample Code for Creating an Interaction Using C# . . . . . . . . . . . . . . . . . . . . . . . . 48 Sample Code for Creating a Contact Using ASP . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Troubleshooting Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 5: Talisma Contact iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 GetRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
iii
GetAttachmentTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 GetCommentsTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 DeleteContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 UpdateCommentsTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 GetPropertiesTab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 CreateContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 GetLinkedTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 UpdatePropertyTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 UpdateRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 UpdateAttachmentTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Chapter 6: Talisma Account iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 DeleteAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 GetRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 GetAttachmentTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 GetCommentsTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 UpdateCommentsTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 GetPropertiesTab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 CreateAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 GetLinkedTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 UpdatePropertyTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 UpdateRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 UpdateAttachmentTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Chapter 7: Talisma Interaction iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 GetPropertiesTab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 GetRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 GetLinkedTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 GetInteractionEvents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 UpdatePropertyTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 UpdateRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 CreateInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 DeleteInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 AddMsgToInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 AddCommentsToInteraction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 DeleteInteractions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 AddAttachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 GetAllInteractionEvents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 GetInteractionEvents2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 GetMessageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 GetAllMessageContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 SetInteractionPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 SetInteractionState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
iv
Contents
Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 GetAttachmentFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 GetAssignToUserList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 GetTransferToList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 GetInteractionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 BeginReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 SaveReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 UpdateInteractionReadUnReadStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 SaveInteractionTrackingInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 UnLockInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 BuildForwardOrConsult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 BuildReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 CancelReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 DeleteReply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 BuildSmsReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Chapter 8: Talisma Reports iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 GetReportsForUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 GetReportForReportId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 CheckReportPermisssionForUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Chapter 9: Talisma COF iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 GetRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 GetAttachmentTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 GetCommentsTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 UpdateCommentsTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 GetPropertiesTab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 UpdateAttachmentTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 DeleteObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 GetLinkedTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 UpdatePropertyTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 UpdateRLTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 CreateObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Chapter 10:Talisma Higher Ed Foundation iService. . . . . . . . . . . . . . . . . . . . . . . . 271

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 CreateInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 UpdateInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 DeleteInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 GetInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294 GetInstances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 GetNextPendingMessages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
AddEnumValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310 UpdateEnumValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 DeleteEnumValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 AddAssociation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319 UpdateAssociation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323 DeleteAssociation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 GetAssociationData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 GetEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331 TestCRMConnectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333 ReturnStatus Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Chapter 11:Talisma Portal iService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336 GetPageSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 GetPortalGlobalLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 GetPortalTabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344 GetPortalTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346 GetPortalTemplateIdentifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 GetPortalTemplateObjectData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 GetPortalWebPartsForTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351 GetRelationShipInstanceIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 SetPageSetting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 UpdatePortalData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 InitializeEventForRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361 RegisterParticipantToEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365 SetStateToRegisterForEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369 CancelParticipant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Chapter 12:Querying Talisma Main Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Querying Talisma Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Chapter 13:Error Codes and Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

Error Codes Applicable to all Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . 380 Error Codes Applicable to Talisma Contact iService . . . . . . . . . . . . . . . . . . . . . . 383 Error Codes Applicable to Talisma Account iService . . . . . . . . . . . . . . . . . . . . . 384 Error Codes Applicable to Talisma Interaction iService . . . . . . . . . . . . . . . . . . . 385 Error Codes Applicable to Talisma COF iService . . . . . . . . . . . . . . . . . . . . . . . . 390 Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
vi
Whats New in Talisma iServices
Chapter 1:Whats New in Talisma iServices

This chapter introduces you to the new iServices in Talisma 8.5.
In this chapter
Talisma Higher Ed Foundation iService................................... Page 2
Whats New in This Release
Documentation Conventions The following conventions are used in this chapter: indicates a new feature. indicates an enhancement.
Talisma Higher Ed Foundation iService

Talisma can now be integrated with an external Student Information System (SIS) using an SIS Connector component that achieves this integration. The SIS Connector is an external component that enables communication between API methods of Talisma CRM, and the SIS. For more information about the SIS Connector, see the SIS Connector documentation. Talisma Higher Ed Foundation iService consists of APIs that enable the SIS to send data to, and retrieve data from Talisma CRM through the SIS Connector. Talisma Higher Ed Foundation iService methods communicate with Talisma Main Database using the following message queues: Incoming Queue - Contains information sent by the SIS to Talisma Main Database. Information is received in Talisma in XML format. Outgoing Queue - Contains information sent by Talisma to the SIS. Information is sent in XML format.
The following diagram illustrates the high-level design of how an SIS interacts with Talisma:
Figure 1
High Level Design of Talisma - SIS Interaction
In the high-level design of Talisma Higher Ed Foundation iService, the entry point for the SIS into Talisma is through the Application Server. Talisma Application Server exposes Talisma Higher Ed Foundation iService as a Web Service through which the SIS interacts with Talisma. Thus, the Talisma Higher Ed Foundation iService supports the real-time integration of key reference data, account data and student operational data elements between Talisma CRM and the SIS.
2
Whats New in Talisma iServices
The SIS connects to Talisma, and communicates with the Talisma system using the following Talisma Higher Ed Foundation iService methods: CreateInstance UpdateInstance DeleteInstance GetInstance GetInstances GetNextPendingMessages AddEnumValue UpdateEnumValue DeleteEnumValue AddAssociation UpdateAssociation DeleteAssociation GetAssociationData GetEnum TestCRMConnectivity
Whats New in This Release
Installing Talisma iServices
Chapter 2:Installing Talisma iServices

This chapter describes the procedure to install Talisma iServices, and manage your installation.
In this chapter
Introduction............................................................................... Minimum System Requirements .............................................. Prerequisites.............................................................................. Setting Up Talisma 8.5 iServices.............................................. Reinstalling Talisma iServices.................................................. Adding a Talisma iService to the Installation........................... Upgrading your Installation of Talisma iServices .................... Uninstalling a Talisma iService ................................................ Uninstalling Talisma iServices ................................................. Publishing Talisma iServices Help ........................................... Page 6 Page 6 Page 10 Page 11 Page 19 Page 22 Page 28 Page 29 Page 31 Page 33
Introduction
Talisma enables the creation of an integrated suite of applications using Extensible Markup Language (XML), which is the universal format for structured data designed for ease of implementation. Talisma iServices enable you to integrate Talisma with any external application. As XML enables flexible format and data sharing, even if external applications are running on different operating systems and heterogeneous technologies, the applications may be integrated with ease, thus reducing platform dependency. In the high-level design of Talisma iServices, the entry point for an external application into Talisma is through the Application Server. Talisma Application Server exposes Talisma iServices as a Web Service through which an external application interacts with Talisma. An external application interacts with Talisma by sending its requests to Talisma iServices. The Web Service Definition Language (WSDL) Interface acts as an interface between the external application and Talisma iServices. Talisma iServices such as Talisma Contact iService, Talisma Account iService, Talisma Interaction iService, Talisma Utils iService, Talisma Reports iService, Talisma Portal iService, Talisma Custom Object Framework (COF) iServic, and Talisma Higher Ed Foundation iService understand the request and send it to the appropriate Object in Talisma Application Server. Talisma Application Server understands the request from Talisma iServices. Talisma Application Server sends a response to the external application through the relevant Talisma iService.
Minimum System Requirements

This section lists the hardware and software required for installing Talisma 8.5 iServices.
Hardware Requirements
The following table describes the Hardware requirements for installing Talisma 8.5 iServices:
Component Talisma 8.5 Server Minimum Requirements Talisma 8.5 Application Server and Talisma 8.5 iServices Pentium IV Processor. 1 GB RAM. 500 MB available hard disk space. Pentium IV Processor. 1 GB RAM. 30 MB available hard disk space.
Note
To determine the hardware sizing for your deployment, please contact Talisma Professional Services.
Software Requirements
The following table describes the software requirements for Talisma 8.5 iServices:
Component Talisma 8.5 Server Minimum Requirements One of the following operating systems: Microsoft Windows Server 2003 with SP2, and Microsoft SQL Server 2005 with SP2. Microsoft Windows R2 Server 2003 with SP2, and Microsoft SQL Server 2005 with SP2.
Microsoft Internet Explorer (IE) 6.0 with SP1. Microsoft Management Console (MMC) 1.1. Microsoft Excel 2000. Microsoft Data Access Component (MDAC) 2.8 SP2. For SQL Server 2005 SP2, the Standard, and Enterprise editions are supported. To install Microsoft SQL Server 2005 with SP2, click http://support.microsoft.com/kb/913089/, and install the software from the How to obtain the latest service pack for SQL Server 2005 page. One of the following operating systems: Microsoft Windows Server 2003 with SP2. Microsoft Windows Server 2003 R2 with SP2.
Note
Talisma 8.5 Application Server
Talisma 8.5 iServices Setup
Microsoft .NET Framework 2.0 SDK must be applied on this server. Microsoft Data Access Components (MDAC) 2.8 SP2. Microsoft Distributed Transaction Coordinator Service. For Internet Connections: Microsoft IIS Server 6.0 on a Windows 2003 Server computer. Microsoft Windows Server 2003 with SP2. Microsoft Windows Server 2003 R2 with SP2. One of the following operating systems:
Microsoft .NET Framework 2.0. Microsoft .NET Framework 2.0 SDK must be applied on this server. Microsoft Data Access Components (MDAC) 2.8 SP2. Microsoft Distributed Transaction Coordinator Service. For Internet Connections: Microsoft IIS Server 6.0 on a Windows 2003 Server computer. Microsoft Web Service Enhancement (WSE) 3.0.
Environments Tested
The following table describes the environments on which Talisma 8.5 iServices have been tested successfully.
Talisma Component Talisma Server Tested On Talisma 8.5 Application Server Microsoft Windows Server 2003 Standard or Enterprise with SP2, and Microsoft SQL Server 2005 with SP2, and SP3. Microsoft Windows R2 Server 2003 with SP2, and Microsoft SQL Server 2005 with SP2, and SP3. Microsoft Windows Server 2008 Standard or Enterprise (32-bit), and Microsoft SQL Server 2008 Standard or Enterprise (32-bit). Microsoft Windows Server 2008 Standard or Enterprise (64-bit), and Microsoft SQL Server 2008 Standard or Enterprise (64-bit). Microsoft Data Access Component (MDAC) 2.8 SP2 for Microsoft Windows Server 2003. VMware Workstation 6.0.1. For SQL Server 2005 SP2, and SP3, the Standard, and Enterprise editions are supported. Talisma Server has also been tested in an Active-Passive cluster environment. Microsoft Windows 2003 Server Standard or Enterprise with SP2. Microsoft Windows R2 Server 2003 with SP2. Microsoft Windows Server 2008 Standard or Enterprise (32-bit). Microsoft Windows Server 2008 Standard or Enterprise (64-bit). Microsoft Data Access Component (MDAC) 2.8 SP2 for Windows Server 2003. Microsoft .NET Framework 2.0 SDK (32-bit) for Windows Server 2003, and Windows Server 2008 (32-bit). Microsoft .NET Framework 2.0 SDK (64-bit) for Windows Server 2003, and Windows Server 2008 (64-bit).
Note
Note Talisma Application Server has been tested in a Network Load Balancing Services (NLBS) environment.
Talisma Component Talisma iServices
Tested On Microsoft Windows 2003 Server Standard or Enterprise with SP2. Microsoft Windows 2003 Server 2003 R2 with SP2. Microsoft Windows Server 2008 Standard or Enterprise (32-bit). Microsoft Windows Server 2008 Standard or Enterprise (64-bit). Microsoft Data Access Component (MDAC) 2.8 SP2 for Windows Server 2003. Microsoft .NET Framework 2.0 (32-bit) for Windows Server 2003, and 2008 (32-bit). Microsoft .NET Framework 2.0 (64-bit) for Windows Server 2003, and 2008 (64-bit). Microsoft Web Service Enhancement (WSE) 3.0.
Prerequisites
The prerequisites for installing Talisma iServices are: Talisma 8.5 Server must be installed. Talisma 8.5 Application Server must be installed. Microsoft Web Service Enhancement 3.0 (WSE 3.0) must be installed on the computer on which Talisma iServices will be installed. You must obtain the following Talisma iServices licenses: Talisma iService - Service: for installing and using Talisma Contact, Account, Interaction, Utils, Reports, and Portal iServices. Talisma iService - COF: for installing and using Talisma COF iService.
Note
Talisma 8.5 Application Server, Microsoft WSE 3.0, and Talisma iServices must be installed on the same computer.
Installing Talisma 8.5 Server

For more information about installing Talisma 8.5 Server, see the Talisma Installation and Deployment Guide.
Installing Talisma 8.5 Application Server

For more information about installing Talisma 8.5 Application Server, see the Talisma Installation and Deployment Guide.
Installing Microsoft WSE 3.0

On the computer where you want to install Talisma iServices, you must install WSE 3.0. To do so: 1. Copy Microsoft WSE 3.0.msi from the WSE 3.0 folder of the Prerequisites Disc in the Talisma Installation Kit to a local folder on your computer. 2. Run Microsoft WSE 3.0.msi.
Obtaining Talisma iServices Licenses

For information about Talisma iServices licenses, contact Talisma Professional Services.
10
Setting Up Talisma 8.5 iServices

This section describes the procedure to install Talisma iServices. 1. Insert Disc2 of the Talisma Installation Kit into the CD-ROM drive. 2. If Autorun is enabled on the computer, the Talisma title screen is displayed. Click Install Talisma iServices. - OR If Autorun is not enabled, browse to the iServices folder on Disc2 of the Talisma Installation Kit, and double click setup.exe. The Welcome page is displayed.
Figure 1 3. Click Next.
The Welcome Page
11
The Customer Information page is displayed.
Figure 2
The Customer Information Page
4. In the User Name field, type your name. In the Company Name field, type the name of your organization. 5. Click Next.
12
The Components page is displayed.
Figure 3
Selecting the Required Talisma iServices for Installation
6. Select the Talisma iService(s) you want to install by clicking the relevant check box(es). -ORClick Select All to select all the Talisma iServices for the installation. Select Clear All to clear the selection. 7. Click Next.
13
The Talisma Database Connection Details page is displayed.
Figure 4
Specifying the Database Connection Details
8. In the Login Name and Password fields, type the login name and password for the Talisma Administrator User. The Application Server field displays the name of the computer on which you are installing Talisma iService to indicate that Talisma Application Server is installed on the computer. This field is disabled. 9. In the Database Server field, type the name of the server computer where SQL Server and Talisma Main Database are installed. 10. In the Database field, type the name of Talisma Main Database. If you select Trusted Security, your Windows user account will be used for authentication.
14
11. Click Next. The Destination Folder page is displayed.
Figure 5
Selecting the Installation Folder for Talisma iServices
12. In the Destination Folder area, specify the location where the selected Talisma iServices must be installed. By default, Talisma iServices are installed in the C:\Program Files\Talisma iServices path. Click Browse to select a different path.
15
13. Click Next. The Talisma iServices Virtual Root page is displayed.
Figure 6
Selecting a Virtual Root
14. Select a virtual root name for each of the Talisma iServices. 15. Click OK. Talisma 8.5 iServices Setup begins to copy all the necessary files.
Figure 7
Copying Files
16
After all the files are copied, the following message box is displayed to indicate that the selected Talisma iServices are successfully installed on your computer.
Click OK.
Note
If the system drive partition is NTFS, ensure that you have Read and Write permissions for the acb1a1639b2309d5e44384b51afe8801_455a36f9-3c1a-4013a10ba8fa6a38a96b file. This file is located in the path <system drive>:\Documents & Settings\AllUsers\Application Data\Microsoft\Crypto\RSA\MachineKeys. The Talisma Setup Complete page is displayed.
Figure 8
Talisma iServices Setup Complete
17
16. The Yes, I want to restart my computer now option is selected by default. Click Finish to restart your computer. - OR Select No, I will restart my computer later option. Click Finish to close the installation wizard.
Note
You must restart your computer for the changes to take effect.
18
Reinstalling Talisma iServices

This section describes the procedure to reinstall a Talisma iService. 1. On the computer where you want to reinstall a Talisma iService, double click setup.exe from the iServices folder available in Disc2 of the Talisma Installation Kit. Talisma 8.5 iServices Setup checks whether any Talisma iService is installed on the computer. The Add/Remove/Reinstall page is displayed.
Figure 9
The Add/Remove/Reinstall Page
2. Click Reinstall.
19
The Reinstall Talisma iServices page is displayed.
Figure 10 Selecting the Talisma iService(s) to Reinstall The Reinstall Talisma iServices page lists all the Talisma iServices installed on your computer. 3. Select the Talisma iService you want to reinstall. 4. Click OK. Talisma 8.5 iServices Setup begins to copy the necessary files. After all the files are copied, the following message box is displayed to indicate that the selected Talisma iService has been successfully reinstalled.
5. Click OK.
Note
If the system drive partition is NTFS, ensure that you have Read and Write permissions for the acb1a1639b2309d5e44384b51afe8801_455a36f9-3c1a-4013a10ba8fa6a38a96b file. This file is located in the path <system drive>:\Documents & Settings\AllUsers\Application Data\Microsoft\Crypto\RSA\MachineKeys.
20
6. The Talisma Setup Complete page is displayed.
Figure 11 Talisma Setup Complete Page 7. The Yes, I want to restart my computer now option is selected by default. Click Finish to restart your computer. - OR Select No, I will restart my computer later option. Click Finish to close the installation wizard.
Note
You must restart your computer for the changes to take effect. 8. Repeat steps 1 through 7 of this procedure for each Talisma iService that you want to reinstall.
21
Adding a Talisma iService to the Installation

This section describes the procedure to add a Talisma iService installation on a computer where you have already installed at least one Talisma iService. 1. On the computer where at least one Talisma iService is installed, double click setup.exe from the iServices folder available on Disc2 of the Talisma Installation Kit. Talisma 8.5 iServices Setup checks whether any Talisma iService is installed on the computer. The Add/Remove/Reinstall page is displayed.
Figure 12 The Add/Remove/Reinstall Page 2. Click Add iService.
22
The Components page is displayed.
Figure 13 Selecting the Required Talisma iServices for Installation 3. Select the Talisma iService(s) you want to install by clicking the relevant check box(es). - OR Click Select All to select all the Talisma iServices for the installation. Select Clear All to clear the selection. 4. Click Next.
23
The Talisma Database Connection Details page is displayed.
Figure 14 Specifying the Database Connection Details 5. In the Login Name and Password fields, type the login name and password for the Talisma Administrator User. The Application Server field displays the name of the computer on which you are installing the selected Talisma iService(s) to indicate that the Talisma Application Server is installed on the computer. This field is disabled. 6. In the Database Server field, type the name of the server where SQL Server and Talisma Main Database are installed. 7. In the Database field, type the name of Talisma Main Database. If you select Trusted Security, your Windows user account will be used for authentication.
24
8. Click Next. The Destination Folder page is displayed.
Figure 15 Selecting a Folder for the Selected iService Installation 9. In the Destination Folder area, specify the location where the selected Talisma iService must be installed. By default, Talisma iServices are installed in the C:\Program Files\Talisma iServices path. Click Browse to select a different path.
25
10. Click Next. The Talisma iServices Virtual Root page is displayed.
Figure 16 Specifying a Virtual Root 11. Select a virtual root name for each of the Talisma iService(s). 12. Click OK. Talisma 8.5 iServices Setup begins to copy all the necessary files.
Figure 17 Copying Files
26
After all the files are copied, the following message box is displayed to indicate that the selected Talisma iService(s) are successfully installed on your computer.
13. Click OK. The Talisma Setup Complete page is displayed.
Figure 18 Talisma Setup Complete 14. The Yes, I want to restart my computer now option is selected by default. Click Finish to restart your computer. - OR Select No, I will restart my computer later option. Click Finish to close the installation wizard.
Note
27
Upgrading your Installation of Talisma iServices

You can upgrade Talisma iServices 1.0 (Beta) to Talisma 8.5 iServices. Before you upgrade your installation to Talisma 8.5 iServices, you must ensure that Talisma 8.5 Application Server, and Microsoft WSE 3.0 are installed on your computer. To upgrade your installation to Talisma 8.5 iServices, follow these steps: 1. On the computer where you have installed Talisma iServices 1.0 (Beta), double click setup.exe from the iServices folder available on Disc2 of the Talisma Installation Kit. Talisma iServices Setup prompts you to confirm the upgrade operation. 2. Click OK. The existing Talisma iServices files, and the registry information are updated to the current version on your computer. 3. Double click setup.exe from the iServices folder available on Disc2 of the Talisma Installation Kit. Talisma 8.5 iServices Setup begins. 4. To install Talisma 8.5 iServices on your computer, follow the procedure described in the Setting Up Talisma 8.5 iServices on page 11.
Note
When you upgrade your iServices installation, the existing iServices are upgraded to version 8.5. You need to run the iServices setup again to install the new iServices, Portal iService and Reports iService.
28
Uninstalling a Talisma iService

This section describes the procedure to uninstall a Talisma iService from your computer. 1. On a computer where you want to uninstall a Talisma iService, double click setup.exe from the iServices folder available on Disc2 of the Talisma Installation Kit. Talisma 8.5 iServices Setup checks whether any Talisma iService is installed on the computer. The Add/Remove/Reinstall page is displayed.
Figure 19 The Add/Remove/Reinstall Page 2. Click Remove iService.
29
The Remove iService page is displayed.
Figure 20 Selecting the Talisma iService to Uninstall The Remove iService page lists all the Talisma iServices installed on your computer. 3. Select the Talisma iService you want to uninstall. 4. Click OK. Talisma 8.5 iServices Setup prompts you to confirm the deletion. 5. Click OK. The following message is displayed to indicate that the selected Talisma iService is successfully uninstalled.
6. Click OK. The Add/Remove/Reinstall page is displayed. 7. Click Exit to exit Talisma iServices Setup. - OR To uninstall another Talisma iService, follow steps 1 through 6 of this procedure. - OR To install a Talisma iService, follow the steps described in the Adding a Talisma iService to the Installation on page 22.
30
Uninstalling Talisma iServices

This section describes the procedure to uninstall Talisma iServices completely from your computer. 1. On the computer where you want to uninstall Talisma iServices, double click setup.exe from the iServices folder available on Disc2 of the Talisma Installation Kit. Talisma 8.5 iServices Setup checks whether any Talisma iService is installed on the computer. The Add/Remove/Reinstall page is displayed.
Figure 21 The Add/Remove/Reinstall Page 2. Click Remove All. Talisma 8.5 iServices setup prompts you to confirm whether all Talisma iServices must be uninstalled from your computer. 3. Click OK. Talisma 8.5 iServices Setup begins uninstalling Talisma iServices from your computer. The following message box is displayed to indicate that Talisma iServices have been successfully uninstalled from your computer.
Figure 22 Talisma iServices Uninstalled

31
4. Click OK. The Talisma Setup Complete page is displayed.
Figure 23 The Setup Complete Page 5. The Yes, I want to restart my computer now option is selected by default. Click Finish to restart your computer. - OR Select No, I will restart my computer later option. Click Finish to close the installation wizard.
Note
32
Publishing Talisma iServices Help

You can publish Talisma 8.5 iServices Help on a computer on which you have installed Internet Information Services (IIS). To publish Talisma 8.5 iServices Help: 1. Copy the Talisma iServices Help folder from Disc2 of the Talisma iServices Installation Kit to a computer on which IIS is installed. 2. Open IIS. 3. Right-click Default Web Site, and select New, Virtual Directory. The Virtual Directory Creation Wizard is displayed. 4. Click Next. 5. In the Alias field, type TalismaiServicesHelp. This Alias is used to access the Web virtual directory. 6. Click Next. The Web Site Content Directory page is displayed. 7. Click Browse. 8. Select the folder where you copied Talisma iServices Help. 9. Click Next. The Access Permissions page is displayed. By default, the Read and Run scripts (such as ASP) permissions are selected. 10. Click Next. A page indicating that the Virtual Directory Creation is complete is displayed. 11. Click Finish. The new Virtual Directory is created under the Default Web Site folder. Users can now access Talisma 8.5 iServices Help in a browser using the following address: http://<Computer on which you created the Virtual Directory>:<TCP Port for the Default Web Site>/<Alias specified for the Virtual Directory>/index.html
Example
You can use the following URL: http://talisma268:8080/TalismaiServicesHelp/index.html
33
34
Talisma iServices - Overview
Chapter 3:Talisma iServices - Overview

This chapter provides an overview of Talisma iServices.
In this chapter
About Talisma iServices ........................................................... Communication Between iServices and Talisma ..................... Talisma iServices Methods ....................................................... Guidelines for Using Talisma iService Methods ...................... Page 36 Page 37 Page 37 Page 38
35
About Talisma iServices

Talisma enables you to create an integrated suite of applications using the Talisma iService methods. Talisma iServices enable you to integrate Talisma with any Web-based application. For example, you can use Talisma iService methods to integrate your VB.NET, or ASP.NET Web-based application with Talisma. Talisma iServices use Extensible Markup Language (XML) for communication between Talisma and the external application. XML is the universal format for structured data designed for ease of implementation. As XML enables flexible format and data sharing, even if external applications are running on different operating systems and heterogeneous technologies, the applications may be integrated with ease, thus reducing platform dependency. For example, when you use a Talisma iService method to perform an operation in Talisma from your external application, the input is sent to Talisma, and the response is received from Talisma, through XML. This Guide describes the methods exposed by Talisma to enable you to integrate external applications with Talisma. In the high-level design of Talisma iServices, the entry point for an external application into Talisma is through the Application Server. Talisma Application Server exposes Talisma iServices as a Web Service through which an external application interacts with Talisma. The following diagram illustrates the high-level design of how Talisma iServices interact with Talisma:
Figure 1
High Level Design of Talisma iServices
36
Communication Between iServices and Talisma

An external application interacts with Talisma by sending its requests to Talisma iServices. The Web Service Definition Language (WSDL) Interface acts as an interface between the external application and Talisma iServices. Talisma iServices such as Talisma Contact iService, Talisma Account iService, Talisma Interaction iService, Talisma Utils iService, Talisma Reports iService, Talisma Portal iService, Talisma Custom Object Framework (COF) iService, and Talisma Higher Ed Foundation iService understand the request, and send it to Talisma Application Server. Talisma Application Server understands the request from Talisma iServices. If the request is valid, Talisma Application Server sends a response to the external application through the relevant Talisma iService. Talisma iServices allow an external application to create, update, delete, and get Talisma Application Server Object items such as Contacts, Accounts, Interactions, and custom Object items. Talisma iServices also enables an external application to retrieve Talisma Reports from Talisma Analytics Database, and retrieve Talisma Customer Portal Tabs, Templates, and other Portal specific items from Talisma Main Database. Talisma Higher Ed Foundation iService enables an external Student Information System (SIS) to send information to, and retrieve information from Talisma. Thus, the Talisma Higher Ed Foundation iService support the real-time integration of key reference data, account data and student operational data elements between Talisma CRM and an SIS.
Talisma iServices Methods

Talisma iServices consist of methods for Talisma Contact iService, Talisma Account iService, Talisma Interaction iService, and Talisma COF iService that enable external applications to interact with Talisma Application Server. The Talisma iService methods enable an external application to send data to, and retrieve data from Talisma. To invoke a Talisma iService method, you can use XML to send the input values to Talisma iService, or invoke the Talisma iService method directly using VB.NET, ASP.NET, C#, or any other application on which your external application is based. The Talisma iService method descriptions in this documentation provide detailed information about each method in Talisma iServices. All parameters for a method are mandatory.
Note
You can use a Talisma iService method to perform a task on a single Object item. For example, you can create only one Contact at a time in Talisma using the CreateContact method.
37
Guidelines for Using Talisma iService Methods

This section discusses the guidelines for using Talisma iService methods. Assumptions It is expected that the User understands the basic operations on the Contact, Account, and Interaction Objects, and custom Objects in Talisma. It is expected that the User understands Talisma Reports, and the functionality of Talisma 8.5 Customer Portal. It is expected that the User knows details such as Tab Name, Group Name, Group ID, Property Name, User Login Name, Team Name to retrieve the relevant IDs by querying Talisma Main Database. Other details such as Contact ID, Account ID, Interaction ID, and custom Object item ID can be obtained by viewing the relevant Talisma Client window.
Using Talisma iServices Methods Directly You can invoke Talisma iService methods directly in VB.NET, ASP.NET, C#, or any other application on which your external application is based. For example, if your sample application is based on Microsoft VB.NET, you can invoke the CreateContact method of the Talisma Contact iService, directly in VB.NET. Note: All parameters for a Talisma iService method are mandatory. Using XML to Invoke Talisma iServices Methods You can send the input values for a particular Talisma iService method using XML. You must send the input XML with all the parameter values for the method to the Talisma iService. All parameters for a specific Talisma iService method are mandatory. Talisma iService generates the response XML, which includes the status of the operation, and the output values. The input XML for every Talisma iService method must contain the following Simple Object Access Protocol (SOAP) header. This header contains Talisma User login credentials such as User Name and Password details required for authentication. This header contains the "<soap:header>" node which in turn contains the "<wsse:UsernameToken>" node that includes the User details. The Password field can be passed either as plain text, or can be encoded using the standard SHA-1 algorithm.
<soap:Header> <wsse:Security soap:actor="http://schemas.xmlsoap.org/soap/actor/next" soap:mustUnderstand="1" xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/07/secext"> <wsse:UsernameToken xmlns:wsu="http://schemas.xmlsoap.org/ws/2002/07/ utility" wsu:Id="SecurityToken-51776951-0ced-4ee1-9ea8-29c4efabf8c5"> <wsse:Username>talismaadmin</wsse:Username>
38
<wsse:Password Type="wsse:PasswordDigest">XE31GqC6+rxYJ6bRCADE7a0xV3s=</wsse:Password> <wsse:Nonce>Xx3XLBHRk1N1iasQFFVIWQ==</wsse:Nonce> <wsu:Created>2006-03-13T11:53:41Z</wsu:Created> </wsse:UsernameToken> </wsse:Security> </soap:Header>
Note
Ensure that you specify the correct login credentials in the SOAP header. When you update Property values using the UpdatePropertyTab, or UpdateRLTab method, the "error" string returned in the response will be in the following format: "PropertyID=ErrorCodeForthePropertyFailure,RowID" Consider the following error string:
"20001=-107777777,RowID=2"
This error string indicates that the Property ID "20001" has failed due to an error that matches the error code "-107777777" and the row ID "2". Multiple property update failures are separated by a semi-colon.
39
40
Integration Using Talisma iServices
Chapter 4:Integration Using Talisma iServices

This chapter describes how you can integrate your application with Talisma using Talisma iServices.
In this chapter
Integrating your Application Using Talisma iServices............. Page 42 General Prerequisites for All Platforms.................................... Page 43 Prerequisites for VB.NET and C# Using Visual Studio 2005 .. Page 43 Steps to Integrate Talisma iServices Using VB.NET or C# ..... Page 43 Prerequisites for using Talisma iServices Methods in an ASP Page Page 46 Steps to Integrate Talisma iServices Using ASP ...................... Page 46 Sample Code for Creating a Contact Using VB.Net ................ Page 47 Sample Code for Creating an Interaction Using C# ................. Page 48 Sample Code for Creating a Contact Using ASP ..................... Page 49 Troubleshooting Tips ................................................................ Page 51
41
Integrating your Application Using Talisma iServices

You can use Talisma iServices to integrate your application with Talisma. You can use Talisma iService for integration irrespective of the platform, or programming language on which your external application is based. To integrate your application, you must write the code for each of the Talisma iService methods in the programming language used to develop your external application.
Example
If your application is developed using VB.NET, to create a Contact in Talisma from your external application, you must write the code in VB.NET using the CreateContact method of the Talisma Contact iService. This section describes how you can start integrating your external application with Talisma using the Talisma iService methods. To begin the integration, open the source code of your external application. For example, if your application is developed using VB.NET, open the VB.NET console, and open the source code of your application. Before writing the code, you must add a Web Reference to each of the Talisma iServices that you want to use, and a Reference to the Microsoft.Web.Services3.dll file. Adding a Web Reference to a Talisma iService enables your application to locate, and use the service description of the Talisma iService, which is essential for your application to communicate with the Talisma iService. Adding a Reference to the Microsoft.Web.Services3.dll file enables secure communication between your external application, and Talisma iServices. After you have added all the References, you must add declarations to the general declarations area of your Project. You can now write the code using Talisma iService methods for performing an operation in Talisma using the external application. For detailed steps to integrate your VB.NET or C# application in Visual Studio 2005, see Steps to Integrate Talisma iServices Using VB.NET or C# on page 43. For VB.NET sample code to create a Contact, see Sample Code for Creating a Contact Using VB.Net on page 47. For C# sample code to create an Interaction, see Sample Code for Creating an Interaction Using C# on page 48.
42
General Prerequisites for All Platforms

The general prerequisites for integrating an external application with Talisma using Talisma iServices are: Installing Talisma iServices on the computer on which you have installed the Talisma Application Server. This computer must be a Web Server. Installing Web Service Enhancements 3.0 (WSE 3.0) on the computer where Talisma iServices will be installed.
Prerequisites for VB.NET and C# Using Visual Studio 2005

In addition to the points listed in the General Prerequisites section, the prerequisites for integrating a VB.NET or C# application in Visual Studio 2005 are: Installing Visual Studio .NET 2005, and Visual Studio .NET 2005 SP1. Alternatively, you can install and use Microsoft .NET Framework 2.0 Runtime Environment and Microsoft .NET Framework 2.0 SDK on the computer where the Talisma iService methods will be used.
Steps to Integrate Talisma iServices Using VB.NET or C#

This section describes the steps to integrate your VB.NET, or C# application using Talisma iServices in Visual Studio .NET 2005. You must open your VB.NET or C# application using Visual Studio .NET 2005, and carry out the steps described in this section. Adding References You must add a Web Reference to each of the Talisma iServices that you want to use, and a reference to the Microsoft.Web.Service3.dll file of Microsoft WSE 3.0. The Web Reference is added to enable your application to locate a Talisma iService, and obtain its service description. The Service description is essential for your application to communicate with the Talisma iService. When you add a Web Reference, a proxy class is created that interfaces with the iService, and provides a local representation of the iService. Adding a Reference to the Microsoft.Web.Services3.dll file enables User Authentication for the User to use the Talisma iServices methods to perform operations in Talisma. To add these References, follow these steps: 1. Open Visual Studio .NET. To do so, select Start, Program, Microsoft Visual Studio 2005, Microsoft Visual Studio 2005.
43
2. In Visual Studio .NET, open your application Project. - OR Create a new Project in Visual Studio 2005.
Example
If the name of your Project is My Project, open My Project in Visual Studio 2005. 3. In your Microsoft Visual Studio Project, add a Reference to the Microsoft.Web.Services3.dll file of WSE 3.0. This Reference is required for User Authentication. To Add a Reference to the Microsoft.Web.Services3.dll File i. In the Solution Explorer, right-click on the References node, and select Add Reference from the shortcut menu. The Add Reference dialog box is displayed.
Figure 1
Adding a Reference
ii. In the .NET tab, locate the Microsoft.Web.Services3.dll file. iii. Click OK. The Reference is added to the Microsoft.Web.Services3.dll file in the Visual Studio Project. 4. In Visual Studio Project, you must add a Web Reference for the Talisma iServices. You must add the Web Reference for every Talisma iService you want to use with the application. The Web Reference is added to enable your application to locate the Talisma iService, and obtain its service description.
44
The Web Reference URL must be in the following format:

http://<WebServer1>/<Name of the iService>/<iservice>.asmx where:
<WebServer1> is the name of the server computer on which the Talisma iServices is installed. <Name of the iService> is the name of the required Talisma iService. For example, ContactiService. <iservice>.asmx is the .asmx file of a specific Talisma iService. For example, Contact.asmx.
Example
Consider that you have to add a Web Reference to the Account iService hosted on the WorldWaves server. The Web Reference URL must be in the following format: http://WorldWaves/AccountiService/account.asmx To Add the Web Reference i. In the Visual Studio window, navigate to the Solution Explorer pane. If the Solution Explorer is not displayed in your window, select Solution Explorer from the View menu. ii. In the Solution Explorer pane, expand the main node which is named after the name of your project. For example, if your Project is called My Project, the main node in the Solution Explorer is also called My Project. iii. Right-click on the Web References node, and select Add Web Reference... from the shortcut menu. The Add Web Reference window is displayed. iv. In the URL field, specify the Web Reference URL for the Talisma iService you want to use. v. Click Go. vi. In the Web reference name field, specify a web reference name for the selected iService. For example, if you have used the Interaction iService, specify Interactioniservice as the web reference name. vii. Click Add Reference. The Web Reference is added for the selected Talisma iService. Repeat steps i to vii to add a Web Reference to all the Talisma iServices you want to use. References are added to the Talisma iServices, and the Microsoft.Web.Services3.dll file of WSE 3.0 in Visual Studio 2005. Writing the Code After adding the required references to your Project in Visual Studio 2005, you must now use the required Talisma iService methods to write the code to integrate your application with Talisma. To begin writing the code, follow these steps: 1. In the Solutions Explorer, select the Form in your application in which you will perform an operation using the Talisma iServices. For example, if you are using the controls in your Create Contact.vb Form to create a Contact, select the Create Contact.vb Form.
45
2. In the General Declarations area of your Form, specify the following lines of code:
Imports Microsoft.Web.Services3.Security Imports Microsoft.Web.Services3.Security.Tokens Imports Microsoft.Web.Services3
3. Write the code for the operation you want to carry out. 4. Save the Project, and execute it.
Prerequisites for using Talisma iServices Methods in an ASP Page

In addition to the points listed in the General Prerequisites section, the prerequisites for using Talisma iService methods in an ASP page are: The computer on which you want to run the ASP page must be a Web server. Microsoft Internet Information Services (IIS) 6.0 must be installed on the computer.
Steps to Integrate Talisma iServices Using ASP

This section describes the procedure to integrate Talisma iServices with an external application developed using ASP technology. To perform a specific operation in Talisma from your ASP application, you must create a new ASP page, or use an existing ASP page of your application to write code using the relevant Talisma iService method.
Example
To create an Account in Talisma from your ASP application, open the required ASP page of your application, and write the code for creating an Account in Talisma using the CreateAccount Talisma iService method. To Write Code Using Talisma iServices Methods for an ASP Application 1. Open the ASP page of your ASP based application, in which you want to write the code for using Talisma iService methods. - OR Create a new ASP page. 2. Write the code for the operation you want to carry out using the relevant Talisma iService method. See the Sample Code for Creating a Contact Using ASP on page 49 for the ASP sample code to create a Contact. 3. Save the ASP file. 4. If you have created a new ASP file in step 1, add the ASP page to the virtual directory of your ASP application.
46
Sample Code for Creating a Contact Using VB.Net

The sample code for creating a Contact using the Talisma Contact iService is given below:
Private Sub CreateContactButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
Comment: Creating an Instance of the Contact Web Service.

Dim CS As New ContactiService.ContactWebService
Comment: Create the PropertyInfo[] array of structures

Dim Propdataobj As ContactiService.PropertyInfo Dim Propdata As Array Array.CreateInstance(GetType(ContactiService.PropertyInfo), 10) =
Comment: Set the Username Token Information. This information is used to pass the User login credentials in the SOAP Header.
Dim token As New Tokens.UsernameToken(LoginNameTextBox.Text.ToString, PasswordTextBox.Text.ToString, Tokens.PasswordOption.SendHashed) CS.RequestSoapContext.Security.Tokens.Add(token)
Comment: Set the URL of the web service.

CS.Url = iServiceURLTextBox.Text.ToString
Comment: Set values for the parameters of the CreateContact method. The following line of code is used to set the value for the Contact E-mail property.
Propdataobj = New ContactiService.PropertyInfo Propdataobj.propertyID = 57 Propdataobj.propValue = "Peter@abccorp.com" Propdataobj.rowID = -1 Propdata.SetValue(Propdataobj, 0)
Comment: Initialize the output parameters.

Dim result As Long Dim contactID As Long Dim errorString As String errorString = " " contactID = -1 'Comment: Call create contact method with required parameters.
47
result = CS.CreateContact("Peter", Propdata, contactID, errorString)
Comment: The CreateContact method returns 0 if the create operation is successful. The contactID variable contains the ID of the newly created Contact. If the operation fails, the errorString variable contains the appropriate error description, and the result variable contains the corresponding error code.
Note
If you have upgraded from Microsoft WSE 1.0 to Microsoft WSE 3.0, replace the following line in the above code when you use this method:
Dim token As New UsernameToken(LoginNameTextBox.Text.ToString, PasswordTextBox.Text.ToString, PasswordOption.SendHashed)
with:
Dim token As Tokens.UsernameToken(LoginNameTextBox.Text.ToString, PasswordTextBox.Text.ToString) New
This code replacement is applicable to all the iService methods.
Sample Code for Creating an Interaction Using C#

The sample code for creating an Interaction using Talisma Interaction iService is given below: //Comment: Creating an Instance of the Interaction Web Service
TestStub1.InteractionService.InteractionWebServiceWse objInteractionService = new TestStub1.InteractionService.InteractionWebServiceWse();
//Comment: Set the Username Token Information.

UsernameToken token = new PasswordOption.SendPlainText); UsernameToken("TalismaAdmin", "talisma",
objInteractionService.RequestSoapContext.Security.Tokens.Add(token);
// Comment: Set the URL of the web service.

objInteractionService.Url Interaction.asmx"; = "http://worldwaves/InteractioniService/
//Comment: Set values for the parameters of the CreateInteraction method.

int contactID = 1; string contactMsg = "Need more info about Corporate Insurance Policies."; string userMsg = "Head of the Insurance Dept to reply."; string subject = "Corporate Insurance Policies" int mediaID = 1; int teamID = 1; int aliasID = -1; 48
int receivedByUserID = 2; int direction = 1; TestStub1.InteractionService.PropertyInfo[] propData = null;
// Comment: Initialize the output parameters.

int interactionID = 0; string errorString = ""; long result = 0;
//Comment: Call the CreateInteraction method by passing the parameters.

result = obj.CreateInteraction(contactID, contactMsg, userMsg, subject, mediaID, teamID, aliasID, receivedByUserID, direction, propData out interactionID, out errorString);
//Comment: The CreateInteraction method returns 0 if the Create operation is successful. The interactionID variable contains the ID of the newly created Interaction. If the create operation fails, the errorString variable contains the appropriate error description, and the result variable contains the corresponding error code.
Sample Code for Creating a Contact Using ASP

<%@LANGUAGE="VBSCRIPT" CODEPAGE="1252"%> <% //Set the Buffer property to False, indicating that the server need not buffer the response until all the script defined in the page is executed.// Response.Buffer = False //The response received from the server will not be stored in memory. Set the value of the Response.Buffer to True to save the response in memory.// //'Declare the variable varHttpReq that will be used to send the SOAP request to the Talisma Server.// Dim varHttpReq //Set the value of the varHttpReq variable to the Server Object that will send the request to the Talisma Server.// Set varHttpReq = Server.CreateObject("Msxml2.SERVERXMLHTTP") //'Declare the variable objReturn that will be used to receive the response from Talisma Server.// Dim objReturn //'Declare the variable objReturn that will be used to receive the response from Talisma Server.// Set objReturn = CreateObject("MSXML2.DOMDocument") //Declare the variable strEnvelope that will be used to save the SOAP Envelope.'// Dim strEnvelope //'Create the SOAP Envelope// strEnvelope = "<?xml version=""1.0"" encoding=""utf-8""?>" &_
49
"<soap:Envelope xmlns:soap=""http://schemas.xmlsoap.org/soap/envelope/"" xmlns:xsi=""http:// www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"" xmlns:wsa=""http://schemas.xmlsoap.org/ws/2004/08/addressing"" xmlns:wsse=""http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"" xmlns:wsu=""http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"">" &_ "<soap:Header> <wsa:Action>http://www.talisma.com/CreateContact</wsa:Action> <wsa:MessageID>urn:uuid:d00ddf2e-e497-4eb7-8056-30e8f17aa04b</wsa:MessageID> <wsa:ReplyTo> <wsa:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:Address> </ wsa:ReplyTo> <wsa:To>http://taldev469/DebugContactService/Contact.asmx?WSDL</wsa:To> <wsse:Security soap:mustUnderstand=""1"">" &_ "<wsse:UsernameToken xmlns:wsu=""http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd"" wsu:Id=""SecurityToken-bf63d8f4-663e-4dca-8eda-304a5409c29d""> <wsse:Username>TalismaAdmin</wsse:Username> <wsse:Password Type=""http://docs.oasis-open.org/ wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"">talisma</ wsse:Password><wsse:Nonce>KHoa+7Xd/bGp1o8OVK1F/w==</wsse:Nonce> <wsu:Created>2007-1022T05:36:38Z</wsu:Created></wsse:UsernameToken>" &_ "</wsse:Security> </soap:Header>" &_ " <soap:Body> <CreateContact xmlns=""http://www.talisma.com/""> <contactName>Sample Contact4</contactName><propData> <PropertyInfo> <propertyID>59</propertyID> <propValue>Test4</propValue><rowID>-1</rowID><relJoinID>0</relJoinID></ PropertyInfo><PropertyInfo><propertyID>62</propertyID><propValue>Talisma</propValue><rowID>1</rowID><relJoinID>0</relJoinID></PropertyInfo><PropertyInfo><propertyID>57</ propertyID><propValue>Test4@talisma.com</propValue><rowID>-1</rowID> <relJoinID>0</ relJoinID></PropertyInfo></propData>" &_ "<bUpdateReadOnly>false</bUpdateReadOnly> bIgnoreMandatoryCheck> </CreateContact> </soap:Body>" &_ "</soap:Envelope>" //Declare the varTotalBytes variable that will be used to obtain the length of the SOAP Envelope'// varTotalBytes = Len(strEnvelope) //'Set-up to post the SOAP Envelope to the Talisma Server.// varHttpReq.open "POST", "http://worldwaves/DebugContactService/Contact.asmx?WSDL", False //'Set the standard SOAP or XML header for the content-type.// varHttpReq.setRequestHeader "Content-Type", "text/xml; charset=UTF-8" varHttpReq.setRequestHeader "Content-Length", varTotalBytes //'Set the header for the Talisma iService method that must be called.//
50
<bIgnoreMandatoryCheck>true</
varHttpReq.setRequestHeader "SOAPAction", "http://www.talisma.com/CreateContact" // Send the SOAP request.// varHttpReq.send strEnvelope 'Load the Response into DOM objReturn.setProperty "ServerHTTPRequest", True objReturn.async = False 'Response Xml Response_Doc = varHttpReq.responseXML.xml 'Response_Doc contains the response 'Response.Write(varHttpReq.responseXML.xml) %>
Troubleshooting Tips
Occasionally, the following error is encountered when a Talisma iService Method is executed: <?xml version="1.0" ?> - <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> - <soap:Header> - <wsu:Timestamp xmlns:wsu="http://schemas.xmlsoap.org/ws/2002/07/utility"> <wsu:Created>2007-10-16T01:10:24Z</wsu:Created> <wsu:Expires>2007-10-16T01:15:24Z</wsu:Expires> </wsu:Timestamp> </soap:Header> - <soap:Body> - <soap:Fault> <faultcode>soap:Server</faultcode> <faultstring>System.Web.Services.Protocols.SoapHeaderException: Server unavailable, please later ---> System.FormatException: Invalid length for a Base-64 char array. System.Convert.FromBase64String(String s) Microsoft.Web.Services.Security.Nonce.LoadXml(XmlElement element) Microsoft.Web.Services.Security.UsernameToken.LoadXml(XmlElement element) Microsoft.Web.Services.Security.SecurityToken..ctor(XmlElement element) Microsoft.Web.Services.Security.UsernameToken..ctor(XmlElement element) Microsoft.Web.Services.Security.Security.LoadXml(XmlElement element) Microsoft.Web.Services.Security.SecurityInputFilter.ProcessMessage(SoapEnvelope envelope) Microsoft.Web.Services.Pipeline.ProcessInputMessage(SoapEnvelope envelope) Microsoft.Web.Services.WebServicesExtension.BeforeDeserializeServer(SoapMessage message) End of inner exception stack trace ---</faultstring>
51
try at at at at at at at at at ---
<faultactor>http://localhost/ContactiService/Contact.asmx?WSDL</faultactor> </soap:Fault> </soap:Body> </soap:Envelope> The error is encountered due to the following reasons: i. The Soap Header contains incorrect Talisma login credentials. ii. In Microsoft Component Services, the User Identity set for TalismaCacheService, and the other Talisma iServices is inconsistent.
To solve the problem: i. Ensure that you specify the correct Talisma login credentials in the SOAP header. ii. In Microsoft Component Services, ensure that the same User Identity is set for TalismaCacheService, and all other Talisma iServices.
Note
In Microsoft Component Services, to check whether the same User Identity is set for TalismaCacheService and all other Talisma iServices, follow these steps: 1. Open Microsoft Component Services. 2. Navigate to the Component Services/Computers/My Computer/COM+ Applications node. 3. Right-click on the TalismaCacheService node. 4. Select Properties from the shortcut menu. The Properties window is displayed. 5. Click the Identity tab, and check the User Account set for the iService. 6. Click OK. 7. Click the node of each Talisma iService in the Component Services/ Computers/My Computer/COM+ Applications node, and repeat steps 4 through 7 for each iService. 8. Ensure that the same User Identity is set for the TalismaCacheService, and all other Talisma iServices.
52
Talisma Contact iService
Chapter 5:Talisma Contact iService

This chapter describes the Talisma Contact iService methods.
In this chapter
Overview................................................................................... GetRLTab .................................................................................. GetAttachmentTab .................................................................... GetCommentsTab ..................................................................... DeleteContact............................................................................ UpdateCommentsTab................................................................ GetPropertiesTab....................................................................... CreateContact............................................................................ GetLinkedTab ........................................................................... UpdatePropertyTab ................................................................... UpdateRLTab ............................................................................ UpdateAttachmentTab .............................................................. Page 54 Page 56 Page 58 Page 60 Page 61 Page 62 Page 64 Page 66 Page 68 Page 69 Page 71 Page 73
53
Overview
A Contact is an individual who interacts with your organization through any media, including e-mail, Chat, telephone, fax, and letter. All the details about a Contact are stored in the Contact Object window in Talisma Client, including the history of the Contacts Interactions with your organization and links to Object items associated with the Contact, such as Accounts. Talisma Contact iService exposes various methods as Web Services to enable an external application to interact with Talisma to manage Contact information. For example, you may use the Contact Object to maintain student information. You can use Talisma Contact iService methods to perform the following operations in Talisma from an external application: Create a new Contact. Delete an existing Contact. Update, or retrieve the Property values of a Contact available in the Properties, and Linked Tabs. Add, or retrieve comment details of a Contact from the Comment Tab. Add, update, retrieve, or delete the Property values of a Contact available in the RecordList Tab. Add a new attachment for a Contact in the Attachment Tab. Delete an existing attachment associated with a Contact from the Attachment Tab.
The following table describes the various Talisma Contact iService methods:
Method GetRLTab Description Gets the Property values of a Contact available in the RecordList Tab of Talisma. You must send the Contact ID, and the RecordList Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns Property values if the get operation is successful. Gets the attachment details of a Contact available in the Attachment Tab of Talisma. You must send the Contact ID, and the Attachment Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the attachment details if the get operation is successful. Gets the comment details of a Contact available in the Comment Tab of Talisma. You must send the Contact ID, and the Comment Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the comment details if the get operation is successful. Deletes an existing Contact from Talisma. You must send the unique Contact ID associated with the Contact that you want to delete as an input parameter to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the delete operation. You must send the deleteRelatedObjects parameter of the DeleteContact method to delete all Object items related to the Contact. The value of this parameter must be set to True to delete all Object items related to the Contact. Set this value to False to exclude the Object items from deletion. 54
GetAttachmentTab
GetCommentsTab
DeleteContact
Method UpdateCommentsTab
Description Adds comment details to a Contact available in the Comment Tab of Talisma. You must send the Contact ID, Comment Tab ID, and the CommentsData structure that contains the details of the comment you want to add as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the add operation. Gets the Property values of a Contact available in a Property Tab of the Contact window in Talisma. You must send the Contact ID, and the Property Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the Property values if the get operation is successful. Creates a new Contact in Talisma. You must send the Contact Name, and the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the unique ID of the Contact if the Contact is created successfully. Gets the Property values of a Contact available in the Linked Tab of Talisma. You must send the Contact ID, and the Linked Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the Property values if the get operation is successful. Updates the Property values of a Contact available in a Property Tab of the Contact window in Talisma. You must send the Contact ID, and the PropertyInfo[] structure that contains the details of Property values you want to update as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the update operation. Adds, deletes, or updates the Property values of a Contact available in the RecordList Tab of Talisma. You must send the Contact ID, RecordList Tab ID, and the PropertyInfo[] structure that contains the details of Property values you want to update as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the update operation. To delete rows from the RecordList Tab of the Contact, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array.
GetPropertiesTab
CreateContact
GetLinkedTab
UpdatePropertyTab
UpdateRLTab
UpdateAttachmentTab
Adds, or deletes attachment details of a Contact available in the Attachment Tab of Talisma. You must send the Contact ID, Attachment Tab ID, and the AttachmentData[] structure that contains the details of the attachment as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the add, or delete operation.
55
GetRLTab
You can use the GetRLTab method to get the Property values of a Contact available in the RecordList Tab of Talisma. Let us consider the scenario of student scores maintained in a RecordList Tab of the Contact Object. You want to fetch the student scores for a student. To get this information from Talisma, you would use the GetRLTab method. You must send the Contact ID, and the RecordList Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetRLTab(long contactID, long tabID, int getPropinfoOrPropxml, out PropertyInfo[] propData, out string rlpropXML, out string error)
GetRLTab Input Parameters The following table describes the input parameters for the GetRLTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to retrieve the Property values from a RecordList Tab of the Contact. The ID of a RecordList Tab associated with the Contact Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1- Specify this value to obtain the output in XML format in the rlpropXML output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the rlpropXML output parameter.
tabID
long
getPropinfoOrPropxml
int
56
GetRLTab Output Parameters The following table describes the output parameters for the GetRLTab method.
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - A unique ID used to identify a Property value row in a RecordList Tab in Talisma. This member returns the row ID. relJoinID (long) - This is not applicable for a RecordList Tab. string This parameter contains the output in XML format. The value of the rlpropXML parameter is NULL if no Property values are available in the specified RecordList Tab of the Contact. error string The error message(s) returned when the get operation fails. Data Type PropertyInfo[] Description An array of the PropertyInfo[] structure. This array contains the ID of a Property, the value assigned to the Property, the ID of the Property row in the RecordList Tab, and the related Objects display Property. The value of the propData array is blank if no Property values are available in the RecordList Tab of a Contact.
rlpropXML
GetRLTab Return Values The GetRLTab method returns 0 if the get operation is successful, and a negative value if the operation fails.
57
GetAttachmentTab
You can use the GetAttachmentTab method to get the attachment details of a Contact available in the Attachment Tab of Talisma. For example, you can use the GetAttachmentTab method to retrieve the score card of a student stored as an attachment in the Attachment Tab of the relevant Contact. You must send the Contact ID, and the Attachment Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the attachment details if the get operation is successful. Method Signature
long GetAttachmentTab(long contactID, attachments, out string error) long tabID, out AttachmentData[]
GetAttachmentTab Input Parameters The following table describes the input parameters for the GetAttachmentTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to retrieve the attachment details from the Attachment Tab of the Contact. The ID of an Attachment Tab associated with the Contact Object.
tabID
long
58
GetAttachmentTab Output Parameters The following table describes the output parameters for the GetAttachmentTab method:
Return Value attachments fileName (string) - Name of the attachment. comment (string) - The User comment that describes the attachment. byte[] fileBlob (string) The text content of the attachment. deleteAttachment (bool) This value indicates whether the attachment should be deleted. You can use the following values: True - The attachment is deleted. False - The attachment is excluded from deletion. Data Type AttachmentData[] Description An array of the AttachmentData[] structure. This array contains the name of the attachment, the comment about the attachment, the text content of the attachment, the boolean value to indicate if the attachment needs to be deleted, and the unique ID for the attachment. The value of the attachments array is blank if no attachment is available in Attachment Tab of a Contact.
attachmentId (long) - A unique ID used to identify an attachment in Talisma. dateModified (DateTime) - The date and time when the attachment was last modified. string The error message(s) returned when the get operation fails.
error
GetAttachmentTab Return Values The GetAttachmentTab method returns 0 if the operation is successful, and a negative value if the operation fails.
59
GetCommentsTab
You can use the GetCommentsTab method to get the comment details of a Contact available in the Comment Tab of Talisma. For example, you can use the GetCommentsTab method to retrieve the comments added by a Recruiter for a student, from the Comment Tab of Talisma. You must send the Contact ID, and the Comment Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the comment details if the get operation is successful. Method Signature
long GetCommentsTab(long contactID, comments, out string error) long tabID, out CommentsData[]
GetCommentsTab Input Parameters The following table describes the input parameters for the GetCommentsTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to retrieve the comment details from a Comment Tab of the Contact. The ID of a Comment Tab associated with the Contact Object.
tabID
long
GetCommentsTab Output Parameters The following table describes the output parameters for the GetCommentsTab method:
Return Value comments userID (long) - A unique ID used to identify a User in Talisma. The comment details in the Comment Tab are added by the User associated with this User ID. date (DateTime) - Date, and time the comment was added. comment (string) - The details of the comment. string The error message(s) returned when the get operation fails. Data Type CommentsData[] Description An array of the CommentsData[] structure. This array contains the ID of the User, the date and time at which the comment was added, and the details of the comment. The value of the comments array is blank if no comments are available in the Comment Tab.
error
60
GetCommentsTab Return Values The GetCommentsTab method returns 0 if the operation is successful, and a negative value if the operation fails.
DeleteContact
You can use the DeleteContact method to delete an existing Contact from Talisma. For example, you may want to delete Contact Cathy who has claimed the insurance amount from your organization. You must send the unique Contact ID associated with the Contact that you want to delete as the input parameter to Talisma Contact iService. Talisma Contact iService processes the input value, and returns the status of the delete operation. You must send the deleteRelatedObjects parameter of the DeleteContact method if you want to delete all Interactions related to the Contact. The value of this parameter must be set to True to delete all Interactions related to the Contact. Set this value to False to exclude the Interactions from deletion. Method Signature
long DeleteContact(long contactID, bool deleteRelatedObjects, out string error)
DeleteContact Input Parameters The following table describes the input parameters for the DeleteContact method:
Input Parameter contactID deleteRelatedObjects Data Type long bool Description The ID of the Contact you want to delete. This value indicates whether the Interactions related with the Contact should also be deleted when the Contact is deleted. You can use the following values: True - Interactions related to the Contact must be deleted. False - Interactions related to the Contact must be excluded from deletion.
61
DeleteContact Output Parameters The following table describes the output parameters for the DeleteContact method:
Return Value error Data Type string Description The error message(s) returned when the Contact deletion fails.
DeleteContact Return Values The DeleteContact method returns 0 if the operation is successful, and a negative value if the operation fails.
UpdateCommentsTab
You can use the UpdateCommentsTab method to add comment details to a Contact available in the Comment Tab of Talisma. For example, the Recruiter can use the UpdateCommentsTab method to add comments for a student in the Comment Tab of Talisma. You must send the Contact ID, Comment Tab ID, and the CommentsData structure that contains the details of the comment you want to add as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the update operation. Method Signature
long UpdateCommentsTab(long contactID, long tabId, CommentsData comment, out string error)
UpdateCommentsTab Input Parameters The following table describes the input parameters for the UpdateCommentsTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to add comments in the Comment Tab of the Contact. The ID of the Comment Tab associated with the Contact Object.
tabID
long
62
Input Parameter comment userID (long) - The ID of the User who is updating the comment, or the ID of the User on behalf of whom the comment is updated. date (DateTime) - Date, and time the comment was added. This value should be in the following format: <Year>-<Month><Date>T<HH>:<MM>:<S S>Z For example, you can use "2006-03-13T12:46:30Z" as a date value. comment (string) - The details of the comment.
Data Type CommentsData
Description The CommentsData structure containing the updated details of the comment.
UpdateCommentsTab Output Parameters The following table describes the output parameters for the UpdateCommentsTab method:
Return Value error Data Type string Description The error message(s) returned when the update operation fails.
UpdateCommentsTab Output Parameters The UpdateCommentsTab method returns 0 if the operation is successful, and a negative value if the operation fails.
63
GetPropertiesTab
You can use the GetPropertiesTab method to get the Property values of a Contact available in the Properties Tab of Talisma. For example, you may want to obtain details such as the E-mail ID, and course details of a student. In this scenario, you would use the GetPropertiesTab method. You must send the Contact ID, and the Property Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetPropertiesTab(long contactID, long tabID, int getPropinfoOrPropxml, out PropertyInfo[] propData, out string propXML, out string error)
GetPropertiesTab Input Parameters The following table describes the input parameters for the GetPropertiesTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to update the Property values in a Property Tab of the Contact. The ID of a Property Tab associated with the Contact Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1 - Specify this value to obtain the output in XML format in the propXML output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the propXML output parameter.
tabID
long
int
64
GetPropertiesTab Output Parameters The following table describes the output parameters for the GetPropertiesTab method:
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) member returns 0 or This -1. Data Type PropertyInfo[] Description An array of the PropertyInfo[] structure. This array contains the ID of the Property, the value assigned to the Property, and the ID of the Property value row. The value of the propData array is blank if no Property values are available in a Property Tab of a Contact in Talisma.
relJoinID (long) - The ID of the related Objects display Property. string
propXML
This parameter contains the output in XML format. The value of the propXML parameter is NULL if no Property values are available in the specified Property Tab of a Contact.
error
string
The error message(s) returned when the get operation fails.
GetPropertiesTab Return Values The GetPropertiesTab method returns 0 if the get operation is successful, and a negative value if the operation fails.
65
CreateContact
You can use the CreateContact method to create a new Contact in Talisma. For example, consider the scenario in which you want to create a Contact, "Tom Baron" and add his E-mail ID in Talisma. In this scenario, you can use the CreateContact method to create a Contact in Talisma. You must send the Contact Name, and the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the unique ID of the Contact if the Contact is created successfully. Method Signature
long CreateContact(string contactName, PropertyInfo[] propData, bool bUpdateReadOnly, bool bIgnoreMandatoryCheck, out long contactID, out string error)
CreateContact Input Parameters The following table describes the input parameters for the CreateContact method:
Input Parameter contactName propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This value must be set to -1. relJoinID (long) - This is the ID of the related Object's display Property, and is applicable only if the Property you want to set is a relationship Property. In all other cases, specify -1 for this variable. Data Type string PropertyInfo[] Description The name of the Contact you want to create in Talisma. This is an array of the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Contact, in a Property Tab associated with the Contact. The value of the propData array is blank if no Property values are available in a Property Tab of a Contact in Talisma.
66
Input Parameter bUpdateReadOnly
Data Type bool
Description If read-only Properties are included in the PropertyInfo[] structure, this parameter enables you to specify whether the read only properties must be updated in the specified Property Tab of the new Contact. Specify one of the following values: TRUE - To update the read-only Properties. FALSE - To ignore readonly Properties.
bIgnoreMandatoryCheck
bool
Enables you to specify whether the method must check for unfilled mandatory properties. Specify one of the following values: TRUE - Indicates that the method must check for unfilled mandatory properties. If there are any unfilled mandatory properties, the create operation fails. FALSE Unfilled mandatory Properties will be ignored.
CreateContact Output Parameters The following table describes the output parameters for the CreateContact method:
Return Value contactID error Data Type long string Description The ID of the new Contact created in Talisma. The error message(s) returned when the Contact creation fails.
CreateContact Return Values The CreateContact method returns 0 if the operation is successful, and a negative value if the operation fails.
67
GetLinkedTab
You can use the GetLinkedTab method to get the Property values of a Contact available in the Linked Tab of Talisma. For example, consider a scenario where course details are stored in an external data source, and a student's course options are maintained in a Linked Tab of the Contact window. You can use the GetLinkedTab method to retrieve the course details stored in the Linked Tab. You must send the Contact ID, and the Linked Tab ID of the Contact as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetLinkedTab(long contactID, long tabID, out PropertyInfo[] propData, out string error)
GetLinkedTab Input Parameters The following table describes the input parameters for the GetLinkedTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to retrieve the Property values from the Linked Tab of the Contact. The ID of the Linked Tab associated with the Contact Object.
tabID
long
GetLinkedTab Output Parameters The following table describes the output parameters for the GetLinkedTab method:
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This member returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string Data Type PropertyInfo[] Description An array of the PropertyInfo[] structure. This array contains the ID of the Property, the value assigned to the Property, and the ID of the Property value row. The value of the propData array is blank if no Property values are available in the Linked Tab.
error
68
GetLinkedTab Return Values The GetLinkedTab method returns 0 if the operation is successful, and a negative value if the operation fails.
UpdatePropertyTab
You can use the UpdatePropertyTab method to update the Property values of a Contact available in a Property Tab of the Contact window in Talisma. For example, you may want to update details such as the E-mail ID, and course details of a student in the relevant Contact window. In this scenario, you would use the UpdatePropertyTab method. You must send the Contact ID, and the PropertyInfo[] structure that contains the details of Property values you want to update as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the update operation. Method Signature
long UpdatePropertyTab(long contactId, PropertyInfo[] propData, bUpdateReadOnly, bool bIgnoreMandatoryCheck, out string error) bool
UpdatePropertyTab Input Parameters The following table describes the input parameters for the UpdatePropertyTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to retrieve the Property values from a Property Tab of the Contact. This is an array of the PropertyInfo[] structure that contains the details of Properties in a Property Tab of the Contact that you want to update. The value of the propData array is blank if no Property values are available in the Property Tab.
propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This value must be set to -1. relJoinID (long) - This is the ID of the related Object's display Property, and is applicable only if the Property you want to update is a relationship Property. In all other cases, specify -1 for this variable.
PropertyInfo[]
69
Input Parameter bUpdateReadOnly
Data Type bool
Description If read-only Properties are included in the PropertyInfo[] structure, this parameter enables you to specify whether the read only properties must be updated in the specified Property Tab of the Contact. Specify one of the following values: TRUE - To update the read-only Properties. FALSE - To ignore readonly Properties.
bIgnoreMandatoryCheck
bool
Enables you to specify whether the method must check for unfilled mandatory properties. Specify one of the following values: TRUE - Indicates that the method must check for unfilled mandatory properties. If there are any unfilled mandatory properties, the update operation fails. FALSE Unfilled mandatory Properties will be ignored.
UpdatePropertyTab Output Parameters The following table describes the output parameters for the UpdatePropertyTab method:
UpdatePropertyTab Return Values The UpdatePropertyTab method returns 0 if the operation is successful, and a negative value if the operation fails.
70
UpdateRLTab
You can use the UpdateRLTab method to add, delete, or update the Property values of a Contact available in the RecordList Tab of Talisma. Let us consider the scenario of student scores maintained in a RecordList Tab of the Contact Object. You would use the UpdateRLTab method to update the student scores for a student. You must send the Contact ID, RecordList Tab ID, and the PropertyInfo[] structure that contains the details of Property values you want to update as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the update operation. To delete rows from the RecordList Tab of the Interaction, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array. Method Signature
long UpdateRLTab(long contactID, long tabID, PropertyInfo[] propData, int[] deleteRows, bool bUpdateReadOnly, out string error)
UpdateRLTab Input Parameters The following table describes the input parameters for the UpdateRLTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to update the Property values in the RecordList Tab of the Contact. The ID of the RecordList Tab associated with the Contact. This is an array of PropertyInfo[] structure contains the details Properties in a RecordList of a the Contact. the that of Tab
tabID propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - The ID of the row in the RecordList Tab associated with a Contact in which you want to update the Property values. relJoinID (long) - This is not applicable for a RecordList Tab.
long PropertyInfo[]
The value of the propData array is blank if no Property values are available in the RecordList Tab.
71
Input Parameter deleteRows
Data Type int[]
Description This is an array of row IDs you want to delete from the RecordList Tab of the specified Contact. If you do not want to delete any rows, ensure that the deleteRows array is declared as a zero length array.
bUpdateReadOnly
bool
If read-only Properties are included in the PropertyInfo[] structure, this parameter enables you to specify whether the read only properties must be updated in the specified RecordList Tab of the Contact. Specify one of the following values: TRUE - To update the read-only Properties. FALSE - To ignore readonly Properties.
UpdateRLTab Output Parameters The following table describes the output parameters for the UpdateRLTab method:
UpdateRLTab Return Values The UpdateRLTab method returns 0 if the operation is successful, and a negative value if the operation fails.
72
UpdateAttachmentTab
You can use the UpdateAttachmentTab method to add, or delete attachment details of a Contact available in the Attachment Tab of Talisma. For example, you can use the UpdateAttachmentTab method to add the score card of a student as an attachment in the Attachment Tab of the relevant Contact. You must send the Contact ID, Attachment Tab ID, and the AttachmentData[] structure that contains the details of the attachment as input parameters to Talisma Contact iService. Talisma Contact iService processes the input values, and returns the status of the add, or delete operation. To add a new attachment, you must set the attachmentId parameter to -1. To delete an attachment in the Attachment Tab, you must set the value of the deleteAttachment parameter to True. Method Signature
long UpdateAttachmentTab(long contactID, long tabId, ref AttachmentData[] attachments, out string error)
UpdateAttachmentTab Input Parameters The following table describes the input parameters for the UpdateAttachmentTab method:
Input Parameter contactID Data Type long Description The ID of the Contact for which you want to update the attachment details in the Attachment Tab of the Contact. The ID of the Attachment Tab associated with the Contact Object.
tabID
long
73
Input Parameter attachments fileName (string) - Name of the Attachment. comment (string) - A User comment that describes the attachment. byte[] fileBlob (string) The text content of the attachment. deleteAttachment (bool) This value indicates whether the attachment should be deleted. You can use the following values: True - The attachment is deleted. False - The attachment is excluded from deletion. This value must be set to False when you want to add a new attachment in the attachment Tab. attachmentId (long) Unique ID used to identify an attachment in Talisma. This value must be set to -1 when you want to add a new attachment in the Attachment Tab. dateModified (DateTime) - The date and time when the attachment was last modified.
Data Type AttachmentData[]
Description This is an array of the AttachmentData[] structure that contains the details of an attachment.
74
UpdateAttachmentTab Output Parameters The following table describes the output parameters for the UpdateAttachmentTab method:
Output Parameter error Data Type string Description The error message(s) returned when the update operation fails.
UpdateAttachmentTab Return Values The UpdateAttachmentTab method returns 0 if the update operation is successful, and an error message if the operation fails.
75
76
Talisma Account iService
Chapter 6:Talisma Account iService

This chapter describes the Talisma Account iService methods.
In this chapter
Overview................................................................................... DeleteAccount .......................................................................... GetRLTab .................................................................................. GetAttachmentTab .................................................................... GetCommentsTab ..................................................................... UpdateCommentsTab................................................................ GetPropertiesTab....................................................................... CreateAccount .......................................................................... GetLinkedTab ........................................................................... UpdatePropertyTab ................................................................... UpdateRLTab ............................................................................ UpdateAttachmentTab .............................................................. Page 78 Page 80 Page 81 Page 83 Page 85 Page 86 Page 87 Page 89 Page 91 Page 92 Page 93 Page 94
77
Overview
An Account is an organization that maintains a business relationship with your organization. An Account comprises one or more Contacts. Contacts are employees of the Account. Talisma Users interact with these Contacts for business transactions. All the details of an Account are stored in the Account Object window in Talisma Client. Talisma Account iService exposes various methods as Web Services to enable an external application to interact with Talisma to manage Account information. For example, you may use the Account Object to maintain details pertaining to schools. You can use Talisma Account iService methods to perform the following operations in Talisma from an external application: Create a new Account. Delete an existing Account. Update, or retrieve the Property values of an Account available in the Property, and Linked tabs. Add, or retrieve comment details of an Account from the Comment Tab. Add, update, retrieve, or delete the Property values of an Account available in the RecordList Tab. Add a new attachment for an Account in the Attachment Tab. Delete an existing attachment associated with an Account from the Attachment Tab.
The following table describes various Talisma Account Service methods:

Method DeleteAccount Description Deletes an existing Account from Talisma. You must send the unique Account ID associated with the account that you want to delete as an input parameter to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the delete operation. You must send the deleteRelObjects parameter of the DeleteAccount method to delete all Object items related to the Account. The value of this parameter must be set to True to delete all Object items related to the Account. Set this value to False to exclude the related Object items from deletion. GetRLTab Gets the Property values of an Account available in the RecordList Tab of Talisma. You must send the Account ID, and the RecordList Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the Property values if the get operation is successful. Gets the attachment details of an Account available in the Attachment Tab of Talisma. You must send the Account ID, and the Attachment Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the attachment details if the get operation is successful. Gets the comment details of an Account, available in the Comment Tab of Talisma. You must send the Account ID, and the Comment Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the comment details if the get operation is successful. 78
GetAttachmentTab
GetCommentsTab
Description Updates the comment details of an Account available in the Comment Tab of Talisma. You must send the Account ID, Comment Tab ID, and the CommentsData structure that contains the comment details you want to add to the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the add operation. Gets the Property values of an Account, available in a Property Tab of the Account window in Talisma. You must send the Account ID, and a Property Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the Property values if the get operation is successful. Creates a new Account in Talisma. You must send the Account Name, and the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the unique ID of the Account if the Account is created successfully. Gets the Property values of an Account available in the Linked Tab of Talisma. You must send the Account ID, and the Linked Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the Property values if the get operation is successful. Updates the Property values of an Account available in a Property Tab of the Account window in Talisma. You must send the Account ID, and the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the update operation. Adds, deletes, or updates the Property values of an Account, available in the RecordList Tab of Talisma. You must send the Account ID, and the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the update operation. To delete rows from the RecordList Tab of the Account, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array.
GetPropertiesTab
CreateAccount
GetLinkedTab
UpdatePropertyTab
UpdateRLTab
UpdateAttachmentTab
Adds, or deletes the attachment details of an Account available in the Attachment Tab of Talisma. You must send the Account ID, and the attachment details that you want to add, or delete as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the add, or delete operation.
79
DeleteAccount
You can use the DeleteAccount method to delete an existing Account from Talisma. You must send the unique Account ID associated with the Account that you want to delete as an input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the delete operation. You must send the deleteRelObjects parameter of the DeleteAccount method to delete all Object items related to the Account. The value of this parameter must be set to True to delete all Object items related to the Account. Set this value to False to exclude the related Object items from deletion. Method Signature
long DeleteAccount(long accountID, bool deleteRelObjects, out string error)
DeleteAccount Input Parameters The following table describes the input parameters for the DeleteAccount method:
Input Parameter accountID deleteRelObjects Data Type long bool Description The ID of the Account you want to delete from Talisma. This value indicates whether the Object items related with the Account should also be deleted when the Account is deleted. You can use the following values: True - Object items related to the Account must be deleted. False - Object items related to the Account must be excluded from deletion.
DeleteAccount Output Parameters The following table describes the output parameters for the DeleteAccount method:
Return Value error Data Type string Description The error message(s) returned when the Account deletion fails.
DeleteAccount Return Values The DeleteAccount method returns 0 if the delete operation is successful, and a negative value if the operation fails.
80
GetRLTab
You can use the GetRLTab method to get the Property values of an Account available in the RecordList Tab of Talisma. For example, you maintain details of schools using the Account Object in Talisma, and you maintain details of students belonging to every school as a RecordList Tab in the Account window. You want to obtain details of students belonging to a particular school. You would use the GetRLTab method to obtain the details. You must send the Account ID, and the RecordList Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetRLTab(long accountID, long tabID, int getPropinfoOrPropxml, PropertyInfo[] propData, out string rlpropXML, out string error) out
Input Parameter accountID Data Type long Description The ID of the Account for which you want to retrieve the values from the RecordList Tab of the Account. The ID of the RecordList Tab associated with the Account Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1 - Specify this value to obtain the output in XML format in the rlpropXML output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the rlpropXML output parameter.
tabID
long
int
81
GetRLTab Output Parameters The following table describes the output parameters for the GetRLTab method:
Return Values propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - A unique ID used to identify a Property value row in a RecordList Tab in Talisma. This member returns the row ID. relJoinID (long) - The ID of the related Objects display Property. string This parameter contains the output in XML format. The value of the rlpropXML parameter is NULL if no Property values are available in the specified RecordList Tab of an Account. error string The error message(s) returned when the get operation fails. Data Type PropertyInfo[] Description This is an array of the PropertyInfo[] structure that contains the Property values retrieved from the RecordList Tab of the specified Account. The value of the propData array is blank if no Property values are available in the RecordList Tab of an Account.
rlpropXML
GetRLTab Return Values The GetRLTab method returns 0 if the operation is successful, and a negative value if the operation fails.
82
GetAttachmentTab
You can use the GetAttachmentTab method to get the attachment details of an Account available in the Attachment Tab of Talisma. For example, you can retrieve details of schools stored as attachments in the Attachment Tab of the Account window. You must send the Account ID, and the Attachment Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the attachment details if the get operation is successful. Method Signature
long GetAttachmentTab(long accountID, attachments, out string error) long tabID, out AttachmentData[]
Input Parameter accountID tabID Data Type long long Description A unique ID used to identify an Account in Talisma. A unique ID used to identify a Tab in Talisma.
83
Return Value attachments fileName (string) - Name of the attachment. comment (string) - The User comment that describes the attachment. byte[] fileBlob (string) The text content of the attachment. deleteAttachment (bool) This value indicates whether the attachment should be deleted. You can use the following values: True - The attachment is deleted. False - The attachment is excluded from deletion. Data Type AttachmentData[] Description An array of the AttachmentData[] structure. This array contains the name of the attachment, the comment about the attachment, the text content of the attachment, the boolean value to indicate if the attachment needs to be deleted, and the unique ID for the attachment. The value of the attachments array is blank if no attachment is available in Attachment Tab of an Account.
error
84
GetCommentsTab
You can use the GetCommentsTab method to get the comment details of an Account, available in the Comment Tab of Talisma. For example, you can retrieve comments about a school added to the Comment Tab of the relevant Account maintained for the school in Talisma. You must send the Account ID, and the Comment Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the comment details if the get operation is successful. Method Signature
long GetCommentsTab(long accountID, long tabID, out CommentsData[] comments, out string error)
Input Parameter accountID Data Type long Description The ID of the Account for which you want to retrieve the comments from the Comment Tab. The ID of the Comment Tab associated with the Account.
tabID
long
Return Value comments userID (long) - A unique ID used to identify a User in Talisma. The comment details in the Comment Tab are added by the User associated with this User ID. date (DateTime) - Date, and time the comment was added. comment (string) - The details of the comment. string The error message(s) returned when the get operation fails. Data Type CommentsData[] Description This is an array of the CommentsData[] structure that contains the details of comments retrieved from the Comment Tab of the specified Account.
error
85
GetCommentsTab Return Values The GetCommentsTab method returns 0 if the get operation is successful, and a negative value if the operation fails.
UpdateCommentsTab
You can use the UpdateCommentsTab method to add comment details to an Account available in the Comment Tab of Talisma. For example, you can add comments about a school to the Comment Tab of the relevant Account. You must send the Account ID, Comment Tab ID, and the CommentsData structure that contains the comment details you want to add to the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the add operation. Method Signature
long UpdateCommentsTab(long accountID, long tabId, CommentsData comment, out string error)
Input Parameter accountID Data Type long Description The ID of the Account for which you want to update the comments in the Comment Tab associated with the Account Object. The ID of the Comment Tab associated with the Account Object. The CommentsData structure containing the updated details of the comment.
tabID
long
comment userID (long) - The ID of the User who is updating the comment, or the ID of the User on behalf of whom the comment is updated. date (DateTime) - Date, and time the comment was added. comment (string) - The details of the comment.
CommentsData
86
UpdateCommentsTab The UpdateCommentsTab method returns 0 if the operation is successful, and a negative value if the operation fails.
GetPropertiesTab
You can use the GetPropertiesTab method to get the Property values of an Account, available in a Property Tab of the Account window in Talisma. For example, you can retrieve the fee details of a school maintained as an Account in Talisma. You must send the Account ID, and the Property Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetPropertiesTab(long accountID, long tabID, int getPropinfoOrPropxml, out PropertyInfo[] propData, out string propXML, out string error)
Input Parameter accountID Data Type long Description The ID of the Account for which you want to retrieve the values from a Property Tab associated with the Account. The ID of a Property Tab associated with the Account.
tabID
long
87
Input Parameter getPropinfoOrPropxml
Data Type int
Description Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1 - Specify this value to obtain the output in XML format in the propXML output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the propXML output parameter.
Return Values propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This member returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string Data Type PropertyInfo[] Description This is an array of Property Info[] structure that contains the Property values retrieved from a Property Tab of the specified Account. The value of the propData array is blank if no Property values are available in the specified Property Tab of the Account.
propXML
This parameter contains the output in XML format. The value of the propXML parameter is NULL if no Property values are available in the specified Property of the Account.
error
string
88
GetPropertiesTab Return Values The GetPropertiesTab method returns 0 if the operation is successful, and a negative value if the operation fails.
CreateAccount
You can use the CreateAccount method to create a new Account in Talisma. For example, you can add the details of a new school by creating an Account in Talisma. You must send the Account Name, and the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the unique ID of the Account if the Account is created successfully. Method Signature
long CreateAccount(string accountName, PropertyInfo[] propData, out long accountID, out string error)
89
CreateAccount Input Parameters The following table describes the input parameters for the CreateAccount method:
Input Parameter accountName propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This value must be set to -1. relJoinID (long) - The ID of the related Objects display Property. Data Type string PropertyInfo[] Description The name of the Account you want to create in Talisma. This is an array of the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Account, in a Property Tab associated with the Account.
CreateAccount Output Parameters The following table describes the output parameters for the CreateAccount method:
Return Value accountID error Data Type long string Description A unique ID assigned to a new Account created in Talisma. The error message(s) returned when the Account creation fails.
CreateAccount Return Values The CreateAccount method returns 0 if the operation is successful, and a negative value if the operation fails.
90
GetLinkedTab
You can use the GetLinkedTab method to get the Property values of an Account available in the Linked Tab of Talisma. You must send the Account ID, and the Linked Tab ID of the Account as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetLinkedTab(long accountID, long tabID, out PropertyInfo[] propData, out string error)
Input Parameter accountID Data Type long Description The ID of the Account for which you want to retrieve the Property values from the Linked Tab associated with the Account. The ID of the Linked Tab associated with the Account.
tabID
long
GetLinkedTab Output Parameters The following table describes the output parameters for the GetLinkedTab method.
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This member returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string The error message(s) returned when the get operation fails. Data Type PropertyInfo[] Description This is an array of the PropertyInfo[] structure that contains the Property values retrieved from the Linked Tab of the specified Account. The value of the propData array is blank if no Property values are available in the Linked Tab of the Account.
error
91
UpdatePropertyTab
You can use the UpdatePropertyTab method to update the Property values of an Account available in a Property Tab of a Account window in Talisma. For example, you can update the fee details of a school maintained as an Account in Talisma. You must send the Account ID, and the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the update operation. Method Signature
long UpdatePropertyTab(long accountID, PropertyInfo[] propData, out string error)
Input Parameter accountID propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This value must be set to -1. relJoinID (long) - The ID of the related Objects display Property. Data Type long PropertyInfo[] Description A unique ID used to identify an Account in Talisma. This is an array of the PropertyInfo[] structure that contains the details of Properties in a Property Tab of an Account, which you want to update. The value of the propData array is blank if no Property values are available in the Property Tab of the Account.
Input Parameter error Data Type string Description The error message(s) returned when the update operation fails.
92
UpdateRLTab
You can use the UpdateRLTab method to add, delete, or update the Property values of an Account, available in the RecordList Tab of Talisma. For example, you want to update details of students maintained as a RecordList Tab in the Account window. You would use the UpdateRLTab method to update the details. You must send the Account ID, and the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the update operation. To delete rows from the RecordList Tab of the Account, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array. Method Signature
long UpdateRLTab(long accountID, long tabID, PropertyInfo[] propData, int[] deleteRows, out string error)
Input Parameter account ID Data Type long Description The ID of the Account for which you want to update the values in the RecordList Tab of the Account. The ID of the RecordList Tab associated with the Account. This is an array of the PropertyInfo[] structure that contains the details of Properties in a RecordList Tab of an Account, which you want to update. The value of the propData array is blank if no Property values are available in the RecordList Tab of the Account.
tabID propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - The ID of the row in the RecordList Tab associated with an Account in which you want to update the Property values. relJoinID (long) - This value is not applicable.
long PropertyInfo[ ]
93
Input Parameter deleteRows
Data Type int[ ]
Description This is an array of row IDs you want to delete from the RecordList Tab of the specified Account. If you do not want to delete any rows, ensure that the deleteRows array is declared as a zero length array.
UpdateAttachmentTab
You can use the UpdateAttachmentTab method to update, or delete the attachment details of an Account available in the Attachment Tab of Talisma. For example, you can add information pertaining to a school as an attachment in the Attachment Tab of an Account. You must send the Account ID, and the attachment details that you want to add, or delete as input parameters to Talisma Account iService. Talisma Account iService processes the input values, and returns the status of the add, or delete operation. Method Signature
long UpdateAttachmentTab(long accountID, long tabId, ref AttachmentData[] attachments, out string error)
94
Input Parameter accountID Data Type long Description The ID of the Account for which you want to update or delete the attachment details available in the Attachment Tab of the Account. The ID of the Attachment Tab associated with the Account Object. An array of the AttachmentData[] structure. This array contains the name of the attachment, the comment about the attachment, the text content of the attachment, the boolean value to indicate if the attachment needs to be deleted, and the unique ID for the attachment.
tabId
long
attachments fileName (string) - Name of the attachment. comment (string) - The User comment that describes the attachment. fileBlob (string) - The text content of the attachment. deleteAttachment (bool) This value indicates whether the attachment should be deleted. You can use the following values: True - The attachment is deleted. False - The attachment is excluded from deletion.
AttachmentData[]
attachmentId (long) - A unique ID used to identify an attachment in Talisma. Set this value to -1 if you are adding a new attachment. dateModified (DateTime) - The date and time when the attachment was last modified.
95
Return Value error Data Type string Description The error message(s) returned when the update, or delete operation fails.
UpdateAttachmentTab Return Values The UpdateAttachmentTab method returns 0 if the operation is successful, and a negative value if the operation fails.
96
Talisma Interaction iService
Chapter 7:Talisma Interaction iService

This chapter describes the Talisma Interaction iService methods.
In this chapter
Overview................................................................................... GetPropertiesTab....................................................................... GetRLTab .................................................................................. GetLinkedTab ........................................................................... GetInteractionEvents ................................................................ UpdatePropertyTab ................................................................... UpdateRLTab ............................................................................ CreateInteraction....................................................................... DeleteInteraction....................................................................... AddMsgToInteraction ............................................................... AddCommentsToInteraction..................................................... DeleteInteractions ..................................................................... AddAttachments ....................................................................... GetAllInteractionEvents ........................................................... GetInteractionEvents2 .............................................................. GetMessageContent .................................................................. GetAllMessageContents ........................................................... SetInteractionPriority................................................................ SetInteractionState .................................................................... Assign ....................................................................................... Transfer ..................................................................................... GetAttachmentFile.................................................................... GetAssignToUserList................................................................ GetTransferToList..................................................................... GetInteractionInfo..................................................................... BeginReply ............................................................................... SaveReply ................................................................................. UpdateInteractionReadUnReadStatus....................................... SaveInteractionTrackingInfo .................................................... UnLockInteraction .................................................................... BuildForwardOrConsult ........................................................... BuildReply ................................................................................ CancelReply.............................................................................. DeleteReply .............................................................................. BuildSmsReply .........................................................................
97
Page 98 Page 110 Page 112 Page 114 Page 116 Page 120 Page 123 Page 124 Page 133 Page 134 Page 141 Page 142 Page 143 Page 147 Page 154 Page 162 Page 164 Page 167 Page 168 Page 170 Page 174 Page 176 Page 177 Page 178 Page 179 Page 185 Page 186 Page 195 Page 196 Page 197 Page 198 Page 215 Page 230 Page 231 Page 233
Overview
An Interaction is an exchange of messages between you and a Contact. An Interaction can contain a message from a Contact, a User's response to the Contact, or any action performed on messages. The Interaction records all these events. An Interaction is created when a Contact sends a message to a Talisma Alias, for example, info@anycompany.com. You can manually create an Interaction when a Contact conveys a message by phone, fax, postal mail, in a Chat session, or in person. As messages are exchanged between a Talisma User and a Contact, Talisma Server adds these messages to the existing Interaction. Talisma Interaction iService exposes various methods as Web Services to enable an external application to interact with Talisma to manage Interactions. For example, you may use the Interaction Object to create and maintain your Interactions with the customers of your company. You can use Talisma Interaction iService methods to perform the following operations in Talisma from an external application: Create a new Interaction. Add a message to an existing Interaction. Add Comments to an existing Interaction. Retrieve Property values available in the Properties, RecordList, and Linked Tabs of an existing Interaction. Retrieve events from the Conversation pane of an existing Interaction. Update Property values available in the Property Tab of an existing Interaction. Update, and delete Property values available in the RecordList Tab of an existing Interaction. Delete a single Interaction, or delete multiple Interactions. Add attachment(s) to a message. Retrieve the details of all events associated with an Interaction. If an event includes attachments, this method also retrieves the details of attachments. Retrieve the event headers of all the events associated with an Interaction. Retrieve the contents of a message associated with an Interaction along with any attachment(s) included in a message. Retrieve the contents of all the messages associated with an Interaction along with the attachment(s). Set the priority of an Interaction to High. Set the state of an Interaction to Open or Resolved. Assign an Interaction to a User in Talisma. Transfer an Interaction to a User in Talisma. Retrieve an attachment associated with a message. Retrieve the list of Users to whom you can assign an Interaction.
98
Retrieve the list of Users to whom you can transfer an Interaction. Retrieve the details of an Interaction. Begin an appropriate action on the Interaction. For example, begin a reply. Save a message that you want to send at a later time. Mark the status of an Interaction as Read or Unread. Track the time spent on an Interaction. Unlock an Interaction, or a message associated with an Interaction. Compose a message you want to forward to other Users, or send to a Specialist. Compose a reply to a message associated with an Interaction. Cancel a reply composed for an Interaction. Delete a message associated with an Interaction. Compose an SMS reply message for an Interaction.
The following table describes the various Talisma Interaction iService methods:
Method GetPropertiesTab Description Gets the Property values available in the Property Tab of an Interaction in Talisma. You must send the Interaction ID, and the Property Tab ID of the Interaction as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the Property values if the get operation is successful. Gets the Property values available in the RecordList Tab of an Interaction in Talisma. You must send the Interaction ID, and the RecordList Tab ID of the Interaction as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the Property values if the get operation is successful. GetLinkedTab Gets the Property values available in the Linked Tab of an Interaction in Talisma. You must send the Interaction ID, and the Linked Tab ID of the Interaction as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input, and returns the Property values if the get operation is successful. Retrieves the details of events associated with an Interaction, from the database. You must send the Interaction ID, and the order in which you want to retrieve the events, as input parameters to the Talisma Interaction iService. The events are retrieved in chronological, or reverse chronological order based on the specification. Talisma Interaction iService processes the input, and retrieves all the events from the database, if the get operation is successful. UpdatePropertyTab Updates the Property values available across Property Tabs of an Interaction. You must send the Interaction ID, and the PropertInfo[] structure that contains the new Property values, as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input, and returns the status of the update operation.
GetRLTab
GetInteractionEvents
99
Method UpdateRLTab
Description Updates, or deletes the Property values of an Interaction available in the RecordList Tab of Talisma. You must send the Interaction ID, RecordList Tab ID, and the PropertInfo[] structure that contains the new Property values as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input parameters, and returns the status of the update operation. To delete rows from the RecordList Tab of the Interaction, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array.
100
Method CreateInteraction
Description Creates a new Interaction in Talisma. You must send the following values as input parameters to the Talisma Interaction iService: The ID of the Contact for which you want to create the Interaction. The phone number of the Contact. For Interactions based on the Phone medium, the date and time when the Contacts phone call was received. The ID of the Medium used for the Interaction. Direction of the Interaction. Specify 0 for this parameter if you have initiated the Interaction. The direction for the Interaction will be set as Outgoing. Any other numeric value will indicate that the Contact initiated the Interaction. The direction for the Interaction will be set to Incoming in Talisma. The ID of the e-mail Alias associated with the Interaction. An Alias is an e-mail address of your organization. It is an e-mail address, such as info@talisma.com or support@talisma.com. Aliases can be associated with specific Teams within your organization. Email messages sent to a Team or Users in a Team are received by the associated Alias, and then routed to that Team or User. The ID of the Team in Talisma to which the Interaction must be assigned. The PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Interaction. The text of your Interaction. The message exchanged with the Contact. The subject of the Interaction The ID of the User creating the Interaction. You can specify your User ID, or the User ID of another User. The ID of the User to whom the Interaction must be assigned. The ID of the e-mail Alias associated with the Interaction. The priority of the Interaction. The resolved parameter to specify whether the Interaction state must be set to resolved. The details of file(s) that must be inserted as attachments to the Interaction.
Talisma Interaction iService processes the input values, and returns the ID of the Interaction created in Talisma. DeleteInteraction Deletes an existing Interaction from Talisma. You must send the ID of the Interaction you want to delete, as an input parameter to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the status of the delete operation. You must send the deleteRelatedObjects parameter of the DeleteInteraction method to delete all Object items related to the Interaction. The value of this parameter must be set to True to delete all related Object items. Set this value to False if you do not want to delete related Object items. 101
Method AddMsgToInteraction
Description Adds the specified message to an existing Interaction in Talisma. You must send the following values as input parameters to the Talisma Interaction iService: Interaction ID. The ID of the Contact associated with the Interaction. The phone number of the Contact. For Interactions based on the Phone medium, the date and time when the Contacts phone call was received. The ID of the Medium used for the Interaction. Direction of the Interaction. Specify 0 for this parameter if you have initiated the Interaction. The direction for the Interaction will be set as Outgoing. Any other numeric value will indicate that the Contact initiated the Interaction. The direction for the Interaction will be set to Incoming in Talisma. The ID of the e-mail Alias associated with the Interaction. An Alias is an e-mail address of your organization. It is an e-mail address, such as info@talisma.com or support@talisma.com. Aliases can be associated with specific Teams within your organization. Email messages sent to a Team or Users in a Team are received by the associated Alias, and then routed to that Team or User The text of your Interaction. The message exchanged with the Contact. The ID of the User who is adding the message to the Interaction. You can specify your User ID, or the User ID of another User. The ID of the User to whom the Interaction must be assigned. The ID of the alias associated with the Interaction. The priority of the Interaction. The resolved parameter to specify whether the Interaction state must be set to resolved.
Talisma Interaction iService processes the input values, and returns the status of the operation. The specified message is added to the Interaction if the operation is successful. AddCommentsToInter action Adds a comment to an existing Interaction in Talisma. When you add a comment to an Interaction in Talisma, a new event is created for the Interaction. You must send the Interaction ID, and the comment string as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the ID of the event created for the Interaction, if the specified comment is successfully added. The AddCommentsToInteraction method also returns the status of the operation.
102
Method DeleteInteractions
Description Deletes multiple Interactions from Talisma. You must send the IDs of the Interactions you want to delete as input parameters to Talisma Interaction iService. You must send the deleteRelatedObjects parameter of the DeleteInteractions method to delete all Object items related to the Interactions. The value of this parameter must be set to True to delete all related Object items. Set this value to False if you do not want to delete related Object items. Talisma Interaction iService processes the input values, and returns the status of the delete operation.
AddAttachments
Enables you to attach multiple attachments to a message in an Interaction. You must send the following values as input parameters to Talisma Interaction iService: The ID of the event associated with adding attachment(s) in the Interaction. The InteractionAttachmentData[] structure that contains the details of file(s) you want to insert as attachment(s) in the message. The includeInTransaction parameter of the AddAttachments method to perform the attach operation in a transaction. The value of this parameter must be set to True to perform the attach operation in a transaction. Set this value to False if you do not want to perform the attach operation in a transaction.
Talisma Interaction iService processes the input values, and returns the status of the add operation. GetAllInteractionEvent s Retrieves the details of all events associated with an Interaction along with attachments. You must send the Interaction ID, and the order in which you want to retrieve the events, as input parameters to Talisma Interaction iService. The events are retrieved in chronological, or reverse chronological order based on the specification. Talisma Interaction iService processes the input values, and retrieves all events associated with the Interaction. If there are any attachments in an event, the method also returns the details of the attachment. GetInteractionEvents2 Retrieves the event headers of all events associated with an Interaction. You must send the Interaction ID, and the EventRetrivingOptions[] structure as input parameters to Talisma Interaction iService. The events are retrieved in chronological, or reverse chronological order based on the specification. Talisma Interaction iService processes the input values, and retrieves the event headers of all the events in the Interaction. GetMessageContent Retrieves the contents of a message. You must send the ID of the message for which you want to retrieve the message contents as input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the contents of the message along with other details of the message.
103
Method GetAllMessageContent s
Description Retrieves the contents of all messages in an Interaction. You must send the ID of the Interaction for which you want to retrieve message contents as input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the contents of all messages in the Interaction along with other details of the message.
SetInteractionPriority
Sets the priority of an Interaction to High in Talisma. You must send the ID of the Interaction for which you want to change the priority, and the priority parameter with the value set to High as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the status of the operation.
SetInteractionState
Sets the state of an Interaction manually in Talisma. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction for which you want to set the Interaction state. The state to which you want to set the Interaction. The comments to be inserted when the state of the Interaction is changed. The force parameter of the SetInteractionState method to specify whether the state of the Interaction must be changed irrespective of any Permissions required for the operation, or any other constraints.
Talisma Interaction iService processes the input values, and returns the following values: The ID of the User who is the owner of the Interaction. The name of the User. The status of the set operation.
104
Method Assign
Description Assigns an Interaction to a User in Talisma. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction which you want to assign to another User. The ID of the User to whom you want to assign the Interaction. The ID of the User who is the current owner of the Interaction. The comments to be inserted when the Interaction is assigned to the specified User. The force parameter of the Assign method to check whether the Interaction must be assigned irrespective of whether the User is the owner of the Interaction. The checkDeletedStatus parameter of the Assign method to check whether the Interaction you want to assign to another User has been deleted from Talisma. The checkClosedStatus parameter of the Assign method to check whether the state of the specified Interaction is set to Closed. The addEvent parameter of the Assign method to add the assign operation as an event of the Interaction. The checkExpiredStatus parameter of the Assign method to check whether the state of the specified Interaction is set to Expired. The checkUndeliveredStatus parameter of the Assign method to check whether the Interaction was created because of an undelivered Interaction.
Talisma Interaction iService processes the input values, and returns the following: Transfer The name of the User to whom the Interaction is assigned. The ID of the event associated with the assign operation. The status of the assign operation.
Transfers an Interaction to a User in Talisma. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction you want to transfer to another User. The ID of the Team to which you want to transfer the Interaction. The ID of the User in the specified Team to whom you want to transfer the Interaction. The transferIfNotOwner parameter of the Transfer method to transfer even if the operation is not performed by owner of the Interaction.
Talisma Interaction iService processes the input values, and returns the ID, and the name of the User to whom the Interaction is transferred. GetAttachmentFile Retrieves a file that is inserted as an attachment in a message. You must send the ID of the attachment which you want to retrieve as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the attachment.
105
Method GetAssignToUserList
Description Retrieves the list of Users to whom you can assign an Interaction. You must send the following values as input parameters to the Talisma Interaction iService: The getUsersBasedOnPermissions parameter which retrieves the User list based on permissions. The ID of the Interaction for which you want to retrieve the list of Users to whom the Interaction can be assigned. The ID of the Team to which the Interactions belongs.
Talisma Interaction iService processes the input values, and returns the list of Users to whom you can assign the Interaction. GetTransferToList Retrieves the list of Users to whom you can transfer an Interaction. You must send the ID of the Interaction for which you want to retrieve the list of Users to whom the Interaction can be transferred. Talisma Interaction iService processes the input value, and returns the list of Users to whom you can transfer the Interaction. GetInteractionInfo Retrieves the details of an Interaction. You must send the InteractionInfo[] structure with only the ID of the required Interaction as the input parameter to Talisma Interaction iService. The values for the remaining variables of the InteractionInfo[] structure must be set to NULL. Talisma Interaction iService processes the input value, and returns the details of the Interaction. BeginReply Enables you to carry out all the prerequisite operations before you can reply to an Interaction. You must send the ID of the required Interaction as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the following: The ID of the User who is the owner of the Interaction. The ID of the event associated with the Reply. The ID of the message to which you are replying. The ID created for the Reply.
106
Method SaveReply
Description Saves a message that you want to send at a later time. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction in which you want to save the message. The ReplyMessage[] structure that contains the details of the message you want to save. The ReplyAddresses[] structure that contains the email address(es) of the recipient(s) of the message you want to save. The send parameter of the SaveReply method to specify whether the message must be sent when you save it. The ID of the message you want to save. The ID of the event associated with the save operation. The unlock parameter of the SaveReply method to specify whether you want to acquire the lock on the message, if the message is being worked upon by another User. The resolve parameter of the SaveReply method to specify whether the Interaction must be resolved when you send the message. The ID of the email Alias associated with the Team to which the Interaction belongs. The addTalismaSignature parameter of the SaveReply method to specify whether the signature configured for the User account in Talisma must be automatically added to the message you want to save. The operationType parameter of the SaveReply method to specify whether the message you want to save must be sent to a specialist, or must be forwarded to another User. The language ID associated with the message you want to save. The reviewReply parameter of the SaveReply method to specify whether you want to send the message for review to other Talisma Users in the same Team. The ID(s) of the Canned Respons(es) you want to insert in the message. The name of the SMS extractor if the message is an SMS message. The ID of the SMS extractor if the message is an SMS message.
Talisma Interaction iService processes the input values, and saves the message. If you have set the value of the send parameter to True, Talisma Interaction iService also sends the message as part of the save operation. UpdateInteractionRead UnReadStatus Marks the status of the required Interactions as Read or Unread. You must send the IDs of the Interactions which you want to mark as Read, and the IDs of the Interactions which you want to mark as Unread as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and updates the status of the specified Interactions.
107
Method SaveInteractionTracki ngInfo
Description Enables you to track the time spent on an Interaction. You must send the ArrayList parameter that contains the list of strings for tracking as the input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input values, and the time spent on an Interaction is saved.
UnLockInteraction
Unlocks an Interaction, or a message that is saved in the Outbox. You must send the ID of the Interaction, or the ID of the message in the Outbox which you want to unlock as input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and the Interaction or the outgoing message is unlocked for use by other Users.
BuildForwardOrConsu lt
Enables you to build a message to forward an Interaction or to consult a specialist on an Interaction. You must send the following values as input parameters to Talisma Interaction iService: The ID of the User who writes the Consult or Forward message. The ID of the Interaction which you want to Consult or Forward. The operation that you want to perform, Consult or Forward. The cached information of the ReplyInfo[] structure of the team to which the Interaction belongs.
Talisma Interaction iService processes the input values, and returns the Interaction that you can Forward or Consult a Specialist on along with other details of the Interaction such as total number of events in the Interaction, Interaction details, attachment details, etc. BuildReply Enables you to retrieve all the details of the Interaction, such as, the attachments included in the Interaction, the number of events in the Interaction, when you want to forward an Interaction, or send an Interaction to a specialist. You must send the following values as input parameters to Talisma Interaction iService: The ID of the logged in User. The ID of the Interaction to which you want to reply. The cached information of the ReplyInfo[] structure of the Team to which the Interaction belongs.
Talisma Interaction iService processes the input values, and returns the ID of the Team to which the Interaction belongs, ID of the event associated with the reply, details of the reply message, Interaction details, etc. CancelReply Enables you to cancel a reply message. You must send the ID of the Interaction in which you are replying, and the ID of the Team to which the Interaction belongs as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the name of the current owner of the Interaction, outgoing message ID created for the reply operation, and the status of the cancel operation.
108
Method DeleteReply
Description Deletes a reply message that you have saved. You must send the ID of the Interaction associated with the reply as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the User name of the current owner of the Interaction, and status of the delete operation.
BuildSmsReply
You can use the BuildSmsReply method to compose an SMS reply message for an Interaction. You must send the following values as input parameters to Talisma Interaction iService: The ID of the User. The ID of the Interaction for which you want to compose an SMS reply message. The cached information of the ReplyInfo structure of the Team to which the Interaction belongs.
Talisma Interaction iService processes the input values, and returns the reply SMS message along with other details such as the extractor and dispatcher used for the SMS reply.
109
GetPropertiesTab
You can use the GetPropertiesTab method to get the Property values of an Interaction available in a Property Tab of the Interaction window in Talisma. For example, you want to obtain the details such as Last Opened, and Interaction State of an Interaction. To get this information from Talisma, you would use the GetPropertiesTab method. You must send the Interaction ID, and the ID of the Property Tab of the Interaction as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetPropertiesTab(long interactionId, long tabId, int getPropInfoOrPropXml, out PropertyInfo[] propData, out string propXml, out string error)
Input Parameter interactionId Data Type long Description The ID of the Interaction for which you want to retrieve the values from a Property Tab of the Interaction. The ID of a Property Tab associated with the Interaction Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1- Specify this value to obtain the output in XML format in the propXml output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the propXml output parameter.
tabId
long
getPropInfoOrPropXml
int
110
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This variable returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string Data Type PropertyInfo[] Description This is an array of PropertyInfo[] structure that contains the Property values retrieved from a Property Tab of the specified Interaction. The value of the propData array is NULL if no Property values are available in the specified Property Tab of the Interaction.
propXml
This parameter contains the output in XML format. The value of the propXml parameter is NULL if no Property values are available in the specified Property Tab of the Interaction.
error
string
Note
Using the GetPropertiesTab method, you cannot retrieve the values of hidden Properties from a Property Tab of an Interaction in Talisma.
111
GetRLTab
You can use the GetRLTab method to get the Property values of an Interaction available in the RecordList Tab of Talisma. You must send the Interaction ID, and the RecordList Tab ID of the Interaction as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input, and returns Property values if the get operation is successful. Method Signature
long GetRLTab(int interactionId, int tabId, int getPropInfoOrPropXml, out PropertyInfo[] propData, out string propXml, out string error)
Input Parameter interactionId Data Type int Description The ID of the Interaction for which you want to retrieve the values from the RecordList Tab of the Interaction. The ID of the RecordList Tab associated with the Interaction Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1- Specify this value to obtain the output in XML format in the propXml output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the propXml output parameter.
tabId
int
int
112
GetRLTab Output Parameters The following table describes the output parameters for the GetRLTab method:
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - The ID of the row in the RecordList Tab of the specified Interaction that contains the Property values. relJoinID (long) - This is not applicable for a RecordList Tab. string This parameter contains the output in XML format. The value of the propXml parameter is NULL if no Property values are available in the RecordList Tab of the Interaction. error string The error message(s) returned when the get operation fails. Data Type PropertyInfo[] Description This is an array of the PropertyInfo[] structure that contains the Property values retrieved from the RecordList Tab of the specified Interaction. The value of the propData array is NULL if no Property values are available in the RecordList Tab of the Interaction.
propXml
GetRLTab Return Values The GetRLTab method returns 0 if the get operation is successful, and a negative value if the operation fails.
113
GetLinkedTab
You can use the GetLinkedTab method to get the Property values of an Interaction available in the Linked Tab of Talisma. You must send the Interaction ID, and the Linked Tab ID of the Interaction as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input, and returns Property values if the get operation is successful. Method Signature
long GetLinkedTab(int interactionId, int tabId, int getPropInfoOrPropXml, out PropertyInfo[] propData, out string propXml, out string error)
Input Parameter interactionId Data Type int Description The ID of the Interaction for which you want to retrieve the values from the Linked Tab of the Interaction. The ID of the Linked Tab associated with the Interaction Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo[] structure. 1- Specify this value to obtain the output in XML format in the propXml output parameter. 2 - Specify this value to obtain the output in the PropertyInfo[] structure, and in XML format in the propXml output parameter.
tabId
int
int
114
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This member returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string This parameter contains the output in XML format. The value of the propXml parameter is NULL if no Property values are available in the Linked Tab of the Interaction. error string The error message(s) returned when the get operation fails. Data Type PropertyInfo[] Description This is an array of the PropertyInfo[] structure that contains the Property values retrieved from the Linked Tab of the specified Interaction. The value of the propData array is NULL if no Property values are available in the Linked Tab of the Interaction.
propXml
GetLinkedTab Return Values The GetLinkedTab method returns 0 if the get operation is successful, and a negative value if the operation fails.
Note
The GetLinkedTab method returns NULL if no Property values are available in the Linked Tab of the Interaction.
115
GetInteractionEvents
You can use the GetInteractionEvents method to retrieve the details of events associated with an Interaction. The event details associated with an Interaction are retrieved from the database. For example, you want to view the events associated with the Interaction with Contact Cathy, who has been regularly communicating with the Insurance Agents in your company for her Insurance needs. You can use the GetInteractionEvents method to retrieve the events related to Cathys Interaction from the database. You must send the Interaction ID, and the order in which you want to retrieve the events, as input parameters to the Talisma Interaction iService. The events are retrieved in chronological, or reverse chronological order based on the specification. Talisma Interaction iService processes the input, and retrieves all the events from the database if the get operation is successful. Method Signature
long GetInteractionEvents(long interactionId, bool eventsOrder, int getPropInfoOrPropXml, out Talisma.Server.Common.ActivityInfo[] activityData, out string activityInfoXml, out int totalEventsCount, out string error)
GetInteractionEvents Input Parameters The following table describes the input parameters for the GetInteractionEvents method:
Input Parameter interactionId Data Type long Description The ID of the Interaction for which you want to retrieve the events from the database. The order in which the events must be retrieved. Specify one of the following values: TRUE - Specify this value if the initial event of the Interaction must be retrieved first. FALSE - Specify this value if the latest event of the Interaction must be retrieved first.
eventsOrder
bool
116
Input Parameter getPropInfoOrPropXml
Data Type int
Description Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo structure. 1- Specify this value to obtain the output in XML format in the activityInfoXml output parameter. 2 - Specify this value to obtain the output in the PropertyInfo structure, and in XML format in the activityInfoXml output parameter.
117
GetInteractionEvents Output Parameters The following table describes the output parameters for the GetInteractionEvents method:
Return Value activityData The members of the ActivityInfo[] structure are: eventID (int) - A unique ID associated with an event in Talisma. eventType (int) - A unique ID associated with an event type in Talisma. from (string) - If a message is received or sent, this is the name of the person who has sent the message. to (string) - If a message is sent or received, this is the name of the person who has received the message. originatorID (int) - The ID of the Contact, User, or System, depending on the activity in the Event. For example, if the Interaction was created after a message was received from a Contact, this method returns the ID of the Contact. This parameter returns the value 1, if the event was originated by the Talisma system. Data Type ActivityInfo[] Description This is an array of the ActivityInfo[] structure that contains the event details of the specified Interaction.
118
Return Value beforeID (int) - This parameter returns the ID of the Previous owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction was assigned to another User, this parameter returns the ID of the User who assigned the Interaction. afterID (int) - This parameter returns the ID of the current owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction is assigned to a User, this field returns the ID of the User to whom the Interaction is assigned. byRule (int) - The name of the Rule that triggered the event. mediaID (int) - The ID of the Medium used for the Interaction in Talisma. date (DateTime) - The date and time when an event occurred. direction (int) - The direction of the Interaction. 0 - indicates that the Interaction was initiated by a User in Talisma. Any other numeric value - indicates that the Interaction was initiated by a Contact.
Data Type
Description
activityInfoXml totalEventsCount
string int
This parameter contains the output in XML format. The total number of events associated with the Interaction. 119
Return Value error
Data Type string
Description The error message(s) returned when the get operation fails.
GetInteractionEvents Return Values The GetInteractionEvents method returns 0 if the get operation is successful, and a negative value if the operation fails.
Note
You can use the GetAllInteractionEvents method if you also want to retrieve the attachments associated with an event, and the total number of events in an Interaction.
UpdatePropertyTab
You can use the UpdatePropertyTab method to update the Property values of an Interaction available in a Property Tab of the Interaction window in Talisma. For example, you may want to update details such as the Order ID in the Interaction window. In this scenario, you would use the UpdatePropertyTab method. You must send the Interaction ID, and the PropertyInfo[] structure that contains the new Property values, as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input, and returns the status of the update operation. Method Signature
long UpdatePropertyTab(int interactionId, PropertyInfo[] propData, updateReadOnly, bool ignoreMandatoryCheck, out string error) bool
120
Input Parameter interactionId Data Type int Description The ID of the Interaction for which you want to update the values in a Property Tab associated with the Interaction. This is an array of the PropertyInfo[] structure that contains the details of Properties in a Property Tab of an Interaction, which you want to update. The value of the propData array is blank if no Property values are available in the Property Tab of the Interaction.
propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - The value of this variable must be set to -1. relJoinID (long) This is the ID of the related Objects display Property, and is applicable only if the Property you want to update is a relationship Property. In all other cases, specify -1 for this variable. updateReadOnly
PropertyInfo[]
bool
If read only Properties are included in the PropertyInfo[] structure, this parameter enables you to specify whether the read only properties must be updated in the specified Property Tab of the Interaction. Specify one of the following values: TRUE - To update the read only Properties. FALSE - To ignore read only Properties.
121
Input Parameter ignoreMandatoryCheck
Data Type bool
Description Enables you to specify whether the method must check for unfilled mandatory properties. Specify one of the following values: TRUE - Indicates that the method must check for unfilled mandatory properties. If there are any unfilled mandatory properties, the update operation fails. FALSE Unfilled mandatory Properties will be ignored.
Note
Using the UpdatePropertyTab method, you cannot update the values of hidden Properties in a Property Tab of an Interaction in Talisma. UpdatePropertyTab Return Values The UpdatePropertyTab method returns 0 if the operation is successful, and a negative value if the operation fails.
122
UpdateRLTab
You can use the UpdateRLTab method to update Property values in a RecordList Tab of an Interaction, and delete a row from the RecordList Tab in Talisma. For example, consider a scenario where you want to update the details of the insurance premium amount paid by a Contact associated with each Interaction, maintained in the RecordList Tab of the Interaction Object. You would use the UpdateRLTab method to update the Property values in the RecordList Tab. You must send the Interaction ID, RecordList Tab ID, and the PropertInfo[] structure that contains the new Property values as input parameters to the Talisma Interaction iService. Talisma Interaction iService processes the input parameters, and returns the status of the update operation. To delete rows from the RecordList Tab of the Interaction, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array. Method Signature
long UpdateRLTab(long interactionId, int tabId, PropertyInfo[] propData, int[] deleteRowsList, out string error)
Input Parameter interactionId Data Type long Description The ID of the Interaction for which you want to update the Property values in the RecordList Tab associated with the Interaction. The ID of the RecordList Tab associated with the Interaction. This is an array of PropertyInfo[] structure contains the details Properties in a RecordList of an Interaction, which want to update. the that of Tab you
tabId propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - The ID of the row in the RecordList Tab associated with an Interaction in which you want to update the Property values. relJoinID (long) - This is not applicable for a RecordList Tab.
int PropertyInfo[]
The value of the propData array is blank if no Property values are available in the RecordList Tab of the Interaction.
123
Input Parameter deleteRowsList
Data Type int[]
Description This is an array of row IDs you want to delete from the RecordList Tab of the specified Interaction. If you do not want to delete any rows, ensure that the deleteRows array is declared as a zero length array.
UpdateRLTab Return Values The UpdateRLTab method returns 0 if the update operation is successful, and a negative value if the operation fails.
CreateInteraction
You can use the CreateInteraction method to create a new Interaction in Talisma. Consider a scenario where you receive an e-mail message from a Contact, Cathy, asking about the insurance policies offered by your company. In this scenario, you can create an Interaction for Cathy in Talisma, and assign the Interaction to the members in the Insurance Division. The Insurance Division is a Team in Talisma. You must send the following values as input parameters to the Talisma Interaction iService: The ID of the Contact for which you want to create the Interaction. The phone number of the Contact. For Interactions based on the Phone medium, the date and time when the Contacts phone call was received. The ID of the Medium used for the Interaction. Direction of the Interaction. Specify 0 for this parameter if you have initiated the Interaction. The direction for the Interaction will be set as Outgoing. Any other numeric value will indicate that the Contact initiated the Interaction. The direction for the Interaction will be set to Incoming in Talisma.
124
The ID of the e-mail Alias associated with the Interaction. An Alias is an e-mail address of your organization. It is an e-mail address, such as info@talisma.com or support@talisma.com. Aliases can be associated with specific Teams within your organization. Email messages sent to a Team or Users in a Team are received by the associated Alias, and then routed to that Team or User. The ID of the Team in Talisma to which the Interaction must be assigned. The PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Interaction. The text of your Interaction. The message exchanged with the Contact. The subject of the Interaction The ID of the User creating the Interaction. You can specify your User ID, or the User ID of another User. The ID of the User to whom the Interaction must be assigned. The ID of the e-mail Alias associated with the Interaction. The priority of the Interaction. The resolved parameter to specify whether the Interaction state must be set to resolved. The details of file(s) that must be inserted as attachments to the Interaction.
Talisma Interaction iService processes the input values, and returns the ID of the Interaction created in Talisma if the create operation is successful. Method Signature
long CreateInteraction(long contactId, string phone, DateTime receivedAt, int receivedByUserId, int mediaId, int direction, string subject, int teamId, int assigntouserId, int aliasId, int priority, int resolved, string contactMsg, string userMsg, InteractionAttachmentData[] IntrnAttachData, PropertyInfo[] propData, out long interactionId, out long evtId, out string error, bool updateReadOnly, bool ignoreMandatoryCheck, out bool contactPreviouslyUnblocked)
125
CreateInteraction Input Parameters The following table describes the input parameters for the CreateInteraction method:
Input Parameter contactId Data Type long Description The unique ID of the Contact for which you want to create an Interaction. If you are creating an Interaction based on a conversation on phone with the Contact, specify the phone number of the Contact. The date and time when the Contacts call was received in Talisma. The ID of the User creating the Interaction, or the ID of the User on behalf of whom the Interaction is being created. Specify one of the following values: 0 - To indicate that the Interaction is created by you. Any other User ID - To indicate that the Interaction is created by you on behalf of the User whose User ID is specified.
phone
string
receivedAt
DateTime
receivedByUserId
int
mediaId
int
A unique ID used to identify the Medium used in Talisma to interact with Contacts. The direction Interaction. of the
direction
int
If the Interaction is initiated by you, set the value of this parameter to 0. The direction of the Interaction will be set to Outgoing in Talisma. Any other numeric value indicates that the Interaction is initiated by the Contact. The direction of the Interaction will be set to Incoming in Talisma.
126
Input Parameter subject teamId
Data Type string int
Description The subject Interaction. of the new
The ID of the Team in Talisma to which you want to assign the new Interaction. The ID of the User to whom the newly created Interaction must be assigned. A unique ID used to identify an e-mail Alias in Talisma. The priority you want to set for the Interaction. You can specify one of the following values: 1 - Specify this value to set the priority of the Interaction to Normal. 2 - Specify this value to set the priority of the Interaction to High.
assigntouserId
int
aliasId priority
int int
resolved
int
Specify whether the Interaction state must be set to Resolved. You can specify one of the following values: 0 - Specify this value to set the Interaction state to Open. 1 - Specify this value to set the Interaction state to Resolved.
contactMsg userMsg
string string
The message exchanged with the Contact. The text of your Interaction.
127
Input Parameter IntrnAttachData eventId (int) - The ID of the event associated with the create Interaction operation. attachmentId (int) - The ID of the attachment you want to insert to the Interaction. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the inline attachment if you are adding an attachment inline. size (int) - The size of the file you want to add as an attachment. byte[] fileBlob - The contents of the file you want to attach. isNewAttachment (bool) Whether the attachment you want to add is a new attachment. You can specify one of the following values: True - Specify this value if the attachment you want to add is new. False - Specify this value if the attachment you want to add is an existing file from the server.
Data Type InteractionAttachmentData[]
Description This is an array of the InteractionAttachmentData[] structure that contains the details of the attachment(s) in an Interaction.
128
Input Parameter copyAttachmentFromServe r (bool) - Whether the attachment you want to add must be copied from the server. You can add files that belong to other events by copying them from the server. You can specify one of the following values: True - Specify this value if the file you want to add as an attachment must be copied from the server. False - Specify this value if the file you want to add as an attachment must not be copied from the server.
Data Type
Description
retainAttachment (bool) Whether you want to retain an attachment. You can specify one of the following values: True - Specify this value if you want to retain the attachment ID and attachment content. False - Specify this value if you do not want to retain the attachment ID and attachment content.
deleteAttachment (bool) Whether you want to delete an attachment. You can specify one of the following values: True - Specify this value if you want to delete the attachment. False - Specify this value if you do not want to delete the attachment.
129
Input Parameter editAttachment (bool) Whether you want to edit the attachment you are adding. You can specify one of the following values: True - Specify this value if you want to edit the attachment. False - Specify this value if you do not want to edit the attachment.
Data Type
Description
propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This must be set to -1. relJoinID (long) - This is the ID of the related Object's display Property, and is applicable only if the Property you want to set is a relationship Property. In all other cases, specify -1 for this variable.
PropertyInfo[]
This is an array of the PropertyInfo[] structure that contains the details of Property values you want to set for the newly created Interaction, in a Property Tab associated with the Interaction. Note Ensure that the propData array is declared as a zero length array if you do not want to set Property values for the Interaction.
updateReadOnly
bool
If read only Properties are included in the PropertyInfo[] structure, this parameter enables you to specify whether the read only properties must be updated in the specified Property Tab of the Interaction. Specify one of the following values: TRUE - To update the read only Properties. FALSE - To ignore read only Properties.
130
Input Parameter ignoreMandatoryCheck
Data Type bool
Description Enables you to specify whether the method must check for unfilled mandatory properties. Specify one of the following values: TRUE - Indicates that the method must check for unfilled mandatory properties. If there are any unfilled mandatory properties, the create operation fails. FALSE Unfilled mandatory Properties will be ignored.
CreateInteraction Output Parameters The following table describes the output parameters for the CreateInteraction method:
Return Value interactionId Data Type long Description The unique ID assigned to the new Interaction created in Talisma. This parameter returns -1 if the create operation fails. evtId long The ID of the event that is created as a result of the create Interaction operation. The error message(s) returned when the create operation fails.
error
string
131
Return Value contactPreviouslyUnblocked
Data Type bool
Description This parameter indicates whether the Block Contact email Property that was previously set to the value Yes for the Contact associated with the Interaction, has now been set to No as a result of the create Interaction operation. This parameter returns one of the following values: 0 - Indicates that the Block Contact e-mail Property was previously set to the value No for the Contact, and the value has not been modified as a result of the create Interaction operation. 1 - Indicates that the Block Contact e-mail Property that was previously set to the value Yes for the Contact, has now been set to No as a result of the create Interaction operation.
CreateInteraction Method Return Values The CreateInteraction method returns 0 if the create operation is successful, and a negative value if the operation fails.
Note
The date and time for the Interaction are set based on the date and time settings of your computer. The User and Contact message text is sent in the form of HTML formatted text to Talisma. If the CreateInteraction operation fails due to unfilled mandatory Properties, the error parameter returns the following message: One or more Mandatory Properties are unfilled.21612,21613,21614.
132
DeleteInteraction
You can use the DeleteInteraction method to delete an existing Interaction in Talisma. For example, you can use the DeleteInteraction method to delete the Interaction with Contact Cathy who has claimed insurance from your company. You must send the Interaction ID as an input parameter to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the status of the delete operation. You must send the deleteRelatedObjects parameter of the DeleteInteraction method to delete all Object items associated with each Interaction whose IDs you have specified. The value of this parameter must be set to True to delete all Object items associated with each Interaction. Set this value to False if you do not want to delete the related Object items. Method Signature
long DeleteInteraction(long interactionId, bool deleteRelatedObjects, out string error)
DeleteInteraction Input Parameters The following table describes the input parameters for the DeleteInteraction method:
Input Parameter interactionId deleteRelatedObjects Data Type long bool Description The ID of the Interaction you want to delete. This value indicates whether the Object items related to the Interaction should also be deleted when the Interaction is deleted. You can use one of the following values: True - Object items related to the Interaction must be deleted. False - Object items related to the Interaction must be excluded from deletion.
DeleteInteraction Output Parameters The following table describes the output parameters for the DeleteInteraction method:
Return Value error Data Type string Description The error message(s) returned when the delete operation fails.
DeleteInteraction Return Values The DeleteInteraction method returns 0 if the delete operation is successful, and a negative value if the operation fails.
133
AddMsgToInteraction
You can use the AddMsgToInteraction method to add a specific message to an existing Interaction in Talisma. For example, you communicate with Contact Peter on the phone about his insurance premium amount details. You can add the communication exchanged with Peter as a message, to the Interaction created for Contact Peter. You must send the following values as input parameters to the Talisma Interaction iService: Interaction ID. The ID of the Contact associated with the Interaction. The phone number of the Contact. For Interactions based on the Phone medium, the date and time when the Contacts phone call was received. The ID of the Medium used for the Interaction. Direction of the Interaction. Specify 0 for this parameter if you have initiated the Interaction. The direction for the Interaction will be set as Outgoing. Any other numeric value will indicate that the Contact initiated the Interaction. The direction for the Interaction will be set to Incoming in Talisma. The ID of the e-mail Alias associated with the Interaction. An Alias is an e-mail address of your organization. It is an e-mail address, such as info@talisma.com or support@talisma.com. Aliases can be associated with specific Teams within your organization. Email messages sent to a Team or Users in a Team are received by the associated Alias, and then routed to that Team or User The text of your Interaction. The message exchanged with the Contact. The ID of the User who is adding the message to the Interaction. You can specify your User ID, or the User ID of another User. The ID of the User to whom the Interaction must be assigned. The ID of the alias associated with the Interaction. The priority of the Interaction. The resolved parameter to specify whether the Interaction state must be set to resolved.
Talisma Interaction iService processes the input values, and returns the status of the operation. The specified message is added to the Interaction if the operation is successful. Method Signature
long AddMsgToInteraction(long interactionId, long contactId, string phone, DateTime receivedAt,int receivedByUserId, int mediaId, int direction, string subject, int assigntouserId, int aliasId, int priority, int resolved, string contactMsg, string userMsg, InteractionAttachmentData[] IntrnAttachData, out long evtId, ref bool contactPreviouslyUnblocked, out string error)
134
AddMsgToInteraction Input Parameters The following table describes the input parameters for the AddMsgToInteraction method:
Input Parameter interactionId Data Type long Description The ID of the Interaction to which you want to add a message. The ID of the Contact associated with the Interaction to which you want to add a message. If you are adding a message to an Interaction based on a conversation on phone with the Contact, specify the phone number of the Contact. The date and time when the Contacts call was received in Talisma. The ID of the User who is adding the message to the Interaction, or the ID of the User on behalf of whom the message is being added. Specify one of the following values: 0 - To indicate that the message is added by you. Any other User ID - To indicate that the message is added by you on behalf of the User whose User ID is specified.
contactId
long
phone
string
receivedAt
DateTime
receivedByUserId
int
mediaId
int
A unique ID used to identify the Medium used to interact with the Contact in this Interaction.
135
Input Parameter direction
Data Type int
Description The direction Interaction. of the
If the Interaction is initiated by you, set the value of this parameter to 0. The direction of the Interaction will be set to Outgoing in Talisma. Any other numeric value indicates that the Interaction is initiated by the Contact. The direction of Interaction will be set to Incoming in Talisma.
subject assigntouserId
string int
The subject of the Interaction. The ID of the User to whom the Interaction must be assigned. The ID of the e-mail Alias associated with the Interaction. The priority you want to set for the Interaction. You can specify one of the following values: 1 - Specify this value to set the priority of the Interaction to Normal. 2 - Specify this value to set the priority of the Interaction to High.
aliasId priority
int int
resolved
int
Specify whether the Interaction state must be set to Resolved. You can specify one of the following values: 0 - Specify this value to set the Interaction state to Open. 1 - Specify this value to set the Interaction state to Resolved.
contactMsg userMsg
string string
The message exchanged with the Contact. The text of your Interaction with the Contact. 136
Input Parameter IntrnAttachData eventId (int) - The ID of the event associated with the add message to Interaction operation. attachmentId (int) - The ID of the attachment you want to insert to the Interaction. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the inline attachment if you are adding an attachment inline. size (int) - The size of the file you want to add as an attachment. byte[] fileBlob - The contents of the file you want to attach. isNewAttachment (bool) Whether the attachment you want to add is a new attachment. You can specify one of the following values: True - Specify this value if the attachment you want to add is new. False - Specify this value if the attachment you want to add is an existing file from the server.
Data Type InteractionAttachmentData[]
Description
137
Data Type
Description
138
Data Type
Description
AddMsgToInteraction Output Parameters The following table describes the output parameters for the AddMessageToInteraction method:
Return Value evtId Data Type long Description The ID of the event that is created as a result of the add message operation. This parameter indicates whether the Block Contact email Property that was previously set to the value Yes for the Contact associated with the Interaction, has now been set to No as a result of the add message operation. This parameter returns one of the following values: 0 - Indicates that the Block Contact e-mail Property was previously set to the value No for the Contact, and the value has not been modified as a result of the add message operation. 1 - Indicates that the Block Contact e-mail Property that was previously set to the value Yes for the Contact, has now been set to No as a result of the add message operation.
contactPreviouslyUnblocked
ref bool
error
string
The error message(s) returned when the operation fails. 139
AddMsgToInteraction Return Values The AddMsgToInteraction method returns 0 if the operation is successful, and a negative value if the operation fails.
Note
The date and time when the message is added to the Interaction are set based on the date and time settings of your computer. The User and Contact message text is sent in the form of HTML formatted text to Talisma.
140
AddCommentsToInteraction
Adds a comment to an existing Interaction in Talisma. When you add a comment to an Interaction in Talisma, a new event is created for the Interaction. You must send the Interaction ID, and the comment string to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the ID of the event created for the Interaction, if the specified comment is successfully added. The AddCommentsToInteraction method also returns the status of the operation. Method Signature
long AddCommentsToInteraction(long interactionId, string comment, out long eventId, out string error)
AddCommentsToInteraction Input Parameters The following table describes the input parameters for the AddCommentsToInteraction method:
Input Parameter interactionId Data Type long Description The ID of the Interaction to which you want to add a comment. The comment string.
comment
string
AddCommentsToInteraction Output Parameters The following table describes the output parameters for the AddCommentsToInteraction method:
Return Value eventId Data Type long Description The ID of the new event created for the Interaction in Talisma. The error message(s) returned when the operation fails.
error
string
AddCommentsToInteraction Return Values The AddCommentsToInteraction method returns 0 if the operation is successful, and a negative value if the operation fails.
141
DeleteInteractions
You can use the DeleteInteractions method to delete Interactions in Talisma. For example, you can use the DeleteInteractions method to delete the Interactions associated with a Contact. You must send the IDs of the Interactions that you want to delete as an input parameter to the Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the status of the delete operation. You must send the deleteRelatedObjects parameter of the DeleteInteractions method to delete all Object items associated with each Interaction whose IDs you have specified. The value of this parameter must be set to True to delete all Object items associated with each Interaction. Set this value to False if you do not want to delete the related Object items. Method Signature
long DeleteInteractions(string interactionIds, bool deleteRelatedObjects, out string error)
DeleteInteractions Input Parameters The following table describes the input parameters for the DeleteInteractions method:
Input Parameter interactionIds Data Type string Description Specify the IDs of the Interactions you want to delete. The Interaction IDs must be separated by comma. Specify whether the Object items associated with the Interactions should also be deleted when the specified Interactions are deleted. You can specify one of the following values: True - Specify this value if you want to delete the Object items associated with the specified Interactions. False - Specify this value if you do not want to delete the Object items associated with the specified Interactions.
deleteRelatedObjects
bool
142
DeleteInteractions Output Parameter The following table describes the output parameter for the DeleteInteractions method:
Return Value error Data Type string Description The error message(s) returned when the delete operation fails.
DeleteInteractions Return Values The DeleteInteractions method returns 0 if the delete operation is successful, and a negative value if the operation fails.
AddAttachments
You can use the AddAttachments method to attach multiple files in a message. Consider a scenario where you receive an e-mail message from Contact Cathy asking about the insurance policies offered by your company. In this scenario, you can attach your companys brochures in the reply message using the AddAttachments method. You must send the following values as input parameters to the Talisma Interaction iService: The ID of the event associated with adding attachment(s) in an Interaction. The InteractionAttachmentData[] structure that contains the details of file(s) you want to insert as attachment(s) in the message. The includeInTransaction parameter to perform the attach operation in a transaction. The value of this parameter must be set to True to perform the attach operation in a transaction. Set this value to False if you do not want to perform the attach operation in a transaction.
Talisma Interaction iService processes the input values, and returns the status of the add attachment operation. Method Signature
long AddAttachments(long eventId, InteractionAttachmentData[] attachmentCollection, bool includeInTransaction, out string error)
143
AddAttachments Input Parameters The following table describes the input parameters for the AddAttachments method:
Input Parameter eventId Data Type long Description The ID of the event associated with adding attachment(s) in an Interaction. This is an array of the InteractionAttachmentData[] structure that contains the details of the attachment(s) in an Interaction.
attachmentCollection eventId (int) - The ID of the event associated with the add attachment operation. attachmentId (int) - The ID of the file that is added as an attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the inline attachment if you are adding an attachment inline. size (int) - The size of the file you want to add as an attachment. byte[] fileBlob - The contents of the file you want to attach. isNewAttachment (bool) Whether the attachment you want to add is a new attachment. You can specify one of the following values: True - Specify this value if the attachment you want to add is new. False - Specify this value if the attachment you want to add is an existing file from the server.
InteractionAttachmentData[]
144
Data Type
Description
145
Data Type
Description
includeInTransaction
bool
Whether you want to perform the attach operation in a transaction. You can specify one of the following values: True - Specify this value if you want to perform the add attachments operation in a transaction. False - Specify this value if you do not want to perform the add attachments operation in a transaction.
AddAttachments Output Parameter The following table describes the output parameter for the AddAttachments method:
Return Value error Data Type string Description The error message(s) returned when the add attachments operation fails.
AddAttachments Method Return Values The AddAttachments method returns 0 if the add attachments operation is successful, and a negative value if the operation fails.
146
GetAllInteractionEvents
You can use the GetAllInteractionEvents method to retrieve the details of all the events associated with an Interaction. The GetAllInteractionEvents method is an enhancement to the GetInteractionEvents method of Talisma Interaction iService. In addition to the event details, the GetAllInteractionEvents method also enables you to retrieve the attachments in an event, and the total number of events associated with an Interaction. Consider a scenario where your supervisor has transferred Contact Cathys Interaction to you. You have been instructed to handle all further Interactions with Cathy. Cathy now sends you a query regarding her premium balance for the year. You can use the GetAllInteractionEvents method to retrieve the details of all the events associated with the Interactions with Cathy, and also the attachment(s) in her previous messages. The event details obtained will help you understand the previous communication with Cathy, and enable you to send an appropriate response. You must send the Interaction ID, and the order in which you want to retrieve the events, as input parameters to the Talisma Interaction iService. The events are retrieved in chronological, or reverse chronological order based on the specification. Talisma Interaction iService processes the input values, and returns the details of all the events associated with the Interaction. Method Signature
long GetAllInteractionEvents(int interactionId, bool eventsOrder, ref ActivityInfo[] activityData, ref AttachmentInfo[] attachmentInfo, out int totalEventsCount, out string error)
GetAllInteractionEvents Input Parameters The following table describes the input parameters for the GetAllInteractionEvents method:
Input Parameters interactionId Data Type int Description The ID of the Interaction for which you want to retrieve the events. The order in which you want to retrieve the events. You can specify one of the following values: True - Specify this value if you want to retrieve the events in reverse chronological order. False - Specify this value if you want to retrieve the events in chronological order.
eventsOrder
bool
147
GetAllInteractionEvents Output Parameters The following table describes the output parameters for the GetAllInteractionEvents method:
Return Value activityData eventId (int) - A unique ID associated with an event in Talisma. eventType (int) - A unique ID associated with an event type in Talisma. This parameter returns the ID of the event type. from (string) - If a message is received or sent, this is the name of the person who has sent the message. to (string) - If a message is received or sent, this is the name of the person who has received the message. cc (string) - If a message is received or sent, this is the name of the person to whom a copy of the message is sent. bcc (string) - If a message is received or sent, this is the name of the person to whom a blank carbon copy of the message is sent. originatorId (int) - The ID of the Contact, User, or system, depending on the activity in the event. For example, if the Interaction was created after a message was received from a Contact, this method returns the ID of the Contact. This parameter returns the value 1, if the event was originated by the Talisma system. Data Type ref ActivityInfo[] Description This is an array of the ActivityInfo[] structure that contains the event details of the specified Interaction.
148
Return Value beforeId (int) - The ID of the previous owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction was assigned to another User, this parameter returns the ID of the User who assigned the Interaction. afterId (int) - This parameter returns the ID of the current owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction is assigned to a User, this field returns the ID of the User to whom the Interaction is assigned. byRule (string) - The name of the Rule that triggered the event. mediaId (int) - The ID of the Medium associated with the event. eventDate (DateTime) Date and time when the event occurred. mailServerEventDate (DateTime) - If a message was sent or received, this is the mail server date and time when the relevant event occurred. direction (int) - The direction of the Interaction. 0 - Indicates that the Interaction was initiated by a User in Talisma. Any other numeric value - Indicates that the Interaction was initiated by a Contact.
Data Type
Description
149
Return Value isIncoming (int) - The value of this parameter indicates whether the Interaction is Incoming or Outgoing. 1 - This value indicates that the Interaction is Incoming. 0 - This value indicates that the Interaction is Outgoing.
Data Type
Description
hasAttachment (bool) This parameter indicates whether the event includes any attachments. True - This value indicates that the event includes attachments. False - This value indicates that the event does not include any attachments.
empty (bool) - This parameter indicates whether there is any message associated with the event. True - This value indicates that there is a message associated with the event. False - This value indicates that there is no message associated with the event.
For example, the value of this parameter is set to True if the event is associated with a reply sent to the Contact in an Interaction.
150
Return Value messageContent (MessageContent) - An array of the MessageContent structure that contains the details of the message, message content, and attachment(s) in the message. The following are the parameters of the MessageContent structure: interactionId (long) The ID of the Interaction associated with the message. eventId (long) - The ID of the event associated with the message. messageContent (string) - The contents of the message in plain text format. messageHtmlContent (string) - The contents of the message in HTML format. hasAttachment (bool) This parameter indicates whether the message includes any attachments. True - This value indicates that the message includes attachments. False - This value indicates that the message does not include any attachments.
Data Type
Description
151
Return Value attachmentInfo - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment. int[] attachmentIds The array containing the IDs of the attachment(s) associated with the message.
Data Type
Description
interactionPriority (string) - This parameter indicates the priority of the Interaction. High - This value indicates that the priority of the Interaction is High. Normal - This value indicates that the priority of the Interaction is Normal.
beforeIdUser (string) Depending on the activity in the event, the name of the Contact, User, Team, or System who was the owner of the Interaction before the event occurred.
152
Return Value afterIdUser (string) Depending on the activity in the event, the name of the Contact, User, Team, or System who is the owner of the Interaction after the event occurred. originatorIdUser (string) The name of the Contact, User, or system, depending on the activity in the event. For example, if the Interaction was created after a message was received from a Contact, this method returns the name of the Contact. subject (string) - If the event is associated with the exchange of a message, this variable indicates the subject of the message. interactionId (long) - The ID of the Interaction associated with the event.
Data Type
Description
attachmentInfo eventId (int) - The ID of the event associated with the attachment. attachmentId (int) - The ID of the attachment associated with the event. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment, in bytes.
ref AttachmentInfo[]
This is an array of the AttachmentInfo[] structure that contains the details of attachments associated with the event.
totalEventsCount error
int string
The total number of events associated with the Interaction. The error message(s) returned when the get operation fails.
153
GetAllInteractionEvents Method Return Values The GetAllInteractionEvents method returns 0 if the operation is successful, and a negative value if the operation fails.
GetInteractionEvents2
You can use the GetInteractionEvents2 method to retrieve the event headers of all the events associated with an Interaction. You must send the ID of the Interaction, and the EventRetrivingOptions structure as input parameters to Talisma Interaction iService. The EventRetrivingOptions structure enables you to specify how you would like to view the events. The events are retrieved in chronological, or reverse chronological order based on the specification. Talisma Interaction iService processes the input values, and retrieves the event headers of all events in the Interaction. Method Signature
long GetInteractionEvents2(long interactionId, EventRetrivingOptions eventRetrivingOptions, ref ActivityInfo[] activityData, out int totalEventsCount, out string error)
GetInteractionEvents2 Input Parameters The following table describes the input parameters for the GetInteractionEvents2 method:
Input Parameters interactionId Data Type long Description The ID of the Interaction for which you want to retrieve the event headers of all the events.
154
Input Parameters eventRetrivingOptions eventsOrder (bool) - The order in which the event headers must be retrieved. You can specify one of the following values: True - Specify this value to retrieve the event headers in reverse chronological order. False - Specify this value to retrieve the event headers in chronological order.
Data Type EventRetrivingOptions
Description This is an array of the EventRetrivingOptions structure that contains information about the manner in which the event headers must be retrieved.
filterEvents (int) - Specify the manner in which the events must be retrieved. You can use the following values: 1 - To retrieve all events except filtered events. 0 - To retrieve all events.
userPreference (bool) Specify whether the event headers must be retrieved based on the User Preference set for the User in Talisma Client. You can specify one of the following values: 0 - Specify this value if you do not want to consider the User Preferences set in Talisma Client to retrieve event headers. 1 - Specify this value if you want to consider the User Preferences set in Talisma Client to retrieve event headers.
155
Input Parameters eventExpandedType (int) - Specify the manner in which the events must be displayed. You can specify one of the following values: 0 - Specify this value if you want to retrieve the event headers with the first event expanded. 1 - Specify this value if you want to display the event headers with the last event expanded. 2 - Specify this value if you want to display the event headers with all events expanded. 3 - Specify this value if you want to display the event headers with all the events collapsed.
Data Type
Description
numberOfEventsToFetch (int) - The number of events you want to fetch per page. showSubInteractionEvents (int) - Specify whether you want to retrieve the event headers of Sub Interactions. You can specify one of the following values 0 - Event headers of Sub Interactions are not retrieved. 1 - Event headers of Sub Interactions are retrieved.
lastEventRetrivedServerTi me (string) - The time in the Server when the last event was retrieved. pageNumber (int) - The number of the page from which you want to retrieve the events.
156
GetInteractionEvents2 Output Parameters The following table describes the output parameters for the GetInteractionEvents2 method:
Return Value activityData eventId (int) - A unique ID associated with an event in Talisma. eventType (int) - A unique ID associated with an event type in Talisma. This parameter returns the ID of the event type. from (string) - If a message is received or sent, this is the name of the person who has sent the message. to (string) - If a message is sent or received, this is the name of the person who has received the message. cc (string) - If a message is sent or received, this is the name of the person to whom a copy of the message was sent. bcc (string) - If a message is sent or received, this is the name of the person to whom a blank carbon copy of the message was sent. originatorId (int) - The ID of the Contact, User, or system, depending on the activity in the event. For example, if the Interaction was created after a message was received from a Contact, this method returns the ID of the Contact. This parameter returns the value 1, if the event was originated by the Talisma system. Data Type ref ActivityInfo[] Description This is an array of the ActivityInfo[] structure that contains the event details of the specified Interaction.
157
Return Value beforeId (int) - The ID of the previous owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction was assigned to another User, this parameter returns the ID of the User who assigned the Interaction. afterId (int) - This parameter returns the ID of the current owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction is assigned to a User, this field returns the ID of the User to whom the Interaction is assigned. byRule (string) - The name of the Rule that triggered the Event. mediaId (int) - The ID of the Medium associated with the Event. eventDate (DateTime) Date and time when the event occurred. mailServerEventDate (DateTime) - If a message was sent or received, this is the mail server date and time when the relevant event occurred. direction (int) - The direction of the Interaction. 0 - Indicates that the Interaction was initiated by a User in Talisma. Any other numeric value - Indicates that the Interaction was initiated by a Contact.
Data Type
Description
158
Return Value isIncoming (int) - The value of this parameter indicates whether the Interaction is Incoming or Outgoing. 1 - This value indicates that the Interaction is Incoming. 0 - This value indicates that the Interaction is Outgoing.
Data Type
Description
hasAttachment (bool) This parameter indicates whether the event includes any attachments. True - This value indicates that the event includes attachments. False - This value indicates that the event does not include any attachments.
For example, the value of this parameter is set to True if the event is associated with a reply sent to the Contact in an Interaction. messageContent (MessageContent) - An array of the MessageContent structure that contains the details of the message, message content, and attachment(s) in the message. 159
Return Value interactionId (long) The ID of the Interaction associated with message. eventId (long) - The ID of the event associated with message. messageContent (string) - The contents of the message in plain text format. messageHtmlContent (string) - The contents of the message in HTML format. hasAttachment (bool) This parameter indicates whether the message includes any attachments. True - This value indicates that the message includes attachments. False - This value indicates that the message does not include any attachments. attachmentInfo - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. fileName (string) - The name of the attached file.
Data Type
Description
160
Return Value cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment. int[] attachmentIds The array containing the IDs of the attachment(s) associated with the message.
Data Type
Description
beforeIdUser (string) Depending on the activity in the Event, the name of the Contact, User, Team, or System who was the owner of the Interaction before the event occurred. afterIdUser (string) Depending on the activity in the Event, the name of the Contact, User, Team, or System who is the owner of the Interaction after the event occurred. originatorIdUser (string) The name of the Contact, User, or system, depending on the activity in the event. For example, if the Interaction was created after a message was received from a Contact, this method returns the name of the Contact.
161
Return Value subject (string) - If the event is associated with the exchange of a message, this variable indicates the subject of the message. interactionId (long) - The ID of the Interaction associated with the event.
Data Type
Description
totalEventsCount error
int string
The total number of events associated with the Interaction. The error message(s) returned when the get operation fails.
GetInteractionEvents2 Method Return Values The GetInteractionEvents2 method returns 0 if the operation is successful, and a negative value if the operation fails.
GetMessageContent
You can use the GetMessageContent method to retrieve the contents of a message. You must send the ID of the message for which you want to retrieve the message contents as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the contents of the message along with other details of the message. Method Signature
long GetMessageContent(long messageId, ref MessageContent messageContent, out string error)
GetMessageContent Input Parameters The following table describes the input parameters for the GetMessageContent method:
Input Parameters messageId Data Type long Description The ID of the message for which you want to retrieve the message contents, or the ID of the relevant event.
162
GetMessageContent Output Parameters The following table describes the output parameters for the GetMessageContent method:
Return Value messageContent interactionId (long) The ID of the Interaction associated with message. eventId (long) - The ID of the event associated with message. messageContent (string) - The contents of the message in plain text format. messageHtmlContent (string) - The contents of the message in HTML format. hasAttachment (bool) This parameter indicates whether the message includes any attachments. True - This value indicates that the message includes attachments. False - This value indicates that the message does not include any attachments. attachmentInfo - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. Data Type ref MessageContent Description An array of the MessageContent structure that contains the details of the message, message content, and attachment(s) in the message.
163
Return Value fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment. int[] attachmentIds - The array containing the IDs of the attachment(s) associated with the message.
Data Type
Description
error
string
GetMessageContent Method Return Values The GetMessageContent method returns 0 if the operation is successful, and a negative value if the operation fails.
GetAllMessageContents
You can use the GetAllMessageContents method to retrieve the contents of all the messages in an Interaction. You must send the ID of the Interaction for which you want to retrieve contents of all the messages as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the contents of all the messages in the Interaction along with other details of the message. Method Signature
long GetAllMessageContents(int interactionId, messageContents, out string error) ref MessageContent[]
GetAllMessageContents Input Parameters The following table describes the input parameters for the GetAllMessageContents method:
Input Parameters interactionId Data Type int Description The ID of the Interaction for which you want to retrieve contents of all the messages in the Interaction.
164
GetAllMessageContents Output Parameters The following table describes the output parameters for the GetAllMessageContents method:
Return Value messageContents interactionId (long) The ID of the Interaction associated with the message. eventId (long) - The ID of the event associated with the message. messageContent (string) - The contents of the message in plain text format. messageHtmlContent (string) - The contents of the message in HTML format. hasAttachment (bool) This parameter indicates whether the message includes any attachments. True - This value indicates that the message includes attachments. False - This value indicates that the message does not include any attachments. Data Type ref MessageContent[] Description An array of the MessageContent[] structure that contains the details of the message, message content, and attachment(s) in the message.
165
Return Value attachmentInfo - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment. int[] attachmentIds - The array containing the IDs of the attachment(s) associated with the message.
Data Type
Description
error
string
GetAllMessageContents Method Return Values The GetAllMessageContents method returns 0 if the operation is successful, and a negative value if the operation fails.
166
You can use the SetInteractionPriority method to set the priority of an Interaction to High in Talisma. Consider a scenario where Contact Rob who has purchased a health insurance policy from your organization has requested for claims. You must immediately send Rob the required forms, and follow-up with Rob regularly. To ensure that Robs requests are processed at the earliest, you can set the priority of Robs Interaction to High. You must send the ID of the Interaction for which you want to change the priority, and the priority parameter with its value set to High as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the status of the operation. Method Signature
long SetInteractionPriority(long interactionId, int priority, out string error)
SetInteractionPriority Input Parameters The following table describes the input parameters for the SetInteractionPriority method:
Input Parameters interactionId Data Type long Description The ID of the Interaction for which you want to change the Interaction Priority. The priority of the Interaction. To change the priority of the Interaction to High, you must specify the value of this parameter as 1.
priority
int
SetInteractionPriority Output Parameter The following table describes the output parameter for the SetInteractionPriority method:
Return Value error Data Type string Description The error message(s) returned when the set priority operation fails.
SetInteractionPriority Method Return Values The SetInteractionPriority method returns 0 if the operation is successful, and a negative value if the operation fails.
167
SetInteractionState
An Interaction can move through various states based on the operations performed on the Interaction, such as opening, closing, reviewing, and sending to a Specialist. The state of an Interaction is set to Open, Pending, Resolved, Closed, or Expired depending on the operation performed on the Interaction. You can also manually set the state of an Interaction to Open or Resolved. Some tasks, such as responding to an Interaction or sending a Canned Response, cannot be performed when an Interaction has expired, or has been resolved. In such cases, you can use the SetInteractionState method in Talisma to set the state of an Interaction manually. For more information about Interaction States in Talisma, see Talisma Client Help. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction for which you want to set the Interaction state. The Interaction state you want to set. The comments to be inserted when the state of an Interaction is changed. The force parameter to specify whether the state of the Interaction must be changed irrespective of whether the User who is performing the operation is the owner of the Interaction. For example, if the Interaction for which you want to set the Interaction state to Resolved is locked by another Talisma User, and if you have set the value of the Force parameter to True, the state of the Interaction will be set to Resolved irrespective of the Interaction being locked by another User. The ID of the User who is the owner of the Interaction. The name of the User. The status of the set operation.
long SetInteractionState(long interactionId, InteractionState interactionState, string comments, bool force, ref int lockedByUserId, out string lockedByUserName, out string error)
Talisma Interaction iService processes the input values, and returns the following values:
Method Signature
SetInteractionState Input Parameters The following table describes the input parameters for the SetInteractionState method:
Input Parameters interactionId Data Type long Description The ID of the Interaction for which you want to set the Interaction state.
168
Input Parameters interactionState
Data Type InteractionState
Description The Interaction state you want to set. The value of this parameter indicates enumerated value of the state of an Interaction. You can specify one of the following values: 1 - To set the state of an Interaction to Open. 2 -To set the state of an Interaction to Resolved.
comments
string
The comments to be inserted when the state of an Interaction is changed. Specify whether the state of the Interaction must be changed irrespective of whether the User who is performing the operation is the owner of the Interaction. You can specify one of the following values: True - Specify this value to set the state of the Interaction irrespective of whether the User who is performing the operation is the owner of the Interaction. False - Specify this value to set the state of the Interaction only if the User who is performing the operation is the owner of the Interaction.
force
bool
SetInteractionState Output Parameters The following table describes the output parameters for the SetInteractionState method:
Return Value lockedByUserId lockedByUserName error Data Type ref int string string Description The ID of the User who is the owner of the Interaction. The name of the User who is the owner of the Interaction. The error message(s) returned when the set operation fails. 169
SetInteractionState Method Return Values The SetInteractionState method returns 0 if the operation is successful, and a negative value if the operation fails.
Assign
You can use the Assign method to assign an Interaction to a User in Talisma. For example, Contact Cathy contacted you regarding her login password several days ago. Her Interaction needs to be assigned to Harry who handles such requests. Using the Assign method, you can assign the Interaction to Harry. You must send the following values as input parameters to the Talisma Interaction iService: The ID of the Interaction which you want to assign to another User. The ID of the User to whom you want to assign the Interaction. The ID of the User who is the current owner of the Interaction. The comments to be inserted when the Interaction is assigned to the specified User. The force parameter to specify whether the Interaction must be assigned irrespective of whether the User who is performing the assign operation is the owner of the Interaction. The checkDeletedStatus parameter to check whether the Interaction you want to assign to another User has been deleted from Talisma. The checkClosedStatus parameter to check whether the state of the specified Interaction is set to Closed. The addEvent parameter to add the assign operation as an event of the Interaction. By default, the value of the addEvent parameter is set to True. Set the value to False if you do not want to add the assign operation as an event of the Interaction. The checkExpiredStatus parameter to check whether the state of the specified Interaction is set to Expired. The checkUndeliveredStatus parameter to check whether the Interaction was created because an earlier message was not delivered. The ID of the User who is the owner of the Interaction. The ID of the event associated with the assign operation. The status of the assign operation.
long Assign( long interactionId, int assignToUserId, ref int lockByUserId, string comment, bool force, bool checkDeletedStatus, bool checkClosedStatus, bool addEvent, bool checkExpiredStatus, bool checkUndeliveredStatus, out string lockByUserName, out long assignEventId, out string error)
Talisma Interaction iService processes the input values, and returns the following:
Method Signature
170
Assign Input Parameters The following table describes the input parameters for the Assign method:
Input Parameters interactionId assignToUserId Data Type long int Description The ID of the Interaction you want to assign to another User. The ID of the User to whom you want to assign the Interaction. The comments you want to specify as part of the assign operation. Specify whether the Interaction must be assigned irrespective of whether the User who is performing the assign operation is the owner of the Interaction. You can specify one of the following values: True - Specify this value to assign the Interaction irrespective of whether the User who is performing the assign operation is the owner of the Interaction. False - Specify this value to assign the Interaction only when the assign operation is performed by the owner of the Interaction.
comment
string
force
bool
checkDeletedStatus
bool
This parameter enables you to check whether the Interaction you want to assign to another User has been deleted from Talisma. You can specify one of the following values: True - Specify this value to check whether the specified Interaction has been deleted from Talisma. False - Specify this value if you do not want to check whether the specified Interaction has been deleted from Talisma.
171
Input Parameters checkClosedStatus
Data Type bool
Description This parameter enables you to check whether the state of the Interaction you want to assign is Closed. You can specify one of the following values: True - Specify this value to check whether the state of the specified Interaction is Closed. False - Specify this value if you do not want to check whether the state of the specified Interaction is Closed.
addEvent
bool
The value of this parameter indicates whether an event must be added when you assign an Interaction to a User. You can specify one of the following values: True - Specify this value to add the assign operation as an event of the Interaction. False - Specify this value if you do not want to add the assign operation as an event of the Interaction.
By default, the value of this parameter is set to True. checkExpiredStatus bool This parameter enables you to check whether the state of the Interaction you want to assign is Expired. You can specify one of the following values: True - Specify this value to check whether the state of the specified Interaction is Expired. False - Specify this value if you do not want to check whether the state of the specified Interaction is Expired.
172
Input Parameters checkUndeliveredStatus
Data Type bool
Description This parameter enables you to check whether the Interaction was created because an earlier message was not delivered. You can specify one of the following values: True - Specify this value to check whether the Interaction was created because of an undelivered message. False - Specify this value if you do not want to check whether the Interaction was created because of an undelivered message.
Assign Output Parameters The following table describes the output parameters for the Assign method:
Return Value lockByUserId lockByUserName assignEventId error Data Type int string long string Description The ID of the User who is the owner of the Interaction. The name of the User who is the owner of the Interaction. The ID of the event associated with the assign operation. The error message(s) returned when the assign operation fails.
Assign Method Return Values The Assign method returns 0 if the assign operation is successful, and a negative value if the operation fails.
173
Transfer
You can use the Transfer method to transfer an Interaction to a User in Talisma. Consider a scenario where the customer service department of your organization has received a query from Contact Cathy regarding discrepancy in service charges. The Interaction needs to be transferred to the billing department, which handles customer queries related to billing. In this scenario, you can use the Transfer method to transfer the Interaction from the customer service department to a User in the billing department. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction you want to transfer to another User. The ID of the Team to which you want to transfer the Interaction. The ID of the User in the specified Team to whom you want to transfer the Interaction. The transferIfNotOwner parameter to specify that the transfer operation can be performed even if the operation is not performed by the owner of the Interaction. The ID of the User who is the owner of the Interaction. The name of the User who is the owner of the Interaction. The status of the assign operation.
long Transfer(long interactionId, int assignToTeamId, int assignToUserId, bool transferIfNotOwner, ref int lockByUserId, out string lockByUserName, out string error)
Talisma Interaction iService processes the input values, and returns the following:
Method Signature
Transfer Input Parameters The following table describes the input parameters for the Transfer method:
Input Parameters interactionId assignToTeamId Data Type long int Description The ID of the Interaction you want to transfer. The ID of the Team to which you want to transfer the Interaction. The ID of the User in the specified Team to whom you want to transfer the Interaction.
assignToUserId
int
174
Input Parameters transferIfNotOwner
Data Type bool
Description Specify whether the Interaction must be transferred if the operation is performed by a User who is not the owner of the Interaction. True - The Interaction is transferred irrespective of the owner of the Interaction. False - The Interaction is transferred only if the operation is performed by the owner of the Interaction.
Transfer Output Parameters The following table describes the output parameters for the Transfer method:
Return Value lockByUserId lockByUserName error Data Type ref int string string Description The ID of the User who is the owner of the Interaction. The name of the User who is the owner of the Interaction. The error message(s) returned when the transfer operation fails.
Transfer Method Return Values The Transfer method returns 0 if the transfer operation is successful, and a negative value if the operation fails.
175
GetAttachmentFile
You can use the GetAttachmentFile method to retrieve a file that is inserted as an attachment in a message. For example, Contact Cathy has sent you a query regarding her insurance policy. Cathy has attached her policy documents in the message. You can retrieve the documents using the GetAttachmentFile method. You must send the ID of the attachment you want to retrieve as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the attachment. Method Signature
long GetAttachmentFile(long attachmentId, out byte[] fileBlob, out string error)
GetAttachmentFile Input Parameters The following table describes the input parameters for the GetAttachmentFile method:
Input Parameters attachmentId Data Type long Description The ID of the attachment you want to retrieve.
GetAttachmentFile Output Parameters The following table describes the output parameters for the GetAttachmentFile method:
Return Value fileBlob error Data Type byte[] string Description The contents of the specified attachment. The error message(s) returned when the get operation fails.
GetAttachmentFile Method Return Values The GetAttachmentFile method returns 0 if the operation is successful, and a negative value if the operation fails.
176
GetAssignToUserList
You can use the GetAssignToUserList method to retrieve the list of Users to whom you can assign an Interaction. Consider a scenario where the customer service department of your organization has received a query from Contact Cathy regarding discrepancy in service charges. The Interaction must be assigned to a User in the billing department. In this scenario, you can use the GetAssignToUserList method to retrieve the list of Users to whom you can assign the Interaction. You must send the following values as input parameters to Talisma Interaction iService: The getUsersBasedOnPermissions parameter to specify whether you want to retrieve the list of Users based on Permissions for the Users. The ID of the Interaction for which you want to retrieve the list of Users to whom the Interaction can be assigned. The ID of the Team to which the User you want to assign the Interaction belongs.
Talisma Interaction iService processes the input values, and returns the list of Users to whom you can assign the Interaction. Method Signature
long GetAssignToUserList(int getUsersBasedOnPermissions, long interactionId, int teamId, out string assignToUsersListXml, out string error)
GetAssignToUserList Input Parameters The following table describes the input parameters for the GetAssignToUserList method:
Input Parameters getUsersBasedOnPermission s Data Type int Description Specify one of the following values: 0 - Specify this value, and the method returns the list of all Users without checking whether the User has permissions to perform the assign operation. 1 - Specify this value, and the method checks whether the User has permissions to assign Interactions. If the User has permissions, the method returns the list of Users.
interactionId
long
The ID of the Interaction for which you want to retrieve the list of Users to whom you can assign the Interaction. The ID of the Team from which the Users list must be retrieved.
teamId
int
177
GetAssignToUserList Output Parameters The following table describes the output parameters for the GetAssignToUserList method:
Return Value assignToUsersListXml Data Type string Description The list of Users to whom you can assign the Interaction. The list is obtained in XML format. The error message(s) returned when the get operation fails.
error
string
GetAssignToUserList Method Return Values The GetAssignToUserList method returns 0 if the operation is successful, and a negative value if the operation fails.
GetTransferToList
You can use the GetTransferToList method to retrieve the list of Teams to which you can transfer an Interaction. You must send the ID of the Interaction as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input value, and returns the list of Teams in XML format. Method Signature
long GetTransferToList(long instanceid, out string transferToListXML, out string error)
GetTransferToList Input Parameter The following table describes the input parameter for the GetTransferToList method:
Input Parameters instanceid Data Type long Description The ID of the Interaction for which you want to retrieve the list of Teams to which the Interaction can be transferred.
GetTransferToList Output Parameters The following table describes the output parameters for the GetTransferToList method:
Return Value transferToListXML Data Type string Description The list of Teams to which you can transfer the Interaction. The list is obtained in XML format. The error message(s) returned when the get operation fails.
error
string
178
GetTransferToList Method Return Values The GetTransferToList method returns 0 if the operation is successful, and a negative value if the operation fails.
GetInteractionInfo
You can use the GetInteractionInfo method to retrieve the details of an Interaction. You must send the InteractionInfo structure with only the ID of the required Interaction as an input parameter to Talisma Interaction iService. The values for the remaining variables of the InteractionInfo structure must be set to NULL. Talisma Interaction iService processes the input value, and returns the details of the Interaction. Method Signature
long GetInteractionInfo(ref error) InteractionInfo interactionInfo, out string
GetInteractionInfo Input Parameters The following table describes the input parameters for the GetInteractionInfo method:
Input Parameters interactionInfo interactionId (long) - The ID of the Interaction for which you want to retrieve the details. teamId (int) - Set this parameter to NULL. teamName (string) - Set this parameter to NULL. ownerId (int) - Set this parameter to NULL. ownerName (string) - Set this parameter to NULL. priority (int) - Set this parameter to NULL. aliasId (long) - Set this parameter to NULL. contactId (long) - Set this parameter to NULL. Data Type ref InteractionInfo Description This is an array of the InteractionInfo structure that contains the details of an Interaction. Note: In this structure, you must send only the Interaction ID as the input parameter. You must set the values of the remaining parameters as NULL.
179
Input Parameters contactName (string) - Set this parameter to NULL. contactEmail (string) - Set this parameter to NULL. subject (string) - Set this parameter to NULL. lastUpdated (DateTime) Set this parameter to NULL. systemPriority (int) - Set this parameter to NULL. userPriority (int) - Set this parameter to NULL. ruleBasedPriority (int) Set this parameter to NULL. interactionState (int) - Set this parameter to NULL. consultState (int) - Set this parameter to NULL. replyState (int) - Set this parameter to NULL. dateOfLastMessageFromCo ntact (DateTime) - Set this parameter to NULL. expiryDate (DateTime) Set this parameter to NULL. lastUpdated (DateTime) Set this parameter to NULL. systemPriority (int) - Set this parameter to NULL. userPriority (int) - Set this parameter to NULL.
Data Type
Description
180
Input Parameters ruleBasedPriority (int) Set this parameter to NULL. interactionState (int) - Set this parameter to NULL. consultState (int) - Set this parameter to NULL. replyState (int) - Set this parameter to NULL. dateOfLastMessageFromCo ntact (DateTime) - Set this parameter to NULL. expiryDate (DateTime) Set this parameter to NULL. isDeleted (bool) - Set this parameter to NULL. messageCount (int) - Set this parameter to NULL. lastOpened (DateTime) Set this parameter to NULL. createdDate (DateTime) Set this parameter to NULL. lastResolvedDate (DateTime) - Set parameter to NULL. this
Data Type
Description
outgoingMessageId (long) - Set this parameter to NULL. reviewerId (long) - Set this parameter to NULL. reviewerState (long) - Set this parameter to NULL. lastMessageLanguageId (long) - Set this parameter to NULL.
181
GetInteractionInfo Output Parameters The following table describes the output parameters for the GetInteractionInfo method:
Return Value interactionInfo interactionId (long) - The ID of the Interaction for which the Interaction details have been retrieved. teamId (int) - The ID of the Team to which the Interaction belongs. teamName (string) - The name of the Team to which the Interaction belongs. ownerId (int) - The ID of the User who is the owner of the Interaction. ownerName (string) - The name of the User who is the owner of the Interaction. priority (int) - The priority of the Interaction. 1 - This value indicates that the priority of the Interaction is High. 0 - This value indicates that the priority of the Interaction is Normal. Data Type ref InteractionInfo Description This is an array of the InteractionInfo structure that contains the details of an Interaction.
aliasId (long) - The ID of the Alias associated with the Team to which the Interaction belongs. contactId (long) - The ID of the Contact associated with the Interaction. contactName (string) - The name of the Contact associated with the Interaction. contactEmail (string) The e-mail address of the Contact associated with the Interaction. subject (string) - The subject of the Interaction.
182
Return Value lastUpdated (DateTime) The date and time when the Interaction was last updated. systemPriority (int) - The priority of the Interaction assigned by the system. userPriority (int) - The priority of the Interaction assigned by a User. ruleBasedPriority (int) The priority of the Interaction assigned based on the Rules configured. interactionState (int) - The current state of the Interaction. consultState (int) - If the Interaction was sent to a specialist, this value indicates the Consult state of the Interaction. replyState (int) - If a reply was sent for the Interaction, this value indicates the Reply state of the Interaction. An Interaction can be in one of the following Reply states: Reply in Progress Reply in Outbox
Data Type
Description
dateOfLastMessageFromCo ntact (DateTime) - The date and time when a message was last received from the Contact associated with the Interaction. expiryDate (DateTime) Date and time when the Interaction will expire, or has expired.
183
Return Value isDeleted (bool) - The value of this parameter indicates whether the Interaction has been deleted from the Talisma system. True - This value indicates that the Interaction has been deleted. False - This value indicates that the Interaction has not been deleted.
Data Type
Description
messageCount (int) - The total number of messages in the Interaction. lastOpened (DateTime) The date and time when the Interaction was last opened. createdDate (DateTime) The date and time when the Interaction was created. lastResolvedDate (DateTime) - The date and time when the Interaction was last resolved. outgoingMessageId (long) - The ID of the outgoing reply to a message. reviewerId (long) - If the Interaction has been sent for review, this is the ID of the User who is reviewing the Interaction. reviewerState (long) - If the Interaction has been sent for review, this value indicates the Review state of the Interaction. An Interaction can be in one of the following Review states: Under Review Reviewed
lastMessageLanguageId (long) - The ID of the language in which the last message was sent. 184
Return Value error
Data Type string
GetInteractionInfo Method Return Values The GetInteractionInfo method returns 0 if the operation is successful, and a negative value if the operation fails.
BeginReply
You can use the BeginReply method to carry out all the prerequisite operations before you can reply to an Interaction. For example, using the BeginReply method, you can check whether a User has sufficient Permissions to send a reply, or acquire the lock on the message. You must send the ID of the required Interaction as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input values, and returns the following: The ID of the User who is the owner of the Interaction. The ID of the event associated with the Reply. The ID of the message to which you are replying. The ID created for the Reply.
long BeginReply(long interactionId, out string lockedByUserName, ref long replyId, out long originalMessageId, out long outgoingMessageId, out string error)
Method Signature
BeginReply Input Parameter The following table describes the input parameter for the BeginReply method:
Input Parameters interactionId Data Type long Description The ID of the Interaction to which you want to reply.
185
BeginReply Output Parameters The following table describes the output parameters for the BeginReply method:
Return Value lockedByUserName replyId originalMessageId outgoingMessageId error Data Type string ref long long long string Description The ID of the User who is the owner of the Interaction. The ID of the event associated with the Reply. The ID of the message to which you are replying. The ID created for the Reply. The error message(s) returned when the operation fails.
BeginReply Method Return Values The BeginReply method returns 0 if the operation is successful, and a negative value if the operation fails.
SaveReply
You can use the SaveReply method to save a message that you want to send at a later time. For example, you have received a query from Contact Rob about the renewal of his insurance policy. You have composed a reply to Rob, but would like to send the message after consulting your manager in person. In this scenario, you can save the message to be sent at a later time. You must send the following values as input parameters to Talisma Interaction iService: The ID of the Interaction to which the message you want to save belongs. The ReplyMessage structure that contains the details of the message you want to save. The ReplyAddresses structure that contains the e-mail address(es) of the recipient(s) of the message you want to save. The send parameter to specify whether the message must be sent when it is saved. The ID of the message you want to save. The ID of the event associated with the save operation. The unlock parameter to specify whether you want to acquire the lock on the message if the message is being worked upon by another User. The resolve parameter to specify whether the Interaction must be resolved after the message is sent. The ID of the Alias associated with the Team to which the Interaction belongs.
186
The addTalismaSignature parameter to specify whether the signature configured for your User account in Talisma must be automatically added to the message you want to save. The operationType parameter to specify whether the message you want to save must be sent to a specialist, or must be forwarded to another User. The language ID associated with the message you want to save. The reviewReply parameter to specify whether you want to send the message for review to other Talisma Users in the same Team. The ID(s) of the Canned Respons(es) you want to insert in the message. The name of the SMS extractor if the message is an SMS message. The ID of the SMS extractor if the message is an SMS message.
Talisma Interaction iService processes the input values, and saves the message. If you have set the value of the send parameter to True, Talisma Interaction iService also sends the message as part of the save operation. Method Signature
long SaveReply(long interactionId, ReplyMessage replyMessage, ReplyAddresses replyAddress, bool send, ref long outgoingMessageId, ref long eventId, bool unlock, bool resolve, int aliasId, bool addTalismaSignature, int operationType, long messageLanguageId, bool reviewReply, string insertedCRIds, string smsExtractorName, int smsExtractorId, out string error)
SaveReply Input Parameters The following table describes the input parameters for the SaveReply method:
Input Parameters interactionId Data Type long Description The ID of the Interaction associated with the message you want to save.
187
Input Parameters replyMessage subjectPrefix (string) The message type prefix that must be added to the subject of the message. For example, if you are saving a reply to a message, specify RE: as the prefix. subject (string) - The subject of the message you want to save. partialMessageContents (string) - The contents of the last saved message in the Interaction. fullMessageContents (string) - The contents of all the messages associated with the Interaction. includeOriginalMessageId ( long) - The ID of the original message to which you are replying. temporaryPath (string) Temporary path where the message must be saved. AttachmentArray - This is an array of the InteractionAttachmentDa ta [] structure that contains details about the attachments in the Interaction. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment.
Data Type ReplyMessage
Description An array of the ReplyMessage structure that contains details of the message you want to save.
188
Input Parameters fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment. byte[] fileBlob - The contents of the file you want to attach. isNewAttachment (bool) - Whether the attachment you want to add is a new attachment. You can specify one of the following values: True - Specify this value if the attachment you want to add is new. False - Specify this value if the attachment you want to add is an existing file from the server. copyAttachmentFromSe rver (bool) - Whether the attachment you want to add must be copied from the server. You can add files that belong to other events by copying them from the server. You can specify one of the following values: True - Specify this value if the file you want to add as an attachment must be copied from the server. False - Specify this value if the file you want to add as an attachment must not be copied from the server.
Data Type
Description
189
Input Parameters retainAttachment (bool) - Whether you want to retain the attachment details. You can specify one of the following values: True - Specify this value if you want to retain the attachment ID and the attachment content. False - Specify this value if you do not want to retain the attachment ID and attachment content. deleteAttachment (bool) - Whether you want to delete an attachment. You can specify one of the following values: True - Specify this value if you want to delete the attachment. False - Specify this value if you do not want to delete the attachment. editAttachment (bool) - Whether you want to edit the attachment you are adding. You can specify one of the following values: True - Specify this value if you want to edit the attachment. False - Specify this value if you do not want to edit the attachment.
Data Type
Description
190
Input Parameters rushReply (bool) - If you have chosen to send the message as part of the save operation, this parameter enables you to specify whether the message must be rushed. If you choose to rush the message, the message will be dispatched prior to other messages that are waiting to be dispatched from Talisma. you can specify one of the following values: True - Specify this value if you want to rush the message. False - Specify this value if you do not want to rush the message. plainTextFullMessageCo ntents (string) Message contents of all the messages in the Interaction in plain text format. partialPlainTextContent s (string) - Message contents of only the last saved message in plain text format. userMsgPlainTextConte nt (string) - The message of the User in plain text format. userMsgHTMLTextCont ent (string) - The message of the User in HTML format. HTMLAttachmentConte nt (string) - Contents of the attachment in HTML format.
Data Type
Description
191
Input Parameters plainTextAttachmentCo ntent (string) Contents of the attachment in plain text format. replyAddress to (string) - The e-mail address(es) of the person(s) to whom you want to send the message. cc (string) - The e-mail address(es) of the person(s) to whom you want to send a copy of the message. bcc (string) - The e-mail address(es) of the person(s) to whom you want to send a blank carbon copy of the message. toDLsExpanded (string) The expanded distribution lists of e-mail addresses to whom you want to send the message. ccDLsExpanded (string) The expanded distribution lists of e-mail addresses to whom you want to send a carbon copy of the message. bccDLsExpanded (string) - The expanded distribution lists of e-mail addresses to whom you want to send a blank carbon copy of the message.
Data Type ReplyAddresses
Description
send
bool
Specify whether the message must be sent when it is saved. You can specify one of the following values: True - Specify this value if you want to send the message when it is saved. False - Specify this value if you do not want to send the message when it is saved.
outgoingMessageId
ref long
The ID of the message you want to save. 192
Input Parameters eventId unlock
Data Type ref long bool
Description The ID of the event associated with the save operation. Specify whether you want to acquire the lock on the message if the message is being worked upon by another User. You can use one of the following values: True - Specify this value if you want to acquire the lock. False - Specify this value if you do not want to acquire the lock.
resolve
bool
Specify whether the Interaction must be resolved when the message is sent. You can specify one of the following values: True - Specify this value if you want to resolve the Interaction when the message is sent. False - Specify this value if you do not want to resolve the Interaction when the message is sent.
aliasID
int
The ID of the Alias associated with the Team to which the Interaction belongs. Specify whether the signature configured for the User account in Talisma must be added to the message you want to save. You can specify one of the following values: True - Specify this value if the Users signature must be added to the message. False - Specify this value if you do not want to add the Users signature to the message.
addTalismaSignature
bool
193
Input Parameters operationType
Data Type int
Description Specify the operation that must be performed on the message. You can specify one of the following values: 0 - Specify this value if you want to perform the Reply, Reply All, or Save Reply operations. 1 - Specify this value if you want to perform the Forward operation. 2 - Specify this value if you want to perform the Consult Specialist operation. 5 - Specify this value if you want to perform SMS Reply operation.
messageLanguageId
long
The language ID associated with the message you want to save. Specify whether you want to send the message for review to other Talisma Users in the same Team. You can specify one of the following values: True - Specify this value if you want to send the message for review. False - Specify this value if you do not want to send the message for review.
reviewReply
bool
insertedCRIDs
string
The IDs of the Canned Responses you want to insert in the message. The name of the SMS extractor used. The name of dispatcher used. the SMS
smsExtractorName smsExtractorId
string int
194
SaveReply Output Parameter The following table describes the output parameter for the SaveReply method:
Return Value error Data Type string Description The error message(s) returned when the save operation fails.
SaveReply Method Return Values The SaveReply method returns 0 if the operation is successful, and a negative value if the operation fails.
UpdateInteractionReadUnReadStatus
You can use the UpdateInteractionReadUnReadStatus method to mark the status of the required Interactions to Read or Unread. For example, you are viewing Talisma Interactions in your external application. You receive a message from Contact Cathy who has requested you to provide information about interest rates for Home Loans based on her annual income. You are involved in some other tasks, and would like to follow up on Cathys request at a later time. In this scenario, you can set the status of Cathys Interaction as Unread. You must send the IDs of the Interactions which you want to mark as Read, and the IDs of the Interactions which you want to mark as Unread as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and updates the status of the specified Interactions. Method Signature
long UpdateInteractionReadUnReadStatus(string unReadInteractionIds, out string error) readInteractionIds, string
UpdateInteractionReadUnReadStatus Input Parameters The following table describes the input parameters for the UpdateInteractionReadUnReadStatus method:
Input Parameters readInteractionIds Data Type string Description The IDs of the Interactions for which you want to mark the status as Read. The Interaction IDs that you specify must be separated by commas. The IDs of the Interactions for which you want to mark the status as Unread. The Interaction IDs that you specify must be separated by commas.
unReadInteractionIds
string
195
UpdateInteractionReadUnReadStatus Output Parameter The following table describes the output parameter for the UpdateInteractionReadUnReadStatus method:
UpdateInteractionReadUnReadStatus Method Return Values The UpdateInteractionReadUnReadStatus method returns 0 if the update operation is successful, and a negative value if the operation fails.
SaveInteractionTrackingInfo
You can use the SaveInteractionTrackingInfo method to track the time spent on an Interaction. You must send the ArrayList parameter that contains the list of strings for tracking time spent on an Interaction as the input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input values, and the time spent on an Interaction is saved. Method Signature
SaveInteractionTrackingInfo(ArrayList error) listOfTrackingStrings, out string
SaveInteractionTrackingInfo Input Parameter The following table describes the input parameter for the SaveInteractionTrackingInfo method:
Input Parameters listOfTrackingStrings Data Type ArrayList Description This is an array that contains the strings to track the time spent on an Interaction.
SaveInteractionTrackingInfo Output Parameter The following table describes the output parameter for the SaveInteractionTrackingInfo method:
Return Value error Data Type string Description The error message(s) returned when the operation fails.
SaveInteractionTrackingInfo Method Return Values The SaveInteractionTrackingInfo method returns 0 if the operation is successful, and a negative value if the operation fails.
196
UnLockInteraction
You can use the UnLockInteraction method to unlock an Interaction, or a message that is saved in the Outbox. You must send the ID of the Interaction, or the ID of the outgoing message you want to unlock as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and if the unlock operation is successful, the Interaction or the outgoing message is unlocked, and can be worked upon by another User. Method Signature
long UnLockInteraction(long interactionId, long outGoingMsgId, out string error)
UnLockInteraction Input Parameters The following table describes the input parameters for the UnLockInteraction method:
Input Parameters interactionId outGoingMsgId Data Type long long Description The ID of the Interaction which you want to unlock. The ID of the outgoing message which you want to unlock.
UnLockInteraction Output Parameter The following table describes the output parameter for the UnLockInteraction method:
Return Value error Data Type string Description The error message(s) returned when the unlock operation fails.
UnLockInteraction Method Return Values The UnLockInteraction method returns 0 if the operation is successful, and a negative value if the operation fails.
197
BuildForwardOrConsult
You can use the BuildForwardOrConsult method when you want to forward an Interaction, or send an Interaction to a specialist. This method enables you to retrieve all the details of the Interaction, such as, the attachments included in the Interaction, the number of events in the Interaction, etc. For example, when you forward an Interaction, you need all the previous messages, and events in the Interaction. In this scenario, you can use the BuildForwardOrConsult method to retrieve the details of the Interaction. You must send the following values as input parameters to Talisma Interaction iService: The ID of the logged in User. The ID of the Interaction you want to forward, or send to a Specialist. The operation you want to perform on the Interaction. The ReplyInfo structure information available in the cache. The ReplyInfo structure information is retrieved for every Team, and is available in the cache after it is retrieved for the first time. This information need not be retrieved again. The force parameter to specify whether the Interaction must be forwarded, or sent to a specialist irrespective of any Permissions required by the User who is performing the operation.
Talisma Interaction iService processes the input values, and returns the details of the Interaction such as the total number of events in the Interaction, Interaction details, attachment details, etc. Method Signature
long BuildForwardOrConsult(long userId, long interactionId, int operation, long[] cachedTeams, ref long teamId, out ReplyInfo replyInfoData, out ActivityInfo[] activityData, out AttachmentInfo[] attachmentData, out int totalEventsCount, out long eventId, out long outGoingMessageId, out bool useExternalDispatcher, bool force, out string lockedByUserName, out InteractionInfo interactionInfo, out byte[] fileBlob, out string error)
BuildForwardOrConsult Input Parameters The following table describes the input parameters for the BuildForwardOrConsult method:
Input Parameters userId interactionId Data Type long long Description The ID of the logged in User. The ID of the Interaction you want to forward, or send to a specialist. The operation you want to perform on the Interaction. 1 - To perform the Forward operation. 2 - To perform the Consult operation.
operation
int
198
Input Parameters cachedTeams
Data Type long[]
Description The ReplyInfo structure information of the Team to which the Interaction belongs, available in the cache. Specify whether the Interaction must be forwarded, or sent to a specialist irrespective of any Permissions required by the User who is performing the operation. You can specify one of the following values: True - Specify this value if the Interaction must be forwarded, or sent to a specialist irrespective of any Permissions. False - Specify this value if the Interaction must be forwarded, or sent to a specialist only if the User who is performing the operation has relevant Permissions.
force
bool
BuildForwardOrConsult Output Parameters The following table describes the output parameters for the BuildForwardOrConsult method:
Return Value teamId Data Type ref long Description The ID of the Team to which the Interaction belongs.
199
Return Value replyInfoData maxCharactersInReply (long) - The maximum number of characters allowed in a message. strPrefix (string) - The message type prefix that is added to the subject of the message. For example, if you have forwarded the message, this variable returns FW:. bEnableFeature (bool) Indicates whether the original message is indented with respect to the reply message. True - This value indicates that the original message is indented. False - This value indicates that the original message is not indented.
Data Type ReplyInfo
Description
SignatureOptions An array of the UserSignature[] structure that contains the details of the User signature. signatureId (long) The ID of the User signature that is added to the message. userId (long) - The ID of the User whose signature is added to the message. teamId (long) - The ID of the Team to which the User belongs. signatureHtmlFormat (string) - The signature of the User in HTML format.
200
Return Value signaturePlainTextForm at (string) - The signature of the User in plain text format. empty (bool) - This parameter indicates whether there is any message when you are forwarding, or sending an Interaction to a specialist. True - This value indicates that there is a message associated. False - This value indicates that there is no message. attachToMessage (bool) - The value of this parameter indicates whether the User signature is automatically inserted in messages belonging to the Interaction. True - This value indicates that the User signature is included in all messages belonging to the Interaction. False - This value indicates that the User signature is not included in messages belonging to the Interaction. LanguageId (long) The ID of the language associated with the User signature.
Data Type
Description
prefixOptions[] - An array of the PrefixOptions [] structure that contains the details of the prefixes in the subject line of a message.
201
Return Value LanguageId (long) The ID of the Language associated with the prefix in the subject line. prefixForReply (string) - The prefix that is added to the subject of the message if the message is replied to. prefixForForward (string) - The prefix that is added to the subject of the message if the message is forwarded.
Data Type
Description
languageOptions - An array of the LanguageInfo [] structure that contains the details of the language used in the message. languageId (long) The ID of the language associated with the message. name (string) - The name of the language associated with the message.
globalConfigOptions - An array of the GlobalConfigDetails structure that contains the global configuration details. strInstallationId (string) - The ID of the Talisma installation. lMaxMessageSizeInKb ( long) - The maximum size of the message, in kilobytes, that is allowed. lMaxMessages (long) The maximum number of messages allowed in an Interaction.
202
Return Value bSendPropDataToConsu ltant (bool) - Indicates whether you want to send the Property data in the e-mail when you are sending an Interaction to a specialist. True - This value indicates that the Property data is included in the e-mail message when the Interaction is sent to a specialist. False - This value indicates that the Property data is not included in the e-mail message when the Interaction is sent to a specialist. bIncludeTagLine (bool) Indicates whether Talisma tag line is included in the message. True - This value indicates that the Talisma tag line is included in the message. False - This value indicates that the Talisma tag line is not included in the message. stOutGoingAliases - An array of the OutGoingAlias [] structure that contains the details of the Alias associated with a Team. aliasId (long) - The ID of the Alias used for the outgoing message. teamId (long) - The ID of the Team to which the Alias belongs.
Data Type
Description
203
Return Value name (string) - The name of the Alias associated with the Team. email (string) - The email address of the Alias associated with the Team. heuristicThread (int) The threading model that is used for Interactions.
Data Type
Description
strSnifferURL (string) The sniffer URL that is included in the message. bOriginalMessageInclude (bool) - Indicates whether the Interaction includes the original message along with the forwarded message. True - This value indicates that the original message is included in the forwarded message. False - This value indicates that the original message is not included in the forwarded message.
bSubjectLineInTheEnd (bool) - Indicates whether the subject line is included at the end of the message. True - The subject line is included at the end of the message. False - The subject line is not included at the end of the message.
strLockedBy (string) - The ID of the User who is the owner of the message.
204
Return Value bLockAcquired (bool) Indicates whether the lock is acquired on the message that was forwarded. True - This value indicates that the lock is acquired to perform operations on the message. False - This value indicates that the lock is not acquired to perform operations on the message.
Data Type
Description
205
Return Value activityData eventId (int) - A unique ID associated with an event in Talisma. eventType (int) - A unique ID associated with an event type in Talisma. This parameter returns the ID of the event type. from (string) - If a message is received or sent, this is the name of the person who has sent the message. to (string) - If a message is sent or received, this is the name of the person who has received the message. cc (string) - If a message is sent or received, this is the name of the person to whom a copy of the message was sent. bcc (string) - If a message is sent or received, this is the name of the person to whom a blank carbon copy of the message was sent. originatorId (int) - The ID of the Contact, User, or system, depending on the activity in the event. For example, if the Interaction was created after a message was received from a Contact, this method returns the ID of the Contact. This parameter returns the value 1, if the event was originated by the Talisma system. beforeId (int) - The ID of the previous owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event.
Data Type ActivityInfo[]
Description This is an array of the ActivityInfo[] structure that contains the event details of the specified Interaction.
206
Return Value For example, if an Interaction was assigned to another User, this parameter returns the ID of the User who assigned the Interaction. afterId (int) - This parameter returns the ID of the current owner, or the Team ID, User ID, Sub Interaction ID, or Contact ID, based on the activity of the event. For example, if an Interaction is assigned to a User, this field returns the ID of the User to whom the Interaction is assigned. byRule (string) - The name of the Rule that triggered the Event. mediaId (int) - The ID of the Medium associated with the Event. eventDate (DateTime) Date and time when the event occurred. mailServerEventDate (DateTime) - If a message was sent or received, this is the mail server date and time when the relevant event occurred. direction (int) - The direction of the Interaction. 0 - Indicates that the Interaction was initiated by a User in Talisma. Any other numeric value - Indicates that the Interaction was initiated by a Contact.
Data Type
Description
isIncoming (int) - The value of this parameter indicates whether the Interaction is Incoming or Outgoing.
207
Return Value 1 - This value indicates that the Interaction is Incoming. 0 - This value indicates that the Interaction is Outgoing. hasAttachment (bool) This parameter indicates whether the event includes any attachments. True - This value indicates that the event includes attachments. False - This value indicates that the event does not include any attachments.
Data Type
Description
For example, the value of this parameter is set to True if the event is associated with the forwarded Interaction. messageContent[] - An array of the MessageContent structure that contains the details of the message, message content, and attachment(s) in the message. interactionId (long) The ID of the Interaction associated with the message. eventId (long) - The ID of the event associated with the message.
208
Return Value messageContent (string) - The contents of the message in plain text format. messageHtmlContent (string) - The contents of the message in HTML format. hasAttachment (bool) This parameter indicates whether the message includes any attachments. True - This value indicates that the message includes attachments. False - This value indicates that the message does not include any attachments. attachmentInfo - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment.
Data Type
Description
209
Return Value int[] attachmentIds The array containing the IDs of the attachment(s) associated with the message.
Data Type
Description
beforeIdUser (string) Depending on the activity in the Event, the name of the Contact, User, Team, or System who was the owner of the Interaction before the event occurred. afterIdUser (string) Depending on the activity in the Event, the name of the Contact, User, Team, or System who is the owner of the Interaction after the event occurred. originatorIdUser (string) The name of the Contact, User, or system, depending on the activity in the event. For example, if the Interaction was created after a message was received from a Contact, this method returns the name of the Contact.
subject (string) - If the event is associated with the exchange of a message, this variable indicates the subject of the message. interactionId (long) - The ID of the Interaction associated with Event.
210
Return Value attachmentData eventId (int) - The ID of the event associated with the attachment. attachmentId (int) - The ID of the attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment.
Data Type AttachmentInfo[]
Description This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message.
totalEventsCount eventId
int long
The total number of events in the Interaction. The ID of the event associated with forwarding an Interaction or sending an Interaction to a specialist. The ID of the outgoing message in the Outbox. The value of this parameter indicates whether an external dispatcher is used while sending or receiving messages. True - This value indicates that an external dispatcher is used. False - This value indicates that the Talisma dispatcher is used.
outGoingMessageId useExternalDispatcher
long bool
lockedByUserName
string
The name of the User who is the current owner of the Interaction.
211
Return Value interactionInfo interactionId (long) - The ID of the Interaction for which the Interaction details are retrieved. teamId (int) - The ID of the Team to which the Interaction belongs. teamName (string) - The name of the Team to which the Interaction belongs. ownerId (int) - The ID of the User who is the owner of the Interaction. ownerName (string) - The name of the User who is the owner of the Interaction. priority (int) - The priority of the Interaction. 1 - This value indicates that the priority of the Interaction is High. 0 - This value indicates that the priority of the Interaction is Normal.
Data Type InteractionInfo
Description This is an array of the InteractionInfo[] structure that contains the details of an Interaction.
aliasId (long) - The ID of the Alias associated with the Team to which the Interaction belongs. contactId (long) - The ID of the Contact associated with the Interaction. contactName (string) - The name of the Contact associated with the Interaction. contactEmail (string) The e-mail address of the Contact associated with the Interaction. subject (string) - The subject of the Interaction. lastUpdated (DateTime) The date and time when the Interaction was last updated.
212
Return Value systemPriority (int) - The priority of the Interaction assigned by the system. userPriority (int) - The priority of the Interaction assigned by a User. ruleBasedPriority (int) The priority of the Interaction assigned based on Rules configured. interactionState (int) - The current state of the Interaction. consultState (int) - If the Interaction was sent to a specialist, this value indicates the Consult state of the Interaction. An Interaction can be in one of the following Consult states: Sent to Specialist Specialist Responded Was Escalated
Data Type
Description
replyState (int) - If a reply was sent for the Interaction, this value indicates the Reply state of the Interaction. An Interaction can be in one of the following Reply states: Reply in Progress Reply in Outbox
213
Return Value isDeleted (bool) - The value of this parameter indicates whether the Interaction has been deleted from the Talisma system. True - This value indicates that the Interaction is deleted. False - This value indicates that the Interaction is not deleted.
Data Type
Description
messageCount (int) - The total number of messages in the Interaction. lastOpened (DateTime) The date and time when the Interaction was last opened. createdDate (DateTime) The date and time when the Interaction was created. lastResolvedDate (DateTime) - The date and time when the Interaction was last resolved. outgoingMessageId (long) - The ID of the outgoing reply to a message. reviewerId (long) - If the Interaction is sent for review, this is the ID of the User who is reviewing the Interaction. reviewerState (long) - If the Interaction is sent for review, this value indicates the Review state of the Interaction. An Interaction can be in one of the following Review states: Under Review Reviewed
lastMessageLanguageId (long) - The ID of the language in which the last message was sent. byte[] 214 The contents of the message.
fileBlob
Return Value error
Data Type string
Description The error message(s) returned when building the Consult or Forward message operation fails.
BuildForwardOrConsult Method Return Values The BuildForwardOrConsult method returns 0 if the operation is successful, and a negative value if the operation fails.
BuildReply
You can use the BuildReply method to compose a reply to a message in an Interaction. You must send the following values as input parameters to Talisma Interaction iService: The ID of the logged in User. The ID of the Interaction to which the reply is being composed. The cached information of the ReplyInfo structure of the Team to which the Interaction belongs.
Talisma Interaction iService processes the input values, and returns the reply message along with other details of the Interaction such as the details of the reply message, Interaction information, etc. Method Signature
long BuildReply(long userId, long interactionId, long[] cachedTeams, ref long teamId, ref long replyId, out ReplyInfo replyInfoData, out ReplyMsg replyinProgress, out ReplyMsg replyOriginalMessage, out InteractionInfo intInfo, out string error)
BuildReply Input Parameters The following table describes the input parameters for the BuildReply method:
Input Parameters userId interactionId Data Type long long Description The ID of the logged in User. The ID of the Interaction to which the reply is being composed. The cached information of the ReplyInfo structure of the Team to which the Interaction belongs.
cachedTeams
long[]
215
BuildReply Output Parameters The following table describes the output parameters for the BuildReply method:
Return Value teamId replyId Data Type ref long ref long Description The ID of the Team to which the Interaction belongs. The ID of the event associated with the build reply operation.
216
Return Value replyInfoData maxCharactersInReply (long) - The maximum number of characters allowed in a reply message. strPrefix (string) - The message type prefix that is added to the subject of the reply message. For example, if you have forwarded the message, this variable returns FW:. bEnableFeature (bool) The value of this parameter indicates whether the original message is indented with respect to the reply message. True - This value indicates that the original message is indented. False - This value indicates that the original message is not indented.
Data Type ReplyInfo
Description
SignatureOptions An array of the UserSignature[] structure that contains the details of the User signature. signatureId (long) The ID of the User signature that is added to the reply message. userId (long) - The ID of the User whose signature is added to the reply message. teamId (long) - The ID of the Team to which the User belongs. signatureHtmlFormat (string) - The signature of the User in HTML format.
217
Return Value signaturePlainTextForm at (string) - The signature of the User in plain text format. empty (bool) - This parameter indicates whether there is any message when you are forwarding an Interaction, or sending an Interaction to a specialist. True - This value indicates that there is a message associated with the Interaction. False - This value indicates that there is no message associated with the Interaction. attachToMessage (bool) - The value of this parameter indicates whether the User signature is automatically inserted in messages belonging to the Interaction. True - This value indicates that the User signature is included in all messages belonging to the Interaction. False - This value indicates that the User signature is not included in messages belonging to the Interaction. LanguageId (long) The ID of the language associated with the User signature.
Data Type
Description
prefixOptions[] - An array of the PrefixOptions[] structure that contains the details of the prefixes in the subject line of a message.
218
Return Value LanguageId (long) The ID of the Language associated with the prefix in the subject line. prefixForReply (string) - The prefix that is added to the subject of the message if the message is replied to. prefixForForward (string) - The prefix that is added to the subject of the message if the message is forwarded.
Data Type
Description
languageOptions - An array of the LanguageInfo [] structure that contains the details of the language used in the message. languageId (long) The ID of the language associated with the message. name (string) - The name of the language associated with the message.
globalConfigOptions - An array of the GlobalConfigDetails structure that contains the global configuration details. strInstallationId (string) - The ID of the Talisma installation. lMaxMessageSizeInKb ( long) - The maximum size of the message, in kilobytes, that is allowed. lMaxMessages (long) The maximum number of messages allowed in an Interaction.
219
Return Value bSendPropDataToConsu ltant (bool) - Indicates whether the Property data is included in the e-mail message when the reply is sent. True - This value indicates that the Property data is included in the e-mail message when the reply is sent. False - This value indicates that the Property data is not included in the e-mail message when the reply is sent. bIncludeTagLine (bool) Indicates whether the Talisma tag line is included in the message. True - This value indicates that the Talisma tag line is included in the message. False - This value indicates that the Talisma tag line is not included in the message. stOutGoingAliases - An array of the OutGoingAlias [] structure that contains the details of the Alias associated with a Team. aliasId (long) - The ID of the Alias used for the outgoing message. teamId (long) - The ID of the Team to which the Alias belongs.
Data Type
Description
220
Return Value name (string) - The name of the Alias associated with the Team. email (string) - The email address of the Alias associated with the Team. heuristicThread (int) The threading model that is used for Interactions.
Data Type
Description
strSnifferURL (string) The sniffer URL that is included in the message. bOriginalMessageInclude (bool) - Indicates whether the Interaction includes the original message along with the reply message. True - This value indicates that the original message is included in the reply. False - This value indicates that the original message is not included in the reply.
bSubjectLineInTheEnd (bool) - This value indicates whether the subject line is included at the end of the message. True - This value indicates that the subject line is included at the end of the message. False - This value indicates that the subject line is not included at the end of the message.
strLockedBy (string) - The ID of the User who is the owner of the message.
221
Return Value bLockAcquired (bool) This value indicates whether the lock is acquired on the message you want to reply. True - Indicates that the lock is acquired to perform operations on the message. False - Indicates that the lock is not acquired to perform operations on the message.
Data Type
Description
222
Return Value replyinProgress msgId (long) - The ID of the reply message. languageId (long) - The language ID associated with the reply message. aliasId (long) - The ID of the Alias associated with the Team to which the Interaction belongs. bHasAttachments (bool) The value of this parameter indicates whether the reply has any attachments. True - This value indicates that the reply has attachments. False - This value indicates that the reply does not have any attachments.
Data Type ReplyMsg
Description
strTo (string) - If a reply is sent or received, this is the name of the person who has received the message. strFrom (string) - If a reply is received or sent, this is the name of the person who has sent the message. strCC (string) - If a reply is sent or received, this is the name of the person to whom a copy of the message was sent. strBcc (string) - If a reply is sent or received, this is the name of the person to whom a blank carbon copy of the message was sent. strSubject (string) - The subject of the reply. strPlainText (string) - The contents of the reply in plain text format. strHTMLText (string) The contents of the reply in HTML format. 223
Return Value strMailServerTime (string) - If a message is sent or received, this is the date and time of the mail server. lOutGoingMsgId (string) The ID of the reply saved in the Outbox. lLockedByUserId (string) - The ID of the User who is the current owner of the Interaction. strLockedByUserName (string) - The name of the User who is the current owner of the Interaction. attachments - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment.
Data Type
Description
224
Return Value replyOriginalMessage msgId (long) - The ID of the reply message. languageId (long) - The language ID associated with the reply message. aliasId (long) - The ID of the Alias associated with the Team to which the Interaction belongs. bHasAttachments (bool) The value of this parameter indicates whether the reply has any attachments. True - This value indicates that the reply has attachments. False - This value indicates that the reply does not have any attachments.
Data Type ReplyMsg
Description
strTo (string) - If a reply is sent or received, this is the name of the person who has received the message. strFrom (string) - If a reply is received or sent, this is the name of the person who has sent the message. strCC (string) - If a reply is sent or received, this is the name of the person to whom a copy of the message was sent. strBcc (string) - If a reply is sent or received, this is the name of the person to whom a blank carbon copy of the message was sent. strSubject (string) - The subject of the reply. strPlainText (string) - The contents of the reply in plain text format. strHTMLText (string) The contents of the reply in HTML format. 225
Return Value strMailServerTime (string) - If a message is sent or received, this is the date and time of the mail server. lOutGoingMsgId (string) The ID of the reply saved in the Outbox. lLockedByUserId (string) - The ID of the User who is the current owner of the Interaction. strLockedByUserName (string) - The name of the User who is the current owner of the Interaction. attachments - This is an array of the AttachmentInfo[] structure that contains the details of the attachments associated with the message. eventId (int) - The ID of the event associated with the attachment. attachmentId (int) The ID of the attachment. fileName (string) - The name of the file that is added as an attachment. cId (string) - The ID of the attachment if the attachment was added as an inline attachment. size (int) - The size of the attachment.
Data Type
Description
226
Return Value intInfo interactionId (long) - The ID of the Interaction for which the Interaction details are retrieved. teamId (int) - The ID of the Team to which the Interaction belongs. teamName (string) - The name of the Team to which the Interaction belongs. ownerId (int) - The ID of the User who is the owner of the Interaction. ownerName (string) - The name of the User who is the owner of the Interaction. priority (int) - The priority of the Interaction. 1 - This value indicates that the priority of the Interaction is High. 0 - This value indicates that the priority of the Interaction is Normal. aliasId (long) - The ID of the Alias associated with the Team to which the Interaction belongs. contactId (long) - The ID of the Contact associated with the Interaction. contactName (string) - The name of the Contact associated with the Interaction. contactEmail (string) The e-mail address of the Contact associated with the Interaction. subject (string) - The subject of the Interaction. lastUpdated (DateTime) The date and time when the Interaction was last updated.
Description This is an array of the InteractionInfo structure that contains the details of an Interaction.
227
Return Value systemPriority (int) - The priority of the Interaction assigned by the system. userPriority (int) - The priority of the Interaction assigned by a User. ruleBasedPriority (int) The priority of the Interaction assigned based on the Rules configured. interactionState (int) - The current state of the Interaction. consultState (int) - If the Interaction was sent to a specialist, this value indicates the Consult state of the Interaction. An Interaction can be in one of the following consult states: Sent to Specialist Specialist Responded Was Escalated
Data Type
Description
228
Return Value isDeleted (bool) - The value of this parameter indicates whether the Interaction is deleted from the Talisma system. True - This value indicates that the Interaction is deleted. False - This value indicates that the Interaction is not deleted.
Data Type
Description
lastMessageLanguageId (long) - The ID of the language in which the last message was sent.
229
Return Value error
Data Type string
Description The error message(s) returned when the building the reply message operation fails.
BuildReply Method Return Values The BuildReply method returns 0 if the operation is successful, and a negative value if the operation fails.
CancelReply
The CancelReply method enables you to cancel a reply message. You must send the ID of the required Interaction, and the ID of the Team to which the Interaction belongs as input parameters to Talisma Interaction iService. Talisma Interaction iService processes the input values, and cancels the reply message. Method Signature
long CancelReply(long interactionId, long teamId, out long lockedByUserId, ref long outGoingMessageId, out string error)
CancelReply Input Parameters The following table describes the input parameters for the CancelReply method:
Input Parameters interactionId teamId Data Type long long Description The ID of Interaction. the required
The ID of the Team to which the Interaction belongs.
CancelReply Output Parameters The following table describes the output parameters for the CancelReply method:
Return Value lockedByUserId Data Type long Description If the Interaction is currently being worked upon by another User, this is the ID of the User. The ID message. of the outgoing
outGoingMessageId error
ref long string
The error message(s) returned when the cancel operation fails.
230
DeleteReply
You can use the DeleteReply method to delete a reply message that you have saved. You must send the ID of the Interaction associated with the reply as an input parameter to Talisma Interaction iService. Talisma Interaction iService processes the input values, and deletes the Interaction. A reply message cannot be deleted if the corresponding Interaction is being worked upon by another User. In this scenario, the DeleteReply method returns the name of the User who is currently working on the Interaction, and the reply will not be deleted. For example, you had saved a reply to be sent to Contact Cathy regarding the balance premium amount to be paid by Cathy. However, Cathy has already been informed about the same. In this scenario, you can delete the saved reply using the DeleteReply method. Method Signature
long DeleteReply(long interactionId, bool string lockedByUserName, out string error) force, bool ignoreLocks, out
DeleteReply Input Parameters The following table describes the input parameters for the DeleteReply method:
Input Parameters interactionId Data Type long Description The ID of the Interaction in which you want to delete a reply message. Specify whether you want to delete the reply if the Interaction is being worked upon by another User. You can specify one of the following values: True - The reply is deleted irrespective of the owner of the Interaction. False - The reply is not deleted if the Interaction is being worked upon by another User.
force
bool
231
Input Parameters ignoreLocks
Data Type bool
Description If an Interaction is locked by another User, this variable enables you to specify whether you want to delete the reply message by ignoring the lock. You can specify one of the following values. True - The locks are ignored when deleting a reply. False - The locks are not ignored when deleting a reply.
DeleteReply Output Parameters The following table describes the output parameters for the DeleteReply method:
Return Value lockedByUserName Data Type string Description The name of the User who is currently working on the Interaction. The error message(s) returned when the delete operation fails.
error
string
DeleteReply Method Return Values The DeleteReply method returns 0 if the operation is successful, and a negative value if the operation fails.
232
BuildSmsReply
You can use the BuildSmsReply method to compose an SMS reply message for an Interaction. You must send the following values as input parameters to Talisma Interaction iService: The ID of the User. The ID of the Interaction for which you want to compose an SMS reply message. The cached information of the ReplyInfo structure of the Team to which the Interaction belongs.
Talisma Interaction iService processes the input values, and returns the reply SMS message along with other details such as the extractor and dispatcher used for the SMS reply. Method Signature
long BuildSmsReply(long userId, long interactionId, ref long teamId, long[] cachedTeams, ref long replyId, out string lockedbyUserName, out bool interactionReplyPermission, out bool sendSmsPermission, out bool isContactValidForSms, out InteractionInfo interactionInfo, out string smsExtractorDispatcherDetails, out string error)
BuildSmsReply Input Parameters The following table describes the input parameters of the BuildSmsReply method:
Input Parameter userId interactionId cachedTeams Data Type long long long[] Description The ID of the required User. The ID of Interaction. the required
The cached information of the ReplyInfo structure of the Team to which the Interaction belongs.
BuildSmsReply Output Parameters The following table describes the output parameters of the BuildSmsReply method:
Return Value teamId replyId lockedbyUserName Data Type ref long ref long string Description The ID of the Team to which the Interaction belongs. The ID of the event associated with the build operation. If the Interaction is currently being worked upon by another User, this is the name of the User. Indicates whether the User has permissions to reply to Interactions. 233
interactionReplyPermission
bool
Return Value sendSmsPermission
Data Type bool
Description Indicates whether the User has Permissions to send SMS messages. Indicates whether the Contact to whom the SMS reply message must be sent is a valid Contact in Talisma.
isContactValidForSms
bool
234
Return Value InteractionInfo interactionId (long) - The ID of the Interaction for which the Interaction details are retrieved. teamId (int) - The ID of the Team to which the Interaction belongs. teamName (string) - The name of the Team to which the Interaction belongs. ownerId (int) - The ID of the User who is the owner of the Interaction. ownerName (string) - The name of the User who is the owner of the Interaction. priority (int) - The priority of the Interaction. 1 - This value indicates that the priority of the Interaction is High. 0 - This value indicates that the priority of the Interaction is Normal. aliasId (long) - The ID of the Alias associated with the Team to which the Interaction belongs. contactId (long) - The ID of the Contact associated with the Interaction. contactName (string) - The name of the Contact associated with the Interaction. contactEmail (string) The e-mail address of the Contact associated with the Interaction. subject (string) - The subject of the Interaction. lastUpdated (DateTime) The date and time when the Interaction was last updated.
Description This is an array of the InteractionInfo structure that contains the details of an Interaction.
235
Return Value systemPriority (int) - The priority of the Interaction assigned by the system. userPriority (int) - The priority of the Interaction assigned by a User. ruleBasedPriority (int) The priority of the Interaction assigned based on the Rules configured. interactionState (int) - The current state of the Interaction. consultState (int) - If the Interaction was sent to a specialist, this value indicates the Consult state of the Interaction. An Interaction can be in one of the following consult states: Sent to Specialist Specialist Responded Was Escalated
Data Type
Description
236
Return Value isDeleted (bool) - The value of this parameter indicates whether the Interaction is deleted from the Talisma system. True - This value indicates that the Interaction is deleted. False - This value indicates that the Interaction is not deleted.
Data Type
Description
lastMessageLanguageId (long) - The ID of the language in which the last message was sent.
237
Return Value smsExtractorDispatcherDeta ils
Data Type string
Description The details of the SMS Extractor and Dispatcher that will be used to send the SMS message. The error message(s) returned when the build operation fails.
error
string
238
Talisma Reports iService
Chapter 8:Talisma Reports iService

This chapter describes the Talisma Reports iService methods.
In this chapter
Overview................................................................................... GetReportsForUser ................................................................... GetReportForReportId .............................................................. CheckReportPermisssionForUser ............................................. Page 240 Page 242 Page 244 Page 247
239
Overview
Information in the form of reports is very useful in analysis and decision-making processes. Talisma can interpret complex data and generate reports to help you in this process. In Talisma, reports help in analyzing information pertaining to Objects and their Properties. Reports are created by Talisma Client Users using the feature-rich Analytics Workspace. Reports in Talisma provide Users with the ability to view data from different perspectives, and to analyze the data on a variety of parameters, enabling better planning and management. Talisma provides a set of predefined reports which Talisma Client Users can generate and view quickly. In addition, Talisma Client Users with appropriate Permissions can also create customized reports. Talisma Client Users can create and manage Talisma Reports, SQL Reports, Microsoft Excel Reports and OLAP Cube-based Reports. You can use Talisma Reports iServices to retrieve Talisma Reports and SQL Reports that are created by Talisma Client Users. Talisma Reports There are two types of Talisma Reports - Cross Tab Reports and Drill Down Reports. A Cross Tab Report evaluates data for a selected base Object with respect to one or more of its Properties. Cross Tab Reports are easy to understand, and are useful in analyzing the information as the data is presented in rows and columns. Drill Down Reports enable you do an in-depth analysis of summary information. You essentially drill through summarized information in a report to get detailed information.
SQL Reports A Microsoft SQL report displays information generated as a result of a user-supplied SQL Query based on a number of Talisma Objects. For more information about reports in Talisma, see Talisma Client Help. You can use Talisma Reports iService methods to perform the following operations in Talisma from an external application: Retrieve Talisma Reports, and SQL Reports to which a specific User has access. Retrieve a Talisma Report, or an SQL Report based on the ID of a report. Check whether a User has access to a specific Talisma Report, or SQL Report.
Example
You are the Team Lead of the Sales department of your company: WorldWaves Products. Using Talisma, your sales Team creates various Talisma Reports every month to analyze the sales trend of your companys products. You want to view specific Talisma Reports created by your Team from your external application. In this scenario, you can use Talisma Reports iService methods to retrieve reports from Talisma.
240
The following table describes the various Talisma Reports iService methods:
Method GetReportsForUser Description Retrieves the Talisma Reports, and SQL Reports to which a specified Talisma User has access. You must send the ID of the required User as an input parameter to the Talisma Reports iService. Talisma Reports iService processes the input value, and returns the XML list of all Talisma Reports, and SQL Reports to which the specified User has access. For Talisma Reports of type Cross Tab, and Drill Down, this method also returns the animated chart types using which the User can view these reports. GetReportForReportId Retrieves a Talisma Report, or an SQL Report based on the specified report ID. You must send the following values as input parameters to the Talisma Reports iService: The ID of the Talisma Report, or SQL Report you want to retrieve. The Database ID of the report type. For example, if the report you want to retrieve is a Cross Tab report, specify the value 1 for the reportType parameter, which indicates that the report is of type Cross Tab. The forDashboard parameter of the GetReportForReportId method. This parameter enables you to specify whether you want to retrieve the specified report with information in the report when it was last scheduled to be run, or you want to retrieve the report from Talisma Analytics Database. The getLatestReport parameter of the GetReportForReportId method. This parameter enables you to specify whether you want to retrieve the report with the most recent information in the report from Talisma Analytics Database.
Talisma Reports iService processes the input values, and returns the report in XML format. CheckReportPermissio nForUser Checks whether a User has access to a specific Talisma Report, or SQL Report in Talisma. You must send the ID of the User, and the ID of the required report as input parameters to the Talisma Reports iService. Talisma Reports iService processes the input values, and returns the userHasAccessToReport parameter which indicates whether the User has access to the specified report.
241
GetReportsForUser
You can use the GetReportsForUser method to retrieve Talisma Reports, and SQL Reports to which a specified Talisma User has access. Consider that you are a Team Manager at Worldwaves Marketing. You want to analyze the productivity patterns in your Team for the previous month. In this scenario, you can use the GetReportsForUser method to retrieve all the productivity related Talisma Reports, or SQL Reports to which you have access. You must send the ID of the required User as an input parameter to the Talisma Reports iService. Talisma Reports iService processes the input value, and returns the XML list of all the Talisma Reports, and SQL Reports to which the specified User has access. For Talisma Reports of type Cross Tab, and Drill Down, this method also returns the animated chart types using which the User can view these reports. Method Signature
long GetReportsForUser(long userId, out string reportsListXml, out string chartTypesList, out string error)
GetReportsForUser Input Parameters The following table describes the input parameter for the GetReportsForUser method:
Input Parameter userId Data Type long Description The ID of the User for whom you want to retrieve the Talisma Reports, or SQL Reports.
GetReportsForUser Output Parameters The following table describes the output parameters for the GetReportsForUser method:
Return Value reportsListXml Data Type string Description The XML list of all Talisma Reports, and SQL Reports to which the specified User has access.
242
Return Value chartTypesList
Data Type string
Description For Talisma Reports of type Cross Tab, and Drill Down, this parameter returns the list of all chart types using which you can view these reports. Example For a Cross Tab report, this parameter returns the list of chart types using which a Cross Tab report can be viewed. Note For SQL Reports, the value of this parameter is NULL.
error
string
GetReportsForUser Return Values The GetReportsForUser method returns 0 if the get operation is successful, and a negative value if the operation fails.
243
GetReportForReportId
You can use the GetReportForReportId method to retrieve a Talisma Report, or an SQL Report based on the specified report ID. Consider that you are the Team Manager of the Sales Team at WorldWaves Products. You use an external application to view, and manage information in Talisma. You want to analyze the Monthly Sales Report created in Talisma by your Team member. In this scenario, you can use the GetReportForReportId method to retrieve the report from Talisma by specifying the Database ID of the Monthly Sales Report. You must send the following values as input parameters to the Talisma Reports iService: The ID of the required Talisma Report, or SQL Report. The Database ID of the report type. For example, if the report you want to retrieve is a Cross Tab report, specify the value 1 for this parameter, which indicates that the report is of type Cross Tab. The forDashboard parameter of the GetReportForReportId method. This parameter enables you to specify whether you want to retrieve the specified report with information in the report when it was last scheduled to be run, or you want to retrieve the report from Talisma Analytics Database. The getLatestReport parameter of the GetReportForReportId method. This parameter enables you to specify whether you want to retrieve the report with the most recent information in the report from Talisma Analytics Database.
Talisma Reports iService processes the input values, and returns the report in XML format. Method Signature
long GetReportForReportId(long reportId, int reportType, bool forDashboard, bool getLatestReport, out string reportXml, out DateTime LastRunDate, out string error)
GetReportForReportId Input Parameters The following table describes the input parameters for the GetReportForReportId method:
Input Parameter reportId reportType Data Type long int Description The ID of the required report. The Database ID of the report type. You can specify one of the following values: 1 - Specify this value if the report you want to retrieve is a Cross Tab Report. 5 - Specify this value if the report you want to retrieve is a Drill Down Report. 2 - Specify this value if the report you want to retrieve is an SQL Report.
244
Input Parameter forDashboard
Data Type bool
Description Specify whether you want to retrieve the report with information in the report when it was last scheduled to be run, or you want to retrieve the report from Talisma Analytics Database. You can specify one of the following values: True - Specify this value if you want to retrieve the report with information in the report when it was last scheduled to be run. False - Specify this value if you want to retrieve the report from Talisma Analytics Database.
Note It is recommended that you set the value of the forDashboard parameter to False, if you have specified the ID of an SQL Report. getLatestReport bool Specify whether you want to retrieve the report with the most recent information in the report from Talisma Analytics Database. You can specify one of the following values: True - Specify this value if you want to retrieve the report with the most recent information in the report from Talisma Analytics Database. False - Specify this value to retrieve the report that was previously retrieved from the Talisma Analytics Database.
245
GetReportForReportId Output Parameters The following table describes the output parameters for the GetReportForReportId method:
Return Value reportXml LastRunDate Data Type string DateTime Description The report in XML format. The date and time when the report was previously retrieved from Talisma Analytics Database. The error message(s) returned when the get operation fails.
error
string
GetReportForReportId Return Values The GetReportForReportId method returns 0 if the get operation is successful, and a negative value if the operation fails.
Note
If you have specified the ID of an SQL Report, and if you have set the value of the forDashboard parameter to True, this method will return an error message, and the value of the reportXml output parameter will be NULL.
246
CheckReportPermisssionForUser
You can use the CheckReportPermissionForUser method to check whether a User has access to a specific Talisma Report, or SQL Report in Talisma. For example, the Sales Department in your company has various Talisma reports to analyze the sales pattern in your organization. However, access to these reports is restricted to some Users only. In this scenario, you can use this method to check whether a User has access to view a specific report. You must send the ID of the required User, and the report ID as input parameters to the Talisma Reports iService. Talisma Reports iService processes the input values, and returns the userHasAccessToReport parameter which indicates whether the specified User has access to view the report. Method Signature
long CheckReportPermissionForUser(long userId, userHasAccessToReport, out string error) long reportId, out bool
CheckReportPermissionForUser Input Parameters The following table describes the input parameters for the CheckReportPermissionForUser method:
Input Parameter userId reportId Data Type long long Description The ID of the required User. The ID of the report for which you want to check whether the specified User has access to view the report.
CheckReportPermissionForUser Output Parameters The following table describes the output parameters for the CheckReportPermissionForUser method:
Return Value userHasAccessToReport Data Type bool Description The value of this parameter indicates whether the User has access to view the report. This parameter can have one of the following values: True - This value indicates that the User has access to view the report. False - This value indicates that the User does not have access to view the report.
error
string
The error message(s) returned when the check operation fails.
247
CheckReportPermissionForUser Return Values The CheckReportPermissionForUser method returns 0 if the operation is successful, and a negative value if the operation fails.
248
Talisma COF iService
Chapter 9:Talisma COF iService

This chapter describes the Talisma COF iService methods.
In this chapter
Overview................................................................................... GetRLTab .................................................................................. GetAttachmentTab .................................................................... GetCommentsTab ..................................................................... UpdateCommentsTab................................................................ GetPropertiesTab....................................................................... UpdateAttachmentTab .............................................................. DeleteObject ............................................................................. GetLinkedTab ........................................................................... UpdatePropertyTab ................................................................... UpdateRLTab ............................................................................ CreateObject ............................................................................. Page 250 Page 253 Page 255 Page 257 Page 258 Page 259 Page 261 Page 263 Page 264 Page 266 Page 267 Page 269
249
Overview
Talisma provides the Custom Object Framework (COF) that enables you to create custom Objects to map your organization's business processes in Talisma. Custom Objects are created in Talisma by the Talisma Business Administrator User. For example, the Talisma Business Administrator User can create the 'Policy' Object to manage the Insurance Policies of your customers. All details of a custom Object are stored in the custom Object window in Talisma. Talisma COF iService exposes various methods as Web Services to enable an external application to interact with Talisma to manage custom Object item information. For example, you may create a custom Object called Department to maintain information pertaining to the various Departments in your organization. You can use Talisma COF iService methods to manage the Department Object items from your external application. You can use Talisma COF iService methods to perform the following operations in Talisma from an external application: Create a new custom Object item. Delete an existing custom Object item. Update, or retrieve the Property values of a custom Object item available in the Property, and Linked tabs. Add, or retrieve comment details of a custom Object item from the Comment Tab. Add, update, retrieve, or delete the Property values of a custom Object item available in the RecordList Tab. Add a new attachment for a custom Object item in the Attachment Tab. Delete an existing attachment associated with a custom Object item from the Attachment Tab.
The following table describes various Talisma COF iService methods:

Method GetRLTab Description Gets the Property values of a custom Object item available in the RecordList Tab of Talisma. You must send the custom Object ID, custom Object item ID, and the RecordList Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Property values if the get operation is successful. Gets the attachment details of a custom Object item available in the Attachment Tab of Talisma. You must send the custom Object ID, custom Object item ID, and the Attachment Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Attachment details, if the get operation is successful. Gets the comment details of a custom Object item available in the Comment Tab of the custom Object window in Talisma. You must send the custom Object ID, custom Object item ID, and the Comment Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the comment details if the get operation is successful.
GetAttachmentTab
GetCommentsTab
250
Description Updates the comment details of a custom Object item available in the Comment Tab of Talisma. You must send the custom Object ID, custom Object item ID, Comment Tab ID, and the CommentsData structure that contains the comment details you want to add to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the update operation. Gets the Property values of a custom Object item available in a Property Tab of a custom Object window in Talisma. You must send the custom Object ID, custom Object item ID, and the Property Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Property values if the get operation is successful. Adds, or deletes the attachment details of a custom Object item available in the Attachment Tab of Talisma. You must send the custom Object ID, custom Object item ID, and the AttachmentData[] structure that contains the attachment details as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the add, or delete operation. Deletes an existing custom Object item from Talisma. You must send the custom Object ID, and the custom Object item ID that you want to delete as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the delete operation. You must send the bDeleteDepInst parameter to the DeleteObject method, if you want to delete all Objects related to the custom Object item along with the custom Object item. You must set the value of this parameter to True.
GetPropertiesTab
UpdateAttachmentTab
DeleteObject
GetLinkedTab
Gets the Property values of a custom Object item available in the Linked Tab of Talisma. You must send the custom Object ID, custom Object item ID, and the Linked Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Property values, if the get operation is successful. Updates the Property values of a custom Object item available in a Property Tab of a custom Object item in Talisma. You must send the custom Object ID, custom Object item ID, and the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the update operation.
UpdatePropertyTab
251
Method UpdateRLTab
Description Adds, deletes, or updates the Property values of a custom Object item available in the RecordList Tab of Talisma. You must send the custom Object ID, custom Object item ID, RecordList Tab ID, the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the update operation. To delete rows from the RecordList Tab of the custom Object, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array.
CreateObject
Creates a new custom Object item in Talisma. You must send the following values as input parameters to Talisma COF iService: The ID of the custom Object A name for the new custom Object item The ID of the User who must be assigned as the owner for the custom Object item. If you are creating a Team custom Object, the ID of the Team with which the custom Object item will be associated. If you are creating a shared custom Object item, the ID(s) of the Team(s) in Talisma with which the custom Object item will be shared. The PropertyInfo[] structure with new Property values.
Talisma COF iService processes the input values, and returns the ID of the custom Object item if the custom Object item is created successfully.
252
GetRLTab
You can use the GetRLTab method to get the Property values of a custom Object item available in the RecordList Tab of Talisma. Let us consider a scenario where you have created a custom Object called Department. You maintain details related to Department Heads in a RecordList Tab of the Department Object. You want to fetch Department Head details for a Department. To get this information from Talisma, you would use the GetRLTab method. You must send the custom Object ID, custom Object item ID, and the RecordList Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetRLTab(long objectType, long objectID, long tabID, int getPropinfoOrPropxml, out PropertyInfo[] propData, out string rlpropXML, out string error)
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item for which you are retrieving the Property values from the RecordList Tab. The ID of the RecordList Tab associated with the custom Object. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo structure. 1- Specify this value to obtain the output in XML format in the rlpropXML output parameter. 2 - Specify this value to obtain the output in the PropertyInfo structure, and in XML format in the rlpropXML output parameter.
tabID
long
int
253
GetRLTab Output Parameters The following table describes the output parameters for the GetRLTab method.
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - A unique ID used to identify a Property value row in a RecordList Tab in Talisma. This member returns the rowID. relJoinID (long) - This is not applicable for a RecordList Tab. string This parameter contains the output in XML format. The value of the rlpropXML parameter is NULL if no Property values are available in the specified RecordList Tab of the custom Object. error string The error message(s) returned when the get operation fails. Data Type PropertyInfo[ ] Description This is an array of the PropertyInfo[] structure that contains the Property values retrieved from the RecordList Tab of the specified custom Object item. The value of the propData array is blank if no Property values are available in the RecordList Tab of the custom Object item.
r1propXML
254
GetAttachmentTab
You can use the GetAttachmentTab method to get the attachment details of a custom Object item available in the Attachment Tab of Talisma. For example, you can use the GetAttachmentTab method to retrieve the Department details stored as an attachment in the Attachment Tab of the relevant Department. You must send the custom Object ID, custom Object item ID, and the Attachment Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the attachment details if the get operation is successful. Method Signature
long GetAttachmentTab(long objectType, long objectID, AttachmentData[] attachments, out string error) long tabID, out
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item for which you are retrieving the attachment details from the Attachment Tab. The ID of an Attachment Tab associated with the custom Object.
tabID
long
255
Return Value attachments fileName (string) - Name of the attachment. comment (string) - The User comment that describes the attachment. fileBlob (string) - The text content of the attachment. deleteAttachment (bool) This value indicates whether the attachment should be deleted. You can use the following values: True - The attachment is deleted. False - The attachment is excluded from deletion. Data Type AttachmentData[] Description An array of the AttachmentData[] structure. This array contains the name of the attachment, the comment about the attachment, the text content of the attachment, the boolean value to indicate if the attachment needs to be deleted, and the unique ID for the attachment. The value of the attachments array is blank if no attachment is available in Attachment Tab of a custom Object item.
error
GetAttachmentTab Return Values The GetAttachmentTab method returns 0 if the operation is successful, and a negative value if the operation fails.
256
GetCommentsTab
You can use the GetCommentsTab method to get the comment details of a custom Object item available in the Comment Tab of Talisma. For example, you can use the GetCommentsTab method to retrieve the comments added to the Comment Tab of a Department maintained in Talisma. You must send the custom Object ID, custom Object item ID, and the Comment Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Comment details if the get operation is successful. Method Signature
long GetCommentsTab(long objectType, long CommentsData[] comments, out string error) objectID, long tabID, out
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object for which you are retrieving the comment details from the Comment Tab of the custom Object. The ID of the Comment Tab associated with the custom Object.
tabID
long
Return Value comments userID (long) - A unique ID used to identify a User in Talisma. The comment details in the Comment Tab are added by the User associated with this User ID. date (DateTime) - The date, and time the comment was added. comment (string) - The details of the comment. Data Type CommentsData[ ] Description This is an array of the CommentsData[] structure that contains the details of comments retrieved from the Comment Tab of the specified custom Object item.
257
Return Value error
Data Type string
GetCommentsTab Return Values The GetCommentsTab method returns 0 if the operation is successful, and a negative value if the operation fails.
UpdateCommentsTab
You can use the UpdateCommentsTab method to add comment details to a custom Object item available in the Comment Tab of Talisma. For example, you can use the UpdateCommentsTab method to add comments to the Comment Tab of a Department maintained in Talisma. You must send the custom Object ID, custom Object item ID, Comment Tab ID, and the CommentsData structure that contains the comment details you want to add to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the update operation. Method Syntax
long UpdateCommentsTab(long objectType, CommentsData comment, out string error) long objectID, long tabID,
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item for which you want to update the comment details in the Comment Tab of the custom Object. The ID of the Comment Tab associated with the custom Object.
tabID
long
258
Input Parameter comment userID (long) - The ID of the User who is updating the comment, or the ID of the User on behalf of whom the comment is updated. date (DateTime) - The date, and time the comment was added. comment (string) - The details of the comment.
Data Type CommentsData
Description The CommentsData structure containing the updated details of the comment.
UpdateCommentsTab Return Values The method returns 0 if the operation is successful, and a negative value if the operation fails.
GetPropertiesTab
You can use the GetPropertiesTab method to get the Property values of a custom Object item available in a Property Tab of a custom Object window in Talisma. For example, you may want to obtain details of a Department maintained in Talisma. In this scenario, you would use the GetPropertiesTab method. You must send the custom Object ID, custom Object item ID, and the Property Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetPropertiesTab(long objectType, long objectID, long tabID, int getPropinfoOrPropxml, out PropertyInfo[] propData, out string propXML, out string error)
259
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object for which you want to retrieve the Property values from a Property Tab of the custom Object item. The ID of a Property Tab associated with the custom Object item. Indicates the format of the output: 0 - Specify this value to obtain the output in the PropertyInfo structure. 1 - Specify this value to obtain the output in XML format in the propXML output parameter. 2 - Specify this value to obtain the output in the PropertyInfo structure, and in XML format in the propXML output parameter.
tabID
long
int
260
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This member returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string Data Type PropertyInfo[ ] Description This is an array of Property Info[] structure that contains the Property values retrieved from a Property Tab of the specified custom Object. The value of the propData array is blank if no Property values are available in the specified Property Tab of the custom Object.
propXML
This parameter contains the output in XML format. The value of the propXML parameter is NULL if no Property values are available in the specified Property Tab of the custom Object.
error
string
UpdateAttachmentTab
You can use the UpdateAttachmentTab method to add, or delete the attachment details of a custom Object item available in the Attachment Tab of Talisma. For example, you can use the UpdateAttachmentTab method to add Department details as an attachment in the Attachment Tab of the relevant Department. You must send the custom Object ID, custom Object item ID, and the AttachmentData[] structure that contains the attachment details as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the add or delete operation. Method Signature
long UpdateAttachmentTab(long objectType, long objectID, long tabID, ref AttachmentData[] attachments, out string error)
261
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object for which you are updating the attachment details from the Attachment Tab. The ID of an Attachment Tab associated with the Custom Object. An array of the AttachmentData[] structure. This array contains the name of the attachment, the comment about the attachment, the text content of the attachment, the boolean value to indicate if the attachment needs to be deleted, and the unique ID for the attachment.
tabID
long
attachments fileName (string) - Name of the attachment. comment (string) - The user comment that describes the attachment. fileBlob (string) - The text content of the attachment. deleteAttachment (bool) This value indicates whether the attachment should be deleted. You can use the following values: True - The attachment is deleted. False - The attachment is excluded from deletion. This value must be set to "False" when you want to add a new attachment in the Attachment Tab. attachmentId (long) - A unique ID used to identify an attachment in Talisma. Set this value to "-1" to add a new attachment in the Attachment Tab. dateModified (DateTime) - The date and time when the attachment was last modified.
AttachmentData[]
262
Return Value error Data Type string Description The error message(s) returned when the update, or delete operation fails.
UpdateAttachmentTab Return Values The method returns 0 if the operation is successful, and a negative value if the operation fails.
DeleteObject
You can use the DeleteObject method to delete an existing custom Object item from Talisma. You must send the custom Object ID, and the custom Object item ID that you want to delete as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the delete operation. You must send the bDeleteDepInst parameter of the DeleteObject method, if you want to delete all Object items related to the custom Object item along with the custom Object item. You must set the value of this parameter to True. Method Signature
public long DeleteObject(long bDeleteDepInst, out string error) objectType, long objectID, bool
DeleteObject Input Parameters The following table describes the input parameters for the DeleteObject method:
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item you want to delete.
263
Input Parameter bDeleteDepInst
Data Type bool
Description This value indicates whether the Objects related with the custom Object item should also be deleted when the custom Object item is deleted. You can use the following values: True - Object items related to the custom Object item must be deleted. False - Object items related to the custom Object item must be excluded from deletion.
DeleteObject Output Parameters The following table describes the output parameters for the DeleteObject method:
Return Value error Data Type string Description The error message(s) returned when the custom Object item deletion fails.
DeleteObject Return Values The DeleteObject method returns 0 if the operation is successful, and a negative value if the operation fails.
GetLinkedTab
You can use the GetLinkedTab method to get the Property values of a custom Object item available in the Linked Tab of Talisma. For example, employee details are stored in an external data source, and a Department's employee details are maintained in the Linked Tab of the Department Object. In this scenario, you would use the GetLinkedTab method to retrieve the employee details for a Department. You must send the custom Object ID, custom Object item ID, and the Linked Tab ID of the custom Object item as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the Property values if the get operation is successful. Method Signature
long GetLinkedTab(long objectType, long PropertyInfo[] propData, out string error) objectID, long tabID, out
264
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item for which you want to retrieve the Property values from the Linked Tab of the custom Object. The ID of the Linked Tab associated with the custom Object.
tabID
long
Return Value propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - This member returns 0 or -1. relJoinID (long) - The ID of the related Objects display Property. string Data Type PropertyInfo[ ] Description This is an array of the PropertyInfo[] structure that contains the Property values retrieved from the Linked Tab of the specified custom Object. The value of the propData array is NULL if no Property values are available in the Linked Tab of the custom Object item.
error
265
UpdatePropertyTab
You can use the UpdatePropertyTab method to update the Property values of a custom Object item available in a Property Tab of a custom Object window in Talisma. For example, you may want to update details of a Department maintained in Talisma. In this scenario, you would use the UpdatePropertyTab method. You must send the custom Object ID, custom Object item ID, and the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the update operation. Method Signature
long UpdatePropertyTab(long propData, out string error) objectType, long objectID, PropertyInfo[]
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item for which you want to update the Property values in a Property Tab of the custom Object. This is an array of the PropertyInfo[] structure that contains the details of Properties in a Property Tab of a custom Object, which you want to update. The value of the propData array is blank if no Property values are available in the Property Tab of the custom Object.
PropertyInfo[ ]
266
UpdatePropertyTab Output Parameters The following table describes the output parameters for the UpdatePropertyTab method.
Input Parameter error Data Type string Description The error message(s) returned when the update operation fails.
UpdateRLTab
You can use the UpdateRLTab method to add, delete, or update the Property values of a custom Object item available in the RecordList Tab of Talisma. For example, you maintain details related to Department Heads in a RecordList Tab of the Department Object. You want to update Department Head details for a Department. To update this information in Talisma, you would use the UpdateRLTab method. You must send the custom Object ID, custom Object item ID, RecordList Tab ID, the PropertyInfo[] structure that contains the new Property values as input parameters to Talisma COF iService. Talisma COF iService processes the input values, and returns the status of the update operation. To delete rows from the RecordList Tab of the custom Object, you must specify the ID of the row as part of the deleteRows array. If you do not want to delete rows, ensure that the deleteRows array is declared as a zero length array. Method Signature
long UpdateRLTab(long objectType, long objectID, long tabID, PropertyInfo[] propData, int[] deleteRows, out string error)
Input Parameter objectType objectID Data Type long long Description A unique ID used to identify a custom Object in Talisma. The ID of the custom Object item for which you want to update the Property values in the RecordList Tab of the custom Object item. The ID of the RecordList Tab associated with the custom Object.
tabID
long
267
Input Parameter propData propertyID (long) - A unique ID used to identify a Property in Talisma. propValue (string) - The value assigned to a Property in Talisma. rowID (long) - The ID of the row in the RecordList Tab associated with a custom Object in which you want to update the Property values. relJoinID (long) - This is not applicable for a RecordList Tab.
Data Type PropertyInfo[ ]
Description This is an array of the PropertyInfo[] structure that contains the details of Properties in a RecordList Tab of a custom Object item, which you want to update. The value of the propData array is blank if no Property values are available in the RecordList Tab of the custom Object.
deleteRows
int[ ]
This is an array of row IDs you want to delete from the RecordList Tab of the specified custom Object item. If you do not want to delete any rows, ensure that the deleteRows array is declared as a zero length array.
UpdateRLTab Output Parameters The following table describes the output parameters for the UpdateRLTab method.
268
CreateObject
You can use the CreateObject method to create a new custom Object item in Talisma. For example, if you have a custom Object called Department in Talisma, you can use the CreateObject method to add a new Department. You must send the following values as input parameters to Talisma COF iService: The ID of the custom Object A name for the new custom Object item The ID of the User who must be assigned as the owner for the custom Object item. If you are creating a Team custom Object, the ID of the Team with which the custom Object item will be associated. If you are creating a shared custom Object item, the ID(s) of the Team(s) in Talisma with which the custom Object item will be shared. The PropertyInfo[] structure with new Property values.
Talisma COF iService processes the input values, and returns the ID of the custom Object item if the custom Object item is created successfully. Method Signature
long CreateObject(long objectType, string objectName, long ownerID, long teamID, string strAddTeam, PropertyInfo[] propData, out long objectID, out string error)
CreateObject Input Parameters The following table describes the input parameters for the CreateObject method:
Input Parameter objectType objectName Data Type long string Description A unique ID used to identify a custom Object in Talisma. The name of the custom Object item you want to create in Talisma. The ID of the User who must be set as the owner for the newly created custom Object item. This value must be set to "-1" when you create a Shared, or Global custom Object item. A unique ID used to identify a Team in Talisma. The custom Object item you create will be associated with this Team. This value is required only when you create a Team custom Object item. 269
ownerID
long
teamID
long
Input Parameter strAddTeam
Data Type string
Description The unique Team IDs with which the new custom Object item will be shared. The Team IDs must be separated with a Comma without any empty spaces. This value is required only when you create a Shared custom Object item.
PropertyInfo[ ]
This is an array of the PropertyInfo[] structure that contains the details of Properties in a Property Tab of a custom Object item. The value of the propData array is blank if no Property values are available in the Property Tab of the custom Object.
CreateObject Output Parameters The following table describes the output parameters for the CreateObject method.
Return Value objectID error Data Type long string Description The ID of the newly created custom Object item. The error message(s) returned when the custom Object item creation fails.
CreateObject Return Values The CreateObject method returns 0 if the operation is successful, and a negative value if the operation fails.
270
Chapter 10:Talisma Higher Ed Foundation iService

This chapter describes the Talisma Higher Ed Foundation iService methods used by the Student Information System to connect to Talisma, and communicate with the Talisma system. .
In this chapter
Overview................................................................................... CreateInstance........................................................................... UpdateInstance.......................................................................... DeleteInstance........................................................................... GetInstance ............................................................................... GetInstances.............................................................................. GetNextPendingMessages ........................................................ AddEnumValue ......................................................................... UpdateEnumValue .................................................................... DeleteEnumValue ..................................................................... AddAssociation......................................................................... UpdateAssociation .................................................................... DeleteAssociation ..................................................................... GetAssociationData .................................................................. GetEnum ................................................................................... TestCRMConnectivity .............................................................. ReturnStatus Structure .............................................................. Page 272 Page 279 Page 285 Page 290 Page 294 Page 296 Page 302 Page 310 Page 313 Page 316 Page 319 Page 323 Page 326 Page 329 Page 331 Page 333 Page 334
271
Overview
Talisma can now be integrated with an external Student Information System (SIS) using an SIS Connector component that achieves this integration. The SIS Connector is an external component that enables communication between API methods of Talisma CRM, and the SIS. For more information about the SIS Connector, see the SIS Connector documentation. Talisma Higher Ed Foundation iService consist of APIs that enable the SIS to send data to, and retrieve data from Talisma CRM through the SIS Connector. Talisma Higher Ed Foundation iService methods communicate with Talisma Main Database using the following message queues: Incoming Queue - Contains information sent by the SIS to Talisma Main Database. Information is received in Talisma in XML format. Outgoing Queue - Contains information sent by Talisma to the SIS. Information is sent in XML format.
In the high-level design of Talisma Higher Ed Foundation iService, the entry point for the SIS into Talisma is through the Application Server. Talisma Application Server exposes Talisma Higher Ed Foundation iService as a Web Service through which the SIS interacts with Talisma. Thus, the Talisma Higher Ed Foundation iService support the real-time integration of key reference data, account data and student operational data elements between Talisma CRM and the SIS. The following table describes the Higher Ed Foundation iService methods:
Method CreateInstance Description This method is used to create an instance of a Talisma Object. You must send the following values as input parameters to the CreateInstance method: The ObjectInformation information: structure containing the following
The type of Talisma Object for which an instance must be created. The ID of the SIS Object instance. This input value is optional. The URL of the system from which the request has been sent. The URL of the system to which the request has been sent. The ID of the Talisma Object Property. The value of the Talisma Object Property.
The CreateInstance method processes the input values, and returns details of the Talisma Object instance when the create operation is successful.
272
Method UpdateInstance
Description This method is used to update the details of an instance of a Talisma Object. You must send the following values as input parameters to the UpdateInstance method: The ObjectInformation information: structure containing the following
The type of Talisma Object whose instance must be updated. The ID of the SIS Object instance. This input value is optional. The URL of the system from which the request has been sent. The URL of the system to which the request has been sent. The ID of the Talisma Object instance that must be updated. The ID of the Property of the SIS Object instance. This input value is optional. The ID of the Talisma Object Property. The value of the Talisma Object Property.
The UpdateInstance method processes the input values, and returns the details of the Talisma Object instance when the update operation is successful. DeleteInstance This method is used to delete an instance of a Talisma Object. You must send the following values as input parameters to the DeleteInstance method: The DeleteObjectInformation structure containing the following information: The type of the Talisma Object. The ID of the SIS Object instance. This input value is optional. The URL of the system from which the request has been sent. The URL of the system to which the request has been sent. The ID of the Talisma Object instance that must be deleted. The mode of deletion (Delete, or Purge).
The DeleteInstance method processes the input values, and returns the details of the Talisma Object instance when the delete operation is successful. GetInstance This method is used to retrieve the details of an instance of a Talisma Object. You must send the following values as input parameters to the GetInstance method: The type of the Talisma Object. The ID of the Talisma Object instance. The IDs of Talisma Object Properties.
The GetInstance method processes the input values, and returns the details of the Talisma Object instance.
273
Method GetInstances
Description This method is used to retrieve the details of multiple instances of a Talisma Object. You must send the following values as input parameters to the GetInstances method: The type of the Talisma Object. The details of the Filter to retrieve Talisma Object instances from Talisma Main Database. The IDs of Talisma Object Properties.
The GetInstances method processes the input values, and returns the details of Talisma Object instances. GetNextPendingMessa ges This method is used to retrieve a specific number of messages whose status is Pending from the Talisma Outgoing Transaction queue. The status of the retrieved messages is automatically changed from Pending to Tagged. You must send the following values as input parameters to the GetNextPendingMessages method: The number of messages that must be retrieved. The Property IDs of the Talisma Outgoing Transaction queue.
The GetNextPendingMessages method processes the input values, retrieves messages, and changes the status of retrieved messages to Tagged. AddEnumValue This method is used to add a value to an enumerated constraint. This constraint can be associated with one or more enumerated Properties. You must send the following values as input parameters to the AddEnumValue method: The EnumInformation information: structure containing the following
The ID of the enumerated constraint. The value that must be added to the enumerated constraint.
The AddEnumValue method processes the input values, and returns the index number of the newly added value of the enumerated constraint. UpdateEnumValue This method is used to update a value of an enumerated constraint. This constraint can be associated with one or more enumerated Properties. You must send the following values as input parameters to the UpdateEnumValue method: The EnumInformation information: structure containing the following
The ID of the enumerated constraint. The index number of the enumerated constraint value. The new value to which the existing enumerated constraint value must be updated.
The UpdateEnumValue method processes the input values, updates the enumerated constraint value, and returns the status of the update operation.
274
Method DeleteEnumValue
Description This method is used to delete a value from an enumerated constraint. This constraint can be associated with one or more enumerated Properties. You must send the following values as input parameters to the DeleteEnumValue method: The EnumInformation information: structure containing the following
The ID of the enumerated constraint. The index number of the enumerated constraint value.
The DeleteEnumValue method processes the input values, deletes the enumerated constraint value, and returns the status of the delete operation. AddAssociation This method is used to associate an instance of a Talisma Object with an instance of the same, or different Talisma Object using a Relationship. The Object instance that must be associated with the former instance is referred to as the target instance. The Object instance with which the target instance must be associated is referred to as the source instance. Note: You can update the Property values of a Relationship only if the Relationship is of type Many to Many. You must send the following values as input parameters to the AddAssociation method: The RelationInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance. The ID of the Property of the Relationship. This input value is required only if the Relationship is of type Many to Many. The value of the Property of the Relationship. This input value is required only if the Relationship is of type Many to Many.
The AddAssociation method processes the input values, associates the instances, and returns the details of the operation.
275
Method UpdateAssociation
Description This method is used to update the Property values of a Relationship using which two instances of the same, or different Talisma Objects are associated. The Object instance that is associated with the former instance is referred to as the target instance. The Object instance with which the target instance is associated is referred to as the source instance. You must send the following values as input parameters to the UpdateAssociation method: The RelationInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance. The ID of the Property of the Relationship. The new value of the Property of the Relationship.
The UpdateAssociation method processes the input values, updates the Property values of the Relationship, and returns the details of the operation.
276
Method DeleteAssociation
Description This method is used to remove an association between two instances of the same, or different Talisma Objects. The Object instance that is associated with the former instance is referred to as the target instance. The Object instance with which the target instance is associated is referred to as the source instance. You must send the following values as input parameters to the DeleteAssociation method: The RelationInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance.
The DeleteAssociation method processes the input values, deletes the association between instances, and returns the details of the operation. GetAssociationData This method is used to retrieve Property details of a Relationship using which two instances of the same, or different Talisma Objects are associated. The Object instance that is associated with the former instance is referred to as the target instance. The Object instance with which the target instance is associated is referred to as the source instance. You must send the following values as input parameters to the GetAssociationData method: The ObjectInformation information: structure containing the following
The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance.
The GetAssociationData method processes the input values, retrieves Property details of the Relationship, and returns the details of the operation.
277
Method GetEnum
Description This method is used to retrieve values, and IDs of an enumerated constraint. This constraint can be associated with one, or more enumerated Properties. You must send the following values as input parameters to the GetEnum method: The EnumFilter structure containing the following information: The ID of the enumerated constraint. The index number of the enumerated constraint value. The enumerated constraint value.
The GetEnum method processes the input values, retrieves details of the enumerated constraint, and returns the details of the operation. TestCRMConnectivity The TestCRMConnectivity method is used to test the connectivity between the Talisma Higher Education Foundation iService methods, and the Talisma Main Database. The TestCRMConnectivity method tests the connectivity, and returns the status of the operation.
278
CreateInstance
The CreateInstance method is used to create an instance of the Talisma Object. You must send the following values as input parameters to the CreateInstance method: The ObjectInformation structure containing the following information: The type of Talisma Object for which an instance must to be created. The ID of the SIS Object instance. This input value is optional. The URL of the system from which the request has been sent. The URL of the system to which the request has been sent. The ID of the Talisma Object Property. The value of the Talisma Object Property.
The CreateInstance method processes the input values, and returns details of the create operation. Method Signature
public ReturnStatus CreateInstance(ObjectInformation objectInformation, out OperationInformation operationInformation, GeneralInfo [] generalInfo)
279
The following tables describe the parameters for the CreateInstance method:
280
Parameter: objectInformation Data Type: ObjectInformation Description: This is an input parameter. The ObjectInformation structure contains information about the Talisma Object for which an instance is being created. Following are the members of the ObjectInformation structure: ObjectType (long) The type of Talisma Object for which an instance must be created. Note: If you pass the value 6 for this member, which indicates that the Object type is of User, a new entry with the information that is passed in the PropertyInformation structure is created in the user mapping table of the Talisma Main Database. ExternalInstanceId (string) The ID of the SIS Object instance. An instance of the Talisma Object that is mapped to this SIS Object will be created. Specifying a value for this member is optional. ExternalInstancePropertyId (string) This member is not used in this method. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Talisma Object. This structure stores the ID, and the value of the Property. Following are the members of the PropertyInformation structure: Note: While creating a User, or Team Object item, it is recommended that you pass the ID, and value for the Name Property of the User, or Team. This ensures that there are no blank rows in the tables under the SIS Settings Node of Talisma Business Administrator using which SIS Users and Teams are mapped with Talisma Users, and Teams. If a User type of Property with the ID, and value of an SIS User is passed, the details of the Talisma User that is mapped to this SIS User is fetched from the user mapping table of the Talisma Main Database, and is used for further processing in Talisma. The Object instance created using the CreateInstance method can be updated by specifying the ID of the Object instance in the UpdateInstance method. Alternatively, if the ID of the Object instance is unavailable, you can pass the values for the ExternalInstanceId, and ExternalInstancePropertyId members in the UpdateInstance method to update the Object instance. To perform the update operation by passing values for the ExternalInstanceId, and ExternalInstancePropertyId members, while creating the Object instance, you must specify the values for the ExternalInstanceId, and ExternalInstancePropertyId members in the Value, and ID members of the PropertyInformation structure of the CreateInstance method. 281 ID (long) The ID of the Talisma Object Property. Value (string) The value of the Talisma Object Property.
Parameter: objectInformation Data Type: ObjectInformation If an SIS Team must be created using the CreateInstance method, you must specify the following values for the ID member of the PropertyInformation structure: 401 - ID of the SIS Team ID Property. 402 - ID of the Name Property of the SIS Team. If an SIS User must be created using the CreateInstance method, you must specify the following values for the ID member of the PropertyInformation structure: 601 - ID of the SIS User ID Property. 602 - ID of the Name Property of the SIS Team. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the CreateInstance method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId member of the OperationInformation structure. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId member of the OperationInformation structure. Parameter: generalInfo Data Type: GeneralInfo Description: This is an input parameter. The generalInfo parameter is an array of the GeneralInfo structure that contains information about the ignoreMandatoryCheck, and updateReadOnly flags. You must specify values for the members of this structure only if you want to create the Object instance without passing values for the mandatory Properties, or to update the values for the read-only Properties. Following are the members of the GeneralInfo structure: KeyName (string) The name of the flag. You can pass the following flag names: ignoreMandatoryCheck - The ignoreMandatoryCheck flag is used to specify whether a check must be performed for the mandatory Properties. To create an Object instance without passing values for the mandatory Properties, set the value of the KeyValue member for this flag to Yes. Otherwise, set the value of this flag to No. updateReadOnly - The updateReadOnly flag is used to specify whether the read-only properties must be updated. To update the read-only Properties, set the value of the KeyValue member for this flag to Yes. Otherwise, set the value of this flag to No.
KeyValue (string) The value that must set for the flag passed in the KeyName member. You can specify one of the following values: Yes No
282
Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
Parameter: operationInformation Data Type: OperationInformation Description: This is an output parameter. The OperationInformation structure returns the ID of the SIS Object instance that was passed as input in the ExternalInstanceId member of the objectInformation parameter, the ID of the Talisma Object instance, and the Transaction ID of the create operation. Following are the members of the OperationInformation structure: ExternalInstanceId (string) The ID of the SIS Object instance. The value of this member will be null if you have not specified a value for the ExternalInstanceId member of the objectInformation parameter.. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. InstanceId (long) The ID of the Talisma Object instance that is created.
CreateInstance Method Return Values The CreateInstance method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the CreateInstance Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <ObjectInformation> <TransactionId>69</TransactionId> <ObjectType>3</ObjectType> <ExternalInstanceId /> <InstanceId>164</InstanceId> <PropertiesInformation> <PropertyInformation> <Id>56</Id> <Value>Contact</Value> </PropertyInformation> <PropertyInformation> <Id>5010044</Id> 283
<Value>10</Value> </PropertyInformation> <PropertyInformation> <Id>57</Id> <Value>Contact@Talisma.com</Value> </PropertyInformation> </PropertiesInformation> <ExternalInstancePropertyId>0</ExternalInstancePropertyId> </ObjectInformation> <GeneralInformations> <GeneralInfo> <KeyName>Ignoremandatorycheck</KeyName> <KeyValue>Yes</KeyValue> </GeneralInfo> <GeneralInfo> <KeyName>Updatereadonly</KeyName> <KeyValue>Yes</KeyValue> </GeneralInfo> </GeneralInformations> <TargetURL /> <SourceURL /> <ActionName>CreateInstance</ActionName> </Message>
284
UpdateInstance
The UpdateInstance method is used to update the details of an instance of a Talisma Object. You must send the following values as input parameters to the UpdateInstance method: The ObjectInformation structure containing the following information: The type of Talisma Object whose instance must to be updated. The ID of the SIS Object instance. This input value is optional. The URL of the system from which the request has been sent. The URL of the system to which the request has been sent. The ID of the Talisma Object instance that must be updated. The ID of the Property of the SIS Object instance. This input value is optional. The ID of the Talisma Object Property. The value of the Talisma Object Property.
The UpdateInstance method processes the input values, and returns the details of the update operation. Method Signature
public ReturnStatus UpdateInstance(ObjectInformation objectInformation, out OperationInformation operationInformation, GeneralInfo[] generalInfo)
285
The following tables describe the parameters for the UpdateInstance method:
Parameter: objectInformation Data Type: ObjectInformation Description: This is an input parameter. The ObjectInformation structure contains information about the Talisma Object whose instance must be updated. Following are the members of the ObjectInformation structure: ObjectType (long) The type of Talisma Object whose instance must be updated. Note: If you pass the value 6 for this member, which indicates that the Object type is of User, the entry in the User mapping table of the Talisma Main Database that is corresponding to the information passed in the PropertyInformation structure is updated. ExternalInstanceId (string) The ID of the SIS Object instance. An instance of the Talisma Object that is mapped to this SIS Object will be updated. Specifying a value for this member is optional. Note: If the ID of the Talisma Object instance that must be updated is unavailable, you must pass the values for the ExternalInstanceId, and ExternalInstancePropertyId members to update the details of the Talisma Object instance. InstanceId (long) The ID of the Talisma Object instance that must be updated. If the value of this member is unavailable, you must pass the values for the ExternalInstanceId, and ExternalInstancePropertyId members to perform the update operation. Note: If the Object instance that must be updated is of type User, or Team, you must pass the actual UserID, or TeamID in this member. ExternalInstancePropertyId (string) The ID of the Property of the SIS Object instance. Specifying a value for this member is optional. You must pass the value for the ExternalInstancePropertyId member if the ID of the Talisma Object instance that must be updated is unavailable. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent.
286
Parameter: objectInformation Data Type: ObjectInformation propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Talisma Object. This structure stores the ID, and the value of the Property. Following are the members of the PropertyInformation structure: Note: If a User type of Property with the ID, and value of an SIS User is passed, the details of the Talisma User that is mapped to this SIS User is fetched from the user mapping table of the Talisma Main Database, and is used for further processing in Talisma. If an SIS Team must be updated using the UpdateInstance method, you must specify the following values for the ID member of the PropertyInformation structure: 402 - ID of the Name Property of the SIS Team. If an SIS User must be updated using the UpdateInstance method, you must specify the following values for the ID member of the PropertyInformation structure: 602 - ID of the Name Property of the SIS Team. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the UpdateInstance method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId member of the OperationInformation structure. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId member of the OperationInformation structure. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS. ID (long) The ID of the Talisma Object Property. Value (string) The value of the Talisma Object Property.
287
Parameter: generalInfo Data Type: GeneralInfo Description: This is an input parameter. The generalInfo parameter is an array of the GeneralInfo structure that contains information about the ignoreMandatoryCheck, and updateReadOnly flags. You must specify values for the members of this structure only if you want to update the details of the Object instance without passing values for the mandatory Properties, or to update the values for the read-only Properties. Following are the members of the GeneralInfo structure: KeyName (string) The name of the flag. You can pass the following flag names: ignoreMandatoryCheck - The ignoreMandatoryCheck flag is used to specify whether a check must be performed for the mandatory Properties. To update the details of the Object instance without passing values for the mandatory Properties, set the value of the KeyValue member for this flag to Yes. Otherwise, set the value of this flag to No. updateReadOnly - The updateReadOnly flag is used to specify whether the read-only properties must be updated. To update the read-only Properties, set the value of the KeyValue member for this flag to Yes. Otherwise, set the value of this flag to No.
KeyValue (string) The value that must set for the flag passed in the KeyName member. You can specify one of the following values: Yes No
Parameter: operationInformation Data Type: OperationInformation Description: This is an output parameter. The OperationInformation structure returns the ID of the SIS Object instance that was passed as input in the ExternalInstanceId member of the objectInformation parameter, the ID of the Talisma Object instance, and the Transaction ID of the create operation. Following are the members of OperationInformation structure: ExternalInstanceId (string) The ID of the SIS Object instance. The value of this member will be null if you have not specified a value for the ExternalInstanceId member of the objectInformation parameter. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. InstanceId (long) The ID of the Talisma Object instance.
UpdateInstance Method Return Values The UpdateInstance method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
288
Sample Message XML for the UpdateInstance Method:

<?xml version="1.0" encoding="utf-16"?> <Message> <ObjectInformation> <TransactionId>70</TransactionId> <ObjectType>3</ObjectType> <ExternalInstanceId /> <InstanceId>164</InstanceId> <PropertiesInformation> <PropertyInformation> <Id>56</Id> <Value>ContactUpdated</Value> </PropertyInformation> </PropertiesInformation> <ExternalInstancePropertyId>0</ExternalInstancePropertyId> </ObjectInformation> <GeneralInformations> <GeneralInfo> <KeyName>Ignoremandatorycheck</KeyName> <KeyValue>yes</KeyValue> </GeneralInfo> <GeneralInfo> <KeyName>updatereadonly</KeyName> <KeyValue>yes</KeyValue> </GeneralInfo> </GeneralInformations> <ActionName>UpdateInstance</ActionName> <TargetURL /> <SourceURL /> </Message>
289
DeleteInstance
The DeleteInstance method is used to delete an instance of a Talisma Object. You must send the following values as input parameters to the DeleteInstance method: The DeleteObjectInformation structure containing the following information: The type of the Talisma Object. The ID of the SIS Object instance. This input value is optional. The URL of the system from which the request has been sent. The URL of the system to which the request has been sent. The ID of the Talisma Object instance that must be deleted. The mode of deletion (Delete, or Purge).
The DeleteInstance method processes the input values, and returns the details of the delete operation. Method Signature
public ReturnStatus DeleteInstance(DeleteObjectInformation deleteObjectInformation, out OperationInformation operationInformation)
290
The following tables describe the parameters for the DeleteInstance method:
Parameter: deleteObjectInformation Data Type: DeleteObjectInformation Description: This is an input parameter. The DeleteObjectInformation structure contains information about the Talisma Object whose instance must be deleted. Following are the members of the DeleteObjectInformation structure: ObjectType (long) The type of the Talisma Object whose instance must be deleted. ExternalInstanceId (string) The ID of the SIS Object instance. An instance of the Talisma Object that is mapped to this SIS Object must be deleted. Specifying a value for this member is optional. Note: If the ID of the Talisma Object instance that must be deleted is unavailable, you must pass the values for the ExternalInstanceId, and ExternalInstancePropertyId members to delete the Talisma Object instance. InstanceId (long) The ID of the Talisma Object instance that must be deleted. If the value of this member is unavailable, you must pass the values for the ExternalInstanceId, and ExternalInstancePropertyId members to perform the delete operation. Note: If the Object instance that must be deleted is of type User, or Team, you must pass the actual UserID, or TeamID in this member. ExternalInstancePropertyId (string) The ID of the Property of the SIS Object instance. Specifying a value for this member is optional. You must pass the value for the ExternalInstancePropertyId member if the ID of the Talisma Object instance that must be deleted is unavailable. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. deletionMode (DeletionMode) Indicates as an enumerated value whether the Object instance has to be deleted permanently, or should be moved to the Trash Can Workspace for a period specified in Talisma Business Administrator after which they are purged from Talisma Main Database. You can specify one of the following values: Delete - To move the Talisma Object instance to the Trash Can Workspace. Purge - To permanently delete the Talisma Object instance.
291
Parameter: deleteObjectInformation Data Type: DeleteObjectInformation TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the DeleteInstance method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId member of the OperationInformation structure. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId member of the OperationInformation structure. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
Parameter: operationInformation Data Type: OperationInformation Description: This is an output parameter. The OperationInformation structure returns the ID of the SIS Object instance that was passed as input in the ExternalInstanceId member of the deleteobjectInformation parameter, the ID of the Talisma Object instance, and the Transaction ID of the create operation. Following are the members of OperationInformation structure: ExternalInstanceId (string) The ID of the SIS Object instance. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. InstanceId (long) The ID of the Talisma Object instance.
DeletInstance Method Return Values The DeleteInstance method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the DeleteInstance Method:
<?xml version="1.0" encoding="utf-16"?> <Message> 292
<ObjectInformation> <TransactionId>71</TransactionId> <ObjectType>3</ObjectType> <ExternalInstanceId /> <InstanceId>164</InstanceId> <DeletionMode>Delete</DeletionMode> <ExternalInstancePropertyId>0</ExternalInstancePropertyId> </ObjectInformation> <GeneralInformations /> <TargetURL /> <SourceURL /> <ActionName>DeleteInstance</ActionName> </Message>
293
GetInstance
The GetInstance method is used to retrieve the details of an instance of a Talisma Object. You must send the following values as input parameters to the GetInstance method: The type of the Talisma Object. The ID of the Talisma Object instance. The IDs of Talisma Object Properties.
The GetInstance method processes the input values, and returns the details of the operation. Method Signature
public ReturnStatus GetInstance(long objectType, string instanceId, long[] propertyIds, out ObjectInformation objectInformation)
The following tables describe the parameters for the GetInstance method:
Parameter: objectType Data Type: long Description: This is an input parameter. The type of the Talisma Object. The details of an instance of this Object must be retrieved. Parameter: instanceId Data Type: string Description: This is an input parameter. The ID of the Talisma Object instance whose details must be retrieved. Parameter: propertyIds Data Type: long Description: This is an input parameter. This is an array of the Property IDs of the Talisma Object instance.
294
Parameter: objectInformation Data Type: ObjectInformation Description: This is an output parameter. The ObjectInformation structure contains information about the Talisma Object instance whose details are retrieved. Following are the members of the ObjectInformation structure: ObjectType (long) The type of the Talisma Object. The details of an instance of this Object are retrieved. ExternalInstanceId (string) The ID of the SIS Object instance. The details of an instance of the Talisma Object that is mapped to this SIS Object are retrieved. InstanceId (long) The ID of the Talisma Object instance whose details are retrieved. ExternalInstancePropertyId (string) This member is not used in this method. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains the information about Properties of the Talisma Object. This structure stores the ID, and the value of the Property. Following are the members of the PropertyInformation structure: ID (long) The ID of the Talisma Object Property. Value (string) The value of the Talisma Object Property.
GetInstance Method Return Values The GetInstance method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
295
GetInstances
The GetInstances method is used to retrieve the details of multiple instances of a Talisma Object. You must send the following values as input parameters to the GetInstances method: The type of the Talisma Object. The details of the Filter to retrieve Talisma Object instances from Talisma Main Database. The IDs of Talisma Object Properties.
The GetInstances method processes the input values, and returns the details of the operation. Method Signature
public ReturnStatus GetInstances(long objectType, FilterCondition[] filterCondition, long[] propertyIds, out ObjectInformation[] objectsInformation)
The following tables describe the parameters for the GetInstances method:
Parameter: objectType Data Type: long Description: This is an input parameter. The type of the Talisma Object. The details of instances of this Object must be retrieved.
296
Parameter: filterCondition Data Type: FilterCondition Description: This is an input parameter. The filterCondition parameter is an array of the FilterCondition structure, which contains information about the Filter parameters used to retrieve Talisma Object instances from Talisma Main Database. Following are the members of the FilterCondition structure: ObjectType (int) The type of the Talisma Object. The details of instances of this Object are retrieved. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Talisma Object. This structure stores the ID, and the value of the Property. Following are the members of the PropertyInformation structure: ID (long) The ID of the Talisma Object Property. Value (string) The value of the Talisma Object Property. Operator (int) This member indicates the type of operator used in a search condition. You must specify the ID of the operator that has to be used in the search condition. For more information about IDs of various operators, see Operators and Operator IDs on page 299. Note: For more information about the various operators available for each data type, see Data Types and Available Operators on page 300. RowOperator (int) This member indicates the row operator. Each member of the filterCondition array is a search condition, and the row operator determines the relationship between individual search conditions. You can specify one of the following values: 1 - Indicates the ID of the OR row operator. If you specify this value, the search must satisfy one or more search conditions. 2 - Indicates the ID of the AND row operator. If you specify this value, the search must satisfy all the search conditions.
Parameter: propertyIds Data Type: long Description: This is an input parameter. This is an array of the Property IDs of the Talisma Object instances.
297
Parameter: objectsInformation Data Type: ObjectInformation Description: This is an output parameter. The objectsInformation parameter is an array of the ObjectInformation structure, which contains information about the Talisma Object instances whose details are retrieved. Following are the members of the ObjectInformation structure: ObjectType (long) The type of the Talisma Object. The details of instances of this Object are retrieved. ExternalInstanceId (string) The ID of the SIS Object instance. The details of instances of the Talisma Object that is mapped to this SIS Object are retrieved. InstanceId (long) The ID of the Talisma Object instance whose details are retrieved. ExternalInstancePropertyId (string) This member is not used in this method. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains the information about Properties of the Talisma Object. This structure stores the ID, and the value of the Property. Following are the members of the PropertyInformation structure: ID (long) The ID of the Talisma Object Property. Value (string) The value of the Talisma Object Property.
GetInstances Method Return Values The GetInstances method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
298
Operators and Operator IDs Table 1 lists the operators, and their corresponding IDs. Table 1 Operators and Their Corresponding Operator IDs
Operator OR AND > >= < <= contains = exists starts with NEAR <> contains near in on on or before on or after does not contain include subteams is null OR (in any row) AND (in any row) > (in any row) >= (in any row) < (in any row) <= (in any row)
Operator ID 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 103 104 105 106 107 108
299
Operator contains (in any row) = (in any row) starts with (in any row) <> (in any row) in (in any row) on (in any row) on or before (in any row) on or after (in any row) does not contain (in any row) is null (in any row) include subteams (in any row) ends with ends with (in any row)
Operator ID 109 110 111 112 113 114 115 116 117 118 119 23 120
Data Types and Available Operators Table 2 lists the supported data types, and the operators available for each data type. Table 2
Data Type long
Data Types and the Operators Available for Each Data Type
Available Operators >, >=, <, <=, =, <>, is null, > (in any row), >= (in any row), < (in any row), <= (in any row), = (in any row), <> (in any row), is null (in any row). contains, =, starts with, does not contain, is null, ends with, contains (in any row), = (in any row), starts with (in any row), does not contain (in any row), is null (in any row), ends with (in any row). in, on, on or before, on or after, is null, in (in any row), on (in any row), on or before (in any row), on or after (in any row), is null (in any row). =, <>, = (in any row), <> (in any row). =, <>, is null, = (in any row), <> (in any row), is null (in any row). contains, =, starts with, <>, does not contain, is null, ends with, contains (in any row), = (in any row), starts with (in any row), <> (in any row), does not contain (in any row), is null (in any row), ends with (in any row).
string
date list constant email
300
Data Type name
Available Operators contains, =, starts with, <>, does not contain, is null, ends with, contains (in any row), = (in any row), starts with (in any row), <> (in any row), does not contain (in any row), is null (in any row), ends with (in any row). contains, =, starts with, <>, does not contain, is null, ends with, contains (in any row), = (in any row), starts with (in any row), <> (in any row), does not contain (in any row), is null (in any row), ends with (in any row). >, >=, <, <=, =, <>, is null, > (in any row), >= (in any row), < (in any row), <= (in any row), = (in any row), <> (in any row), is null (in any row). =, <>, is null, = (in any row), <> (in any row), is null (in any row). contains, starts with, does not contain, ends with, contains (in any row), starts with (in any row), does not contain (in any row), ends with (in any row). =, <>, include subteams, = (in any row), <> (in any row), include subteams (in any row). =, <>, = (in any row), <> (in any row). contains, =, is null, contains (in any row), does not contain (in any row), is null (in any row). =, <>, include subteams, = (in any row), <> (in any row), include subteams (in any row).
url
float
predefconstant fulltext
teamlist listand exceptional teamlistand
301
GetNextPendingMessages
The GetNextPendingMessages method is used to retrieve a specific number of messages whose status is Pending from the Talisma Outgoing Transaction queue. The status of the retrieved messages is automatically changed from Pending to Tagged. You must send the following values as input parameters to the GetNextPendingMessages method: The number of messages that must be retrieved. The Property IDs of the Talisma Outgoing Transaction queue.
The GetNextPendingMessages method processes the input values, retrieves messages, and changes the status of retrieved messages to Tagged. Method Signature
public ReturnStatus GetNextPendingMessages(int recordCount, long[] propertyIds, out ObjectInformation[] objectsInformation)
The following tables describe the parameters for the GetNextPendingMessages method:
Parameter: recordCount Data Type: int Description: This is an input parameter. The number of messages that must be retrieved from the Talisma Outgoing Transaction queue. For example, if you want to retrieve five messages from the Talisma Outgoing Transaction queue, specify the value 5, and the first five messages of the queue are retrieved. Note: In the above example, if the queue contains only three messages, only those three messages are retrieved. Parameter: propertyIds Data Type: long Description: This is an input parameter. This is an array of Property IDs of the Talisma Outgoing Transaction queue.
302
Parameter: objectsInformation Data Type: ObjectInformation Description: This is an output parameter. The objectInformation parameter is an array of the ObjectInformation structure, which contains information about the Talisma Outgoing Transaction queue whose messages are retrieved. Following are the members of the ObjectInformation structure: ObjectType (long) This member returns 20027, which is the type of the Talisma Outgoing Transaction queue. ExternalInstanceId (string) This member stores null value. InstanceId (long) The ID of the message in the Talisma Outgoing Transaction queue that is retrieved. ExternalInstancePropertyId (string) This member is not used in this method. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Talisma Outgoing Transaction queue. This structure stores the ID, and the value of the Property. Following are the members of the PropertyInformation structure: Note: If you have specified a null value for the propertyIds parameter, the values of the following IDs are returned in the ObjectInformation structure: 4831001 - Indicates the ID of the Transaction ID Property. 4831002 - Indicates the ID of the TransactionName Property. 4831102 - Indicates the ID of the StatusDate Property. 4831103 - Indicates the ID of the StatusEnum Property. 4831104 - Indicates the ID of the MessageXML Property. 4831105 - Indicates the ID of the StatusMessage Property. 4831106 - Indicates the ID of the TransactionCode Property. ID (long) The ID of the Talisma Outgoing Transaction queue Property. Value (string) The value of the Talisma Outgoing Transaction queue Property.
GetNextPendingMessages Method Return Values The GetNextPendingMessages method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
303
Sample Outgoing XML Messages

This section lists the XML messages that are generated when a specific action is performed. These XML messages are stored in the Talisma Outgoing Transaction queue, and are retrieved by the GetNextPendingMessages method. Sample Message XML for Instance Creation of the Contact Object
<?xml version="1.0" encoding="utf-16"?> <Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target</TargetURL> <TransactionId>2232</TransactionId> <ActionName>CreateInstance</ActionName> <ObjectInformation> <ObjectType xmlns="http://www.Talisma.com/">20020</ObjectType> <InstanceId xmlns="http://www.Talisma.com/">2</InstanceId> <ExternalInstanceId xmlns="http://www.Talisma.com/">1080 </ExternalInstanceId> <PropertiesInformation <PropertyInformation> <Id>56</Id> <Value>TestName</Value> </PropertyInformation> <PropertyInformation> <Id>57</Id> <Value>TestEmail@Talisma.com</Value> </PropertyInformation> </PropertiesInformation> </ObjectInformation> <AssignmentLogInformation>  <AssignmentLog> <Owner></Owner> <Stage></Stage> <PreviousStage></PreviousStage> <SchoolStatus></SchoolStatus> <PreviousSchoolStatus></PreviousSchoolStatus> <Team></Team> <PreviousTeam></PreviousTeam> 304 xmlns="http://www.Talisma.com/"> 
<CreatedDate></CreatedDate> <ModifiedDate></ModifiedDate> </AssignmentLog> <AssignmentLog> <Owner></Owner> <Stage></Stage> <PreviousStage></PreviousStage> <SchoolStatus></SchoolStatus> <PreviousSchoolStatus></PreviousSchoolStatus> <Team></Team> <PreviousTeam></PreviousTeam> <CreatedDate></CreatedDate> <ModifiedDate></ModifiedDate> </AssignmentLog> </AssignmentLogInformation> </Message>
Sample Message XML for Instance Creation of other Objects

<?xml version="1.0" encoding="utf-16"?> <Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target</TargetURL> <TransactionId>8232</TransactionId> <ActionName>CreateInstance</ActionName> <ObjectInformation> <ObjectType xmlns="http://www.Talisma.com/">20020</ObjectType> <InstanceId xmlns="http://www.Talisma.com/">2</InstanceId> <ExternalInstanceId xmlns="http://www.Talisma.com/">1080 </ExternalInstanceId> <PropertiesInformation <PropertyInformation> <Id>4810812</Id> <Value>Jerry</Value> </PropertyInformation> <PropertyInformation> <Id>4810815</Id> <Value>12345678</Value> 305 xmlns="http://www.Talisma.com/"> 
</PropertyInformation> </PropertiesInformation> </ObjectInformation> </Message>
Sample Message XML for Updating an Instance

<?xml version="1.0" encoding="utf-16"?> <Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target</TargetURL> <TransactionId>2732</TransactionId> <ActionName>UpdateInstance</ActionName> <ObjectInformation> <ObjectType xmlns="http://www.Talisma.com/">20020</ObjectType> <InstanceId xmlns="http://www.Talisma.com/">2</InstanceId> <ExternalInstanceId xmlns="http://www.Talisma.com/">1080 </ExternalInstanceId> <PropertiesInformation <PropertyInformation> <Id>4810812</Id> <Value>Grace</Value> </PropertyInformation> <PropertyInformation> <Id>4810815</Id> <Value>87654321</Value> </PropertyInformation> </PropertiesInformation> </ObjectInformation> </Message> xmlns="http://www.Talisma.com/"> 
Sample Message XML for Deletion an Instance

<?xml version="1.0" encoding="utf-16"?> <Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target</TargetURL> 306
<TransactionId>2232</TransactionId> <ActionName>DeleteInstance</ActionName> <ObjectInformation> <ObjectType xmlns="http://www.Talisma.com/">20020</ObjectType> <InstanceId xmlns="http://www.Talisma.com/">2</InstanceId> <ExternalInstanceId xmlns="http://www.Talisma.com/">1080 </ExternalInstanceId> </ObjectInformation> </Message>
Sample Message XML for Addition of an Association

<?xml version="1.0" encoding="utf-16"?> <Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target/</TargetURL> <TransactionId>2232</TransactionId> <ActionName>AddAssociation</ActionName> <RelationInformation> <SourceObjectType>5001</SourceObjectType> <TargetObjectType>3</TargetObjectType> <RelationshipId>20287<RelationshipId> <SourceInstanceId>123</SourceInstanceId> <TargetInstanceId>786</TargetInstanceId> <PropertiesInformation> <PropertyInformation> <Id>21600</Id> <Value>Talisma</Value> </PropertyInformation> <PropertyInformation> <Id>21601</Id> <Value>CRM</Value> </PropertyInformation> </PropertiesInformation> </RelationInformation> </Message>
Sample Message XML for Deletion of an Association

<?xml version="1.0" encoding="utf-16"?> 307
<Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target/</TargetURL> <TransactionId>2232</TransactionId> <ActionName>DeleteAssociation</ActionName> <RelationInformation> <SourceObjectType>5001</SourceObjectType> <TargetObjectType>3</TargetObjectType> <RelationshipId>20287<RelationshipId> <SourceInstanceId>123</SourceInstanceId> <TargetInstanceId>786</TargetInstanceId> </RelationInformation> </Message>
Sample Message XML for Updating an Association

<?xml version="1.0" encoding="utf-16"?> <Message> <SISId>123</SISId> <SISCode>S123</SISCode> <SourceURL>http://Source/</SourceURL> <TargetURL>http://Target/</TargetURL> <TransactionId>2232</TransactionId> <ActionName>UpdateAssociation</ActionName> <RelationInformation> <SourceObjectType>5001</SourceObjectType> <TargetObjectType>3</TargetObjectType> <RelationshipId>20287<RelationshipId> <SourceInstanceId>123</SourceInstanceId> <TargetInstanceId>786</TargetInstanceId> <PropertiesInformation> <PropertyInformation> <Id>21600</Id> <Value>Talisma</Value> </PropertyInformation> <PropertyInformation> <Id>21601</Id> <Value>CRM</Value> </PropertyInformation> 308
</PropertiesInformation> </RelationInformation> </Message>
309
AddEnumValue
The AddEnumValue method is used to add a value to an enumerated constraint. This constraint can be associated with one or more enumerated Properties. You must send the following values as input parameters to the AddEnumValue method: The EnumInformation structure containing the following information: The ID of the enumerated constraint. The value that must be added to the enumerated constraint.
The AddEnumValue method processes the input values, and returns the index number of the newly added value of the enumerated constraint.
Note
You cannot add value(s) to a predefined enumerated constraint. Method Signature
public ReturnStatus AddEnumValue(ref EnumInformation enumInfo, transactionId) out long
310
The following tables describe the parameters for the AddEnumValue method:
Parameter: enuminfo Data Type: EnumInformation Description: This is a reference parameter. The EnumInformation structure contains information about the enumerated constraint to which a value must be added. Following are the members of the EnumInformation structure: Constraint Id (long) The ID of the enumerated constraint to which the value must be added. Index (long) This member returns the index number of the newly added value. EnumValue (string) The value that must be added to the enumerated constraint. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the AddEnumValue method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId parameter. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId parameter. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
Parameter: transactionId Data Type: long Description: This is an output parameter. The ID of the transaction in the Talisma Incoming Transaction queue.
311
AddEnumValue Method Return Values The AddEnumValue method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the AddEnumValue Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <EnumInformation> <TransactionId>73</TransactionId> <ConstraintId>5010015</ConstraintId> <EnumValue>Male</EnumValue> <Index>1</Index> </EnumInformation> <ActionName>AddEnumValue</ActionName> <TargetURL /> <SourceURL /> </Message>
312
UpdateEnumValue
The UpdateEnumValue method is used to update a value of an enumerated constraint. This constraint can be associated with one or more enumerated Properties. You must send the following values as input parameters to the UpdateEnumValue method: The EnumInformation structure containing the following information: The ID of the enumerated constraint. The index number of the enumerated constraint value. The new value to which the existing enumerated constraint value must be updated.
The UpdateEnumValue method processes the input values, updates the enumerated constraint value, and returns the status of the update operation.
Note
You cannot update the value(s) of a predefined enumerated constraint. Method Signature
public ReturnStatus UpdateEnumValue(EnumInformation enumInfo, transactionId) out long
313
The following tables describe the parameters for the UpdateEnumValue method:
Parameter: enuminfo Data Type: EnumInformation Description: This is a reference parameter. The EnumInformation structure contains information about the enumerated constraint whose value must be updated. Following are the members of the EnumInformation structure: Constraint Id (long) The ID of the enumerated constraint whose value must be updated. Index (long) The index number of the enumerated constraint value that must be updated. EnumValue (string) The new value to which the existing enumerated constraint value must be updated. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the UpdateEnumValue method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId parameter. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId parameter. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
314
UpdateEnumValue Method Return Values The UpdateEnumValue method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the UpdateEnumValue Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <EnumInformation> <TransactionId>74</TransactionId> <ConstraintId>5010015</ConstraintId> <EnumValue>Campus</EnumValue> <Index>1</Index> </EnumInformation> <ActionName>UpdateEnumValue</ActionName> <TargetURL /> <SourceURL /> </Message>
315
DeleteEnumValue
The DeleteEnumValue method is used to delete a value from an enumerated constraint. This Enumerated constraint can be associated with one or more enumerated Properties. You must send the following values as input parameters to the DeleteEnumValue method: The EnumInformation structure containing the following information: The ID of the enumerated constraint. The index number of the enumerated constraint value.
The DeleteEnumValue method processes the input values, deletes the enumerated constraint value, and returns the status of the delete operation.
Note
You cannot delete the value(s) from a predefined enumerated constraint. Method Signature
public ReturnStatus DeleteEnumValue(EnumInformation enumInfo, out long transactionId)
316
The following tables describe the parameters for the DeleteEnumValue method:
Parameter: enuminfo Data Type: EnumInformation Description: This is a reference parameter. The EnumInformation structure contains information about the enumerated constraint whose value must be deleted. Following are the members of the EnumInformation structure: Constraint Id (long) The ID of the enumerated constraint whose value must be deleted. Index (long) The index number of the enumerated constraint value that must be deleted. EnumValue (string) This member is not used in DeleteEnumValue method. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the AddEnumValue method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId parameter. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId parameter. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
317
DeleteEnumValue Method Return Values The DeleteEnumValue method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the DeleteEnumValue Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <EnumInformation> <TransactionId>75</TransactionId> <ConstraintId>5010015</ConstraintId> <EnumValue /> <Index>1</Index> </EnumInformation> <ActionName>DeleteEnumValue</ActionName> <TargetURL /> <SourceURL /> </Message>
318
AddAssociation
The AddAssociation method is used to associate an instance of a Talisma Object with an instance of the same, or different Talisma Object using a Relationship. The Object instance that must be associated with the former instance is referred to as the target instance. The Object instance with which the target instance must be associated is referred to as the source instance.
Example
You want to associate a new Contact, B, with an existing Account, A, in Talisma. In this scenario, Contact B is the target instance, and Account A is the source instance. You must send the following values as input parameters to the AddAssociation method: The RelationInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance. The ID of the Property of the Relationship. This input value is required only if the Relationship is of type Many to Many. The value of the Property of the Relationship. This input value is required only if the Relationship is of type Many to Many.
The AddAssociation method processes the input values, associates the instances, and returns the details of the operation. Method Signature
public ReturnStatus long transactionId) AddAssociation(RelationInformation relationInfo, out
319
The following tables describe the parameters for the AddAssociation method:
Parameter: relationInfo Data Type: RelationInformation Description: This is an input parameter. The RelationInformation structure contains information about the Object instances between which an association must be established. Following are the members of the RelationInformation structure: SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. Specifying a value for this member is optional. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. Specifying a value for this member is optional. SourceInstanceId (long) The ID of the source instance with which the target instance must be associated. SourceObjectype (long) The Object type of the source instance. TargetObjectType (long) The Object type of the target instance. Specifying a value for this member is optional. RelationshipId (long) The ID of the Relationship using which the source instance and the target instance must be associated. TargetInstanceId (long) The ID of the target instance that must be associated with the source instance. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Relationship from the target instance side. Specify values for the members of this structure only if the Relationship between the Objects is of type Many to Many. This structure stores the ID, and value of the Property. Following are the members of the PropertyInformation structure: ID (long) The ID of the Property. Value (string) The value of the Property.
320
Parameter: relationInfo Data Type: RelationInformation TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the AddAssociation method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId parameter. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId parameter. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
Parameter: transactionId Data Type: long Description: This is an ouput parameter. The ID of the transaction in the Talisma Incoming Transaction queue.
AddAssociation Method Return Values The AddAssociation method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the AddAssociation Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <RelationInformation> <TransactionId>77</TransactionId> <SourceInstanceId>100</SourceInstanceId> <SourceObjectType>3</SourceObjectType> <TargetObjectType>2</TargetObjectType> <RelationshipId>4810702</RelationshipId> <TargetInstanceId>5</TargetInstanceId> <PropertiesInformation> <PropertyInformation> <Id>21763</Id> 321
<Value>2</Value> </PropertyInformation> </PropertiesInformation> </RelationInformation> <ActionName>AddAssociation</ActionName> <TargetURL /> <SourceURL /> </Message>
322
UpdateAssociation
The UpdateAssociation method is used to update the Property values of a Relationship using which two instances of the same, or different Talisma Objects are associated. The Object instance that is associated with the former instance is referred to as the target instance. The Object instance with which the target instance is associated is referred to as the source instance.
Note
You can update Property values of a Relationship only if the Relationship is of type Many to Many. You must send the following values as input parameters to the UpdateAssociation method: The RelationInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance. The ID of the Property of the Relationship. The new value of the Property of the Relationship.
The UpdateAssociation method processes the input values, updates the Property values of the Relationship, and returns the details of the operation. Method Signature
public ReturnStatus UpdateAssociation(RelationInformation relationInfo, out long transactionId)
323
The following tables describe the parameters for the UpdateAssociation method
Parameter: relationInfo Data Type: RelationInformation Description: This is an input parameter. The RelationInformation structure contains information about Object instances between which an association has been established using the Relationship whose Property values you want to update. Following are the members of the RelationInformation structure: SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. Specifying a value for this member is optional. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. Specifying a value for this member is optional. SourceInstanceId (long) The ID of the source instance with which the target instance is associated. SourceObjectype (long) The Object type of the source instance with which the target instance is associated. TargetObjectType (long) The Object type of the target instance that is associated with the source instance. Specifying a value for this member is optional. RelationshipId (long) The ID of the Relationship using which the source instance and the target instance are associated. The Property values of this Relationship must be updated. TargetInstanceId (long) The ID of the target instance that is associated with the source instance. propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Relationship from the target instance side. This structure stores the ID, and value of the Property. Following are the members of the PropertyInformation structure: ID (long) The ID of the Property. Value (string) The new value of the Property. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the UpdateAssociation method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId parameter. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId parameter.
324
Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
UpdateAssociation Method Return Values The UpdateAssociation method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the UpdateAssociation Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <RelationInformation> <TransactionId>80</TransactionId> <SourceInstanceId>100</SourceInstanceId> <SourceObjectType>3</SourceObjectType> <TargetObjectType>2</TargetObjectType> <RelationshipId>4810702</RelationshipId> <TargetInstanceId>5</TargetInstanceId> <PropertiesInformation> <PropertyInformation> <Id>21763</Id> <Value>5</Value> </PropertyInformation> </PropertiesInformation> </RelationInformation> <ActionName>UpdateAssociation</ActionName> <TargetURL /> <SourceURL /> </Message>
325
DeleteAssociation
The DeleteAssociation method is used to remove an association between two instances of the same, or different Talisma Objects. The Object instance that is associated with the former instance is referred to as the target instance. The Object instance with which the target instance is associated is referred to as the source instance. You must send the following values as input parameters to the DeleteAssociation method: The RelationInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance.
The DeleteAssociation method processes the input values, deletes the association between instances, and returns the details of the operation. Method Signature
public ReturnStatus DeleteAssociation(RelationInformation relationInfo, out long transactionId)
326
The following tables describe the parameters for the DeleteAssociation method
Parameter: relationInfo Data Type: RelationInformation Description: This is an input parameter. The RelationInformation structure contains information about the Object instances between which the association you want to remove has been established. Following are the members of the RelationInformation structure: SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. Specifying a value for this member is optional. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. Specifying a value for this member is optional. SourceInstanceId (long) The ID of the source instance with which the target instance is associated. SourceObjectype (long) The Object type of the source instance with which the target instance is associated. TargetObjectType (long) The Object type of the target instance that is associated with the source instance. Specifying a value for this member is optional. RelationshipId (long) The ID of the Relationship using which the source instance and the target instance are associated. TargetInstanceId (long) The ID of the target instance that is associated with the source instance. TransactionId (long) The ID of the transaction in the Talisma Incoming Transaction queue. This input value is required only if the DeleteAssociation method is resubmitted to the Talisma Incoming Transaction queue, and you want to prevent the creation of duplicate transactions for the same API request. Note: If the value of this member is less than, or equal to 0, a transaction is created, and the ID of this transaction is returned as output value in the TransactionId parameter. If the value of this member is greater than 0, the value that is passed as input in this member is returned as output in the TransactionId parameter. Parameter: SuppressMsgFlag Data Type: Bool Description: This is an input parameter. This is a parameter of the SuppressMsg class, and is used to specify whether the details of the transaction must be sent to the SIS. You can pass one of the following values for this parameter: True - The details of the transaction will not be sent to the SIS. False - The details of the transaction will be sent to the SIS.
327
DeleteAssociation Method Return Values The DeleteAssociation method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334. Sample Message XML for the DeleteAssociation Method:
<?xml version="1.0" encoding="utf-16"?> <Message> <RelationInformation> <TransactionId>81</TransactionId> <SourceInstanceId>100</SourceInstanceId> <SourceObjectType>3</SourceObjectType> <TargetObjectType>2</TargetObjectType> <RelationshipId>4810702</RelationshipId> <TargetInstanceId>5</TargetInstanceId> </RelationInformation> <ActionName>DeleteAssociation</ActionName> <TargetURL /> <SourceURL /> </Message>
328
GetAssociationData
The GetAssociationData method is used to retrieve Property details of a Relationship using which two instances of the same, or different Talisma Objects are associated. The Object instance that is associated with the former instance is referred to as the target instance. The Object instance with which the target instance is associated is referred to as the source instance. You must send the following values as input parameters to the GetAssociationData method: The ObjectInformation structure containing the following information: The URL of the system from which the request has been sent. This input value is optional. The URL of the system to which the request has been sent. This input value is optional. The ID of the source instance. The Object type of the source instance. The Object type of the target instance. This input value is optional. The ID of the Relationship. The ID of the target instance.
The GetAssociationData method processes the input values, retrieves Property details of the Relationship, and returns the details of the operation. Method Signature
public ReturnStatus GetAssociationData(ref RelationInformation relationInfo)
329
The following tables describe the parameters for the GetAssociationData method:
Parameter: relationInfo Data Type: RelationInformation Description: This is a reference parameter. The RelationInformation structure contains information about Object instances between which an association has been established using the Relationship whose Property details you want to retrieve. In the RelationInformation structure, the values for the following members must be passed as input: SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. This input value is optional. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent. This input value is optional. SourceInstanceId (long) The ID of the source instance with which the target instance is associated. SourceObjectype (long) The Object type of the source instance with which the target instance is associated. TargetObjectType (long) The Object type of the target instance that is associated with the source instance. This input value is optional. RelationshipId (long) The ID of the Relationship using which the source instance and the target instance are associated. The Property details of this Relationship must be retrieved. TargetInstanceId (long) The ID of the target instance that is associated with the source instance. In the RelationInformation structure, the values for the members of the PropertyInformation structure are returned as output: propertyInformation (PropertyInformation) The propertyInformation parameter is an array of the PropertyInformation structure that contains information about Properties of the Relationship from the target instance side. This structure stores the ID, and value of the Property. Following are the members of the PropertyInformation structure: ID (long) The ID of the Property. Value (string) The value of the Property.
GetAssociationData Method Return Values The GetAssociationData method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
330
GetEnum
The GetEnum method is used to retrieve values, and IDs of an enumerated constraint. This constraint can be associated with one, or more enumerated Properties. You must send the following values as input parameters to the GetEnum method: The EnumFilter structure containing the following information: The ID of the enumerated constraint. The index number of the enumerated constraint value. The enumerated constraint value.
The GetEnum method processes the input values, retrieves details of the enumerated constraint, and returns the details of the operation. Method Signature
public ReturnStatus GetEnum(EnumFilter enumFilter, out EnumInformation[] enumsInformation)
The following tables describe the parameters for the GetEnum method:
Parameter: enumFilter Data Type: EnumFilter Description: This is an input parameter. The EnumFilter structure contains information about the enumerated constraint whose values, and corresponding IDs must be retrieved. Following are the members of the EnumFilter structure: ConstraintId (long) The ID of the enumerated constraint. Note: If only ConstraintId is passed as the input value, and the index number of the enumerated constraint is unavailable, you must pass the value -99 for the Index member to return all the enumerated constraint values, and their corresponding index numbers.
Index (long) The index number of the enumerated constraint value that must be retrieved. Note: If ConstraintId, and Index are passed as input values, this method returns the corresponding enumerated constraint value.
EnumValue (string) The enumerated constraint value whose index number must be retrieved. This input value is casesensitive. Note: If ConstraintId, and EnumValue are passed as input values, this method returns the corresponding index number. For a particular index number, if you pass an incorrect enumerated constraint value, this method returns the correct enumerated constraint value.
331
Parameter: enumsInformation Data Type: EnumInformation Description: This is an ouput parameter. The enumsInformation parameter is an array of the EnumInformation structure, which contains information about values of the enumerated constraint. Following are the members of the EnumInformation structure: Constraint Id (long) The ID of the enumerated constraint. The details of values of this constraint are retrieved. Index (long) The index number of the enumerated constraint value that is retrieved. EnumValue (string) The enumerated constraint value that is retrieved. SourceURL (string) The URL of the SIS or Talisma system from which the request has been sent. TargetURL (string) The URL of the SIS or Talisma system to which the request has been sent.
GetEnum Method Return Values The GetEnum method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
332
TestCRMConnectivity
The TestCRMConnectivity method is used to test the connectivity between the Talisma Higher Education Foundation iService, and the Talisma Main Database. Method Signature
public ReturnStatus TestCRMConnectivity()
The TestCRMConnectivity method tests the connectivity, and returns the status of the operation.
Note
The TestCRMConnectivity method does not test the functionalities of other iService methods.
TestCRMConnectivity Method Return Values The TestCRMConnectivity method returns the ReturnStatus structure with the value of the statusId member as 0 if the operation is successful, and -1 along with the error code and error message if the operation fails. For more information about the ReturnStatus structure, see ReturnStatus Structure on page 334.
333
ReturnStatus Structure
Every Talisma Higher Education Foundation method returns the members of the ReturnStatus structure as return values. The following table describes the members of the ReturnStatus structure:
Structure: ReturnStatus Following are the members of the ReturnStatus structure: StatusId (int) This member returns 0 if the operation is successful, and -1 if the operation fails. ErrorCode (long) This member returns the error code if the operations fails. ErrorMessage (string) This member returns the error message associated with the error code if the operations fails.
334
Talisma Portal iService
Chapter 11:Talisma Portal iService

This chapter describes the Talisma Portal iService methods.
In this chapter
Overview................................................................................... GetPageSetting.......................................................................... GetPortalGlobalLinks ............................................................... GetPortalTabs............................................................................ GetPortalTemplate .................................................................... GetPortalTemplateIdentifiers.................................................... GetPortalTemplateObjectData .................................................. GetPortalWebPartsForTab ........................................................ GetRelationShipInstanceIDs..................................................... SetPageSetting .......................................................................... UpdatePortalData...................................................................... InitializeEventForRegistration.................................................. RegisterParticipantToEvent ...................................................... SetStateToRegisterForEvent ..................................................... CancelParticipant ...................................................................... Page 336 Page 341 Page 342 Page 344 Page 346 Page 347 Page 348 Page 351 Page 353 Page 354 Page 355 Page 361 Page 365 Page 369 Page 372
335
Overview
Talisma Customer Portal is a web-based application that is a one-stop-shop for all interactions a customer has with the organization. Talisma Customer Portal enables Portal visitors to have anytime access to their Portal accounts. Talisma Customer Portal can be configured to display content specific to the organization, to the logged in Portal user, or general information such as news through Web pages. Talisma Customer Portal displays information in the form of Tabs. You can create various types of Tabs based on the content that must be displayed in the Tab. Each Tab in Talisma Customer Portal is created, and configured based on the Object selected for the Tab. Talisma Portal iService exposes various methods as Web Services to enable an external application to interact with Talisma Customer Portal. You can use these methods to implement the features of Talisma Customer Portal in your application. For example, you can display a table view of Events on the home page of your Web site by retrieving the content from the relevant Tab of Talisma Customer Portal. From an external application, you can use Talisma Portal iService methods to perform the following operations in Talisma Customer Portal: For a specific Portal User, retrieve page setting information from the Home Tab of a Portal. Retrieve Global Links configured for a specific Portal. Retrieve Tabs configured for a specific Portal. Retrieve a specific Template. Retrieve Identifiers used in the Templates defined for a specific Portal Tab. Retrieve Property information of an Object from a Page in a Template. Retrieve Web Parts configured for a specific Portal Tab. Retrieve IDs of related Object Properties. For a specific Portal User, set the layout of Web Parts for the Home Tab of a Portal. Update Talisma Main Database with any changes in the Portal. Carry out all prerequisite operations on an Event before a Contact can register for the Event. Register Contacts for an Event. For a specific Participant, set the Participation status to Registered for an Event. Cancel the registration of a Participant of an Event.
336
The following table describes the various Talisma Portal iService methods:
Method GetPageSetting Description For a specific User, this method retrieves the Web Parts layout from the Home Tab of a Talisma Customer Portal. You must send the following values as input parameters to Talisma Portal iService: The ID of the required Portal user. The ID of the Home Tab.
Talisma Portal iService processes the input values, and returns the page setting information of the Home Tab. GetPortalGlobalLinks Retrieves Global Links configured for a Talisma Customer Portal. You must send the required Portal ID, the ID of the language associated with the Portal, the ObjInstanceData structure that contains the details of the Object whose Properties are included as parameters in the Global Link, and the unique identifier key as input parameters to Talisma Portal iService. Talisma Portal iService processes the input values, and returns the Global Links configured for the specified Talisma Customer Portal. GetPortalTabs Retrieves information from all the Tabs configured for a Talisma Customer Portal. You must send the required Portal ID, the ID of the language associated with the Portal, the ObjInstanceData structure that contains the details of the Object that is configured for a Portal Tab, and the unique identifier key as input parameters to Talisma Portal iService. Talisma Portal iService processes the input values, and returns information from all Tabs configured for the specified Talisma Customer Portal. GetPortalTemplate Retrieves a Template created for a Talisma Customer Portal Tab. The Talisma Business Administrator User can configure multiple Templates for a Portal Tab. Templates are specific formats in which Portal users can view, or update information in the various Tabs of Talisma Customer Portal. You must send the ID of the required Template as an input parameter to the Talisma Portal iService. Talisma Portal iService processes the input value, and returns the Template in XML format. GetPortalTemplateIde ntifiers Retrieves Identifiers associated with all Templates configured for a specific Talisma Customer Portal Tab. You must send the following values as input parameters to Talisma Portal iService: The ID of the required Portal. The Tab type of the Portal Tab for which the Templates are configured. The ID of the required Portal Tab.
Talisma Portal iService processes the input values, and returns the Template Identifiers in XML format.
337
Method GetPortalTemplateObj ectData
Description Retrieves Property values from a Page in a Portal Template. For Properties that have single values, this method retrieves the Property name, and the Property value. You must send parameter values for the ObjInstanceData structure as input parameters to the Talisma Portal iService. Talisma Portal iService processes the input values, and returns the Property name, and Property values of the relevant Object item from the specified Page in the Template. The method also returns the unique identifier key. Note This method does not retrieve Property names and values for enumerated Properties.
GetPortalWebPartsFor Tab
Retrieves Web Parts configured for a Talisma Customer Portal Tab. You must send the ID of the required Talisma Customer Portal Tab, and the ObjInstanceData structure as input parameters to Talisma Portal iService. Talisma Portal iService processes the input value, and returns the Web Parts configured for the specified Tab in XML format. Returns the IDs of Properties of an Object related to the base Object. You must send the base Object item ID, the Relationship path of the base Object, and the required Object ID as input parameters to Talisma Portal iService. Talisma Portal iService processes the input values, and returns the IDs of the Properties of the Object.
GetRelationShipInstan ceIDs
SetPageSetting
For a specific user, this method sets the layout of Web Parts in the Home Tab of a Talisma Customer Portal. You must send the following values as input parameters to Talisma Portal iService: The ID of the required Portal user. The ID of the Home Tab on the Portal. The page setting.
Talisma Portal iService processes the input values, and the Web Parts layout is set for the Home Tab in the Portal
338
Method UpdatePortalData
Description Updates Talisma Main Database with any changes made to the components of Talisma Customer Portal. Based on the information that you want to update, you must send the values for the relevant parameters from each of the following structures as input parameters to Talisma Portal iService: The ObjInstanceData[] structure that contains the details of an Object item. The RLData[] structure that contains information from a RecordList Tab of an Object. The AttachmentFile[] attachment(s). structure that contains details of
The AttachmentComments[] structure that contains details of the comments added for an attachment. The CommentsTab[] structure that contains information from a Comments Tab of an Object item.
You must also send the refreshAfterUpdate parameter of the UpdatePortalData method if you want to refresh information on the Portal with the latest updates. Talisma Portal iService processes the input values, and updates Talisma Main Database. InitializeEventForRegi stration Enables you to carry out all prerequisite operations before you can register a Contact for an Event. For example, using the InitializeEventForRegistration method, you can check whether a Contact is already a registered Participant in the Event, whether a Contact already exists in Talisma, and specify details of the Participant. You must send the following values as input parameters to the Talisma Portal iService: The ID of the required Event. The ID of the Contact you want to register for the Event. The ParticipantDetails[] structure that contains the participation details of the specified Contact. The isGroupRegistration parameter to specify whether you want to enable Contacts to register for the Event as a group, or as individual Participants.
Talisma Portal iService processes the input values, and returns the following values: The isSeatAvailable parameter that indicates whether sufficient seats are available in the Event for Contacts to register for the Event. The discounted cost available for the specified Contact.
339
Method RegisterParticipantTo Event
Description Registers a specific Contact for an Event. You must send the following values as input parameters to the Talisma Portal iService: The ID of the required Event. The ID of the Contact you want to register for an Event. The ParticipantDetails structure that contains the participation details of the specified Contact. The isGroupRegistration parameter to specify whether you want to enable Contacts to register for the Event as a group, or as individual Participants.
Talisma Portal iService processes the input values, and returns the isSeatAvailable parameter that indicates whether sufficient seats are available in the Event for Contacts to register for the Event. SetStateToRegisterFor Event Sets the participation status of a Participant to Registered for an Event. You must send the following values as input parameters to the Talisma Portal iService: The ID of the required Event. The ID of the Contact for whom you want to set the participation status to Registered in Talisma. The ParticipantDetails structure that contains the participation details of the specified Contact. For paid Events, send the paymentTransactionDetails parameter that contains details of the payment made by the specified Contact for registration to the Event. For free Events, set the value of this parameter to NULL.
Talisma Portal iService processes the input values, and sets the participation status of the specified Contact to Registered in Talisma. CancelParticipant Cancels the registration of Participants for an Event. You must send the IDs of Participants for whom you want to cancel the registration for an Event as an input parameter to the Talisma Portal iService. Talisma Portal iService processes the input value, and cancels the registration of the Participants. If Event registration could not be canceled for one or more of the specified Participants, this method returns the IDs of such Participants.
340
GetPageSetting
For a specific Portal user, you can use the GetPageSetting method to retrieve the layout of Web Parts from the Home Tab of a Talisma Customer Portal. You must send the following values as input parameters to Talisma Portal iService: The ID of the required Portal User. The ID of the Home Tab.
Talisma Portal iService processes the input values, and returns the page setting information of the Home Tab. Method Signature
long GetPageSetting(int userId, int portalId, ref string pageSetting, out string error)
GetPageSetting Input Parameters The following table describes the input parameters for the GetPageSetting method:
Input Parameter userId portalId Data type int int Description The ID of the required Portal user. The ID of the Home Tab.
GetPageSetting Output Parameters The following table describes the output parameters for the GetPageSetting method:
Return Value pageSetting Data type ref string Description The layout of Web Parts in the Home Tab. This information is retrieved in XML format. The error message(s) returned when the get operation fails.
error
string
GetPageSetting Return Values The GetPageSetting method returns 0 if the get operation is successful, and a negative value if the operation fails.
341
GetPortalGlobalLinks
You can use the GetPortalGlobalLinks method to retrieve Global Links configured for a Talisma Customer Portal. For example, you want to display the Global Links configured for a Talisma Customer Portal on the Home page of your organizations Web site. In this scenario, you can use the GetPortalGlobalLinks method to retrieve the Global Links configured for the Portal, and use the Global Link XML data returned by the method to configure the Global Links on your organizations Web site. You must send the required Portal ID, the ID of the language associated with the Portal, the ObjInstanceData structure that contains the details of the Object whose Properties are included as parameters in the Global Link, and the unique identifier key as input parameters to Talisma Portal iService. Talisma Portal iService processes the input values, and returns the Global Links configured for the specified Talisma Customer Portal. Method Signature
long GetPortalGlobalLinks(int portalId, int langId, ref ObjInstanceData[] arrObjInst, string strSessionKey, out string linkXml, out string error)
GetPortalGlobalLinks Input Parameters The following table describes the input parameters for the GetPortalGlobalLinks method:
Input Parameter portalId langId Data type int int Description The ID of the required Portal. The ID of the language associated with the Portal.
342
Input Parameter arrObjInst objectType (long) - The Object type ID of the Object whose Properties are included as parameters in the URL of a Global Link. instanceId (long) - The ID of the Object item. propData (String) Note: This parameter is an output parameter, and is described in the Output Parameters table of this method. tabIDs (string) - The ID of the Objects Item View tab in which the required Properties are configured. propIDs (string) - The IDs of the Properties that are included as parameters in the URL of a Global Link. pageID (long) - The ID of the Template Page in which the Properties are configured. arrPropInfo Note: This structure is currently not used in Talisma. teamId (long) - The ID of the Team to which the Object item belongs. objInstName (string) - The name of the Object item. relationshipInfo (string) The relationship path for the related Object Property.
Data type ref ObjInstanceData[]
Description This is an array of the ObjInstanceData[] structure that contains information about the Object item.
strSessionKey
string
This is a unique identifier key.
343
GetPortalGlobalLinks Output Parameters The following table describes the output parameters for the GetPortalGlobalLinks method:
Return Value arrObjInst propData (string) Data type ref ObjInstanceData[] Description The propData parameter is an output parameter of the ObjInstanceData structure that returns the Property name, and Property values. The Global Links configured for the Portal. This information is retrieved in XML format. The error message(s) returned when the get operation fails.
linkXml
string
error
string
GetPortalGlobalLinks Return Values The GetPortalGlobalLinks method returns 0 if the get operation is successful, and a negative value if the operation fails.
GetPortalTabs
You can use the GetPortalTabs method to retrieve information from all the Tabs configured for a specific Talisma Customer Portal. You must send the required Portal ID, the ID of the language associated with the Portal, the ObjInstanceData structure that contains the details of the Object that is configured for a Portal Tab, and the unique identifier key as input parameters to Talisma Portal iService. Talisma Portal iService processes the input values, and returns information from all Tabs configured for the specified Talisma Customer Portal. Method Signature
long GetPortalTabs(int portalId, int langId, ref ObjInstanceData[] arrObjInst, string strSessionKey, out string tabXml, out string error)
GetPortalTabs Input Parameters The following table describes the input parameters for the GetPortalTabs method:
Input Parameter portalId langId Data type int int Description The ID of the required Portal. The ID of the language associated with the Portal.
344
Input Parameter arrObjInst objectType (long) - The Object type ID of the Object that is configured for a Portal Tab. instanceId (long) - The ID of the Object item. propData (String) Note: This parameter is an output parameter, and is described in the Output Parameters table of this method. tabIDs (string) - The ID of the Objects Item View tab in which the required Properties are configured. propIDs (string) - The IDs of the required Object Properties. pageID (long) - The ID of the Template Page in which the Properties are configured. arrPropInfo Note: This structure is currently not used in Talisma. teamId (long) - The ID of the Team to which the Object item belongs. objInstName (string) - The name of the Object item. relationshipInfo (string) The relationship path for the related Object Property.
Data type ref ObjInstanceData[]
Description This is an array of the ObjInstanceData[] structure that contains information about the Object item of an Object configured for the Portal Tab.
strSessionKey
string
345
GetPortalTabs Output Parameters The following table describes the output parameters for the GetPortalTabs method:
Return Value arrObjInst propData (string) Data type ref ObjInstanceData[] Description The propData parameter is an output parameter of the ObjInstanceData structure that returns the Property name, and Property values of an Object item. The information from all the Tabs configured for the Portal. This information is retrieved in XML format. The error message(s) returned when the get operation fails.
tabXml
string
error
string
GetPortalTabs Return Values The GetPortalTabs method returns 0 if the get operation is successful, and a negative value if the operation fails.
GetPortalTemplate
You can use the GetPortalTemplate method to retrieve a Template created for a Talisma Customer Portal Tab. The Talisma Business Administrator User can configure multiple Templates for a Portal Tab. Templates are specific formats in which Portal users can view, or update information in the various Tabs of Talisma Customer Portal. For example, an Application used by an Applicant in the My Applications Tab of Talisma Customer Portal is based on a specific Application Template configured by the Talisma Business Administrator User for the My Applications Tab. Consider a scenario where the Talisma Business Administrator User has created an Application Template in Talisma. An Application Template is the format in which an Application is displayed to applicants on Talisma Customer Portal. You want to display the same Application on your organizations Web site. In this scenario, you can use the GetPortalTemplate method to retrieve the Application Template. You must send the ID of the required Template as an input parameter to the Talisma Portal iService. Talisma Portal iService processes the input value, and returns the Template.
346
Method Signature
long GetPortalTemplate(long string error) templateId, out string itemViewMetaXml, out
GetPortalTemplate Input Parameter The following table describes the input parameter for the GetPortalTemplate method:
Input Parameter templateId Data type long Description The ID of the Template you want to retrieve.
GetPortalTemplate Output Parameters The following table describes the output parameters for the GetPortalTemplate method:
Return Value itemViewMetaXml error Data type string string Description The Template is retrieved in XML format. The error message(s) returned when the get operation fails.
GetPortalTemplate Return Values The GetPortalTemplate method returns 0 if the get operation is successful, and a negative value if the operation fails.
GetPortalTemplateIdentifiers
You can use the GetPortalTemplateIdentifiers method to retrieve Identifiers associated with all Templates configured for a specific Talisma Customer Portal Tab. In Talisma, Templates can be created based on various Identifiers. On Talisma Customer Portal, a Template is displayed to Users based on a combination of Identifier values selected by users. You must send the following values as input parameters to Talisma Portal iService: The ID of the required Portal. The Tab type of the Portal Tab for which Templates are configured. The ID of the required Portal Tab.
Talisma Portal iService processes the input values, and returns the Template Identifiers in XML format.
347
Method Signature
long GetPortalTemplateIdentifiers(long portalId, long portalTabType, long portalTabId, out string templateIdentifierXml, out string error)
GetPortalTemplateIdentifiers Input Parameters The following table describes the input parameters for the GetPortalTemplateIdentifiers method:
Input Parameter portalId portalTabType Data type long long Description The ID of the required Portal. The type of the Portal Tab for which Templates are configured. The ID of the required Portal Tab.
portalTabId
long
GetPortalTemplateIdentifiers Output Parameters The following table describes the output parameters for the GetPortalTemplateIdentifiers method:
Return Value templateIdentifierXml Data type string Description Identifiers associated with all Templates configured for a Tab. This information is retrieved in XML format. The error message(s) returned when the get operation fails.
error
string
GetPortalTemplateIdentifiers Return Values The GetPortalTemplateIdentifiers method returns 0 if the get operation is successful, and a negative value if the operation fails.
GetPortalTemplateObjectData
You can use the GetPortalTemplateObjectData to retrieve Property values from a Page in a Portal Template. For Properties that have single values, this method retrieves the Property name, and the Property value.
Note
This method does not retrieve the Property names and their values for enumerated type of Properties.
348
You must send parameter values for the ObjInstanceData structure as input parameters to the Talisma Portal iService. Talisma Portal iService processes the input values, and returns the Property name, and Property values of the relevant Object item from the specified Page in the Template. The method also returns the unique identifier key. Method Signature
long GetPortalTemplateObjectData(ref string error, string sessionKey) ObjInstanceData[] objectsData, out
GetPortalTemplateObjectData Input Parameters The following table describes the input parameters for the GetPortalTemplateObjectData method:
Input Parameter objectsData objectType (long) - The Object type ID of the Object whose Properties are configured in a Template Page. instanceId (long) - The ID of the Object item whose Property values you want to retrieve. propData (String) Note: This parameter is an output parameter, and is described in the Output Parameters table of this method. tabIDs (string) - The ID of the Objects Item View tab in which the required Properties are configured. propIDs (string) - The IDs of the Properties for which you want to retrieve values. The IDs that you specify must be separated by commas. pageID (long) - The ID of the Template Page in which the Properties are configured. arrPropInfo Note: This structure is currently not used in Talisma. Data type ref ObjInstanceData[] Description This is an array of the ObjInstanceData[] structure that contains information about the Object item of a Portal Template.
349
Input Parameter teamId (long) - The ID of the Team to which the Object item belongs. objInstName (string) - The name of the Object item for which you want to retrieve Property values. relationshipInfo (string) If you want to retrieve the value of a related Object Property, specify the relationship path for the related Property.
Data type
Description
sessionKey
string
GetPortalTemplateObjectData Output Parameters The following table describes the output parameters for the GetPortalTemplateObjectData method:
Return Value objectsData propData (string) Data type ref ObjInstanceData[] Description The propData parameter is an output parameter of the ObjInstanceData structure that returns the Property name, and Property values. The error message(s) returned when the get operation fails.
error
string
GetPortalTemplateObjectData Return Values The GetPortalTemplateObjectData method returns 0 if the get operation is successful, and a negative value if the operation fails.
350
GetPortalWebPartsForTab
You can use the GetPortalWebPartsForTab method to retrieve Web Parts configured for a Talisma Customer Portal Tab. For example, the General Announcements Web Part is configured for the All Events Tab of your University Portal. You want to configure the same Web Part for your University Web site. In this scenario, you can use the GetPortalWebPartsForTab method to retrieve the Web Parts configured for the All Events Tab, and use the Web Parts XML data returned by the method to configure the Web Parts on your organizations Web site. You must send the ID of the required Talisma Customer Portal Tab, and the ObjInstanceData structure as input parameters to Talisma Portal iService. Talisma Portal iService processes the input value, and returns the Web Parts configured for the specified Tab in XML format. Method Signature
long GetPortalWebPartsForTab(long portalTabId, ref ObjInstanceData[] arrObjInst, string strSessionKey, out string webPartsForTabXml, out string error)
GetPortalWebPartsForTab Input Parameters The following table describes the input parameters for the GetPortalWebPartsForTab method:
Input Parameter portalTabId Data type long Description The ID of the required Portal Tab.
351
Input Parameter arrObjInst objectType (long) - The Object type ID of the Object instanceId (long) - The ID of the Object item. propData (String) Note: This parameter is an output parameter, and is described in the Output Parameters table of this method. tabIDs (string) - The ID of the Objects Item View tab in which the required Properties are configured. propIDs (string) - The IDs of the required Object Properties. pageID (long) - The ID of the Template Page in which the Properties are configured. arrPropInfo Note: This structure is currently not used in Talisma. teamId (long) - The ID of the Team to which the Object item belongs. objInstName (string) - The name of the Object item. relationshipInfo (string) The relationship path for the related Object Property.
Data type ref ObjInstanceData
Description This is an array of the ObjInstanceData[] structure that contains information about an Object item.
strSessionKey
string
352
GetPortalWebPartsForTab Output Parameters The following table describes the output parameters for the GetPortalWebPartsForTab method:
Return Value objectsData propData (string) Data type ref ObjInstanceData[] Description The propData parameter is an output parameter of the ObjInstanceData structure that returns the Property name, and Property values. The Web Parts configured for the Portal Tab. This information is returned in XML format. The error message(s) returned when the get operation fails.
webPartsForTabXml
string
error
string
GetPortalWebPartsForTab Return Values The GetPortalWebPartsForTab method returns 0 if the get operation is successful, and a negative value if the operation fails.
GetRelationShipInstanceIDs
For a specified base Object item, the GetRelationShipInstanceIDs method enables you to retrieve the IDs of the related Objects Properties, or tabs. For example, two custom Objects, Course, and Faculty are available in your system. The Contact Object is related to the Course Object, and the Course Object is related to the Faculty Object. In this scenario, you can use the GetRelationShipInstanceIDs method to retrieve the value of a Property belonging to the Faculty Object, by specifying Contact as the base Object. You must send the relationship path string, and the ID of the base Object item as input parameters to Talisma Portal iService. In Talisma, a relationship path string indicates the relationship between two Objects. Talisma Portal iService processes the input values, and returns the ID of the related Object item. Method Signature
long GetRelationShipInstanceIDs(string ObjectPathString, BaseInstanceID,out string InstanceIDs,out string error) long
353
GetRelationShipInstanceIDs Input Parameters The following table describes the input parameters for the GetRelationShipInstanceIDs method:
Input Parameter ObjectPathString BaseInstanceID Data type string long Description The relationship path string. The ID of the base Object item.
GetRelationShipInstanceIDs Output Parameters The following table describes the output parameters for the GetRelationShipInstanceIDs method:
Return Value InstanceIDs error Data type string string Description The IDs of the related Object items. The error message(s) returned when the get operation fails.
GetRelationShipInstanceIDs Return Values The GetRelationShipInstanceIDs method returns 0 if the get operation is successful, and a negative value if the operation fails.
SetPageSetting
For a specific Portal user, you can use the SetPageSetting method to perform the following operations: Set the layout of Web Parts in the Home Tab of a Portal. Save the layout of Web Parts retrieved from the Home Tab of a Portal. The ID of the required Portal user. The ID of the Home Tab on the Portal. The page setting.
You must send the following values as input parameters to Talisma Portal iService:
Talisma Portal iService processes the input values, and the Web Parts layout is set for the Home Tab in the Portal. Method Signature
long SetPageSetting(int userId, int portalId, string pageSetting, out string error)
354
SetPageSetting Input Parameters The following table describes the input parameters for the SetPageSetting method:
Input Parameter userId Data type int Description The ID of the Portal user for whom you want to configure the page setting. The ID of the Portal Tab for which you want to configure the page settings for the Portal user. The page setting information to configure the Portal ID for the Portal user.
portalId
int
pageSetting
string
SetPageSetting Output Parameters The following table describes the output parameters for the SetPageSetting method:
Return Value error Data type string Description The error message(s) returned when the set operation fails.
SetPageSetting Return Values The SetPageSetting method returns 0 if the operation is successful, and a negative value if the operation fails.
UpdatePortalData
You can use the UpdatePortalData method to update Talisma Main Database with any changes made to the components of the Portal. For example, a Portal User has modified information in a Form, and saved the Form. You can use the UpdatePortalData method to update the Talisma Main Database with these changes. Based on the information you want to update, send the values for the relevant parameters from each of the following structures as input parameters to Talisma Portal iService: The ObjInstanceData structure that contains the details of an Object item. The RLData structure that contains the information from a RecordList tab of an Object. The RelationshipData structure that contains the information about the relationship between Objects. The AttachmentFile structure that contains the details of attachment(s). The CommentsTab structure that contains the information from a Comments tab of an Object item.
You must also send the refreshAfterUpdate parameter of the UpdatePortalData method if you want to refresh information on the Portal with the latest updates. Talisma Portal iService processes the input values, and updates Talisma Main Database.
355
Method Signature
long UpdatePortalData(ref ObjInstanceData[] objectsData, ref RLData[] recordListsData, ref RelationshipData[] relationshipsData, ref AttachmentFile[] attachmentFiles, ref AttachmentComments[] comments, ref CommentsTab[] commentsTabs, bool refreshAfterUpdate, out string error)
UpdatePortalData Input Parameters The following table describes the input parameters for the UpdatePortalData method:
Input Parameter objectsData objectType (long) - The Object type ID of the Object. For example, if you want to update Talisma Main Database with the changes made to Faculty Object item, specify the Object type ID of the Faculty Object. instanceId (long) - The ID of the Object item whose Property values you want update. propData (string) - The Property name, and Property values that must be updated. tabIDs (string) - The ID of the Object's Item View tab which must be updated. propIDs (string) - The IDs of the Properties whose values you want to update. The IDs that you specify must be separated by commas. pageID (long) - The ID of the Template Page in which you want to update Properties. arrPropInfo[] PropertyInfo Note: This structure is currently not used in Talisma. Data type ref ObjInstanceData[] Description This is an array of the ObjInstanceData[] structure that contains information about Object items.
356
Input Parameter teamId (long) - The ID of the team to which the Object item belongs. objInstName (string) - The name of the Object item which you want to update.
Data type ref RLData[]
Description An array of the RLData structure that contains details of the RecordList tab of an Object.
relationshipInfo (string) If you want to update the value of a related Object Property, specify the relationship path for the related Property. recordListsData objectType (long) - The Object type ID of the Object. For example, if you want to update the RecordList tab of the Faculty Object item, specify the Object type ID of the Faculty Object. instanceId (long) - The ID of the Object item you want to update with the information specified in the RecordList tab of the Object item. tabIDs (string) - If the Object includes multiple RecordList tabs, specify the ID of the tabs. You must specify the tab IDs separated by commas. tabID (long) - If the Object includes a single RecordList tab, specify the ID of the tab you want to update. count (long) - The number of records you want to fetch from the database. rlpropdata (string) - The Property name, and Property values that must be updated. deleterows (string) - You must set the value of this parameter to -1. 357
Input Parameter arrPropInfo[] Note: This structure is currently not used in Talisma. objInstName (string) - The name of the Object item you want to update. teamId (long) - The ID of the team to which the Object item belongs. relationshipInfo (string) If you want to update the value of a related Object Property, specify the relationship path for the related Property.
Data type
Description
relationshipsData objectType (long) - The Object type ID of the Object. tabId (long) - The ID of the Object's Item View tab. instanceId (long) - The ID of the Object Property, or tab. objectIds (string) - The IDs of the Objects in the relationship. addInstance (bool) - To establish or remove a relationship between Objects. True - Specify this value if you want to establish a relationship. False - Specify this value if you want to remove an existing relationship.
ref RelationshipData[]
An array of the RelationshipData structure that contains details of the relationship between Objects.
358
Input Parameter attachmentFiles lObjectType (long) - The Object type ID of the Object in which an attachment is inserted. lObjectId (long) - The ID of the Object in which the attachment is inserted. lAttachmentID (long) The ID of the attachment. lTabId (long) - The ID of an Attachment tab in an Object in which the attachment is inserted. fileBlob (byte[]) - The contents of the attachment. strAttName (string) - The name of the attachment. PropertyInfo[] arrPropInfo This structure is currently not used Talisma. objInstName (string) - The name of the Object item that contains the attachment. teamId (long) - The ID of the Team to which the Object item belongs. relationshipInfo (string) If you want to update the value of a related Object Property, specify the relationship path for the related Property.
Data type ref AttachmentFile[]
Description An array of the AttachmentFile structure that contains details of the attachment(s) in an Object instance.
comments
ref AttachmentComments[]
Note: This structure is currently not used in Talisma.
359
Input Parameter commentsTabs objType (long) - The ID of the Object which contains the Comments tab. lEntityID (long) - The ID of the Object item for which comments are added. lTabID (long) - The ID of the Comment tab which you want to update. comments (string) - The comments inserted in the Comment tab. arrPropInfo[] Note: This structure is currently not used in Talisma. objInstName (string) - The name of the Object item that contains the comments in the Comment tab. teamId (long) - The ID of the team to which the Object item belongs. relationshipInfo (string) If you want to update the value of a related Object Property, specify the relationship path for the related Property.
Data type ref CommentsTab[]
Description An array of the AttachmentComment structure that contains details of the Comments tab of an Object.
refreshAfterUpdate
bool
Specify whether you want to refresh information on the Portal with the latest updates. You can specify one of the following values: True - Specify this value if you want to refresh information on the Portal with the latest updates. False - Specify this value if you do not want to refresh information on the Portal with the latest updates.
360
UpdatePortalData Output Parameters The following table describes the output parameters for the UpdatePortalData method:
Return Value error Data type string Description The error message(s) returned when the update operation fails.
UpdatePortalData Return Values The UpdatePortalData method returns 0 if the operation is successful, and a negative value if the operation fails.
InitializeEventForRegistration
You can use the InitializeEventForRegistration method to carry out all prerequisite operations before you can register a Contact for an Event. For example, using the InitializeEventForRegistration method, you can check whether a Contact is already a registered Participant in the Event, whether a Contact already exists in Talisma, and specify details of the Participant. You must send the following values as input parameters to the Talisma Portal iService: The ID of the required Event. The ID of the Contact you want to register for the Event. The ParticipantDetails structure that contains the participation details of the specified Contact. The isGroupRegistration parameter to specify whether you want to enable Contacts to register for the Event as a group, or as individual Participants. The isSeatAvailable parameter that indicates whether sufficient seats are available in the Event for Contacts to register for the Event. The discounted cost available for the specified Contact.
long InitializeEventForRegistration(long eventId, long contactId, ref ParticipantDetails[] participantsList, bool isGroupRegistration, out bool isSeatAvailable, out double discountedCost, out string error)
Talisma Portal iService processes the input values, and returns the following values:
Method Signature
InitializeEventForRegistration Input Parameters The following table describes the input parameters for the InitializeEventForRegistration method:
Input Parameter eventId contactId Data type long long Description The ID of the required Event. The ID of the Contact you want to register for an Event.
361
Input Parameter participantsList contactId (long) - A unique ID associated with a Contact in Talisma. participantId (long) - A unique ID associated with a Participant in Talisma. emailId (string) - The email address of the Contact. name (string) - The name of the Contact. contactPropertyString (string) - If you want to update the Property values for the Contact associated with the Participant, specify the Property IDs, and the Property values. You must specify the Property IDs, and their values in the following format: PropertyID=Value+/PropertyID=Value participantPropertyString ( string) - If you want to update the Property values of the Participant, specify the Property IDs, and the Property values. You must specify the Property IDs, and their values in the following format: PropertyID=Value+/PropertyID=Value
Data type ref ParticipantDetails[]
Description This is an array of the ParticipantDetails structure that contains the participation details of a Contact.
362
Input Parameter isNewContact (bool) - The value of this parameter indicates whether the Contact is newly created in Talisma, or is an existing Contact. 0 - Indicates that the Participant is an existing Contact in Talisma. 1 - Indicates that the Contact is newly created.
Data type
Description
isAlreadyRegistered (bool) - The value of this parameter indicates whether the Participant is already registered for the Event. 0 - Indicates that the Participant is not registered for the Event. 1- Indicates that the Participant is registered for the Event. bool Enables you to specify whether you want to enable Contacts to register for the Event as a group, or as individual Participants. Specify one of the following values: 0 - Specify this value to enable Contacts to register for an Event as individual Participants. 1 - Specify this value to enable Contacts to register for an Event as a group.
isGroupRegistration
363
InitializeEventForRegistration Output Parameters The following table describes the output parameters for the InitializeEventForRegistration method:
Return Value isSeatAvailable Data type bool Description This parameter indicates whether sufficient seats are available for Contacts to register for the Event. This parameter returns one of the following values: 0 - Indicates that sufficient seats are not available in the Event. 1 - Indicates that sufficient seats are available in the Event.
discountedCost error
double
The discounted cost available for the specified Contact. The error message returned when the initialize operation fails.
InitializeEventForRegistration Return Values The InitializeEventForRegistration method returns 0 if the operation is successful, and a negative value if the operation fails.
364
RegisterParticipantToEvent
You can use the RegisterParticipantToEvent method to register a specific Contact for an Event. Consider a scenario where your University has published Events on the Universitys Web site, and wants to enable students to register for Events from the Web site. In this scenario, you can use the RegisterParticipantToEvent method to enable students to register for Events. You must send the following values as input parameters to the Talisma Portal iService: The ID of the required Event. The ID of the Contact you want to register for an Event. The ParticipantDetails structure that contains the participation details of the specified Contact. The isGroupRegistration parameter to specify whether you want to enable Contacts to register for the Event as a group, or as individual Participants.
Talisma Portal iService processes the input values, and returns the isSeatAvailable parameter that indicates whether sufficient seats are available in the Event for Contacts to register for the Event. Method Signature
long RegisterParticipantToEvent(long eventId, long contactId, ref ParticipantDetails[] participantsList, bool isGroupRegistration, out bool isSeatAvailable, out string error)
RegisterParticipantToEvent Input Parameters The following table describes the input parameters for the RegisterParticipantToEvent method:
Input Parameter eventId contactId Data type long long Description
The ID of the required Event.

The ID of the Contact who wants to register for an Event.
365
366
Data type
Description
isAlreadyRegistered (bool) - The value of this parameter indicates whether the Participant is already registered for the Event. 0 - Indicates that the Participant is not registered for the Event. 1- Indicates that the Participant is registered for the Event.
isPrimaryParticipant (bool) - For Group registration of the Event, specify whether the Participant is the primary Participant. 0 - Indicates that the Participant is not a primary Participant. 1 - Indicates that the Participant is a primary Participant.
367
Input Parameter isGroupRegistration
Data type bool
Description Enables you to specify whether you want to enable Contacts to register for the Event as a group, or as individual Participants. Specify one of the following values: 0 - Specify this value to enable Contacts to register for an Event as individual Participants. 1 - Specify this value to enable Contacts to register for an Event as a group.
RegisterParticipantToEvent Output Parameters The following table describes the output parameters for the RegisterParticipantToEvent method:
Return Value isSeatAvailable Data type bool Description This value indicates whether sufficient seats are available for Contacts to register for the Event. This parameter returns one of the following values: 0 - Indicates that sufficient seats are not available in the Event. 1 - Indicates that sufficient seats are available in the Event.
discountedCost
double
The discounted cost available for a Contact who wants to register for the Event. The error message(s) returned when the register operation fails.
error
string
RegisterParticipantToEvent Return Values The RegisterParticipantToEvent method returns 0 if the operation is successful, and a negative value if the operation fails.
368
SetStateToRegisterForEvent
You can use the SetStateToRegisterForEvent method to set the participation status of a Participant to Registered for an Event. Consider a scenario where your University has published Events on the Universitys Web site, and enables students to register for Events from the Web site. In this scenario, you can use the SetStateToRegisterForEvent method to set the participation status of registered students to Registered in Talisma. You must send the following values as input parameters to the Talisma Portal iService: The ID of the required Event. The ID of the Contact for whom you want to set the participation status to Registered in Talisma. The ParticipantDetails structure that contains the participation details of the specified Contact. For paid Events, send the paymentTransactionDetails parameter that contains details of the payment made by the specified Contact for registration to the Event.
Talisma Portal iService processes the input values, and sets the participation status of the specified Contact to Registered in Talisma. Method Signature
long SetStateToRegisterForEvent(long eventId, long contactId, ref ParticipantDetails[] participantsList, string paymentTransactionDetails, out string error)
SetStateToRegisterForEvent Input Parameters The following table describes the input parameters for the SetStateToRegisterForEvent method:
Input Parameter eventId contactId Data type long long Description The ID of the required Event. The ID of the Contact for whom you want to set the participation status to Registered in Talisma.
369
370
Data type
Description
isAlreadyRegistered (bool) - The value of this parameter indicates whether the Participant is already registered for the Event. 0 - Indicates that the Participant is not registered for the Event. 1- Indicates that the Participant is registered for the Event.
isPrimaryParticipant (bool) - For Group registration of the Event, specify whether the Participant is the primary Participant. 0 - Indicates that the Participant is not a primary Participant. 1 - Indicates that the Participant is a primary Participant. string For paid Events, details of the payment made by the specified Contact for registration to the Event.
paymentTransactionDetails
371
SetStateToRegisterForEvent Output Parameters The following table describes the output parameters for the SetStateToRegisterForEvent method:
Return Value error Data type string Description The error message(s) returned when the set status operation fails.
SetStateToRegisterForEvent Return Values The SetStateToRegisterForEvent method returns 0 if the operation is successful, and a negative value if the operation fails.
CancelParticipant
You can use the CancelParticipant method to cancel the registration of Participants for an Event. Consider a scenario where your University has published Events on the Universitys Web site, and enables students to register for Events from the Web site. The University also wants to enable Participants to cancel their registration for Events from the Web site. In this scenario, you can use the CancelParticipant method to cancel the registration of Participants for an Event. You must send the IDs of Participants for whom you want to cancel the registration for an Event as an input parameter to the Talisma Portal iService. Talisma Portal iService processes the input value, and cancels the registration of the Participants. If Event registration could not be canceled for one or more of the specified Participants, this method returns the IDs of such Participants. Method Signature
long CancelParticipant(string participantsIdList, failedParticipantIdList, out string error) out string
CancelParticipant Input Parameter The following table describes the input parameter for the CancelParticipant method:
Input Parameter participantsIdList Data type string Description The IDs of the Participants for whom you want to cancel the registration for an Event. You must specify the Participant IDs separated by comma.
372
CancelParticipant Output Parameters The following table describes the output parameters for the CancelParticipant method:
Return Value failedParticipantIdList Data type string Description The IDs of the Participants for whom the Event registration could not be canceled. The error message(s) returned when the Cancel operation fails.
error
string
CancelParticipant Return Values The CancelParticipant method returns 0 if the operation is successful, and a negative value if the operation fails.
373
374
Querying Talisma Main Database
Chapter 12:Querying Talisma Main Database

This chapter describes how you can query Talisma Database.
In this chapter
Querying Talisma Database ...................................................... Page 376
375
Querying Talisma Database

You can query Talisma Main Database to obtain meta IDs that you need when working with Talisma iService methods. The following table lists the queries you need to run to obtain meta IDs:
To Get Tab ID Group ID Run This Query Select aTabID from tblTab where tTabName = '<TabName>' Select aGroupID from tblFieldGroup '<GroupName>' and nTabID = <TabID> Note For default groups, leave the Group Name blank. Property ID Select aColumnID from tblColumnMain inner join tblCustomField on aColumnID = nColumnID where tDisplayName = '<Property Name>' and nGroupID = <GroupID> Select * from tblUser where tLoginName = '<Login Name>' Select * from tblTeam where tName = '<Team Name>' Select * from tblEnum where nConstraintID in (Select nConstraintID from tblColumnConstraintMap inner join tblConstraint on aConstraintiD = nConstraintID where nColumnID = <PropertyID>) Select * from tblMedia. In this table, the aMediaID column displays the ID for each medium used in Talisma. alias ID Select * from tblGroupAlias In this table, the aGpAliasID column displays the ID of each Alias. The tDisplayName column displays the name of the Alias. rowID To obtain the ID of a row in the RecordList Tab of an Object item, you must first query the database to find the name of the table which contains the details of RecordList Tabs. To do so, execute the following query: Select tBaseTable from tblColumnMain where tDisplayName = <RecordList Tab Property name> where, <RecordList Tab Property name> is the name of the Property in the RecordList whose rowID you want to find. Note the name of the table that contains the details of the RecordList Tabs. To obtain the rowIDs of the RecordList Tab, execute the following query: Select * from <table name> where, <table name> is the name of the table obtained by executing the previous query. The nKeyID column displays the ID of each row in the RecordList Tab. where tGroupName =
User ID Team ID Enum ID
Media ID
376
Querying Talisma Main Database
To query Talisma Main Database Using Query Analyzer 1. From the Start menu, point to Programs, Microsoft SQL Server, and select Query Analyzer. The Connect to SQL Server dialog box is displayed. 2. From the SQL Server list, select the computer on which Talisma Main Database is installed. 3. In the Connect Using area, select Windows Authentication to connect to Talisma Main Database using your Windows login credentials. - OR Select SQL Server Authentication, and specify your Login name and Password in the respective fields. 4. Click OK. The Query Analyzer is displayed. 5. In the Query Analyzer, execute the required query.
377
378
Error Codes and Known Issues
Chapter 13:Error Codes and Known Issues

The topics in this chapter describe the error codes that you may encounter when working with Talisma iServices. This chapter also describe the known issues in Talisma iServices.
In this chapter
Error Codes Applicable to all Talisma iServices ...................... Error Codes Applicable to Talisma Contact iService ............... Error Codes Applicable to Talisma Account iService .............. Error Codes Applicable to Talisma Interaction iService .......... Error Codes Applicable to Talisma COF iService.................... Known Issues ............................................................................ Page 380 Page 383 Page 384 Page 385 Page 390 Page 392
379
Error Codes Applicable to all Talisma iServices

The following table describes Error Codes applicable to all Talisma iServices:
Method Name UpdatePropertiesTab Error Code -1073691753 -1073689916 Description Duplicate e-mail address. Some Properties failed to update. For details of such Properties, view the error string. Invalid value specified. Invalid Object ID. The specified Tab ID is not a Properties Tab ID. Invalid Object ID. The value for a Property has not been set. Invalid Object ID. The specified Tab ID is not a RecordList Tab ID. Invalid value specified. Invalid Object ID. Some Properties failed to update. For details of such Properties, view the error string. Duplicate e-mail address. The Property you are trying to update is already deleted. The specified row in the RecordList Tab is not found. Invalid Object ID. The specified Tab ID is not an Attachment Tab ID. The Contact ID for which Attachments are to be updated has been deleted. Invalid Attachment ID. Invalid Object ID. 380
-1073689913 -1073691684 -1073690820 -1073689901 -1073689915 UpdateRLTab -1073689901 -1073690820 -1073689913 -1073691684 -1073689916
-1073691753 -1073691610 -1073690790 UpdateAttachmentsTab -1073691684 -1073690820 -1073690923
-1073676555 -1073689901
Method Name UpdateCommentsTab
Error Code -1073689901 -1073690820 -1073691684
Description Invalid Object ID. The specified Tab ID is not a Comments Tab ID. Invalid Object ID. Invalid Object ID. The specified Tab ID is not a Properties Tab ID. Operation failed. Invalid Object ID. Value for the specified Property is not available. Invalid Object ID. The specified Tab ID is not a RecordList Tab ID. Invalid Object ID. The specified row in the RecordList Tab is not found. Invalid Object ID. The specified Tab ID is not a Comments Tab ID. The Contact for which you want data has been deleted. Invalid Object ID. Operation failed. Invalid Object ID. The specified Tab ID is not an Attachments Tab ID. Invalid Object ID. Invalid Object ID. The specified Tab ID is not a Linked Tab ID. Invalid Object ID. Value for the specified Property is not available.
GetPropertiesTab
-1073691684 -1073690820 -1073691019 -1073689901 -1073690803
GetRLTab
-1073691684 -1073690820 -1073689901 -1073690790
GetCommentsTab
-1073691684 -1073690820 -1073691804 -1073689901
GetAttachmentTab
-1073691019 -1073691684 -1073690820 -1073689901
GetLinkedTab
-1073691684 -1073690820 -1073689901 -1073690803
381
Method Name Common Errors
Error Code -1073676544 -1073691607 -1073691577 -1073678777 -1073711817 -1073691117 -1073711820
Description User authentication has failed. Invalid password. The Database is invalid. You do not have permission to view this Interaction. This is an invalid Interaction. Invalid Permission. Access denied.
382
Error Codes Applicable to Talisma Contact iService

The following table describes Error Codes applicable to Talisma Contact iService:
Method Name CreateContact Error Code -1073676655 -1073691600 -1073690923 -1073691753 -1073691635 -1073689916 Description You do not have Permission(s) to create the Contact. Unmapped error. The Contact you are trying to insert is deleted. Duplicate e-mail address. The Contact you are trying to insert is deleted. Some Properties failed to update. For details of such Properties, view the error string. You do not have Permission(s) to set Properties for the Contact. Some of the mandatory Properties for the Contact have not been specified. Invalid value specified. Invalid Object ID. You do not have Permission(s) to delete the Contact. This Contact cannot be deleted The Contact's e-mail messages are still unresolved. Failed to delete the related Interactions of this Contact. The Contact ID specified for deletion is invalid. The Contact ID specified for deletion has already been deleted. Invalid Object ID specified.
-1073691609
-1073690808
-1073689913 -1073691684 Delete Contact -1073676636 -1073676550
-1073676588 -1073691745 -1073690923
-1073691684
383
Error Codes Applicable to Talisma Account iService

The following table describes Error Codes applicable to Talisma Account iService:
Method Name CreateAccount Error Code -1073676655 -1073691600 -1073690921 -1073691753 -1073689916 Description You do not have Permissions to create the Account. Unmapped error. The Account you are creating has been deleted. Duplicate e-mail address. Some Properties failed to update. For details of such Properties, view the error string. You do not have Permission(s) to set Properties for the Account. Some of the mandatory Properties for the Contact have not been specified. Invalid value specified. Invalid Object ID. You do not have Permission(s) to delete the Account. Failed to delete the related Objects of this Account. The ID of the Account you want to delete is invalid. The Account you are creating has been deleted. Invalid Object ID.
-1073691609
-1073690808
-1073689913 -1073691684 Delete Account -1073676636 -1073676588 -1073691061 -1073690921 -1073691684
384
Error Codes Applicable to Talisma Interaction iService

The following table describes the error codes applicable to Talisma Interaction iService.
Method Name CreateInteraction Error Code -1073691611 -1073690808 -1073690782 Description Duplicate Property value. Mandatory fields for Interaction are not filled. the
The Team to which you want to assign the Interaction is invalid. You do not have Permission to create an Interaction. No permission to perform this operation. Unable to complete the operation. The item may have been deleted. Invalid operation. Duplicate e-mail address. The Interaction deleted. has been
-1073691609 -1073691609 -1073690806
-1073690777 -1073689905 -1073711815 -1073690802 -1073689914 -1073689913 DeleteInteraction -1073691609
Object does not exist. The data types do not match. You have specified an invalid value. You do not permissions to Interaction. have the delete an
-1073690923 -1073690921 -1073711815 -1073690806
The Contact related to the Interaction is deleted. The Account related to the Interaction is deleted. This Interaction deleted. has been
Unable to delete the Interaction. The Interaction may already be deleted. Enumeration deleted. 385 is already
-1073689902
Method Name DeleteInteractions
Error Code -1073691609
Description The User does not have sufficient Permissions to delete Interactions. The file(s) could not be copied to the server. The Interaction may have been deleted, or purged from Talisma. The Interaction may have been deleted, or purged from Talisma. The User does not have sufficient Permissions to set Interaction priority. The Interaction may have been deleted, or purged from Talisma. The Interaction is merged with another Interaction. The Interaction is deleted from Talisma. The specified Interaction is created as a result of an undelivered Interaction. Interaction priority cannot be set for such an Interaction using the SetInteractionPriority method. The specified Interaction is transferred to a Team to which the User does not have access Permission.
AddAttachments GetAllInteractionEvents
-1073691812 -1073691809
GetInteractionEvents2
-1073691809
-1073711753
-1073691809
-1073691719 -1073691804 -1073691741
-1073691805
386
Method Name SetInteractionState
Description The Interaction may have been deleted, or purged from Talisma. The Interaction state has been set to Closed. The Interaction state has been set to Expired. The state of a Sub Interaction belonging to specified Interaction is set to Open or Pending. The Interaction is currently being worked upon by another Talisma User. Another Talisma User is currently sending a reply to a message associated with the Interaction. The User does not have sufficient Permissions to set Interaction states. The User performing the Set Interaction State operation is not the owner of the Interaction. The User does not have sufficient Permissions to assign Interactions. The Interaction is currently being worked upon by another Talisma User. The User does not have sufficient Permissions to transfer Interactions. The Interaction is currently being worked upon by another Talisma User. The get operation failed due to unknown reasons.
-1073691791 -1073691695 -1073676712
-1073691808
-1073691764
-1073676789 - OR -1073691609 -1073691806
Assign
-1073691609
-1073691808
Transfer
-1073691609
-1073691808
GetAttachmentFile
-1073691019
387
Method Name GetAssignToUserList
Description The User does not have sufficient Permissions perform the get operation. The User does not have sufficient Permissions perform the operation. The Interaction is currently being worked upon by another Talisma User. The User does not have sufficient Permissions perform the save operation. The number of recipients to whom the reply is addressed exceeds the maximum recipients size set for Interactions in Talisma. The Interaction may have been deleted, or purged from Talisma. The Interaction is merged with another Interaction. The Interaction has expired. The Interaction may have been deleted, or purged from Talisma. The Interaction state has been set to Closed. The specified Interaction is transferred to a Team to which the User does not have access Permission. The specified Interaction is created as a result of an undelivered Interaction. The build operation cannot be performed on such an Interaction using the BuildForwardOrConsult method.
BeginReply
-1073691609
-1073691808
SaveReply
-1073691609
-1073691676
BuildForwardOrConsult
-1073691809
-1073691719 -1073691695 -1073691804
-1073691791 -1073691805
-1073691741
388
Method Name BuildReply
Description The Interaction is currently being worked upon by another Talisma User. The Interaction may have been deleted, or purged from Talisma. The Interaction is merged with another Interaction. The Interaction has expired. The Interaction is deleted from Talisma. The Interaction state has been set to Closed. The specified Interaction is transferred to a Team to which the User does not have access Permission. The specified Interaction is created as a result of an undelivered Interaction. The build operation cannot be performed on such an Interaction using the BuildReply method. The Interaction is currently being worked upon by another Talisma User. The specified Interaction ID is invalid.
-1073691809
-1073691719 -1073691695 -1073691804 -1073691791 -1073691805
-1073691741
DeleteReply
-1073691808
-1073691684
389
Error Codes Applicable to Talisma COF iService

The following table describes Error Codes applicable to Talisma COF iService:
Method Name CreateObject Error Code -1073676655 Description You do not have the required Permission(s) to create the custom Object. Unmapped error. The custom Object you are trying to create does not exist. Duplicate e-mail address. Some properties failed to update. For details of such Properties, view the error string. You do not have Permission(s) to set the Properties of the custom Object. Some of the mandatory properties for the Contact have not been specified. Invalid value specified for saving the Property. Invalid Object ID. The custom Object item you are trying to create has been deleted.
-1073691600 -1073701754 -1073691753 -1073689916
-1073676654
-1073690808
-1073689913 -1073691684 -1073678793
390
Method Name DeleteObject
Description You do not have Permission(s) to delete the custom Object item. Failed to delete the related Objects of this custom Object item. The ID of the Account Object specified for deletion is invalid. The custom Object item you are trying to delete has already been deleted. Invalid object ID. The custom Object you are trying to create does not exist.
-1073676588
-1073691061
-1073690807
-1073691684 -1073701754
391
Known Issues
If you are not granted the Set Interaction Properties Permission to set Property values for an Interaction, the CreateInteraction method fails when you try to create an Interaction, and set Property values using the method. Workaround: You must set the propData array structure of the CreateInteraction method as a zero length array. Occasionally, when a particular operation that uses a Talisma iService method is completed successfully, the error string returns the +/- character. The setting of Enumerated Property values for any Object to a blank value is not supported through Talisma Higher Ed Foundation iService. For example, when the Activity Type Property is changed in an SIS Activity, the Event Activity Result Property is set to a blank value. When the SIS Connector attempts to integrate this upgrade transaction, the corresponding Status Property of the Talisma Activity does not take the blank value.
392
Index
Index
A
About Talisma iServices 36 Account iService CreateAccount 89 DeleteAccount 81 Error Codes 154 GetAttachmentTab 84 GetCommentsTab 86 GetLinkedTab 91 GetPropertiesTab 88 GetRLTab 82 Overview 78 UpdateAttachmentTab 94 UpdateCommentsTab 87 UpdatePropertyTab 92 UpdateRLTab 93 AddCommentsToInteraction Interaction iService 120 Adding iService 19 AddMsgToInteraction Interaction iService 118
C
COF iService CreateObject 143 DeleteObject 137 Error Codes 156 GetAttachmentTab 129 GetCommentsTab 131 GetLinkedTab 138 GetPropertiesTab 134 GetRLTab 127 Overview 124 UpdateAttachmentTab 135 UpdateCommentsTab 133 UpdatePropertyTab 140 UpdateRLTab 141 Contact iService CreateContact 66 DeleteContact 62 Error Codes 153 GetAttachmentTab 59 GetCommentsTab 61 GetLinkedTab 68
393
GetPropertiesTab 65 GetRLTab 57 Overview 54 UpdateAttachmentTab 73 UpdateCommentsTab 63 UpdatePropertyTab 69 UpdateRLTab 71 CreateAccount Account iService 89 CreateContact Contact iService 66 CreateInteraction Interaction iService 113 CreateObject COF iService 143
D
DeleteAccount Account iService 81 DeleteContact Contact iService 62 DeleteInteraction Interaction iService 117 DeleteObject COF iService 137
E
Environments Tested 4 Error Codes Account iService 154 COF iService 156 Contact iService 153 General 150 Interaction iService 155
G
General Error Codes 150 GetAttachmentTab Account iService 84 COF iService 129 Contact iService 59 GetCommentsTab Account iService 86 COF iService 131 Contact iService 61 GetInteractionEvents Interaction iService 107
394
Index
GetLinkedTab Account iService 91 COF iService 138 Contact iService 68 Interaction iService 105 GetPropertiesTab Account iService 88 COF iService 134 Contact iService 65 Interaction iService 101 GetRLTab Account iService 82 COF iService 127 Contact iService 57 Interaction iService 103 Guidelines Using Talisma iService Methods 39
H
Hardware Requirements 3
I
Installing Microsoft WSE 3.0 5 Talisma 8.5 Application Server 5 Talisma 8.5 iServices 6 Talisma 8.5 Server 5 Interaction iServices and Talisma 37 Interaction iService AddCommentsToInteraction 120 AddMsgToInteraction
118
CreateInteraction 113 DeleteInteraction 117 Error Codes 155 GetInteractionEvents 107 GetLinkedTab 105 GetPropertiesTab 101 GetRLTab 103 Overview 98 UpdatePropertyTab 110 UpdateRLTab 112 Introduction Talisma iServices 2 iService Adding 19 Uninstalling 27
395
K
Known Issues 34
M
Minimum System Requirements 3
O
Overview Account iService 78 COF iService 124 Contact iService 54 Interaction iService 98
P
Prerequisites 5 Publishing Talisma 8.5 iServices Help 33
Q
Querying Talisma Database 146
R
Reinstalling Talisma iServices 15 Requirements Hardware 3 Software 3
S
Software Requirements 3
T
Talisma 8.5 iServices Help Publishing 33 Talisma iService Methods 38 Talisma iServices Reinstalling 15 Uninstalling 30 Upgrading 26
U
Uninstalling iService 27 Talisma iServices 30 UpdateAttachmentTab Account iService 94
396
Index
COF iService 135 Contact iService 73 UpdateCommentsTab Account iService 87 COF iService 133 Contact iService 63 UpdatePropertyTab Account iService 92 COF iService 140 Contact iService 69 Interaction iService 110 UpdateRLTab Account iService 93 COF iService 141 Contact iService 71 Interaction Interaction iService 112 Upgrading Talisma iServices 26
397
398

Installing and Using Talisma Iservices

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Installing and Using Talisma Iservices

Enviado por

Direitos autorais:

Formatos disponíveis

Talisma 8.

Installation and Usage Guide

Phone: (561) 923-2500 Visit our Web site at www.talisma.com

About Talisma iServices

About This Guide

Who Should Read This Guide

Installing and Using Talisma 8.5 iServices

Contacting Talisma for Technical Support

Consultancy and Outsourced services are available

Chapter 3: Talisma iServices - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Chapter 4: Integration Using Talisma iServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Chapter 5: Talisma Contact iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Installing and Using Talisma 8.5 iServices

Chapter 6: Talisma Account iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Chapter 7: Talisma Interaction iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Chapter 8: Talisma Reports iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Chapter 9: Talisma COF iService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Chapter 10:Talisma Higher Ed Foundation iService. . . . . . . . . . . . . . . . . . . . . . . . 271

Installing and Using Talisma 8.5 iServices

Chapter 11:Talisma Portal iService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Chapter 12:Querying Talisma Main Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Chapter 13:Error Codes and Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

Whats New in Talisma iServices

Chapter 1:Whats New in Talisma iServices

Whats New in This Release

Talisma Higher Ed Foundation iService

High Level Design of Talisma - SIS Interaction

Whats New in Talisma iServices

Whats New in This Release

Installing Talisma iServices

Chapter 2:Installing Talisma iServices

Installing and Using Talisma 8.5 iServices

Minimum System Requirements

Installing Talisma iServices

Talisma 8.5 Application Server

Talisma 8.5 iServices Setup

Installing and Using Talisma 8.5 iServices

Installing Talisma iServices

Talisma Component Talisma iServices

Installing and Using Talisma 8.5 iServices

Installing Talisma 8.5 Server

Installing Talisma 8.5 Application Server

Installing Microsoft WSE 3.0

Obtaining Talisma iServices Licenses

Installing Talisma iServices

Setting Up Talisma 8.5 iServices

Figure 1 3. Click Next.

The Welcome Page

Installing and Using Talisma 8.5 iServices

The Customer Information page is displayed.

The Customer Information Page

Installing Talisma iServices

The Components page is displayed.

Selecting the Required Talisma iServices for Installation

Installing and Using Talisma 8.5 iServices

The Talisma Database Connection Details page is displayed.

Specifying the Database Connection Details

Installing Talisma iServices

11. Click Next. The Destination Folder page is displayed.

Selecting the Installation Folder for Talisma iServices

Installing and Using Talisma 8.5 iServices

Selecting a Virtual Root