Inhalt

Das CLARC Development Studio ist die integrierte Entwicklungsumgebung in CLARC ENTERPRISE.

In diesem Abschnitt der Dokumentation möchten wir Ihnen einen Einstieg in das CLARC Development Studio ermöglichen. Das Studio bietet Ihnen umfangreiche Möglichkeiten im Bereich des CLARC ENTERPRISE Scriptings.

Hier einige Features:

Umfangreicher Code-Editor.
Syntax-Prüfung.
Direkte Code-Ausführung.
Integrierter Application-Debugger.
Integrierter Datenbank-Browser für MSSQL, MYSQL und ORACLE.
Direkter Zugriff auf C4 Scripte.
Verschlüsselung.
Zugriff auf C4 Objekte wie Feldschemas.
Online-Hilfe via CDN.
Viele nützliche Tools.
uvm.

Das Studio GUI

Für das Development Studio ist eine Anmeldung notwendig. Das Standardlogin ist der Benutzer clarc mit dem Passwort admin.

Nach dem Starten des CLARC Development Studios erscheint die IDE mit den zuletzt geöffnet Dateien und Skripten. Die Ansichten können individuell eingestellt werden.

Das GUI besteht aus folgenden Elementen:

Hauptmenü und Buttonleiste
Inhaltsbereich mit entsprechenden Tabs.
Statusleiste.

Weitere Ansichten sind:

Hilfe-Bereich.
C4 Browser.
Historie der Zwischenablage.

Hauptmenü

Hier das Hauptmenü und die verfügbaren Funktionen kurz beschrieben:

Menüstruktur

Beschreibung

Shortcut

File

New

Bietet eine Auswahl von verschiedenen Dateitypen an. Beim Klick auf eines der Formate wird ein neues Tab mit entsprechender inhaltlicher Vorbelegung erstellt.

Strg+N

Open

Öffnet den Datei-Öffnen-Dialog über den eine Datei ausgewählt werden kann. Handelt es sich bei der Datei um ein verschlüsseltes Skript, erscheint ein entsprechender Passwort-Dialog.

Strg+O

Save

Speichert den aktuellen Inhalt des Editors. Wurde der Inhalt bisher noch nicht gespeichert, wird ein Speichern-Unter-Dialog angezeigt.

Strg+S

Save as...

Öffnet den Speichern-Unter-Dialog und speichert den aktuellen Editor-Inhalt in diese Datei.

Save all

Speichert alle geöffneten Dateien und C4-Skripte.

eMail

Versendet das aktuelle File entweder als Anlage oder Body-Text der eMail.

Print

Druckt den aktuellen Inhalt des Editors aus.

Setting

Die Scripte werden über Setting versioniert. Die Version des Scriptes wird im Attribut "Version" gespeichert und im Development Studio in der Statusleiste angezeigt. Über File > Setting kann die Version des Scriptes einfach geändert werden. Beim Aktivieren des Scriptes wird die Revision automatisch um eins erhöht. Zudem ist die Version sowohl im C4 als auch in der Script-Historie sichtbar.

Protect / Remove protection

Über diese Funktion kann das aktuelle Skript mit einem Passwort geschützt werden oder das hinterlegte Passwort einfach entfernt werden.

Secure

Über diese Funktion kann das aktuelle Skript verschlüsselt gespeichert werden.

Close

Beendet das CLARC Development Studio.

Edit

Standardfunktionen für die Zwischenablage.

Scripting

Syntax check

Führt eine Syntaxprüfung des aktuell geöffneten Skripts durch. Evtl. auftretende Fehler werden in einem Bereich unterhalb des Editors angezeigt und können von dort aus direkt angesprungen werden.

Strg+F9

Execute

Führt das aktuelle Skript aus.

Info
An dieser Stelle werden keine Server-spezifischen Skriptfunktionen unterstützt. Lediglich Standardskript-Funktionen und Klassen können verwendet werden.

F9

Debug

Session passwords

In diesem Bereich können für verschlüsselte Skripte Sitzungspasswörter hinterlegt werden. Ohne die Hinterlegung der Passwörter, können keine verschlüssleten Skripte gedebugt werden.

Hier werden alle registrierten Anwendungen aufgelistet, welche gedebugt werden können. Wird eine Anwendung ausgewählt, erhält sie einen Haken und bei der nächsten Ausführung eines Skripts wird der Debugger im Development Studio geöffnet.

