Installation

Dieses Kapitel beschreibt die Installation für den Documents-Part für Squeeze Invoice. Die Installation kann abhängig von der aktuellen Kundenlösung sehr unterschiedlich ausfallen.

Einleitung

Diese Dokumentation beschreibt die Integration der Validierung inklusive des Einsatzes des Squeeze-Viewers in Documents.

Die Basis-Installation besteht aus diversen unverschlüsselten Portal-Skripten und dem Mappentypen "SqueezeInvoice" sowie externen Documents-Resourcen. Die Beleglesung findet in Squeeze statt und pro Rechnung wird eine Mappe vom Mappentypen "SqueezeInvoice" erstellt.

Die Umstellung sollte zunächst auf einem Testsytsem erfolgen. Documents sollte vorab auf eine stabile aktuelle Version aktualisiert werden.

 

Voraussetzungen

In jedem Fall wird eine Lizenz für einen zusätzlichen Mappentypen benötigt. Die Scripting-Lizenz müsste bei einem bestehenden Rechnungs-Workflow vorhanden sein. Es wird eine "named"-Lizenz für den Import-Benutzer vorausgesetzt. Da die Installation eine bestehende Konfiguration ablöst sollte die Lizenz automatisch vorhanden sein. Falls für die evtl. neuen Anwender noch keine Documents-Lizenz zur Verfügung steht, müssen

Wenn die Squeeze-Konfiguration über Documents gesteuert werden soll wird eine Gadget-Lizenz für die Konfigurations-Ordner benötigt. Die Konfiguration kann optional komplett in Squeeze erfolgen. Dadurch ist die Gadget-Lizenz keine zwingende Voraussetzung.

Die Lösung benötigt keinen separaten Workflow! Die Steuerung erfolgt über öffentliche Filter-Ordner und Portal-Skripte. Eine Implementation beim Kunden erfordert daher Kenntnisse im Portal-Skripting und Kenntnisse im Umgang mit den externen Ressourcen.

 

Aufbau

Die Auslieferung beinhaltet den Documents-Mappentypen "SqueezeInvoice" sowie eine Reihe von unverschlüsselten Portal-Skripten, öffentlichen Ordnern und externe Ressourcen mit einigen hilfreichen Konfigurations-Beispielen.

Nach der Beleganalyse werden die Mappen vom Typen "SqueezeInvoice" erzeugt. Diese werden den Anwendern über die öffentlichen Filter-Ordner angezeigt. Nach der Validierung wird ein Mappentyp-Wechsel auf den bestehenden Mappentypen ausgeführt. Die Feldwerte müssen entsprechend zugeordnet werden.

Eine genauere Beschreibung der Abläufe wird auf den folgenden Seiten beschrieben.

 

Anbindung Squeeze

Für die Anbindung von Squeeze an Documents existiert bereits die Dokumentation "Invoice Squeeze Anbindung". Aus diesem Grund wird die Anbindung in dieser Dokumentation nur rudimentär erklärt.

Bei vorhandener Gadget-Lizenz kann die Anbindung über die WEB-Konfiguration erfolgen. Andernfalls muss die Anbindung manuell über die Dateien "SqueezeConfig.js" und "ServerConfig.js" erfolgen.

image-1613032442927.png

image-1613032503486.png

 

XML-Importe

Der Mappentyp "SqueezeInvoice", sowie die öffentlichen Ordner als auch die Portal-Skripte können via XML-Import hinzugefügt werden. Die importierten Dateien können abgesehen von den verschlüsselten Skripten beliebig angepasst werden.

Das Installationspaket enthält nur einer einzigen XML-Datei. Diese XML beinhaltet den Mappentyp; alle Skripte und die öffentlichen Ordner sowie einen Nummernkreis "Invoice".

Externe Ressourcen

