maximizer crm 11 customization manual

Notice of Copyright

Published by Maximizer Software Inc. Copyright ©1988-2010 All rights reserved.

Registered Trademarks and Proprietary Names

Product names mentioned in this document may be trademarks or registered trademarks of Maximizer Software Inc. or other hardware, software, or service providers and are used herein for identification purposes only.

Applicability

This document applies to Maximizer CRM 11 and Maximizer CRM 11 Customization Suite software.

Maximizer Software Address Information

Corporate Headquarters Americas

Maximizer Software Inc. 1090 West Pender Street – 10th Floor Vancouver, BC, Canada V6E 2N7

+1 604 601 8000 phone +1 604 601 8001 fax +1 888 745 4645 support

[email protected] www.maximizer.com Knowledge Base: www.maximizer.com/knowledgebase

Europe, Middle East, and Africa

Maximizer Software Ltd Apex House, London Road Bracknell, Berkshire RG12 2XH United Kingdom

+44-1344-766900 phone +44-1344-766901 fax

[email protected] www.maximizer.co.uk

Asia

Maximizer Asia Limited 17/F, Regent Centre 88 Queen's Road Central Central, Hong Kong +(852) 2598 2811 phone +(852) 2598 2000 fax

[email protected] www.maximizer.com.hk

Australia

Maximizer Software Solutions Pty. Ltd. Level 10, 815 Pacific Highway Chatswood NSW 2067 Australia +61 (0)2 9957 2011 phone +61 (0)2 9957 2711 fax

[email protected] www.maximizer.com.au

Contents i

Contents

Chapter 1 Introduction ............................................................................1Who Should Use This Guide?........................................................................2Related Documentation................................................................................2

Chapter 2 COM: MaAccess and MaConfig COM Objects........................3MaAccess: Introduction.................................................................................4

Methods and Properties ........................................................................4Using MaAccess ......................................................................................4Referential Integrity and Business Rules ..............................................7Getting Error Feedback .........................................................................8

Using MaAccess or MaConfig with the .NET Framework ...........................9MaAccess and Managed C++ .NET ......................................................10

MaAccess: MaHost Object...........................................................................11Connecting to MaAccess using Early and Late Binding.....................11CheckForLoginAccess ...........................................................................14CreateObject ........................................................................................15DBLoginCheck ......................................................................................16Init.........................................................................................................17ValidDate ..............................................................................................18ValidTime..............................................................................................19

MaAccess: Other Objects ............................................................................20Account Object.....................................................................................21Address Object .....................................................................................22Appointments Object ..........................................................................23CampaignAccounts Object ..................................................................25CampaignData Object .........................................................................25Company Object...................................................................................26CSCase Object.......................................................................................27CustomIndependent ............................................................................28CustomChild .........................................................................................29Detail Object ........................................................................................30DetailDefs Object .................................................................................32Documents Object................................................................................34Email Object .........................................................................................34GroupMembers Object ........................................................................35Hotlist Object .......................................................................................36Letters Object .......................................................................................37Library Object.......................................................................................39

Maximizer CRM 11Customization Suite - Volume II

ii

Notes Object .........................................................................................40OMSObject Object................................................................................41OppActivity Object...............................................................................42OppLink Object ....................................................................................43Opportunity Object..............................................................................44OppRating Object ................................................................................45OppStep Object ....................................................................................46People Object .......................................................................................47Resources Object ..................................................................................48SecurityGroup Object ...........................................................................48StoredProcedure Object.......................................................................49Strategy Object.....................................................................................50StrategyLink Object..............................................................................51SysGroups Object..................................................................................52Team Object..........................................................................................53UserDetails Object................................................................................54Users Object..........................................................................................55Hidden Objects .....................................................................................56