Class builder

Öffnet den Class Builder Dialog. Hier können eigene Klassen definiert und in Code umgesetzt werden.

SQL builder

Öffnet den SQL Builder Dialog.

Import Dll headers

Importiert aus einer Dll-Datei die Header-Definitionen und trägt diese in den aktuell geöffneten Editor ein.

Database

Import

Importiert eine Datei in die aktuelle Tabelle.

Export

Exportiert die aktuell geöffnet Daten - siehe Abschnitt Database Browser.

Online mode

Bei aktivem Online-Mode können Tabelleninhalte direkt bearbeitet werden.

Tools

RegEx builder

Öffnet den RegEx Builder Dialog. Hier können reguläre Ausdrücke getestet werden.

ASCII list

Öffnet eine ASCII Liste um Sonderzeichen in den Editor einzufügen.

CDN

CDN steht für Clarc Developer Network. Eine Mitgliedschaft ist beispielsweise für den Zugang zur Online- bzw. Kontexthilfe im Scripting erforderlich.

Info
Für die Nutzung des CDN wird eine Internetverbindung benötigt. Proxies werden unterstützt.

Account

Center

Öffnet den CDN Center Dialog um das eigene Profil zu verwalten.

Login

Anmeldung am CDN.

Logout

Abmeldung am CDN.

Network

Join clarc developer network

Öffnet den CDN Registrierungsdialog.

View

Close all

Schließt alle offenen Tabs.

Code explorer

Zeigt den Code-Explorer an über den alle Variablen und Methoden angezeigt und direkt angesprungen werden können.

Code resources

Nicht verwendet.

Clipboard history

Öffnet den Bereich für die Zwischenablage-Historie.

Help editor

Öffnet den Hilfe-Editor.

Show right margin

Zeigt im Code-Editor eine Linie auf der rechten Seite an um einen Seitenrand darzustellen.

Show active line

Die aktive Zeile im Editor wird hiermit hervorgehoben.

Hide exceptions

Schließt den Exception-Bereich eines Editors.

Show all exceptions

Bei aktiver Option werden alle Exceptions angezeigt - ggf. auch solche die sich nur auf Grund des eigentlichen Fehlers ergeben.

Database

Hier können verschiedene Optionen zur Darstellung des Datenbank-Browser gewählt werden.

C4

Open

Öffnet den C4 Browser und bietet eine Auswahl der im C4 definierten Skripte an. Zudem auch eine Sicht auf die Skripte aus Portal-Sicht.

Refresh

Aktualisiert die C4 Ansicht.

Options

Use smart tabs

Tabs werden auf Grund des umgebenden Texts automatisch in der Länge variiert und entsprechend der Cursor positioniert.

Enhanced home key

Pos1 springt dann nicht immer direkt ein Spalte eins, sondern von Abschnitt zu Abschnitt in der entsprechenden Zeile.

Code tooltips

Zeigt die Tooltips zur aktuellen Skript-Funktion an.

Explicit variable declaration check

Der interne Compiler wird angewiesen auf eine explizite Variablen-Deklaration zu achten. Alle Variablen müssen damit vor der Verwendung deklariert werden.

Save on execute / Auto save

Gibt an, ob das aktuelle Skript vor der Ausführung automatisch gespeichert werden soll. Die Auto save Funktion speichert automatisch bei entsprechenden Aktionen: Aktivieren, Schließen, Ausführen, bei denen sonst eine Abfrage kommen würde.

Debugger

Close finished sessions

Bei aktiver Option wird das entsprechende Debug-Fenster automatisch nach Beendigung der Debug-Session geschlossen.

Date format

Auswahl des verwendeten Datumsformats für div. Vorbelegungen.

Auto corrections

An dieser Stelle können eigene Autokorrektur-Werte definiert werden.

Logfile

clarc automation processor

Aktiviert die Erzeugung eines Logfiles für den CLARC AUTOMATION Processor. Skripte können direkt aus dem Development Studio auf dem Processor ausgeführt werden.

Font

Auswahl der Editor-Schriftart.

Style

Auswahl des Editor-Styles.

File associations

Hier können Dateiverknüpfungen zum Development Studio gesetzt werden.

Help