Externe Ressourcen werden in Documents verwendet, um möglichst alle projektspezifischen Anpassungen an definierten Orten zu verwalten, damit zum Beispiel Documents-Updates möglichst unabhängig von den Anpassungen ausgeführt werden können. Bei einer bestehenden Rechnungseingangs-Lösung ist davon auszugehen, dass bereits externe Ressourcen existieren. Die Anpassungen müssen somit in die bestehende Lösung integriert werden. Aus diesem Grund ist es schwierig eine einheitliche Vorgabe für die Umsetzung zu geben.

Der Einstiegspunkt ist die Datei "documents.xml" unter "...\Documents5\tomcat8\conf\Documents\localhost". In der Datei werden die Ablageorte für die externen Ressourcen definiert und diese Datei dürfte bereits existieren. Falls die Datei noch nicht existiert muss Sie erstellt werden. Der folgende Screenshot zeigt eine bereits angepasste Datei.

image-1612877351668.png

In dem Beispiel befinden sich alle externen Ressourcen im Ordner "DOCUMENTS5-EXT". Die Datei sollte bereits einen Pfad zur Datei "script.jsp" enthalten. Im Screenshot ist es der oberste markierte Pfad.

Die unteren beiden Einträge wurden hinzugefügt und müssen auf den mitgelieferten Squeeze-Ordner verweisen.

 

script.jsp

Vermutlich existiert bereits eine Datei "script.jsp", welche wiederum diverse js-Dateien importiert. Diese Datei muss um mindestens 2 Einträge erweitert werden. Zum einen muss die "SqueezeFunctions.js" importiert werden, um Zugriff auf spezifische Funktionen zu erhalten. Zum anderen sollte die "GridColumnAggregator.js" importiert werden, um im Gentable eine Summenzeile zu erzeugen.

image-1612878050227.png

Die folgenden Funktionen können entweder in eine eigene JSP-Dateien ausgelagert werden oder können in eine bereits verwendete Datei hinzu kopiert werden.

 

Mappentyp im Bearbeitungs-Modus öffnen

Über den Workflow kann eine Aktion derart konfiguriert werden, dass sich die Mappe immer direkt im Bearbeitungs-Modus öffnet. Bei der Validierung wird dieses Verhalten in der Regel gewünscht. Um das Verhalten nachzuahmen kann die folgende Funktion eingebunden werden.

/** Öffnet den Beleg immer im Bearbeitungs-Modus
 **/
(function(){
    var autoEditEnabled = true;
    documents.sdk.exitRegistry.registerFileExitCallback("SqueezeInvoice","File.afterFileOpen", function(documentsContext, options){
        if(autoEditEnabled){
            documentsContext.getFileContext().startFileEditMode();
            autoEditEnabled = false;
        }
    });
    documents.sdk.exitRegistry.registerFileExitCallback("SqueezeInvoice","File.afterFileEditCommit,File.afterFileEditCancel", function(documentsContext, options){
        autoEditEnabled = true;
    });
})();

 

Stammdaten-Auswahl via Pop-Up

Damit keine umständlichen Datenbank-Abfragen konfiguriert werden müssen können die Daten direkt aus den Squeeze-Stammdaten-Tabellen gezogen werden. Der Aufruf "documents.sdk.exitRegistry.registerFileFieldExitCallback()" benötigt den technischen Namen des Mappentypen sowie den technischen Feldnamen. Am Mappentyp-Feld muss auf dem Register "Exits" der Typ "Aktionsknopf neben dem Feld" gesetzt werden.

image-1612884793662.png

Bei Positionsfeldern lautet der Aufruf "documents.sdk.gentable.gentableRegistry.registerCallback()". Hier muss als erster Parameter der technische Name der Gentable-Definition angegeben werden und als zweiter Parameter muss der Funktionsname am Gentable-Button eingetragen werden.