MaAccess: Methods .....................................................................................57AddEmailDocument .............................................................................60AssignOppSFStanding ..........................................................................63ChangeMemberList ..............................................................................63ChangeMemberListEx ..........................................................................64ChangePassword ..................................................................................64Clear ......................................................................................................65ConvertToCompany..............................................................................65ConvertToIndividual .............................................................................66Delete....................................................................................................66Download .............................................................................................67EndSelect ..............................................................................................67Execute..................................................................................................68GetDescription......................................................................................68GetEmailSignature ...............................................................................69GetLastEventCode ................................................................................69GetLastEventDesc .................................................................................70GetMAObjectName..............................................................................70GetMemberList .....................................................................................71GetMemberListEx .................................................................................71GetNext.................................................................................................72GetParameter .......................................................................................73GetSolutionNote ..................................................................................73GetText..................................................................................................74GetTotalRowCount...............................................................................74GetUserDisplayName ...........................................................................75GroupInsert...........................................................................................75Insert .....................................................................................................76LockRecord ...........................................................................................76

Contents iii

Select.....................................................................................................77SelectAllRelated ...................................................................................78SelectCalendarUserModifyList.............................................................78SelectCalendarUserReadList ................................................................79SelectDetailListForClient ......................................................................79SelectDetailListForDelete.....................................................................80SelectDetailListForModify....................................................................80SelectDetailListForRead .......................................................................81SelectExtensionList ...............................................................................81SelectFromCampaign ...........................................................................81SelectFromList ......................................................................................82SelectFromSNList ..................................................................................82SelectHotlistUserModifyList.................................................................83SelectHotlistUserReadList ....................................................................83SelectTemplates....................................................................................83SelectWithAccountCondition ..............................................................83SelectWithCampaignCondition...........................................................84SelectWithCSCaseCondition ................................................................84SelectWithOppCondition.....................................................................85SetDateRange.......................................................................................85SetDetailIn ............................................................................................86SetDetailLike ........................................................................................86SetDetailRange.....................................................................................87SetEmailSignature................................................................................88SetEnumValue ......................................................................................89SetFilterEnum .......................................................................................89SetFilterLike..........................................................................................90SetFilterRange ......................................................................................91SetKeyWordValue ................................................................................92SetLikeValue .........................................................................................92SetMaxValue.........................................................................................93SetMinValue .........................................................................................94SetParameter........................................................................................94SetPhraseValue.....................................................................................95SetRange...............................................................................................96SetSolutionNote ...................................................................................97SetSortOrder.........................................................................................97SetUserDisplayName ............................................................................98SetUserIdRange ....................................................................................98SubFilterEnd .........................................................................................98SubFilterStart........................................................................................99UnlockRecord .....................................................................................100Update ................................................................................................100

MaConfig COM Object..............................................................................101GetConfigString .................................................................................101SetConfigString ..................................................................................102Four-letter Module Codes..................................................................102


iv

MaConfig Table: Entries and their Meanings ...................................103

Chapter 3 Maximizer.Data: Introduction ...........................................111Maximizer.Data Introduction....................................................................112Developing with .NET and Maximizer.Data.............................................113

Namespaces ........................................................................................113Exceptions...........................................................................................113Working with Lists..............................................................................115

Search String Language ............................................................................116Search Syntax......................................................................................116Search Operators................................................................................116Exceptions...........................................................................................120

Chapter 4 Maximizer.Data: Hooks and Other Customizations .........123Address Book, Customer Service, and Opportunity Hooks .....................124

Creating a Custom Hook....................................................................124Creating an ASP.NET Web Application Custom Dialog Box.............125Adding Your Custom Hook to the CustomHooks.xml File...............127

Custom Tabs ...............................................................................................128Creating a Custom Tab.......................................................................128Creating an ASP.NET Web Application Custom Tab .........................129Adding Your Custom Tab to the DialogTabs.xml File.......................132

Actions Menu Customization....................................................................133Creating a Custom Action for the Actions Menu.............................133Creating an ASP.NET Web Application Custom Action Dialog Box.134Adding Custom Actions to the CustomActions.xml File ..................135Creating Custom Links to External Websites ....................................137

AppointmentHook ....................................................................................139Web.config .........................................................................................139AppointmentHook.js..........................................................................140

