SAPERION Classic Connector

Transkript

1 SAPERION Classic Connector

2 Copyright 01 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Inhaltsverzeichnis 1 Einführung... Der Classic Connector... Classic Connector Projekt... 4 Generelle Regeln für HQL... e....1 Login/ Logoff.... Dokumente anlegen.... Suche nach Dokumenten....4 Parallele Suche in zwei Datenbankdefinitionen.... Suche mit "In-clause".... Suche nach gelöschten Dokumenten....7 Update von Dokumenten : Anfügen einer Datei : Ändern eines Feldes in den Dokumentenmetadaten....8 Connection Pool verwenden und verwalten....9 Suche mit SelectHQL und Mehrfachfeldern... Workflow - e....1 Login.... Workflow starten.... Benutzer für einen Task auswählen....4 Alle Tasks ablehnen

4 SAPERION Classic Connector 1 Einführung Die vorliegende Dokumentation richtet sich an Entwickler und bietet einige Programmierbeispiele des Classic Connectors, welche unterschiedliche Operationen über die API darstellen. Detaillierte Informationen zu den Klassen und Methoden finden Sie in den Javadocs des Classic Connectors (siehe SAPERION Dokumentationsportal) unter folgendem Link: Javadocs Classic Connector Der Classic Connector Der Classic Connector wurde für die einfache Zusammenarbeit mit dem SAPERION Backendsystem entwickelt, so unterstützt er Methoden zum Suchen, Erstellen, Ändern und Lesen von Dokumenten. Der Connector arbeitet dabei dokumentenzentriert. Folgende Funktionen werden vom Classic Connector zur Verfügung gestellt: Login / Logoff an das SAPERION Backend Speichern und Ändern von Dokumenten einschließlich der Metadaten Dokumentensuche und Abfrage über die Metadaten und über den Volltext der Datenbank Lesen von Dokumenten einschließlich der Metadaten Versionierung von Dokumenten und Aufrufen der Versionshistorie Speichern und Ändern von Ordnern Zugriffskontrolle über Zugriffslisten Event Control Workflow Benutzerverwaltung Classic Connector Projekt Um mit einem Classic Connector Projekt beginnen zu können, ist es notwendig, folgende Dateien, die sich in den angegebenen Verzeichnissen befinden, in die Entwicklungsumgebung einzubinden: <SAPERION Installationsverzeichnis>/scr-classicconnector/lib <SAPERION Installationsverzeichnis>/scr-classicconnector/config Im folgenden werden die einzelnen in Eclipse notwendigen Schritte zum Anlegen eines Classic Connector Projekts genannt:

5 4 Generelle Regeln für HQL Starten Sie Eclipse. Legen Sie ein neues Java Projekt an. Legen Sie die Verzeichnisse " lib", "logs" und "config" im Projekt an. Kopieren Sie alle Dateien von "<SAPERION Installationsverzeichnis>/scr-classicconnector/lib" in das erstellte "lib"-verzeichnis im neuen Projekt. Fügen Sie die Libraries zum Buildpath hinzu. Kopieren Sie alle Dateien von "<SAPERION Installationsverzeichnis>/scr-classicconnector/config" in das erstellte "config"-verzeichnis im neuen Projekt. Um ein Log zu erstellen, müssen Sie die Datei "log4j.properties" im "config"-verzeichnis anpassen. Dabei müssen Sie den Pfad zum "logs"-verzeichnis des Projekts angeben. Generelle Regeln für HQL Bitte beachten Sie folgende Regeln bei der Programmierung des Classic Connectors: HQL-Abfragen müssen mit Aliase benutzt werden: select d.name from defaultexample d where d.sysrowid='...' Felder in HQL-Abfragen werden immer in Großbuchstaben geschrieben: d.scomment d.name DDC Namen werden in HQL immer in Kleinbuchstaben geschrieben: defaultexample d e.1 Login/ Logoff Für ein Login per SaClassicConnector müssen Sie zunächst eine Implementierung dieses Interfaces, z.b. mit einer Pfadangabe auf die "saperion.properties" instanziieren. SaClassicConnector connector = new SaClassicConnectorImpl( c:/saperion/scr/config/saperion.properties ); Alternativ kann die Implementierung auch mit leerem Konstruktor instanziiert werden, falls der JVM die entsprechende Verzeichnisangabe mitgegeben wurde. unter Eclipse Eclipse > Runtime Configurations > -Dsaperion.config=c:/saperion/scr/config/" (x) = arguments > VM arguments >"