Hilfe-Funktionen.

F1

Suchfunktion

Die Suchfunktion arbeitet kontextabhängig. Das heißt im Falle eines geöffneten Editors wird dort gesucht, bei einer Datenbank entsprechend dort.

Über die Eingabe eines Wertes und drücken von F1 wird der Wert in der Hilfedatenbank gesucht. Die Suche streckt sich dabei auch auf Beiträge des angebundenen Community-Forums aus. Die Hilfe kann ebenfalls über die Markierung eines Werts im Editor und F1 geöffnet werden.

Im Kontext des Suche-Buttons gibt es auch die Funktion für Suchen und Ersetzen.

Über das Development Studio suchen Sie mit der Tastenkombination Strg + H direkt nach dem markierten Text in unserer Online Hilfe für CLARC ENTERPRISE.

Buttonleiste

Die Buttonleiste zeigt die entsprechenden Menüfunktionen als Buttons an und bietet beispielsweise beim Öffnen-Button eine Zusatzauswahl für die Dateihistorie und Zugriff auf alle Dateien des aktuellen Pfads.

Über den Button "Lock editing" kann der Zugriff auf die Scripte während einer Änderung für weitere Benutzer gesperrt werden. Das gesperrte Script kann bis zur Freigabe des Lock- Users nicht mehr für Änderungen verwendet werden, sondern nur angezeigt werden. Die Änderungen werden über den Button "Activate changes" entsprechend aktiviert. Dabei werden die Änderungen vorerst in einen temporären Arbeitsbereich zwischengespeichert und anschließend im eigentlichen Arbeitsbereich abgelegt. Die Lock-Funktion wird über die Properties LockUser und LockDate, welche auch im C4 sichtbar sind, gesteuert.

Der Ausführen Button (Play-Symbol) hat hingegen noch einige Zusatzfunktionen zu bieten

Button		Beschreibung
		Speichert Änderungen am Script. Der Button wird aktiv sobald Änderungen vorgenommen wurden.
		Öffnet den Datei öffnen Dialog zur Auswahl von Skripten
		Fügt einen neues Script in einer neuen Registerkarte ein
		Kopiert den markierten Inhalt
		Schneidet den Inhalt aus
		Fügt den kopierten Inhalt ein
		Bearbeitung werden Rückgängig gemacht.
		Sperrt den Zugriff während Änderungen.
		Aktiviert die Änderungen vom jeweiligen Script
		Führt eine Syntax Prüfung durch
	Execute	Führt das aktuelle Skript aus
	Execute Subroutine	Führt die ausgewählte Subroutine im Development Studio aus.
	Debug	Debug-Funktionen.
	Execute in clarc automation processor	Führt das aktuelle Skript mit dem CLARC AUTOMATION Processor aus.
	Execute in clarc batch processor	Führt das aktuelle Skript mit dem CLARC BATCH Processor aus.
	Upload XML to WARP processing queue	Importiert eine ausgewählte XML Datei in die Verarbeitungsqueue des WARP Daemons.
		Blendet die C4-Scripte ein

Inhaltsbereich

Im Inhaltsbereich gibt es grundlegend zwei verschiedene Typen der Anzeige. Zum einen den Code-Editor und zum anderen den Datenbank-Browser/Editor.

Markierungen

Im Code-Editor können Sie mit dem Tastenkürzel Strg + M eine Codemarkierungen an jeder beliebigen Stelle im Code hinzufügen in dem Sie mit dem Cursor auf die entsprechende Stelle klicken und über Strg + M eine Markierung hinzufügen oder ändern. Hierbei können Sie auch eine enstprechende Notiz für die Markierung hinterlegen. Die Notizen werden dann in der Statusleiste mit dem hinterlegten Kommentar eingeblendet. Mit dem Tastenkürzel Umsch + Strg + M navigieren Sie einfach durch alle Codemarkierungen. Für die Codemarkierungen sind Farben vorhanden, die entweder eine Information oder eine Warnung signalisieren.

Des Weiteren können Sie über Strg + L in beliebige Zeilen des Codes automatisch springen in dem Sie die Zeilennummer angeben.

Info

title	Information

Das Hinzufügen oder entfernen von Markierungen erfolgt über den gleichen Tastaturbefehl.

C4-Scripte

