KNIME Server Workshop · • Install Tomcat/TomEE 1.7 • Configure Application Server – JVM Options – KNIME Server settings – Create email resource • Define users (or configure

Copyright © 2015 KNIME.com AG

KNIMEServerWorkshopJonFullerApplicationScientistKNIME.com AG


TableofContents

ServerArchitectureServerAdministrationWorkflowandDataSharingMetanode /Subnode TemplatesRemote&ScheduleExecutionKNIMEWebPortalWebserviceInterface

2

Copyright © 2015 KNIME.com AG 3

Architecture&Administration


KNIMEServer– FunctionalSetup

WizardExecution

REST/SOAPInterface

WorkflowVersioning /Diff

WebPortal Templates

Tomcat/TomEEAppServer


KNIMEServer– Architecture

5

Java8

Tomcat/TomEEApplicationServer

VAADIN7

KNIMEWebPortal KNIME

ServerKNIMEExecutor(headlessKNIME

AnalyticsPlatform)


Why TomEE?

6

• ApacheTomEE isbasedonApacheTomcat– MuchhigheradoptionthanGlassfish– AdditionallibrariestosupportEJB

• CommunicationsolelyviaHTTP– Less firewall problems– SSLEncryptionforclient- andweb-to-servercommunication

• Installationand deployment considerably easier• Betteruserandgroupmanagement• Simultaneousconnectiontomultipleservers• KNIMEServer4.0availablemidof2015


InstallationOverview

7

• InstallJava8• InstallKNIMEAnalyticsPlatform• Createsharedworkflowrepository• InstallTomcat/TomEE 1.7• ConfigureApplicationServer

– JVMOptions– KNIMEServersettings– Createemailresource

• Defineusers(orconfigureLDAP/AD)• DeployKNIMEServer• DeployKNIMEWebPortal


AdministrationOverview

8

Typicalresponsibilities oftheKNIMEServerAdministrator:• Performserversideupdates(~2xperyear)

– Intermediatebugfixreleasesprovided ifnecessary

• Structuretheworkflowrepository• Manageruseraccessviapermissions


ClientAccess


NewfeaturesareneededfortheKNIMEAnalyticsPlatformtoaccesstheServer.

InstalltheKNIME.comClient-SideExtensionsfromtheKNIMEServerupdatesite.

KNIMEServerClientExtensions

10


Serverconnectionsareshownas“mountpoints”intheKNIMEExplorer.Toaddanewmountpointsimply:

1. ClickontheconfigurebuttonintheKNIMEExplorer.2. ClickNew…3. ConfigureaServerSpace withyourdetails

DefininganewServerSpace

11


Serverconnectionsareshownas“mountpoints”intheKNIMEExplorer.Toaddanewmountpointsimply:

1. ClickontheconfigurebuttonintheKNIMEExplorer.

2. ClickNew…3. ConfigureaServerSpace with

yourdetails

DefininganewServerSpace

12


TheServerprovidesanareaintheExplorerforsharingworkwithyourcolleagues.Useworkflowgroupstoorganizeyourworkflows,metanodes,anddatafiles.

• Workflowgroups• Datafiles• Workflows• Metanodes

ServerSpaceasasharedrepository

13

Tomoveresourcessimplydraganddroporcopyandpaste


Permissions

14

Available in KNIME Server

Owner

Groups

Everybody Else


RemoteExecutionandScheduling

15



RemoteExecutionandScheduling

16



WorkflowJobs

17

Remotelyexecutedworkflowsarerunas“Jobs”

• Aworkflowjobisacopyoftheworkflowwithspecificsettingsanddata.

• Jobsaretiedtoaparticularversionofaworkflow

• Orphanedjobsarecoloredred• Jobshavemessages(e.g.successful,or

failure)• Canbesavedasworkflowfordata

provenanceanddebugging(right-clicksaveas)


KNIMEWebPortal


WebPortal EnabledDataMining(legacy)

19


WrappedMetanodes

• SimilartoMetanodes• Differinkeyareas:

– Limitedvariablescope(c.f.globalscopeforMetanodes)– UsewithQuickFormnodes(AnalyticsPlatform3.1+)

• KeytoadvancedfunctionalityinKNIMEproducts:– UsefornewWebPortal pages

20


WrappedMetanodes

21

Select

Collapse

Wrap


Metanodes vs.WrappedMetanodes (WebPortal)

Metanodes WrappedMetanodes

QuickForms Legacy Standard

Variable scope Global Local

WebPortal Execution Old New(work withloops/switches)JavaScriptviews inWebPortal

Notsupported Supported

WebPortal Usage Quickforms usedglobally Views/Quickforms mustbeembedded inaWrappedMetanode

Recommended uses Legacyworkflows NewdevelopmentsCompatibility KNIMEServer3.x/4.x KNIMEServer4.2+

22

*ValidforKNIMEAnalyticsPlatform3.1andabove


WebPortal EnabledDataMining

23


ExecutiononServerviaWebPortal- 1Webportal EnabledDataMining

24


Execution onServerviaWebPortal - 2Webportal EnabledDataMining

25



26



27



28


ExecutiononServerviaWebPortal- 6Webportal EnabledDataMining

29


KNIMEWebPortal:URLParameter

30


WebPortal Templates(I)


WebPortal Templates(II)


WebPortal Templates(III)


WebPortal Templates(IV)


WebPortal Templates(V)

• Layoutcanbeconfiguredbytemplates– Footer&header– Mainpanel– Loginpage– …

• Customstylesheet• CustomJavaScriptlibraries

– Canbere-usedinJS-basedviews


WebPortal Templates(VI)

• Templatesarepartoftheconfigurationandarenotoverriddenbyupdates


WebserviceAccess(SOAPandREST)


SOAPWebservice API

38

• SOAPBased,InstalledwiththeKNIMEServerapplicationhttp://<servername>:8080/GenericWorkflowService/GenericWorkflow?wsdl

• Supportsauthentication

• ExecuteworkflowsfromwithinKNIMEorotherapplications

• Codeexamplesavailableuponrequest


KNIMEServer:Webservice Interface

39


Programmaticaccess

40

URLwsdlURL =...;

QName name=newQName("http://www.knime.com/soap","GenericWorkflowService");

ServiceknimeService =Service.create(wsdlURL,name);

GenericWorkflowWebService accessor =knimeService.getPort(GenericWorkflowWebService.class);

BindingProvider bin=((BindingProvider)accessor);

Map<String,Object>requestContext =bin.getRequestContext();

requestContext.put(BindingProvider.USERNAME_PROPERTY,user);

requestContext.put(BindingProvider.PASSWORD_PROPERTY,pass);

accessor.listWorkflows();accessor.invokeAsync(...);


SOAPNodes

41

• UsetoaccessKNIMEWebservices(orothers)

• Supportsworkflowcredentials


RESTInterface

• Mainaddition to KNIMEServer4.1• REST=RepresentationalStateTransfer

– Communicationbased onHTTP– Usually clear text

• Many possible clients– Webbrowser– Javaapplications (e.g.viaJAX-RS)– KRESTnodes

• https://www.knime.org/blog/the-knime-server-rest-api• https://www.knime.org/blog/giving-the-knime-server-a-rest

42


RESTExample:ListWorkflows(I)

• Viabrowser– http://localhost:8080/com.knime.enterprise.server/rest/v4/repository/list

– Requires user authentication


RESTExample:ListWorkflows(II)

• ViaKNIMEand KRESTnodes


RESTExample:ExecuteWorkflow(I)

• Viabrowser– Loadworkflow

• http://localhost:8080/com.knime.enterprise.server/rest/v4/jobs/load/UGM2015/RESTDemo/Report

• Returnsunique job ID– Executejob

• http://localhost:8080/com.knime.enterprise.server/rest/v4/jobs/syncExec/24a76fec-a74e-45ba-b03f-cabf528b6a69

• Returnsfinalstatus– Render report

• http://localhost:8080/com.knime.enterprise.server/rest/v4/jobs/renderReport/24a76fec-a74e-45ba-b03f-cabf528b6a69/PDF

• Formatcan be specified inrequest


RESTExample:ExecuteWorkflow(II)

• ViaKNIMEand KRESTnodes


RESTExample:Live-Scoringonserver (I)

• Get expected parameter format fromworkflow• Setinput parameters ininput quickformnodes• Executeworkflow• Get results from quickformoutput nodes

Scoringworkflow,calledviaREST


RESTExample:Live-Scoringonserver (II)

• Get expected parameter format fromworkflow• Setinput parameters ininput quickformnodes• Executeworkflow• Get results from quickformoutput nodes


RESTExample:LiveScoringonserver (III)

• ViaCallRemoteWorkflownode– Analyzes input parameters– Prepare input data accordingly– Executes job and gets backresults


JSONType&UtilityNodes

• JSON– JavaScriptObjectNotation• Hierarchicaldataformat


JSONType&UtilityNodes- Applications

• WebServiceconsumption((K)REST)• NoSQL databases/MongoDB• KNIMEWebService


JSON– “JSONPath”

$.['UGMsessions'].['talks'].[*].['presenter']


KNIME.comAGTechnoparkstr.18005ZurichSwitzerland

[email protected]

Documents

KNIME Server Workshop · • Install Tomcat/TomEE 1.7 • Configure Application Server – JVM Options – KNIME Server settings – Create email resource • Define users (or configure