6 4 Eine Authentifizierung am Classic Connector kann anschließend anhand eines Passworts sowie einer Benutzerrolle erfolgen (in Multimandantensystemen muss des Weiteren der Mandant angegeben werden). Folgende Benutzerrollen bzw. "com.saperion.constants.saconstants): Lizenztypen stehen zur Verfügung Benutzerrollen/ Lizenztypen Code Benutzerrolle 1 Index Abfrage Universal/ Administrator 4 Web Abfrage 7 Web Index 1 Workflow 1 Scan 14 Scan (Highend) 1 API Abfrage 1 API Index 17 API Scan 0 Administrator 9 Web Workflow Login als Universal/ Administrator Das Login erfolgt anhand der Methode "logon": connector.logon("user name", "password",, "client"); Überprüfung der Verbindung Es kann des Weiteren wie folgt überprüft werden, ob die Verbindung noch besteht: System.out.println(connector.isAlive()? "Connection still alive." : "Connection has died.") Ausloggen der Benutzer Weiterhin können Benutzer anhand der Methode "logoff" wieder ausgeloggt werden: connector.logoff(); (vgl.

7 e. Dokumente anlegen Beim Anlegen eines Dokuments müssen je nach Dokumentendefinitionstabelle entsprechende Metadaten angegeben werden, da ohne Pflichtfelder keine Dokumente angelegt werden können. Im folgenden wird in der Datenbankdefinition "example71" ein Dokument angelegt. //Meta data HashMap<String, Object> metadata = new HashMap<String, Object>(); metadata.put("ex7_docname", "Example Document Name"); metadata.put("ex7_comment", "Example Document description"); metadata.put("ex7_arcdate", new Date()); metadata.put("ex7_language", "English"); //Creating a document on SaClassicConnector instance connector connector.createdocument(new DocumentInfo(SADEFINITION, metadata, new ContentStream[] { new ContentStream(new FileInputStream( "<path>/file.doc"), "File description") }, "Comment"));. Suche nach Dokumenten Über die Methode "searchhql" kann mittels HQL-Syntax nach Dokumenten gesucht werden. So lassen sich alle Dokumente einer Definition beispielsweise mit folgendem HQL-String abfragen: select d from <definition name> d Werden nur spezifische Informationen benötigt, können diese wie folgt abgefragt werden: select d.<field name> from <definition name> d where d.<another field name> like '%<STRING>%' Suche nach der letzten Archivierung von Dokumenten mit "ECM" im Namen: String DATEFIELD = "EX7_ARCDATE"; SaQueryInfo info = new SaQueryInfo("select d."datefield" from example71 d where d.ex7_docname like '%ECM%'")); List<SaDocumentInfo> docs = connector.searchhql(info); Calendar latestcal = null; Calendar calendar = null; for (SaDocumentInfo doc : docs) { SaValue value = doc.getvalue(datefield).getvalues()[0]; if (value.getvaluetype() == SaConstants.FT_DATE) { calendar = value.getcalendarvalue(); if ((latestcal == null) (calendar.compareto(latestcal) > 0)) latestcal = calendar; } }

8 System.out.println("The latest ECM file archive was on " new SimpleDateFormat("yyyy-MM-dd").format(latestcal.getTime()));.4 Parallele Suche in zwei Datenbankdefinitionen In dem folgenden erfolgt die Suche nach Dokumenten in zwei verschiedenen Datenbankdefinitionen gleichzeitig. Das Dokument weist dabei im Feld "EX7_DOCNAME" in den Definitionen "example7" sowie "example71" eine Übereinstimmung vor. String hql_search_string = "select d from EXAMPLEV7 d, EXAMPLE71 e where d.ex7_docname = e.ex7_docname"; List<SaDocumentInfo> results = connector.searchhql(new SaQueryInfo( hql_search_string)); for (SaDocumentInfo doc : results) { System.out.println(doc.getValue("EX7_DOCNAME").getStringValue() " is in both definitions possible duplicate"); }. Suche mit "In-clause" Anhand einer Parameterliste kann eine bestimmte Teilmenge von Dokumenten abgefragt werden, welche in diesem in "namelist" angegeben sind. String hql_search_string = "select d from EXAMPLE71 d where d.ex7_docname in (:names) "; SaQueryInfo query = new SaQueryInfo(hql_search_string); Collection<String> namelist = new ArrayList<String>(); namelist.add("example Document Name1"); namelist.add("example Document Name"); //etc. query.setparameterlist("names", namelist); List<SaDocumentInfo> results = connector.searchhql(query);. Suche nach gelöschten Dokumenten Grundbedingung für eine Suche nach gelöschten Dokumenten ist, dass in der betreffenden Datenbankdefinition (DDC) die Option "Papierkorb und Indexertask aktivieren (SYSINDEXSTATE)"