Custom Applications in Web Access Sites ................................................141Creating Custom Applications...........................................................141Creating Icons for Custom Applications............................................141Linking Custom Applications to Web Access Sites ...........................142

Chapter 5 Maximizer.Data: Field Matrices and Object Hierarchies..145MxField.......................................................................................................147

MxString .............................................................................................148MxDateTime .......................................................................................149MxInteger ...........................................................................................150MxDouble ...........................................................................................150MxBoolean..........................................................................................151

MxKey Object ............................................................................................152MxKey .................................................................................................152ToString...............................................................................................152

Contents v

IsForObject..........................................................................................152ValidateKeyType.................................................................................153

Data Objects ..............................................................................................154ResetKey .............................................................................................154

AddressBook Object ..................................................................................155AbEntry Object ..........................................................................................156

Company Object.................................................................................161Individual Object................................................................................161Contact Object ...................................................................................162

Address Object ..........................................................................................164Appointment Object .................................................................................165Article Object.............................................................................................167Campaign Object.......................................................................................168ColumnSetup Object .................................................................................170CSCase Object ............................................................................................171CustomChild Object ..................................................................................173CustomIndependent Object .....................................................................175Document Object ......................................................................................177Email Object ..............................................................................................178FavoriteList Object ....................................................................................179Note Object ...............................................................................................180Opportunity Object...................................................................................181Option Object............................................................................................183Quota Object .............................................................................................183SecurityPermissions Object .......................................................................184SecurityPrinting Object .............................................................................184SecurityPrivilege Object ............................................................................184SecurityRole Object ...................................................................................185Task Object.................................................................................................185UdfDefinition Object ................................................................................186User Object ................................................................................................187

CloneDetailInfo ..................................................................................188CloneAccessSettings...........................................................................188ClonePreferences ...............................................................................188User Details.........................................................................................188User Rights..........................................................................................189Logging Preferences ..........................................................................192

Chapter 6 Maximizer.Data: Access Objects ........................................197Exceptions..................................................................................................199AddressBookMaster Object ......................................................................201

AddressBookMaster ...........................................................................202CompleteForcedPasswordChange.....................................................202Create...Access ....................................................................................204


vi

EmailForgottenCredentials ................................................................206ExternalLogin .....................................................................................207GetCurrentAddressBookName ..........................................................207GetCurrentSqlDatabaseName ...........................................................208GetDBList ............................................................................................208Login ...................................................................................................208LoginAuth...........................................................................................209LoginMaximizer..................................................................................210ValidateCredential .............................................................................211ValidateCredentialAuth .....................................................................212

GlobalAccess Object ..................................................................................213GetMaConfigString ............................................................................213GetModuleVersionString ...................................................................214GetWebServiceInfo.............................................................................214ReadAddressBookList .........................................................................215

MxAbAccess Object ...................................................................................216GetLastQuarterEndDate ....................................................................216GetLastQuarterStartDate...................................................................217GetNextQuarterEndDate ...................................................................217GetNextQuarterStartDate..................................................................217GetThisQuarterEndDate ....................................................................218GetThisQuarterStartDate...................................................................218GetQ1EndDate ...................................................................................218GetQ1StartDate..................................................................................219GetQ2EndDate ...................................................................................219GetQ2StartDate..................................................................................219GetQ3EndDate ...................................................................................220GetQ3StartDate..................................................................................220GetQ4EndDate ...................................................................................220GetQ4StartDate..................................................................................221ReadFiscalYearStartMonth.................................................................221

AbEntryAccess Object................................................................................222AddPartnerLink ..................................................................................223AddToRecentEntryList ........................................................................224ChangeExternalPassword ..................................................................225ConvertContactToIndividual ..............................................................225ConvertIndividualToCompanyAndContact .......................................226Delete..................................................................................................226DeletePartnerLink ..............................................................................227GetLoggedInUser ...............................................................................228GetLoggedInUserKey .........................................................................228GetSearchMetricValue .......................................................................228Insert ...................................................................................................229IsFullAccessGranted............................................................................230ReadAddressList .................................................................................230ReadCampaignList..............................................................................231ReadContactList..................................................................................231