Das Developmemt Studio ermöglicht den direkten Zugriff auf die C4-Skripte über den Navigationsbaum, welchen man sich über den Button "Browse C4 database" einblenden lassen kann. Darüber hinaus können C4-Skripte zum einen im Development Studio direkt oder im C4 angelegt werden. Unter /Templates/Bodies ist eine eine Vorlage für die Scripte hinterlegt, die automatisch die wichtigen Headerinformationen wie z.B. Author oder Creationdate setzen.

Datenbank-Browser

Sie können eine Datenbank öffnen in dem Sie eine .udl Datei über den Öffnen-Dialog auswählen oder im Explorer über das Development Studio Öffnen.

Beim Öffnen einer .udl Datei wird auf der linken Seite eine Liste der verfügbaren Tabellen und deren Spalten angezeigt. Zudem noch Informationen zur entsprechenden .udl Datei. In der Statusleiste sehen Sie den ermittelten Datenbank-Typ und die Version des Datenbankservers.

Mit einem Doppelklick auf die jeweilige Tabelle wird diese geöffnet und die ersten 100 Zeilen angezeigt. Gleichsam wird im SQL-Editor das entsprechende Statement angezeigt, welches im Anschluss angepasst werden kann. Über F9 oder den entsprechenden Button in der Buttonleiste führen Sie das Statement aus.

Im Standard sind immer alle Spalten einer Tabelle ausgewählt, mit einem Klick auf das Check-Symbol der Spalte bzw. des Feldnamens auf der linken Seite im Tabellen-Browser, können einzelne Spalten ab- oder ausgewählt werden. Öffnen Sie die Tabelle erneut (siehe Kontextmenü) werden nur die ausgewählten Spalten berücksichtigt.

Das Kontextmenü zur Tabelle bietet zudem noch weitere Möglichkeiten. Diese sind:

Db-Tabellen Menüstruktur		Beschreibung
Open		Tabelle öffnen und Statement im Editor anzeigen.
Tasks	Import	Importieren von Tabelleninhalten welche zuvor via Export exportiert wurden. Unterstützt wird CSV, XML und BIN.
	Export	Export der angezeigten Tabelleninhalte. Zur Auswahl stehen folgende Formate: TXT CSV HTML XML BIN XLS DOC
	Rename	Umbenennen der Tabelle.
	Clear	Leeren der Tabelle via Schnellfunktion (kein DELETE FROM ...).
	Delete	Löschen der gesamten Tabelle.
Refresh database		Lädt alle Tabellen und Spalten erneut aus der Datenbank.

Über das Kontextmenü auf einer Zelle im Ergebnis-Browser kann der Wert in die Zwischenablage kopiert oder eine Suche nach dem markierten Wert ausgeführt werden. Das entsprechende Statement wird wieder im Editor-Bereich bereitgestellt.

Ein Doppelklick auf eine Zeile im Browser öffnet ein Detail-Dialog mit allen Informationen zur aktuellen Zeile.

Info
Über das Database Menü kann die Tabelle in einen Online-Mode versetzt werden. Dies bedeutet, dass die Tabelle geändert werden kann. Angepasste Zelleninhalte werden direkt in die Tabelle geschrieben.

Editor Kontext-Menü

Das Kontextmenü im Editor bietet eine Fülle an Funktionen und Tools die die Arbeit deutlich vereinfachen können. Hier alle verfügbaren Funktionen vorgestellt:

Menüstruktur			Beschriebung	Shortcut
Undo			Wiederruft die letzte Änderungsaktion.	Strg+Rück
Copy			Kopiert den aktuell markierten Text in die Zwischenablage.	Strg+C
Cut			Kopiert den aktuell markierten Text in die Zwischenablage und löscht den markierten Text aus dem Editor.	Strg+X
Paste			Fügt den aktuellen Wert aus der Zwischenablage in den Editor ein.	Strg+V
Delete			Löscht den markierten Text aus dem Editor.	Entf.
Select all			Markiert den gesamten Inhalt des Editors.	Strg+A
Toggle comment			Schaltet den aktuell markierten Bereich im Editor zwischen kommentiert und unkommentiert um. Die Zeilen erhalten einen entsprechenden Prefix mit //.	Shift+Strg+Q
New comment			Fügt ein neues Kommentar in den Editor ein.	Strg+Q
Search	Search for <selection>		Sucht nach dem aktuell markierten Text.
	Search		Öffnet den erweiterten Such-Dialog.	Strg+F
	Replace		Öffnet den Suchen und Erstzen Dialog.	Strg+R
	Ask Google		Sucht den aktuell markierten Wert in Google - dazu wird der entsprechende Standardbrowser im System geöffnet.	Strg+G