9 e 7 ausgewählt ist. Hierdurch wird das Dokument lediglich temporär und nicht direkt aus der Tabelle gelöscht (erst beim nochmaligen Löschen wird es aus der Tabelle entfernt) und erhält den SYSINDEXSTATE-Wert 00. Bei einer regulären Abfrage werden alle Dokumente, deren SYSINDEXSTATE-Feld den Wert 00 vorweisen, ignoriert. Mit dem folgenden Workaround können Sie dennoch auf temporär gelöschte Dokumente zurückgreifen: String sql = "select d from EXAMPLE71 d where d.sysindexstate=00"; SaQueryInfo query; query = new SaQueryInfo(sql); //Set new upper limit for SYSINDEXSTATE: query.setinteger("sysindexstate", 00); List<SaDocumentInfo> results = connector.searchhql(query); System.out.println("Found " results.size() " deleted documents.");! Der hier beschriebene Workaround wird ab SAPERION 7..1 nicht mehr unterstützt, zu diesem Zweck wird ab dieser Version die Classic Connector API entsprechend erweitert..7 Update von Dokumenten Das Updaten von Dokumenten in SAPERION wird durch unterschiedliche Integerwerte parametrisiert, diese sind: Update-Parameter Integerwert Beschreibung - Der existierende Dokumenteninhalt wird gelöscht, so dass eine leere Dokumentenstruktur entsteht. -1 Der existierende Dokumenteninhalt wird gelöscht und fügt einen definierten Inhalt als erstes Element ein. 0 Der angegebene Inhalt wird als letztes Element angefügt. >0 Das Element mit der angegebenen Nummer wird durch den angegebenen Inhalt ersetzt, so dass die Anzahl der Elemente unverändert bleibt. : Anfügen einer Datei //Create new content stream File file = new File("D:/<any path>/content.txt"); String filename = file.getname(); InputStream newfile = new FileInputStream(file); //0 for append ContentStream newcs = new ContentStream(newFile, filename, 0); //Create new array ContentStream[] csarray = new ContentStream[]{newcs}; //Update document, hdoc 87 is known (e.g. by query)

10 8 connector.updatedocument(new UpdateDocumentInfo( definition, "87CBA9FF44140F ", new HashMap<String, Object>(), csarray, "comment")); : Ändern eines Feldes in den Dokumentenmetadaten Sollen nur Metadaten verändert werden, wird beim Update der ContentStream[] mit null angegeben: //Create meta data field Map<String, Object> changedfields = new HashMap<String, Object>(); changedfields.put("ex7_arcdate", new Date()); //Nur Metadaten updaten (csarray ist hier null) connector.updatedocument(new UpdateDocumentInfo(SADEFINITION, "87CBA9FF44140F ", changedfields, null, "updated date"));.8 Connection Pool verwenden und verwalten Eine Administration des Connection Pools können Sie über die Klasse "ConnectionPoolUtil" erreichen. Der zugrunde liegende Pool basiert auf dem "GenericKeyedObjectPool" und kann grundsätzlich auch wie dieser konfiguriert werden. Siehe auch: Damit eine Verbindung zum Java Core Server hergestellt werden kann, müssen Sie zunächst die Pfadangabe als JVM Runtime Parameter in der Konfigurationsdatei "saperion.properties" setzen. unter Eclipse Eclipse > Runtime Configurations > -Dsaperion.config=c:/saperion/scr/config/ " (x) = arguments > VM arguments : > Eine Minimalkonfiguration und das Instanziieren des Classic Connectors kann wie folgt aussehen: Properties poolconfiguration = new Properties() ; //Set minimal properties: poolconfiguration.setproperty("poolutil.test.on.return", "false"); poolconfiguration.setproperty("poolutil.test.while.idle", "false"); poolconfiguration.setproperty("pool.min.idle", "0"); poolconfiguration.setproperty("pool.max.idle", "8"); poolconfiguration.setproperty("pool.max.active", "10"); poolconfiguration.setproperty("pool.max.total", "-1"); poolconfiguration.setproperty("pool.max.wait", "-1"); poolconfiguration.setproperty("pool.idle.test.count", ""); poolconfiguration.setproperty("pool.exhausted.action", "1"); poolconfiguration.setproperty("pool.time.between.eviction","10000"); poolconfiguration.setproperty("pool.idle.test.count",""); poolconfiguration.setproperty("pool.idle.min.evictable.time","10000"); "