In den Funktionen wird ein SqueezePopup-Objekt erzeugt. Die Funktion "addMasterdataID()" benötigt hierbei nicht den Namen der Tabelle, sondern die eindeutige ID der Tabelle. Für das Pop-Up kann eine Größe definiert werden und es kann eine Überschrift angegeben werden. Es muss zwingend angegeben werden ob es sich um ein Pop-Up für ein Kopf- oder Positionsfeld handelt. Bei der "set()" Funktion wird zuerst der technische Feldname angegeben, dann der Name der Tabellen-Spalte und beim dritten Parameter kann angegeben werden ob die Spalte im Pop-Up angezeigt werden soll oder nicht. Über "showOnly()" können Spalten im Pop-Up angezeigt werden, welche später nicht gesetzt werden und über "processData" kann nach dem Setzen der Werte weiterer Code ausgeführt werden. In dem Beispiel wird aus einer weiteren Squeeze-Stammdaten-Tabelle die Zahlungsbedingung zum Kreditor ermittelt. Der Wert wird über ein Portal-Script ermittelt.

Die "open()" Funktion öffnet das Pop-Up.

/** Kreditor-Auswahl **/
documents.sdk.exitRegistry.registerFileFieldExitCallback("SqueezeInvoice", "CreditorID", function(d5Context, options){        
	var popup = new SqueezePopup(d5Context, options);
	popup.width = 1500;
	popup.height = 800;
	popup.type = "head";
	popup.title = "Kreditoren";
	popup.addMasterdataID("2"); 
	popup.set("CreditorID", "CreditorId", true);
	popup.set("CreditorName", "Name1", true);
	popup.set("Creditor_PostCode", "Zip", true);
	popup.set("Creditor_City", "City", true);
	popup.set("Creditor_Country", "CountryCode", true);
	popup.set("Creditor_TaxID", "EUTaxId", true);
	popup.set("Creditor_NationalTaxID", "NationalTaxId", true);
	//popup.set("Creditor_Mail", "Email", true);
	popup.set("IBAN", "IBAN", true);
	//popup.showOnly("ColumnName");
	
	// Wird nach dem Setzen der Werte aufgerufen
	popup.processData = function(data, d5Context, options){
		var fileContext = d5Context.getFileContext();
		var creditorID  = fileContext.getFileFieldValue("CreditorID");
		var hasOrder    = fileContext.getFileFieldValue("HasOrder");
		console.log("hasOrder: ", hasOrder);
		if( hasOrder==="0" || hasOrder==="false" || hasOrder===0 || hasOrder===false ){
			var params = {};
			params.pCredID = creditorID;
			var PPC = squeeze_callScript("SqueezeInvoice_UDA_GetPPCByCreditor", params);
			console.log("PPC: ", PPC);
			
			if (PPC !== ""){
				fileContext.setFileFieldValue("ConditionsOfPayment_ID", PPC);
			}
		}
	};
	
	popup.open();
});

Es werden zusätzliche Beispiele für die Bestellnummer, die Zahlungsbedingung sowie die Bestelldatenauswahl auf Positionsebene ausgeliefert.

 

Automatische Berechnungen

Bei einigen Betragsfeldern sollen automatische Berechnungen ausgeführt werden. Zum Beispiel kann aus dem Netto- und Brutto-Wert automatisch der Steuerbetrag berechnet werden. An den Feldern muss auf dem Exit-Register der Typ "Bei Wertänderung" gesetzt werden. Funktionen und Beispiele können der Hersteller-Dokumentation entnommen werden.

 

HTML Style

Für die korrekte Darstellung muss zwingend der folgender Style hinzugefügt werden. Der Part kann optional direkt in die "script.jsp" hinzugefügt werden.

 <style>
	.dexValidEntry
	{
		color: green;
	}

	.dexInvalidEntry
	{
		color: red;
	}
</style>

 

 

Properties

Die Feldbezeichnungen am Mappentypen sowie die Bezeichnungen der öffentlichen Ordner, etc. sind alle internationalisiert. Die Übersetzungen befinden sich in properties-Dateien, welche im Documents-Installations-Ordner unter "...\server\locale\" abgelegt werden müssen.