Indent more			Rückt die markierten Zeilen um zwei Blanks nach rechts ein.	Strg++
Indent less			Rückt die markierten Zeilen um zwei Blanks nach links ein.	Strg+-
Insert	C4	Field scheme	Über diesen Bereich können bestehende Felder aus einem im C4 definierten Feldschema ausgewählt und eingefügt werden.
		Resource	Fügt die am Skript im C4 hinterlegten Ressourcen in den Editor ein.
		Template	Öffnet einen Auswahldialog um eines der im C4 unter /clarc/Scripts/Templates defnierten Templates im Editor einzufügen.	Strg+J
	Database		Fügt Spalten von im Development Studio geöffneten Tabellen in den Editor ein.
	Regular expression		Öffnet den RegEx Builder Dialog.
	ASCII code		Öffnet den ASCII Code Dialog.
	Path		Öffnet einen Datei-Öffnen-Dialog und fügt den Pfad der ausgewählten Datei in den Editor ein.
	UNC path		Öffnet einen Datei-Öffnen-Dialog und fügt den UNC-Pfad der ausgewählten Datei in den Editor ein.
	Connection string		Öffnet den UDL Editor mit der Vorbelegung des ausgewählten ConnectionStrings im Editor und fügt den neuen ConnectionString dann wieder ein.
	File content		Öffnet einen Datei-Öffnen-Dialog und fügt den Inhalt der ausgewählten Datei in den Editor ein.
	MD5 from file		Fügt den MD5 Hashwert einer ausgewählten Datei in den Editor ein.
	CRC from file		Fügt den CRC Wert einer ausgewählten Datei in den Editor ein.
	ID		Fügt eine neue ID in den Editor ein (32 Stellen).
	GUID		Fügt eine neue GUID in den Editor ein.
	Date		Fügt das aktuelle Datum in den Editor ein.
	Time		Fügt die aktuelle Uhrzeit in den Editor ein.
	Date time		Fügt das aktuelle Datum und die Uhrzeit in den Editor ein.
	ccTimeStamp		Fügt einen clarc TimeStamp in den Editor ein. Siehe auch Timestamp Format.
	User name		Fügt den aktuellen Windows-Benutzernamen in den Editor ein.
	Computer name		Fügt den aktuellen Computernamen in den Editor ein.
Modify	Uppercase		Ändert den ausgewählten Text im Editor in Großbuchstaben ab.
	Lowercase		Ändert den ausgewählten Text im Editor in Kleinbuchstaben ab.
	Reverse		Dreht den markierten Text im Editor um.
	Int to hex		Wandelt den markierten Integer-Wert in seine Hexadezimal-Entsprechung um.
	Hex to int		Wandelt einen Hexadezimalwert in seine Integer Entsprechung um.
	Base64 encode		Wandelt den markierten Text in Base64 um.
	Base64 decode		Wandelt den markierten Base64-Text in normalen Text um.
	ASCII Hex encode		Wandelt den markierten Text in seine ASCII Hex ENtsprechung um. Zum Beispiel wird aus TEST > 54455354. T ~ 54, E ~ 45, S ~ 53 und T ~ 54.
	WideString to UTF8String		Wandelt den markierten Wert in seine UTF-8 Entsprechung um,
	UTF8String to WideString		Wandelt den markierten UTF-8 Text in seine Widestring Entsprechung um.
	Get MD5		Wandelt den marierten Text in seine MD5 Hashwert Entsprechung um.
	Get CRC		Wandelt den marierten Text in seine CRC Wert Entsprechung um.
	TimeStamp	DateTime to ccTimeStamp	Wandelt das markierte Datum in einen clarc TimeStamp um.
	TimeStamp	ccTimeStamp to DateTime	Wandelt den markierten clarc TimeStamp in ein normales Datum um.