11 Workflow - e UsernamePasswordKey key = new usernamepasswordkey( login, password,,""); //leerer Pfad zu saperion.properties cpu.initialize(poolconfiguration, ""); PooledSession session = (PooledSession) cpu.borrowobject(key); SaClassicConnector connector = session.connection(); Wurde die Instanz übergeben, können Operationen regulär ausgeführt werden: System.out.println(connector.isAlive()? "Connection still alive." : "Connection has died."); Abschließend kann die Ressource dann wieder an den Pool zur weiteren Verwendung zurückgegeben werden: cpu.returnobject(key, session);.9 Suche mit SelectHQL und Mehrfachfeldern Wenn nach einem Multivalue-Feld gesucht wird, generiert der Web Client select d from multi_test d join d.multi as multi where multi.multival in ( :ngc0 ) In diesem hat die DDC hat ein Multivalue-Feld vom Typ Zeichen namens "Multi". Im Parameter "ngc0" steht eine Liste mit den Strings, nach denen gesucht werden soll. Die Sicherheitsprüfung auf SYSACLUSERLIST wird standardmäßig mit einem "exists" und einem "subselect" ausgeführt. Workflow - e Der SaWFConnector ermöglicht den Zugriff auf die Workflow-Funktionen von SAPERION. Er kann entweder über den SAPERION Classic Connector instanziiert oder selbst erstellt werden. SaWFConnector wfc = connector.getworkflowconnector(); oder SaWFConnector wfc = new SaWFConnectorImpl(); 9

12 10.1 Login Die Anmeldung erfolgt mit Hilfe der Methode "logon"; analog zum Classic Connector werden die Parameter für die Authentifizierung verwendet. wfc.logon("login", "password",, "client");. Workflow starten Sobald eine SaWFConnector-Instanz erzeugt wurde, können Geschäftsfälle mit der Methode "executestartprocess" gestartet werden. Der Benutzername ist hierbei der Benutzerkurzname oder auch Login-Name des Benutzers. ActorInfo nextactor = new ActorInfoImpl("User name"); TaskInfo info = wfc.executestartprocess("approval", nextactor, "Test start", "" wfc.getuserid());. Benutzer für einen Task auswählen Soll eine Geschäftsfall-Aufgabe einem bestimmten Benutzer zugewiesen werden, gibt es folgende Möglichkeiten: SaWFTask task = wfc.gettask("sysrowid"); Der Benutzer, der aktuell am Classic Connector angemeldet ist, erhält den Task: task.executeassigntome(); Ein definierter Benutzer erhält den Task: task.executedelegate(new ActorInfoImpl("User name")); Der Task wird einem neuen Besitzer zugewiesen: task.executechangeowner(new ActorInfoImpl("User name"));.4 Alle Tasks ablehnen Soll es notwendig sein, alle Geschäftsfall-Tasks abzulehnen und diese einem neuen Benutzer zuzuweisen, erfolgt dies wie folgt:

13 Workflow - e SaWFConnector wfc = connector.getworkflowconnector(); List<BoxDefinition> boxdefs = wfc.getboxdefinitions(); for (BoxDefinition def : boxdefs) { List<TaskInfo> taskinfos = wfc.gettasklist( new int[] { def.getboxid() }, ""); for (TaskInfo info : taskinfos) { Map<String, SaPropertyValue> propmap = info.getsysfields(); SaWFTask task = wfc.gettask(propmap.get("sysrowid").getstringvalue()); task.setcomment("denied Workflow because..."); task.executereject(new ActorInfoImpl("User name")); } } 11