Contents vii

ReadContactOnlyList..........................................................................232ReadCSCaseList ...................................................................................233ReadDefaultEntry...............................................................................233ReadDocumentList .............................................................................234ReadDuplicateAbEntryList .................................................................234ReadIndividualOnlyList ......................................................................235ReadKeyFieldListList...........................................................................236ReadKeyFieldSettings ........................................................................236ReadList ..............................................................................................236ReadNoteList ......................................................................................240ReadOpportunityList..........................................................................241ReadPartnerList ..................................................................................241ReadRecentEntryList ..........................................................................242ReadTaskList .......................................................................................242RefreshMandatoryFieldProperty.......................................................242SetDefaultEntry..................................................................................243Update ................................................................................................243

AddressAccess Object ................................................................................245Delete .................................................................................................245Insert ...................................................................................................246ReadList ..............................................................................................246Update ................................................................................................247

AppointmentAccess Object ......................................................................248Delete .................................................................................................248GetAllLocations ..................................................................................249GetAllResources .................................................................................249GetHolidays ........................................................................................249GetSearchMetricValue .......................................................................249GetUsersWeCanMakeAppointmentWith..........................................250GetUsersWeCanSeeCalendarOf.........................................................250Insert ...................................................................................................251QuickInsert .........................................................................................251ReadList ..............................................................................................252ReadListSpecial ...................................................................................253TranslateKeyForUser ..........................................................................255Update ................................................................................................255

ArticleAccess Object ..................................................................................256Delete .................................................................................................256Download ...........................................................................................257Insert ...................................................................................................257ReadList ..............................................................................................258SetData ...............................................................................................259Update ................................................................................................259

CampaignAccess Object ............................................................................260GetSearchMetricValue .......................................................................260RetrieveClickedThroughAbEntryKeys ...............................................261


viii

RetrieveOpenedEmailAbEntryKeys ...................................................261RetrieveUnsuccessfulAbEntryKeys.....................................................262

ColumnSetupAccess Object.......................................................................263Delete..................................................................................................265Get...PartnerDataSet ..........................................................................265GetOppEntryPartnerAndCompetitorDataSet ...................................266Insert ...................................................................................................267Read...ColumnSetupList .....................................................................267Read...UdfColumnSetupMergeFields ................................................268Read...View.........................................................................................268ReadColumnList..................................................................................271ReadList...............................................................................................272Update ................................................................................................273UpdateColumnList..............................................................................273

CSCaseAccess Object..................................................................................274Assign..................................................................................................275Delete..................................................................................................276GenerateDeadlineDateByResponseTimePreference ........................276GetSearchMetricValue .......................................................................277GetSolutionNote ................................................................................277Insert ...................................................................................................278ReadCSManagersList ..........................................................................278ReadCSRepresentativesList ................................................................279ReadDefaultCSCaseEntry ...................................................................279ReadDocumentList .............................................................................279ReadKeyFieldListList ...........................................................................280ReadList...............................................................................................280ReadNoteList ......................................................................................281ReadProductAndCategory .................................................................281ReadStatusOptionListForAssign ........................................................282ReadStatusOptionListForEscalate......................................................282ReadStatusOptionListForResolve.......................................................282Resolve ................................................................................................282SetDefaultCSCaseEntry ......................................................................284SetSolutionNote .................................................................................284Update ................................................................................................285

CustomAccess Object.................................................................................286Delete..................................................................................................286Insert ...................................................................................................287ReadChildList ......................................................................................287ReadIndependentList .........................................................................288Update ................................................................................................290

DetailFieldAccess Object ...........................................................................291DocumentAccess Object ............................................................................294

Delete..................................................................................................294Download ...........................................................................................295

Contents ix

