BLR - Custom Service Brokers

Implementing a Static Service Broker
Create .NET class library (or edit existing class) Add Reference to SourceCode.SmartObjects.Services.ServiceSDK.dll Inherit the base class:
Custom Service Brokers on K2 Underground
K2 Underground’s blackmarket has a section dedicated to custom service brokers
/groups/default.aspx?GroupID=61
Custom Service Brokers
This learning module describes how to extend the K2 platform with custom service brokers, which are used to expose back-end systems as K2 SmartObjects
Review: SmartObject architecture
Service Brokers
K2 Provides several standard service brokers
▪ E.g. Microsoft Active Directory, SharePoint, SQL server, SSRS, , Microsoft Dynamics CRM, Oracle and more
▪ Class = Service Object Create a Class for each Service Object and decorate with the [Attributes.ServiceObject] attribute
▪ Class Properties = Service Object Properties Create public Properties for each Class and decorate with the [Attributes.Property] Attribute
underlying system
Installing brokers:
▪ Copy the broker .dll file to all K2 servers ▪ Register the broker with the K2 environment ▪ Register one or more service instances of the broker
Registering Custom Service Brokers
Deployment
▪ Copy the Service Broker assembly to the ServiceBroker folder on each K2 server default location: C:\Program Files (x86)\K2 blackpearl\ServiceBroker
Implementing brokers:
▪ .NET developers create a class library using a SDK ▪ Class library contБайду номын сангаасins all the logic to discover, describe and interact with the
▪ Class Methods = Service Object Methods Create public Methods for each Class and decorate with the [Attributes.Method] Attribute
Implement the DescribeSchema() method Implement the Execute() method
Custom Service Brokers can expose other systems as K2 SmartObjects
Custom Service Brokers can be
▪ Static (describe the underlying system) or
▪ Dynamic (discover the underlying system)
SourceCode.SmartObjects.Services.ServiceSDK.ServiceAssemblyBase
Override and implement GetConfigSection() method
▪ this.Service.ServiceConfiguration.Add(…)
LAB 2: Creating and registering a Static Service Broker
This lab exercise shows how to create a static (Described) service broker.
We will create a static Service Broker that will expose an existing “Time Zone” .NET class as a Service Object
implementing interfaces, using attribute descriptors ▪ K2 SmartObjects Intermediate (200.PER module)
Compatibility
▪ K2 blackpearl V 4.5 update 1420 or higher
Override and implement DescribeSchema() method
▪ This is the discovery method that translates the Provider’s Schema into Service Objects ▪ Define ServiceObject for each class/object/entity ▪ Define and add Property to the ServiceObject for each property ▪ Define and add Method to the ServiceObject for each method ▪ Add the ServiceObject to the Service Instance
this.Service.ServiceObjects.Add(…)
Override and implement the Execute() method (Runtime)
▪ This is the Runtime method which actually executes the Service Object methods ▪ Determine the Method requested and input properties ▪ Initialize Result Table ▪ Connect to the Provider’s API and execute method using input properties ▪ Populate return properties and bind to result table
Worklist Service Broker /groups/worklist_service_broker/default.aspx
15 minutes
Implementing Custom Service Brokers: Before you begin
SourceCode.SmartObjects.Services.ServiceSDK.ServiceAssemblyBase Define Configuration values in the GetConfiguration method
▪ serviceBroker.Service.ServiceConfiguration[] Describe your objects in Service Object terms
(static) ▪ Decide between a Dynamic or Static Broker ▪ Configuration settings for the broker (e.g. special character
replacements for Service Object names)
In this lab exercise you will download a custom Service Broker from K2 Underground and then register the broker in the K2 environment.
For this exercise we will use the custom Worklist Service Broker to expose the K2 Worklist as K2 SmartObjects
Service Instance Registration
▪ Configure the Service for a specific provider ▪ K2 Workspace ▪ BrokerManagement.exe ▪ SmartObject Service Tester.exe
LAB 1: Downloading and registering a service broker from the K2 Underground
Considerations
▪ The Provider’s API(s) and API security ▪ Other Security considerations (e.g. encryption, persistence of user