API changes

New Archive providers

v10.2.6
- EmailFlowContentProvider
- ExternalDocumentItems
v10.2.5
- ExternalDocumentFolder (Renamed in 10.2.6)
- ExternalDocumentItems
- ExternalDocuments
v10.2.4
v10.2.3
v10.2.2
- Recycle ticket

New MDO providers

v10.2.11
- InvitationTemplateLanguage
v10.2.10
- EmailPhone
- WorkflowSplitOptionType
v10.2.9
v10.2.8
v10.2.4
v10.2.3
- workflowsteptype
v10.2.2

New web service methods

Agent Name	Method Name	Version
IAIAgent	ExpandText	10.2.9
IAIAgent	GetChatbotPromptSuggestions	10.2.9
IAIAgent	GetChatbotResponse	10.2.9
IAIAgent	GetSummarizeContactPrompt	10.2.9
IAIAgent	GetSummarizeSalePrompt	10.2.9
IAIAgent	GetSummarizeTicketPrompt	10.2.9
IAIAgent	RephraseText	10.2.9
IAIAgent	SummarizeContact	10.2.9
IAIAgent	SummarizeSale	10.2.9
IAIAgent	SummarizeText	10.2.9
IAIAgent	SummarizeTicket	10.2.9
IAppointmentAgent	CleanUpBookingDeletedWithUpdateMode	10.2.3
IAppointmentAgent	CreateAppointmentEntityFromExisting	10.2.8
IAppointmentAgent	GetAppointmentEmailInvitation	10.2.11
IAppointmentAgent	GetAssociatesDiaryInfo	10.2.11
IAppointmentAgent	GetNextAvailableTime	10.2.10
IAppointmentAgent	SaveWithCustomInvitation	10.2.11
IAppointmentAgent	SetSeenMany	10.2.2
IArchiveAgent	GetRelatedData	10.2.1
IArchiveAgent	GetRelatedData2	10.2.1
IAssociateAgent	GetEncryptionKey	10.2.6
IConfigurationAgent	GetAllFeatureToggles	10.2.11
IContactAgent	GetDomainDuplicates	10.2.10
ICRMScriptAgent	ExecuteScriptByString	10.2.8
ICRMScriptAgent	ValidateScriptByString	10.2.8
IDiagnosticsAgent	GetEntityCountsForAllUsers	10.2.11
IDiagnosticsAgent	GetEntityCountsForCurrentUser	10.2.4
IDocumentAgent	CopyDocumentToCsAttachment	10.2.8
IEMailAgent	HasSPFRecord	10.2.1
IEMailAgent	ResolveEMailRecipients	10.2.4
IListAgent	CreateDefaultTaskMenu	10.2.1
IListAgent	CreateDefaultTicketTypeEntity	10.2.8
IListAgent	DeleteAppTaskMenus	10.2.1
IListAgent	DeleteTaskMenu	10.2.1
IListAgent	DeleteTicketTypeEntity	10.2.8
IListAgent	GetAllTicketTypeEntities	10.2.8
IListAgent	GetTicketType	10.2.8
IListAgent	GetTicketTypeEntity	10.2.8
IListAgent	GetTicketTypeList	10.2.8
IListAgent	GetTicketTypes	10.2.8
IListAgent	GetAppTaskMenus	10.2.1
IListAgent	GetTaskMenu	10.2.1
IListAgent	GetTaskMenuByProgId	10.2.1
IListAgent	GlobalChangeTicketType	10.2.10
IListAgent	SaveTaskMenu	10.2.1
IListAgent	SaveTicketTypeEntity	10.2.8
IMarketingAgent	GetFormSubmissionsCount	10.2.2
IPersonAgent	CreateDefaultPersonImage	10.2.1
IPersonAgent	CreateOrUpdateUserCandidate	10.2.4
IPersonAgent	GetCustomerCentrePasswordReplyTemplate	10.2.4
IPersonAgent	GetPersonImages	10.2.1
IPersonAgent	GetUserCandidateByPerson	10.2.4
IPersonAgent	SendEmail	10.2.4
IPersonAgent	SendEmailWithEventName	10.2.10
ITicketAgent	ClearNotify	10.2.3
ITicketAgent	CopyFromCRMDocument	10.2.3
ITicketAgent	CopyToTempFile	10.2.6
ITicketAgent	GetDefaultMessageContentFull	10.2.10
ITicketAgent	GetNextInQueue	10.2.3
ITicketAgent	GetTicketMessageEntities	10.2.9
ITicketAgent	GetTicketMessageWithOptions	10.2.1
ITicketAgent	SplitTicket	10.2.8
ITicketAgent	UndeleteByIds	10.2.1
ITicketAgent	ValidateAttachments	10.2.1
IUserAgent	GetUserPresenceStatus	10.2.1
IUserAgent	SetUserPresenceStatus	10.2.1
IUserDefinedFieldInfoAgent	ClearCaches	10.2.1
IViewStateAgent	GetLiveUiConfig	10.2.4
IViewStateAgent	PublishAndRetrieveUiEvents (in 10.2.4)	10.2.6
IWorkflowAgent	ConnectEmailFlowContent	10.2.6
IWorkflowAgent	CopyEmailFlowContent	10.2.8
IWorkflowAgent	CreateDefaultWorkflowEvent	10.2.8
IWorkflowAgent	CreateDefaultWorkflowEventResult	10.2.8
IWorkflowAgent	CreateDefaultWorkflowFilter	10.2.4
IWorkflowAgent	CreateDefaultWorkflowGoal	10.2.4
IWorkflowAgent	CreateDefaultWorkflowStepFromType	10.2.4
IWorkflowAgent	CreateDefaultWorkflowStepOptionFromType	10.2.10
IWorkflowAgent	CreateDefaultWorkflowTrigger	10.2.4
IWorkflowAgent	CreateEmailFlowContent	10.2.6/8
IWorkflowAgent	DeleteWorkflowGoal	10.2.4
IWorkflowAgent	DeleteWorkflowTrigger	10.2.4
IWorkflowAgent	GetWorkflowGoal	10.2.4
IWorkflowAgent	GetWorkflowStepOption	10.2.4
IWorkflowAgent	GetWorkflowTrigger	10.2.4
IWorkflowAgent	RemoveParticipantsFromEmailFlow	10.2.8
IWorkflowAgent	Run	10.2.8
IWorkflowAgent	SaveWorkflowGoal	10.2.4
IWorkflowAgent	SaveWorkflowTrigger	10.2.4
IWorkflowAgent	SendEvent	10.2.8