GetDocumentList ...............................................................................296GetSubFolderList ................................................................................296GetText................................................................................................297Insert ...................................................................................................297IsFullTextSearchingSupported ...........................................................299ReadAnnouncementList ....................................................................299ReadList ..............................................................................................299SetData ...............................................................................................300Update ................................................................................................301

EmailAccess Object....................................................................................302GetBestEmailAddress .........................................................................302GetEmailSignatureText ......................................................................302Insert ...................................................................................................303IsEmailLoggingDefinedForLoggedInUser .........................................303SaveEmailAsDocument ......................................................................303SendHtmlEmail ...................................................................................305SendTextEmail ....................................................................................306

FavoriteListAccess Object ..........................................................................308AddEntriesToFavoriteList ...................................................................308AddToRecentEntryList........................................................................309ClearRecentEntryList ..........................................................................309Delete .................................................................................................310GetDescription ...................................................................................310GetNumberOfVisibleEntries ..............................................................311Insert ...................................................................................................311ReadList ..............................................................................................312ReadRecentEntryList ..........................................................................313RemoveAllEntriesFromFavoriteList ...................................................313RemoveEntriesFromFavoriteList ........................................................313SetDescription ....................................................................................314Update ................................................................................................314

GroupAccess Object ..................................................................................315Delete .................................................................................................315GetGroupMemberList ........................................................................316Insert ...................................................................................................317ReadList ..............................................................................................317Update ................................................................................................319

NoteAccess Object .....................................................................................320Delete .................................................................................................321Insert ...................................................................................................321ReadDefault...Note ............................................................................322ReadDefault...NoteText .....................................................................322ReadList ..............................................................................................323SetDefault...Note ...............................................................................324Update ................................................................................................324

OpportunityAccess Object ........................................................................325


x

AddCompetitorLink ...........................................................................326AddPartnerLink ..................................................................................326DeleteCompetitorLink .......................................................................327DeletePartnerLink ..............................................................................328EvaluateCurrentUserInSalesTeam......................................................328GetReasonListForStatus .....................................................................329GetSearchMetricValue .......................................................................329Insert ...................................................................................................330ReadCompetitorList ...........................................................................330ReadFullCompetitorList .....................................................................331ReadFullPartnerList ............................................................................331ReadKeyFieldListList ...........................................................................331ReadLibraryOpportunityStrategy......................................................332ReadOpportunityStrategy .................................................................332ReadPartnerList ..................................................................................332ReadSalesTeamList..............................................................................333ReadUserList .......................................................................................333Update ................................................................................................333UpdateOpportunityStrategy .............................................................334

OptionAccess Object .................................................................................335GetUsersLoggedInUserCanSeeOrModifyCalendarOf .......................335GetUsersLoggedInUserCanSeeOrModifyHotlistOf ...........................336GetUsersWhoCanSeeOrModifyCalendarOfLoggedInUser ...............336GetUsersWhoCanSeeOrModifyHotlistOfLoggedInUser ...................336KeyFieldListKeyToInt ..........................................................................337OpportunityStrategyKeyToInt ...........................................................337ReadList...............................................................................................337ReadSearchList....................................................................................339ReadUdfNames...................................................................................340SalesTeamKeyToInt.............................................................................340

QuotaAccess Object...................................................................................341Delete..................................................................................................341GetDescription....................................................................................342GetSearchMetricValue .......................................................................342GetSearchMetricValueForListControl ................................................343Insert ...................................................................................................344ReadList...............................................................................................344ReadSalesTeamForLoggedInUser.......................................................345SetDescription ....................................................................................346Update ................................................................................................346

RightAccess Object ....................................................................................347CloneRightList ....................................................................................349CreateRightsByOwner........................................................................350Delete .................................................................................................350GetRightListByOwner.........................................................................351GetRightPermission............................................................................351GetRightPrinting ................................................................................352

Contents xi