Use	Shellexecute selected		Führt den aktuell ausgewählten Text via ShellExecute aus. Zum Beispiel Web-Adressen.
Go To Line			Springt automatisch in die angegebene Zeile im Code.	Strg + L
Toggle Marker			Fügt eine Markierung ein und ernöglicht die Hinterlegung von Notizen für die Markierung	Strg + M
Got to next			Navigiert durch alle eingefügten Markierungen	Umsch + Strg + M
Help			Sucht nach dem markierten Wert in der Hilfe.	F1
CLARC Help Wiki			Sucht nach dem markierten Wert direkt im CLARC Help Wiki.	Strg + H

Tabs

Über der Statusleiste links befinden sich neue Registerkarten:

Explorer
Resources
Includes
Main
Description
History
JavaScript
StyleSheet

Explorer

Übersicht der Funktionen und der Variablen von dem Script.

Resources

Listet alle für das Script eingepflegten Ressourcen auf und ermöglicht deren Bearbeitung.

Includes

Zeigt die die entsprechenden Includes an und ermöglicht durch Doppelklick im Inhaltsbereich die Bearbeitung und Entfernung von Includes.

Main

Hier befindet sich das eigentliche Script.

Description

In Description kann eine Beschreibung für das jeweilige Script hinterlegt werden.

History

Die History ermöglicht das Erstellen von Code-Historien von dem jeweiligen Script und protokolliert übersichtlich die Änderungen entsprechend in der Historienansicht. In der Historie werden die Änderungen an Resourcen, Includes, Code sowie Versionsänderungen zentral in einem Eintrag protokolliert. Die Einträge werden nachdem aktivieren des Scriptes entsprechend in der Ansicht angelegt. Aus der Ansicht heraus kann genau verfolgt werden welcher User an welchem Datum eine Änderung vorgenommen hat. Des Weiteren können Sie in der Historienansicht permanente Historien erstellen, um z.B. einen gewissen Stand des Scriptes zu sichern. Hierfür drücken Sie im Inhaltsbereich der Historienansicht auf die rechte Maustaste und wählen im Kontextmenü die Funktion "Take Snapshot" aus. Die permanenten Historien zeichnen sich durch ihre grüne Markierung aus. Darüber hinaus können Sie einfach mit der Funktion "Restore" im Kontextmenü die älteren Versionen des Scriptes, der Ressourcen sowie von den Includes wiederherstellen. Außerdem ermöglicht die WinMerge-Funktion einen Vergleich zwischen dem aktuellen Script deren Resourcen und Includes und einem Historieneintrag. In der History sind zwei Datumsangaben vorhanden. Während Created das Datum der Historie angibt, zeigt Date das Erstellungs- sowie Änderungsdatum des Skriptes

JavaScript/ StyleSheet

Die JavaScript- und StyleSheet-Ressourcen können direkt im Development Studio, inkl. entsprechendem Syntax Highlighting, bearbeitet werden. Diese werden nur angezeigt, wenn welche hinterlegt sind und finden Ihre Anwendung insbesondere in der Portal-Entwicklung.

Statusleiste

In der Statusleiste wird von links nach rechts folgende Informationen angezeigt:

Aktuell geöffnetes File oder C4 Skript.
Aktuell angemeldeter Benutzer am CDN.
Die Cursorposition im Editor.
Die Anzahl der im Editor ausgewählten Zeichen.
Änderungsdatum des aktuellen Files oder C4 Skripts.
Zusatzinformationen in Abhängigkeit des aktuellen Kontexts oder Aktion.
Version des Scriptes

Startparameter

Das Studio kann als Startparameter eine Datei oder C4 Script-Pfad entgegennehmen.

Tipp

title	Tipp

Über den Startparameter "–c4init=false" kann des CLARC DEVELOPMENT STUDIO ausserhalb einer CLARC ENTERPRISE Installation - standalone - betrieben werden.

Registry Parameter

Bereich	Pfad	Property	Typ	Beschreibung
HKCU	\SOFTWARE\clarc\DevStudio\	DisableActivationSyntaxCheck	Bool	Hierüber kann die Syntaxprüfung bei der Aktivierung von Scripten deaktiviert werden.

Inhalt

Untergeordnete Seiten (Anzeige untergeordneter Seiten)

all	true
depth	1

Versionen im Vergleich

Alte Version 1

Neue Version Aktuell

Schlüssel

Inhalt

Das Studio GUI

Hauptmenü

File