Breaking changes - modified web service methods

Agent Name	Method Name	Version	Reason
ITicketAgent	SaveTicketMessageEntityWithOptions	10.2.4
ITicketAgent	SplitTicket	10.2.8	Added two new arguments.
IWorkflowAgent	CreateEmailFlowContent	10.2.8	Added one new argument
IWorkflowAgent	CreateDefaultWorkflowStepOption	10.2.10	Deleted
IWorkflowAgent	DeleteWorkflowStepOption	10.2.10	Deleted
IWorkflowAgent	SaveWorkflowStepOption	10.2.10	Deleted

Authentication using SoAccessTokenSecurityToken

The following is a breaking change in the API. SoAccessTokenSecurityToken was removed from the codebase in version 10.? without notification.

var accessToken = "8A:Cust12345.ey...token_string...54321abcd";

using (var session = SoSession.Authenticate(new SoAccessTokenSecurityToken(accessToken)))
{
  Console.WriteLine($"Authenticated {session.Principal.Associate} using implicit Windows Identity.");
}

Instead, now you are required to use the new SoCredentials class.

var accessToken = "8A:Cust12345.ey...token_string...54321abcd";

using (var session = SoSession.Authenticate(new SoCredentials(accessToken)))
{
    // execute NetServer code...
}

Context Provider changes

The custom ContextProvider functionality was changed and caused breaking changes for partner applications. Please refer to the forum post on Community. No additional resources exist for this topic.

NetServer Core changes

Session Mode Changes

The config file setting for Session Mode has been removed. This has been replaced with a session handling implementation to AddNetServerCore.

services.AddNetServerCore<SuperOffice.Web.Security.HttpContextProvider>(options =>
{
  //... set options
}

The session mode is an implementation of ISoContextProvider.

public static IServiceCollection AddNetServerCore<TSessionMode>(this IServiceCollection services,
  Action<NetServerCoreOptionsBuilder> optionsAction = null) where TSessionMode : class, ISoContextProvider
{
  //... set options
}

There are several default implementations of ISoContextProvider located in SoCore.

ThreadContextProvider
ContextContextProvider
ProcessContextProvider

Another is HttpContextProvider, located in SuperOffice.DCFWeb.

Services Mode Changes

The Setting for Services Local or Remote NetServer mode has been removed from the Config. This has been replaced with extension methods to IServiceCollection. For Local mode calling Services Implementation, use:

services.AddDCFServicesImplementation();
services.AddServicesImplementation();
services.AddMessagingServicesImplementation();

For remote mode using proxies, use:

services.AddServicesProxies();

Logging Changes

Configuration of logging has been moved from NetServer to the application using NetServer. SuperOffice NetServer now support logging in the appsettings.json file.

{
 "Logging": {
    "LogLevel": {
      "Default": "Error",
      "Microsoft": "Error",
      "SuperOffice": "Warning"
    }
  }
}

It is configured using the AddLogging extension method.

services.AddLogging(a =>
{
   a.AddConfiguration(configuration.GetSection("Logging"));
});

Introduction

SuperOffice 12

SuperOffice 11

SuperOffice 10

Database changelog

New Archive providers

New MDO providers

New web service methods

Breaking changes - modified web service methods

Authentication using SoAccessTokenSecurityToken

Context Provider changes

NetServer Core changes

Session Mode Changes

Services Mode Changes

Logging Changes

All API changes

​New Archive providers

​New MDO providers

​New web service methods

​Breaking changes - modified web service methods

​Authentication using SoAccessTokenSecurityToken

​Context Provider changes

​NetServer Core changes

​Session Mode Changes

​Services Mode Changes

​Logging Changes

​All API changes

New Archive providers

New MDO providers

New web service methods

Breaking changes - modified web service methods

Authentication using SoAccessTokenSecurityToken

Context Provider changes

NetServer Core changes

Session Mode Changes

Services Mode Changes

Logging Changes

All API changes