GetRightPrivilege ...............................................................................352GetRightUserRole...............................................................................353GetSecurityPermissionListByOwner ..................................................353GetSecurityPrintingListByOwner.......................................................354GetSecurityPrivilegeListByOwner......................................................354GetSecurityRoleListByOwner.............................................................355Insert ...................................................................................................355RebuildUserEffectiveRights ...............................................................356RemoveRightsByOwner .....................................................................356Update ................................................................................................357UpdateRightsByOwner ......................................................................357

TaskAccess Object ......................................................................................358Delete .................................................................................................358GetSearchMetricValue .......................................................................359Insert ...................................................................................................360ReadList ..............................................................................................360Reassign ..............................................................................................362Update ................................................................................................362

UdfAccess Object.......................................................................................363Delete .................................................................................................368GetBestEmailAddress .........................................................................369GetFieldValue .....................................................................................369GetShowTreeViewSetting..................................................................370GetUdfSetupDescription....................................................................370Insert ...................................................................................................371IsFieldInUseByFormulas......................................................................371LoadCurrentUserDefaultEntryValues................................................372ReadAppointmentCategoryUdfSetup...............................................372ReadAppointmentProductUdfSetup.................................................372ReadKeyFieldList ................................................................................372ReadUdfDefinitionAndUdfList ..........................................................373ReadUdfDefinitionList .......................................................................373ReadUdfList ........................................................................................374SetFieldValue......................................................................................374SetShowTreeViewSetting...................................................................375UdfSetupInsert ...................................................................................375UdfSetupTableItemInsert...................................................................376Update ................................................................................................378

UserAccess Object......................................................................................379ChangePassword ................................................................................380Delete .................................................................................................382GetUser ...............................................................................................382GetUsersFriendlyName ......................................................................383Insert ...................................................................................................383ReadCalendarAppMemberModifyList ..............................................384ReadCalendarAppMemberReadList ..................................................385ReadCalendarUserModifyList ............................................................385


xii

ReadCalendarUserReadList ................................................................385ReadCaseMonitoringUserList ............................................................386ReadGroupList ....................................................................................386ReadHotlistUserModifyList ................................................................387ReadHotlistUserReadList ....................................................................387ReadList...............................................................................................387ReadLoggedInUser .............................................................................388ReadOppMonitoringUserList .............................................................389ReadPegboardUsersList......................................................................389Update ................................................................................................390UpdateCaseMonitoringUserList ........................................................391UpdateOppMonitoringUserList .........................................................391UpdatePegboardWithCurrentAppointments ...................................392

Chapter 7 Maximizer Web Service ......................................................395About Maximizer Web Service .................................................................396Configuring Maximizer Web Service........................................................396CreateNew[ObjectName] ..........................................................................397AbEntryAccess... Methods.........................................................................398

AbEntryAccessAddAccessPartnerLink................................................399AbEntryAccessDelete .........................................................................399AbEntryAccessDeletePartnerLink ......................................................400AbEntryAccessGetLoggedInUser .......................................................400AbEntryAccessGetLoggedInUserKey .................................................400AbEntryAccessInsert ...........................................................................401AbEntryAccessIsFullAccessGranted....................................................402AbEntryAccessReadAddressList .........................................................402AbEntryAccessReadCampaignList .....................................................403AbEntryAccessReadCompanyOnlyList ...............................................403AbEntryAccessReadContactList .........................................................404AbEntryAccessReadContactOnlyList..................................................404AbEntryAccessReadCSCaseList ...........................................................405AbEntryAccessReadDefaultEntry.......................................................405AbEntryAccessReadDocumentList .....................................................406AbEntryAccessReadDuplicateAbEntryList .........................................406AbEntryAccessReadIndividualOnlyList ..............................................407AbEntryAccessReadKeyFieldListList...................................................407AbEntryAccessReadKeyFieldSettings ................................................408AbEntryAccessReadList ......................................................................408AbEntryAccessReadNoteList ..............................................................409AbEntryAccessReadOpportunityList..................................................409AbEntryAccessReadTaskList ...............................................................410AbEntryAccessSetDefaultEntry..........................................................410AbEntryAccessUpdate ........................................................................411

AddressAccess... Methods .........................................................................412AddressAccessDelete..........................................................................412

Contents xiii

AddressAccessInsert ...........................................................................413AddressAccessGetLoggedInUser .......................................................413AddressAccessGetLoggedInUserKey .................................................413AddressAccessReadList.......................................................................413AddressAccessUpdate ........................................................................414

AddressBookMaster... Methods................................................................415AddressBookMasterGetConnectionAddressBookName ..................415AddressBookMasterGetConnectionSqlDatabaseName....................416AddressBookMasterGetDBList...........................................................416AddressBookMasterLogin..................................................................417AddressBookMasterLoginAuth .........................................................417AddressBookMasterLoginMaximizer ................................................418AddressBookMasterValidateCredential ............................................419AddressBookMasterValidateCredentialAuth ...................................419

AppointmentAccess... Methods................................................................420AppointmentAccessGetAllLocations.................................................420AppointmentAccessGetAllResources ................................................420AppointmentAccessGetLoggedInUser ..............................................421AppointmentAccessGetLoggedInUserKey........................................421AppointmentAccessGetUsersWeCanMakeAppointmentWith ........421AppointmentAccessQuickInsert ........................................................422

DetailFieldAccess... Methods ....................................................................423DetailFieldAccessGetFieldValue ........................................................423DetailFieldAccessGetLoggedInUser...................................................423DetailFieldAccessGetLoggedInUserKey ............................................423DetailFieldAccessGetUdfSetupDescription .......................................423DetailFieldAccessReadUdfDefinitionAndUdfList..............................424DetailFieldAccessReadUdfDefinitionList...........................................424DetailFieldAccessReadUdfList............................................................424DetailFieldAccessSetFieldValue .........................................................424

DocumentAccess... Methods.....................................................................425DocumentAccessDelete .....................................................................425DocumentAccessDownload ...............................................................426DocumentAccessGetLoggedInUser ...................................................426DocumentAccessGetLoggedInUserKey .............................................426DocumentAccessInsert .......................................................................426DocumentAccessIsFullTextSearchingSupported ...............................427DocumentAccessReadList ..................................................................427DocumentAccessUpdate ....................................................................427

Global Access... Method............................................................................428GlobalAccessReadAddressBookList ...................................................428

NoteAccess... Methods ..............................................................................429NoteAccessDelete...............................................................................429NoteAccessGetLoggedInUser ............................................................429NoteAccessGetLoggedInUserKey ......................................................430NoteAccessInsert ................................................................................430


xiv

NoteAccessIsFullTextSearchingSupported.........................................430NoteAccessReadDefaultAbEntryNote ...............................................431NoteAccessReadList ............................................................................431NoteAccessSetDefaultAbEntryNote ..................................................432NoteAccessUpdate .............................................................................432

TaskAccess... Methods ...............................................................................433TaskAccessDelete ................................................................................433TaskAccessGetLoggedInUser..............................................................433TaskAccessGetLoggedInUserKey........................................................433TaskAccessInsert..................................................................................434TaskAccessReadList .............................................................................434TaskAccessReassign.............................................................................435TaskAccessUpdate...............................................................................435

UdfAccess... Methods ................................................................................436UdfAccessGetFieldValue ....................................................................436UdfAccessGetLoggedInUser...............................................................436UdfAccessGetLoggedInUserKey ........................................................437UdfAccessGetUdfSetupDescription ...................................................437UdfAccessReadAppointmentCategoryUdfSetup..............................437UdfAccessReadAppointmentProductUdfSetup ................................438UdfAccessReadKeyFieldList................................................................438UdfAccessReadUdfDefinitionAndUdfList..........................................439UdfAccessReadUdfDefinitionList.......................................................439UdfAccessReadUdfList........................................................................440UdfAccessSetFieldValue .....................................................................440

UserAccess... Methods ...............................................................................441UserAccessGetLoggedInUser .............................................................441UserAccessGetLoggedInUserKey .......................................................441UserAccessGetUser .............................................................................441UserAccessReadList.............................................................................442

Chapter 8 Maximizer.Web.Integration...............................................443EmployeePortal.General Class ..................................................................444

IsSessionExpired Property ..................................................................444EmployeePortal.Content.ContentModule Class ......................................445

LastSearchString Property..................................................................445ForceRefresh Property........................................................................445

EmployeePortal.Content.AddressBook Class ...........................................446ForceRecentEntriesRefresh Property.................................................446GetCurrentKeysList Method ..............................................................446GetSelectedKeysList Method .............................................................446

Chapter 9 MaxExchange Web Service Interface ................................447Introduction to the MaxExchange Web Service ......................................448Installing the MaxExchange Web Service ................................................448Configuring DCOM for MaxExchange Web Service ................................449

Contents xv

MaxExchange Data Types .........................................................................450SiteData ..............................................................................................450ConnectedSiteData ............................................................................451FavoriteData.......................................................................................451SynchronizedAddrBookData .............................................................452

MaxExchange Web Service Methods .......................................................453Login ...................................................................................................454AddressBookMaintenance.................................................................455GetAddressBookMaintSched.............................................................456GetAddressBookMaintSettings .........................................................457GetConnectedSites.............................................................................458GetCurrentState .................................................................................459GetDatabaseDescription....................................................................460GetEmailOpts .....................................................................................460GetEmailType......................................................................................462GetFavorites .......................................................................................463GetIsRunningTimeout ........................................................................463GetLoggingOpts.................................................................................464GetMachineName ..............................................................................465GetMessageBoxInfo ...........................................................................466GetProcessingType .............................................................................467GetProcessRefreshOnly ......................................................................467GetProcessSiteInfo .............................................................................468GetProgress ........................................................................................468GetServerType ....................................................................................469GetSites...............................................................................................469GetStatus ............................................................................................470GetSynchronizedAddressBookInfo....................................................471GetSyncProcessSched .........................................................................472GetSyncTransportSched .....................................................................473ImportLstInitialDistLst ........................................................................474MessageBoxResponse ........................................................................475Pause...................................................................................................476Resume ...............................................................................................476SetAddressBookMaintSched..............................................................477SetAddressBookMaintSettings ..........................................................478SetEmailOpts ......................................................................................479SetEmailType ......................................................................................480SetIndependentProcessing ................................................................481SetLoggingOpts..................................................................................482SetProcessRefreshOnly.......................................................................483SetSimultaneousProcessing ...............................................................483SetSyncProcessSched ..........................................................................484SetSyncTransportSched ......................................................................485SetToManualProcessing .....................................................................485Sync .....................................................................................................486

MaxExchange Web Service Methods – Remote Server ...........................487


xvi

GetFTPSettings ...................................................................................488GetHttpSettings..................................................................................489GetSaveToDisk ....................................................................................489GetSynchronizedAddrBks ..................................................................490SetFtpPort ...........................................................................................490SetFtpPort2 .........................................................................................491SetFTPSettings ....................................................................................492SetHttpSettings ..................................................................................493SetSaveToDisk .....................................................................................493SetTransportAddress ..........................................................................494TestFTPConnection .............................................................................495

Chapter 10 Customizing the Maximizer Interface...............................497Customizing Text in the Maximizer Interface..........................................498

Creating Customizations....................................................................498Saving Customizations .......................................................................503

Customizing Interfaces in Web Access Sites.............................................505Customizing Interfaces in MaxMobile......................................................506Adding Items to Maximizer’s Tools Tab....................................................507Adding Commands to Maximizer’s Custom Actions Tab.........................507

Chapter 11 Integrating Maximizer with SharePoint ...........................509Viewing Maximizer Data in Microsoft SharePoint ..................................510Business Data Lists .....................................................................................511

AbEntry ...............................................................................................511Note ....................................................................................................513Udf ......................................................................................................514

Business Data Related Lists .......................................................................515Note ....................................................................................................515Udf ......................................................................................................515

Index ....................................................................................517