Toolmaker Produkt-Dokumentation

Befehle und Exit-Programme für 5250-Sitzungen und Client-Programme

Inhaltsübersicht

Grundsätzlich wird directarchiv webbasiert verwaltet.Für bestimmte Zwecke stehen jedoch CL-Befehle zur Verfügung.

Darüber hinaus stellt directarchiv verschiedene Exit-Befehle zur Verfügung, die Programmierer in ihre Programme einbauen können

CL-Befehle zur Steuerung

Befehl STRIFSMON IFS Monitor starten

Mit dem Befehl STRIFSMON wird der IFS Monitor gestartet. Mit dem Befehl ENDIFSMON kann der IFS Monitor wieder beendet werden.

0187 – Befehl STRIFSMON

IFS Monitor

Name des zu startenden IFS Monitors.

0458 – Befehl STRIFSMON - Hinweismeldung

Der gestartete IFS Monitor läuft unter dem Subsystem DIRARC.

0228 – IFS Monitor gestartet

Befehl ENDIFSMON IFS Monitor beenden

Mit dem Befehl ENDIFSMON wird der IFS Monitor beendet. Mit dem Befehl STRIFSMON kann der IFS Monitor wieder gestartet werden

0188 – Befehl ENDIFSMON

IFS Monitor

Name des zu beendenden IFS Monitors.

Beenden

Gibt an, ob der IFS Monitor sofort oder kontrolliert beendet werden soll.

Gültige Werte sind:

{}CNTRLD{*}Der IFS Monitor wird kontrolliert beendet. Dadurch kann das Programm eine Bereinigung (Jobendeverarbeitung) durchführen.

*IMMED - {*}Der IFS Monitor wird sofort beendet. Das System führt eine Bereinigung bei Jobende durch.

0459 - Befehl ENDIFSMON – Hinweismeldung

Befehl STRWEBEML E-Mail Dienst starten

Mit dem Befehl STRWEBEML wird der E-Mail Dienst, der automatisch mit dem Start von directweb mitgestartet wird, manuell gestartet werden. Mit dem Befehl ENDWEBEML kann dieser wieder beendet werden.

Der Befehl hat keine Parameter.

Befehl ENDWEBEML E-Mail Dienst beenden

Mit dem Befehl ENDWEBEML wird der E-Mail Dienst, der automatisch mit dem Start von directweb mitgestartet wird, manuell beendet werden. Mit dem Befehl STRWEBEML kann dieser wieder gestartet werden.

Der Befehl hat keine Parameter.

Befehl STROCRMON OCR Monitor starten

Mit dem Befehl STROCRMON wird der OCR Monitor gestartet.

Befehl STROCRMON

OCR Monitor - Name des OCR Monitors, der gestartet werden soll.

Befehl ENDOCRMON OCR Monitor beenden

Mit dem Befehl ENDOCRMON wird der OCR Monitor beendet.

0447 - Befehl ENDOCRMON

OCR Monitor - Name des OCR Monitors, der beendet werden soll.

Beenden - Auswahl, wie der OCR Monitor beendet werden soll.

Gültige Werte sind.

*CNTRLD - Der OCR Monitor wird kontrolliert beendet. Dadurch kann das Programm eine Bereinigung (Jobendeverarbeitung) durchführen.
*IMMED - Der OCR Monitor wird sofort beendet. Das System führt eine Bereinigung bei Jobende durch

Befehl STRSGNMON Signatur-Monitor starten

Mit dem Befehl STRSGNMON wird der Signatur-Monitor gestartet.

Befehl ENDSGNMON

Signatur-Monitor - Name des Signatur-Monitors, der gestartet werden soll.

Befehl ENDSGNMON Signatur-Monitor beenden

Mit dem Befehl ENDSGNMON wird der Signatur-Monitor beendet.

Befehl ENDSGNMON

Signatur-Monitor - Name des Signatur-Monitors, der beendet werden soll.

Beenden - Auswahl, wie der Signatur-Monitor beendet werden soll.

Gültige Werte sind.

*CNTRLD - Der Signatur-Monitor wird kontrolliert beendet. Dadurch kann das Programm eine Bereinigung (Jobendeverarbeitung) durchführen.
*IMMED - Der Signatur-Monitor wird sofort beendet. Das System führt eine Bereinigung bei Jobende durch.*

Befehl STRTHMMON Thumbnail Monitor starten

Mit dem Befehl STRTHMMON wird der Thumbnail-Monitor gestartet.

Befehl STRTHMMON

Thumbnail Monitor - Name des Thumbnail-Monitors, der gestartet werden soll.

Befehl ENDTHMMON Thumbnail Monitor beenden

Mit dem Befehl ENDTHMMON wird der Thumbnail-Monitor beendet.

Befehl ENDTHMMON

Thumbnail Monitor - Name des Thumbnail-Monitors, der beendet werden soll.

Beenden - Auswahl, wie der Thumbnail-Monitor beendet werden soll.

Gültige Werte sind.

*CNTRLD - Der Thumbnail-Monitor wird kontrolliert beendet. Dadurch kann das Programm eine Bereinigung (Jobendeverarbeitung) durchführen.
*IMMED - Der Thumbnail-Monitor wird sofort beendet. Das System führt eine Bereinigung bei Jobende durch.

Befehl STRDSTMON Verteilerjob starten

Der Verteilerjob DIRARCDST steuert den Versand von E-Mails und Faxen über die Automatische Verteilung.

Der Verteilerjob muss nach jedem IPL mit dem Befehl STRDSTMON gestartet werden. Er muss auch gestartet werden, wenn das Subsystem DIRARC beendet wurde (z.B. für die Sicherung).

Der Verteilerjob läuft im Subsystem DIRARC.

Befehl STRDSTMON - Monitorjob

Befehl ENDDSTMON Verteilerjob beenden

Mit dem Befehl ENDDSTMON wird der Verteilerjob beendet.

Beenden - Hier wird gesteuert, wie der Verteilerjob beendet wird.

Gültige Werte sind.

*CNTRLD - Der Verteilerjob wird kontrolliert beendet. Dadurch kann das Programm eine Bereinigung (Jobendeverarbeitung) durchführen.
*IMMED - Der Verteilerjob wird sofort beendet. Das System führt eine Bereinigung bei Jobende durch.*


Befehl MOVVOLDOC Datenträgerdokumente übertragen

Mit dem Befehl MOVVOLDOC werden Dateien eines Volumes auf ein anderes Volume verschoben und ändert dabei auch die Verknüpfung zu den Dokumenten im Archiv.

Dieser Befehl kann dazu verwendet werden, um Dokumente, die nicht in Containern gespeichert wurden, auf ein Volume mit Containerspeicherung zu kopieren (oder umgekehrt um Dokumente aus Containern herauszulösen).

Die Containerspeicherung bietet den Vorteil, dass nicht so viele Dateien auf dem Volume erstellt werden und somit die Dateien des Volume bei einer Datensicherung oder bei sonstigen Kopiervorgängen schneller verarbeitet werden kann.

0543 - Befehl MOVVOLDOC

Von Datenträger - Eingabe des Datenträgers (Volume) von dem die Dokumente übertragen werden sollen.

Nach Datenträger/Datenträger - Eingabe des Datenträgers (Volume) zu dem die Dokumente übertragen werden sollen.

Archiv - Eingabe des Archivs, aus dem die Dokumente zu einem anderen Datenträger verschoben werden sollen.

Befehl CHGARCLNG – Sprache ändern

Mit dem Befehl CHGARCLNG kann die Spracheinstellung von DirectArchiv geändert werden.

Befehl CHGARCLNG _ Sprache ändern

Sprache - Hier können folgende Sprachen ausgewählt werden:

DES - Deutsch (Schweiz)
DEU - Deutsch
ENG - Englisch
FRA - Französisch
ITA - Italienisch
FRS - Französisch (Schweiz)
POL - Polnisch

Nach Auswahl der Sprache erscheinen zusätzliche Parameter.

Befehle in Bibliothek kopieren - Hiermit steuern Sie, ob die wichtigsten directarchiv-Befehle in eine weitere Bibliothek kopiert werden sollen (z.B. QGPL, QUSRSYS). Wenn Sie dies nutzen, können Sie diese Befehle immer aufrufen, auch wenn die Bibliothek DIRWEB nicht Bestandteil Ihrer Bibliotheksliste ist.

Bibliothek - Wenn Sie in o. g. Parameter entschieden haben, dass Sie die directarchiv-Befehle in eine weitere Bibliothek kopieren wollen, geben Sie hier die entsprechende Bibliothek (QUSRSYS, bzw. QGPL) an.

ASP-Gruppe - Wenn Sie mit iASP (independent Auxiliary Storage Pools) arbeiten, geben Sie hier den Namen des Pools ein, in dem Ihre Bibliothek DIRWEB gespeichert ist (Standardmäßig IASP33). Gültige Werte sind 1 – 32.

ASP-Einheit - Eingabe eines Namens für die ASP-Einheit.

*SYSBAS - Speicherbereich der Originaleinheit (Systembasis)

CL-Befehle zu Archiven und Volltextindizes

Befehl DSPARC Archivtreffer anzeigen

Mit dem native initiierten Befehl DSPARC können aus einer 5250-Anwendung heraus in einem ausgewählten Archiv Dokumente am Arbeitsplatz des Anwenders in einem Browserfenster angezeigt werden. Zum evtl. Einschränken der Trefferliste können weitere Parameter (z.B. Archivierungsdatum) angegeben werden.

Befehl DSPARC 1.Seite

Archiv - Eingabe der Archivs das angezeigt werden soll.

Suchtext - Durch Eingabe eines Suchtextes kann die Trefferliste eingeschränkt werden.

Beispiel für eine Suchtext


Ergebnis bei Eingabe eines bestimmten Suchtextes

Index - Die Trefferliste kann durch Eingabe eines Indexes nur für dieseneinen Indexwert eingeschränkt werden.

Wert - Wurde im Feld Index ein Indexwert eingetragen, so kanndem Index ein bestimmter Wert für die Auswahl zugewiesen werden.

Beispiel Selektion eines bestimmten Indexwertes

Archivdatum vom - Hier wird festgelegt, ab welchem Datum die Trefferliste angezeigt werden soll. Dieser Parameter kann mit dem Parameter Archivdatum bis kombiniert werden. Eingabe im Format TT.MM.JJJJ

Archivdatum bis - Hier wird festgelegt, bis zu welchem Datum die Trefferliste angezeigt werden soll. Dieser Parameter kann mit dem Parameter Archivdatum vom kombiniert werden. Eingabe im Format TT.MM.JJJJ

Volltextsuche - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

Befehl DSPARC 2.Seite

CCSID der Indexwerte - Hier kann eine zu verwendende CCSID oder *JOB für die Indexwerte angegeben werden.

Einzeltreffer sofort anzeigen - Mit diesem Parameter kann angegeben werden, ob bei einem einzelnen Treffer sofort das Dokument im Browser angezeigt werden soll.

Gültige Werte:

*YES - Jeder Einzeltreffer kommt sofort zur Anzeige
*NO - Anzeige der Trefferliste erfolgt erst nach Abschluss der Recherche

Menübaum anzeigen - Mit diesem Parameter wird die Anzeige des Menübaums gesteuert.

Gültige Werte:

*YES - Anzeige des Menübaums
*NO - keine Anzeige des Menübaums

Anzeige des Menübaums




keine Anzeige des Menübaums


Suchfilter anzeigen - Mit diesem Parameter wird die Anzeige des Suchfilters gesteuert.

Gültige Werte:

*YES - Anzeige des Suchfilters
*NO - keine Anzeige des Suchfilters
*PROTECT - Im Suchfilter kann keine Eingabe erfolgen



Suchfilter - *NO

Suchfilter *YES


Suchfilter *PROTECT


Hinzufügen erlauben - Mit diesem Parameter wird das Hinzufügen von Dokumenten gesteuert.

Gültige Werte:

*YES - Hinzufügen erlauben
*NO - Hinzufügen nicht erlauben

Befehl DSPARC Hinzufügen erlauben *YES

Befehl DSPARC Hinzufügen erlauben *NO

Befehl DSPFTISTS Volltextindex Status anzeigen

Mit dem Befehl DSPFTISTS wird der Volltextindex Status angezeigt.

Dieser Befehl kann nur für Archive verwendet werden, bei denen Volltextsuche möglich ist.

Befehl DSPFTISTS

Archiv - Eingabe des Archiv.

Befehl DSPFTISTS - Anzeige

Befehl RGZARCCNT – Korrigieren des Dokumentzählers

Mit dem Befehl RGZARCCNT kann der Dokumentzähler korrigiert werden. Durch Programmabbrüche etc. kann es vorkommen, dass der Dokumentzähler auf Archivebene nicht mehr korrekt ist. Dieser kann mit dem o.a. Befehl korrigiert werden.

Hinweis: Bei großen Archiven kann die Ausführung dieses Befehls einige Zeit in Anspruch nehmen. Während der Ausführung können keine Dokumente archiviert werden. Dies ist bei der Ausführung zu beachten!

Befehl RGZARCCNT

Archiv - Eingabe des Archivnamens, für das der Dokumentenzähler reorganisiert werden sol.

Befehl RGZARCCNT

Befehl DLTDUPDOC – Löschen doppleter Archivdokumente

Mit dem Befehl DLTDUPDOC kann ein doppelt archiviertes Dokument gelöscht werden.

Befehl DLTDUPDOC

Archiv - Eingabe eines gültigen Archivnamens, das nach doppelten Archivdokumenten durchsucht werden soll.

Eindeutige Indizes - Bei der Suche nach doppelten Archivdokumenten kann die Suche durch Eingabe von Indexwerten eingeschränkt werden.

Gültige Werte sind:

Zeichenwert - Es wird nur nach den angegebenen Indizes gesucht.
*ALL
- Es werden alle Indizes durchsucht.

Nur Prüfung durchführen

Gültige Werte sind:

*YES - Es wird nur eine Prüfung durchgeführt und kein Archivdokument gelöscht.
*NO
- Es wird keine Prüfung durchgeführt und das doppelte Archivdokument gelöscht.

Dokument löschen - Mit diesem Parameter wird festgelegt, welches der doppelten Archivdokumente gelöscht werden soll.

Gültige Werte sind:

*OLDEST - Löscht das älteste Dokument.
*NEWEST - Löscht das neueste Dokument.

Index Werte - Eingabe des/der Indexwert(e) nach denen nach doppelten Archivdokumenten gesucht werden soll.

Archivdatum vom - Eingabe des Archivdatums, ab dem nach doppelten Archivdokumenten gelöscht werden soll.

Gültige Werte sind:

Datum - Ab dem angegebenen Datum werden doppelte Archivdokumente gelöscht.
*AVAILEs - wird keine Datumsprüfung durchgeführt und alle doppelten Archivdokumente werden abhängig vom Eintrag im Parameter Archivdatum bis gelöscht. Standardwert.

Archivdatum bis

Eingabe des Archivdatums, bis zu dem nach doppelte Archivdokumenten gelöscht werden sollen.

Gültige Werte sind:

Datum Bis zm angegebenen Datum werden doppelte Archivdokumente gelöscht.

*AVAIL - Es wird keine Datumsprüfung durchgeführt und alle doppleten Archivdokumente gelöscht. Standardwert.

CCSID der Indexwerte - Hier wird festgelegt, welche CCSID für die Indexwerte verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Befehl CHKARCSGN – Signaturprüfung

Mit dem Befehl CHKARCSGN wird eine Signaturprüfung auf ein Archiv basierend auf einen Filter durchgeführt.

Befehl CHKARCSGN

Archiv - Eingabe eines gültigen Archivnamens, in dem eine Signaturprüfung durchgeführt werden soll.

Suchtext - Durch die Eingabe eines Suchtextes wird die Signaturprüfung auf beswtimmte Archivdokumente eingeschränkt.

Index WerteEingabe des/der Indexwert(e) nach denen eine Signaturprüfung durchgeführt werden soll.

Archivdatum vom - Eingabe des Archivdatums, ab dem eine Signaturprüfung durchgeführt werden soll.

Gültige Werte sind:

Datum - Ab dem angegebenen Datum wird die Signaturprüfung duchgeführt
*AVAIL - Es wird keine Datumsprüfung durchgeführt und alle Archivdokumente werden abhängig vom Eintrag im Parameter Archivdatum bis einer Signaturprüfung unterzogen. Standardwert.

Archivdatum bis - Eingabe des Archivdatums, bis zu dem eine Signaturprüfung durchgeführt werden soll.

Gültige Werte sind:

Datum - Bis zu dem angegebenen Datum wird die Signaturprüfung duchgeführt
*AVAIL - Es wird keine Datumsprüfung durchgeführt und alle Archivdokumente werden abhängig vom Eintrag im Parameter Archivdatum von einer Signaturprüfung unterzogen. Standardwert.

Volltextsuche - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

CCSID der Indexwerte - Hier wird festgelegt, welche CCSID für die Indexwerte verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Nach Durchführung des Befehls CHKARCSGN kommt folgende Hinweismeldung

Befehl CHKARCSGN – Ausgabe Hinweismeldung

Detailanzeige der Hinweismeldung

Befehl CHKARCSGN – Detalanzeige Hinweismeldung

Es wird zusätzliche eine Protokolldatei über das Ergebnis der Signaturprüfung erstellt.

Befehl CHKARCSGN – Protokolldatei

Befehl EXPARCDEF Archiv-Definitionen exportieren

Dieser Befehl ist verfügbar ab Version 1.80, PTF 10

Mit Befehl EXPARCDEF kann die Struktur eines Archivs incl. der Definition der Spalten aber ohne Daten in eine XML-Datei gesichert werden.

Mit diesem Befehl und dem Befehl IMPARCDEF haben Sie die Möglichkeit, gleiche Archivstrukturen auf Filialmaschinen oder Test-LPARs einzurichten, ohne die Inhalte zu übernehmen.

Befehl EXPARCDEF

Archiv - Name des zu exportierenden Archivs

<archivname> - Name des Archivs, dessen Definition exportiert werden soll
*ALL
- es werden die Definitionen aller Archive exportiert

IFS-Objekt - Pfad und Name einer XML-Datei, in der die zu exportierenden Daten gespeichert werden sollen

Bestehende Defintion ersetzen - Was soll passieren, wenn bereits eine XML-Datei unter dem Namen existiert, der im Parameter IFS Objekt eingetragen ist:

Gültige Werte

*YES - Die bestehende XML-Datei wird  gelöscht und ersetzt
*NO - Der Export schlägt fehl

Befehl IMPARCDEF Archiv-Definitionen importieren

Dieser Befehl ist verfügbar ab Version 1.80, PTF 10

Mit dem Befehl IMPARCDEF kann die gesicherte Struktur eines Archivs auf einer anderen Maschine unter demselben oder einem anderen Namen in eine Directarchiv Umgebung zurück gespeichert werden. Der Name des Archivs darf auf der Zielmaschine noch nicht existieren.

Mit diesem Befehl und dem Befehl EXPARCDEF haben Sie die Möglichkeit, gleiche Archivstrukturen auf Filialmaschinen oder Test-LPARs einzurichten, ohne die Inhalte zu übernehmen.


Befehl IMPARCDEF

IFS-Objekt - Pfad und Name einer XML-Datei, die zuvor mit dem Befehl EXPARCDEF erstellt wrude

IFS-Objekt löschen - Soll die XML-Datei nach dem Import gelöscht werden?

Archivdefinition - Name der Archivdefinition in der XML-Datei

Gültige Werte

<name> - die XML-Datei enthält die Definitionen eines oder mehrerer Archive, es ist die Definition mit diesem Namen zu verwenden
*ANY - die XML-Datei enthält die Definition eines Archivs, diese Definition ist zu verwenden

nach Archivdefinition - Name des Archives, das zu erstellen ist

Gültige Werte

<name> - Es wird ein Archiv mit diesem Namen errichtet. Sollte ein Archiv mit diesem Namen bereits existieren muss der nächste Parameter "Bestehende Definition ersetzen" auf *YES gestellt werden. Anderenfalls ist der Import nicht möglich.
*SAME - Es wird ein Archiv mit demselben Namen errichtet, den auch das exportierte Archiv hatte.Sollte ein Archiv mit diesem Namen bereits existieren muss der nächste Parameter "Bestehende Definition ersetzen" auf *YES gestellt werden. Anderenfalls ist der Import nicht möglich.

Bestehende Defintion ersetzen - Soll ein bereits bestehendes, gleichnamiges Archiv ersetzt werden? Was soll passieren, wenn bereits ein Archiv unter dem Namen existiert, der im Parameter nach Archivdefinition eingetragen ist:

Gültige Werte

*YES - Das bestehende Archiv wird  gelöscht und durch das exportierte ersetzt. Die Dokumente des bestehenden Archivs sind nicht mehr zugänglich.
*NO - Der Import schlägt fehl

REPLACE(*YES) macht die Dokumente unzugänglich. Es löscht Sie aber nicht

Wenn Sie REPLACE(*YES) angeben, dann wird ein bestehendes Archiv nicht vollständig mit allen seinen Inhalten gelöscht. Das neue, gleichnamige, Archiv hat die neue Struktur - die des zuvor exportierten Archivs. Aber seine Dokumente existieren weiterhin. Die Verbindungen zu den Dokumenten sind aber gelöscht, wodurch sie nicht mehr zugänglich sind.

CALL DIRARC/DASTRFTI - Start des Search Servers über ein Batchprogramm

Hinzugefügt in Version 1.80, PTF 10

Wenn der IBM OmniFind Text Search Server nicht aktiv ist, werden bestimmte Funktionen für die Volltextsuche nicht ausgeführt. Durch ein unerwartetes Systemende kann es aber dazu kommen, dass die Konfiguration des Servers nach dem IPL eine Aktivität anzeigt, obwohl das Programm gar nicht läuft.

Dieses Programm DASTRFTI erlaubt es, den IBM OmniFind Text Search Server auch über einen Batchvorgang zu starten.

Befehle zur Pflege der Volltextindizes

Hinweis: ab Version 1.80 von directarchiv wird für die Volltext-Indexierung und -suche das IBM Lizenzprogramm OminFind (5733OMF) verwendet. Davor war es das Lizenzprogramm "DB2 Text Extender".

Für die Pflege der Volltextsuche in den einzelnen Archiven stehen folgende Befehle zur Verfügung

WOPiXX beenden

Bitte beenden Sie WOPiXX mit dem Befehl ENDDIRWEB, bevor Sie die unten beschriebenen Befehle verwenden.

RBLFTI - Volltextindex wiederherstellen

Kopiert sämtliche Volltext-TXT-Dateien eines Archives wieder in das TEMP IFS Verzeichnis.

Befehl RBLFTI

RGZFTI vor RBLFTI aufrufen

Bitte beachten, dass das Verzeichnis: /Toolmaker/DirectArchive/Temp/Fulltext vorher von Textdateien bereinigt wurde, in dem für alle Volltextarchive der Befehl RGZFTI aufgerufen wurde.

Dieser Befehl löscht alle temporären Textdateien, die nicht mehr benötigt werden. Somit sollte das Verzeichnis anschließend leer sein.

Erst dann den Befehl RBLFTI aufrufen.

RGZFTI - Reorg Fulltextindex

Reorganisiert den Index eines Archivs.

Befehl RGZFTI

Archiv - Name des Archivs für das der Index reorganisiert werden soll.

Löschen temporärer IFS Dateien - Hier wird festgelegt, ob temporäre IFS Dateien nach dem Reorganisationslauf gelöscht werden sollen.

Gültige Werte sind:

*YES - Temporäre IFS Dateien werden gelöscht.
*NO - Temporäre IFS Dateien werden nicht gelöscht.

UPDFTI - Update Fulltext Index

Started den Index Update für alle Dokumente, die noch nicht indexiert wurden.

Befehl UPDFTI

Archiv - Name des Archivs für das der Index aktualisiert werden soll.

RMVFTI - Volltext Index entfernen

Entfernt den Suchindex von einem Archiv.

Um das Archiv danach wieder für Volltextsuche zu verwenden, muss einmal der Reiter Volltextsuche in den Archiveigenschaften neu konfiguriert werden.

Befehl RMVFTI

Archiv - Name des Archivs für das der Index entfernt werden soll.

CL-Befehle zu archivierten Dateien/Dokumenten

Befehl DSPARCDOC Archivdokument anzeigen

Mit dem Befehl DSPARCDOC kann ein archiviertes Dokument über die interne eindeutige Dokumenten-ID angezeigt werden. Die Dokumenten-ID kann mit anderen APIs ermitteln werden.

Befehl DSPARCDOC

Archiv - Eingabe des Archivs aus dem ein Dokument angezeigt werden soll.

Dokument ID - Eingabe der Dokument ID des anzuzeigenden Archivdokumentes. Die Dokument ID steht in den Eigenschaften des archivierten Dokumentes.

Befehl DSPGLOLNK Globalen Link durchsuchen

Mit dem Befehl DSPGLOLNK kann aus einer 5250-Anwendung in einem Global Link gesucht werden. Zum evtl. Einschränken der Trefferliste können weitere Parameter (z.B. Archivierungsdatum) angegeben werden.

Befehl DSPGLOLNK Seite 1

Globaler Link - Eingabe des globalen Links der angezeigt werden soll.

Suchtext - Durch Eingabe eines Suchtextes kann die Trefferliste eingeschränkt werden. Der Suchtext entspricht dem Filterfeld.

Index/Wert - Die Trefferliste kann durch Eingabe eines Indexes nur für diesen einen Indexwert eingeschränkt werden.

Archivdatum vom - Mit dem Archivdatum vom kann festgelegt werden, ab welchem Datum die Trefferliste angezeigt werden soll. Dieser Parameter kann mit dem Parameter Archivdatum bis kombiniert werden.

Archivdatum bis - Mit dem Archivdatum bis kann festgelegt werden, bis zu welchem Datum die Trefferliste angezeigt werden soll. Dieser Parameter kann mit dem Parameter Archivdatum vom kombiniert werden.

Volltextsuche - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

Befehl DSPGLOLNK Seite 2

CCSID der Indexwerte - Hier kann eine bestimmte zu verwendende CCSID oder die *JOB für die Indexwerte angegeben werden.

Einzeltreffer sofort anzeigen - Mit diesem Parameter kann angegeben werden, ob bei einem einzelnen Treffer sofort das Dokument im Browser angezeigt werden soll.

Gültige Werte:

*YES - Jeder Einzeltreffer kommt sofort zur Anzeige
*NO - Anzeige der Trefferliste erfolgt erst nach Abschluss der Recherche

Menübaum anzeigen - Mit diesem Parameter wird die Anzeige des Menübaums gesteuert.

Gültige Werte:

*YES - Anzeige des Menübaums
*NO - keine Anzeige des Menübaums

Suchfilter anzeigen - Mit diesem Parameter wird die Anzeige des Suchfilters gesteuert.

Gültige Werte:

*YES - Anzeige des Suchfilters
*NO - keine Anzeige des Suchfilters
*PROTECT Im Suchfilter kann keine Eingabe erfolgen

Archivauswahl anzeigen - Mit diesem Parameter wird die Anzeige der Archivauswahl gesteuert.

Gültige Werte:

*YES - Anzeige der Archivauswahl
*NO - keine Anzeige der Archivauswahl
*PROTECT - Im Suchfilter kann keine Eingabe erfolgen

Befehl ARCSTMF Datenstromdatei archivieren

Der Befehl ARCSTMF archiviert IBM i IFS-Objekte, wie diese im Parameter IFS Objekt eingetragen sind.

Befehl ARCSTMF Datenstromdatei archivieren Seite 1

IFS Objekt - Name des zu archivierenden IFS Objektes.

Archiv - Eingabe des Archivs, in dem das IFS Objekt abgelegt werden soll.

Datenstromdatei löschen - Hier wird angegeben, ob die Datenstromdatei nach dem Archivieren gelöscht werden soll.

Gültige Werte sind:

*YES - Datenstromdatei wird nach dem Archivieren gelöscht.
*NO - Datenstromdatei wird nach dem Archivieren nicht gelöscht.

Index / Wert -Eingabe von einem oder mehreren Indizes mit zugehörigem Wert für die zu archivierende Datenstromdatei.

CCSID der Indexwerte - Hier kann eine bestimmte zu verwendende CCSID oder die *JOB für die Indexwerte angegeben werden.

Textversion der Datei - Name der .txt-Datei auf dem IFS-Pfad. Textdatei wird für die Volltextsuche verwendet.

Textdatei löschen - Hier kann angegeben werden, ob die erstellte Textdatei nach dem Archivierungsvorgang gelöscht werden soll.

Bei jedem Archivierungsvorgang wird eine separate Textdatei erstellt und in einem Verzeichnis von directarchiv abgelegt.

Gültige Werte sind:

*YES - Textdatei wird nach dem Archivieren gelöscht.
*NO - Textdatei wird nach dem Archivieren nicht gelöscht.


Befehl ARCSTMF Datenstromdatei archivieren Seite 2

Email Adresse Fehlermeldungen - Eingabe der Email-Adresse, an die Fehlermeldungen beim Ausführen des Befehls ARCSTMF gesendet werden sollen.

Befehl DLTARCDOC Archivdokumente löschen

Der Befehl DLTARCDOC ermöglicht bei entsprechender Berechtigung das gezielte Löschen von Dokumenten aus einem Archiv.

Befehl DLTARCDOC Archivdokumente löschen Seite 1

Archiv - Name des Archivs, in dem sich das zu löschenden Dokument befindet.

Gültige Werte

<archivname> - Name eines existierenden Archivs
*ALL - 
Löschen aller alter Dokumente abhängig vom Verfallsdatum

Alte Dokumente löschen - Alte Dokumente in einem Archiv können abhängig vom Verfallsdatum gelöscht werden.

Gültige Werte sind:

*YES - Löschen nach Verfallsdatum
*NO - Löschen nach Filter

Suchtext - Eingabe eines Suchtextes für das zu löschende Dokument.

Index / Wert -Eingabe von einem oder mehreren Indizes mit zugehörigem Wert für die zu löschenden Dokumente

Archivdatum vom - Eingabe eines Archivdatums, ab welchem Datum das zu löschende Dokument ausgewählt werden soll. Dieser Parameter kann in Kombination mit dem Parameter Archivdatum bis verwendet werden.

Archivdatum bis - Eingabe eines Archivdatums, bis zu welchem Datum das zu löschende Dokument ausgewählt werden soll. Dieser Parameter kann in Kombination mit dem Parameter Archivdatum vom verwendet werden.

Befehl DLTARCDOC Archivdokumente löschen Seite 2

Volltextsuche - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

CCSID der Indexwerte - Hier wird festgelegt, welche CCSID verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Befehl RTVARCHIT Archivtreffer ermitteln

Mit dem Befehl RTVARCHIT können die Treffer einer Suche ermittelt werden.

Dieser Befehl ist zur Verwendung in einem CL-Programm vorgehsehen. Im Dialog kann er nicht verwendet werden.

Der Parameter HITS wird an das rufende Programm zurückgegeben und enthält die Anzahl von Dokumenten, die den Suchkriterien entsprechen.

0191 – Befehl RTVARCHIT Archivtreffer ermitteln Seite 1

Archiv - Name des Archivs, aus dem die Archivtreffer ermittelt werden sollen.

CL-Var. für Treffer (11,0) - Eingabe einer CL-Variablen für die Treffer. Im rufenden Programm ist die Variable, die in diesem Parameter übergeben wird mit TYPE(*DEC) LEN(11 0) zu deklarieren.

Suchtext - Eingabe eines Suchtextes für die Trefferliste.

Index / Wert -Eingabe von einem oder mehreren Indizes mit zugehörigem Wert für die zu suchenden Dokumente

Archivdatum vom - Eingabe eines Archivdatums, ab welchem Datum das zu findende Dokument ausgewählt werden soll. Dieser Parameter kann in Kombination mit dem Parameter Archivdatum bis verwendet werden.

Archivdatum bis - Eingabe eines Archivdatums, bis zu welchem Datum das zu findende Dokument ausgewählt werden soll. Dieser Parameter kann in Kombination mit dem Parameter Archivdatum vom verwendet werden.

 Befehl RTVARCHIT Archivtreffer ermitteln Seite 2

Volltextsuche - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

CCSID der Indexwerte - Hier wird festgelegt, welche CCSID verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Berechtigung prüfen - Mit diedem Parameter kann die Berechtigungsprüfung umgangen werden.

Gültige Werte sind:

*YES - Es findet keine Berechtigungsprüfung statt
*NO - Es findet keine Berechtigungsprüfung statt

Befehl EXPARCDOC Archivdokumente exportieren

Für Massenexport ist die Komponente "EXP" erfoderlich

Einzelne Dokumente können mit dem Befehl EXPARDOC ohne weitere Lizenz exportiert werden.

Wenn aber mehr als ein Dokument exportiert werden soll ("Massen-Export") dann ist eine Lizenz für die Komponente "EXP" erforderlich. Mit den Befehlen ADDLIBLE DIRARC, DSPLICINFO *FULL kann festgestellt werden, ob diese Lizenz verfügbar ist. Wenn nicht, dann fordern Sie bitte ein Angebot an, bei sales@toolmaker.de

Mit dem Befehl EXPARCDOC können einzelne oder mehrere Archivdokumente aus dem Archiv in das IFS exportiert werden.

Hinweis: Geänderte Dokumente können nicht exportiert werden.

Archiv (ARCHIVE) - Name des Archivs, aus dem die Archivdokumente exportiert werden sollen.

IFS Objekt (OBJ) - Name des zu exportierenden IFS Objektes.

Objekt ersetzen (REPLACE) - Hier wird angegeben, ob ein vorhandene Objekt beim Exportieren ersetzt werden soll.

Gültige Werte sind:

*YES - Ein vorhandenes Archivdokument wird ersetzt
*NO - Ein vorhandenes Archivdokument wird nicht ersetzt

Suchtext (FIND) - Eingabe eines Suchtextes für das zu exportierende Archivdokument.

Index / Wert (INDEX) -Eingabe von einem oder mehreren Indizes mit zugehörigem Wert für die zu exportierenden Dokumente

Archivdatum vom (ARCFROM) - Eingabe eines Archivdatums, ab welchem Datum das zu exportierende Archivdokument ausgewählt werden soll. Dieser Parameter kann in Kombination mit dem Parameter Archivdatum bis verwendet werden.

Archivdatum bis (ARCTO) - Eingabe eines Archivdatums, bis zu welchem Datum das zu exportierende Archivdokument ausgewählt werden soll. Dieser Parameter kann in Kombination mit dem Parameter Archivdatum vom verwendet werden.


Volltextsuche (FULLTEXT) - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

CCSID der Indexwerte (CCSID) - Hier wird festgelegt, welche CCSID bei der Suche im Archiv verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Notizen in PDF einfügen (NOTES) - Mit diesem Parameter wird gesteuert, ob Notizen in PDF-Dokumente eingefügt werden sollen oder nicht.

Gültige Werte sind:

*YES - Notizen werden in PDF eingefügt.
*NO - Notizen werden nicht in PDF eingefügt.


Befehl EXPARCDOC Archivdokumente exportieren Seite 2 Notizen in PDF einfügen

Formulare verwenden (OVERLAYS) - Mit diesem Parameter wird gesteuert, ob Dokumente mit oder ohne Formulare exportiert werden sollen.

Gültige Werte sind:

*NO - Dokumente werden mit Formular exportiert.
*NO -
Dokumente werden ohne Formular exportiert.

CSV Datei für Indexwerte (CSVIDXOBJ) - Eingabe einer CSV Datei, die die Indexwerte enthält. Wird hier eine Datei angegeben, so wird diese im angegebenen IFS-Pfad mit folgendem Aufbau abgelegt: Dokument ID, IFS-Pfad, exportierter Dokumentname, Originaldokumentname.

Beispiel für eine CSV-Datei mit den Indexwerten

Objekt ersetzen (CSVREPLACE) - Hier wird angegeben, ob ein vorhandenes PDF-Objekt beim Exportieren ersetzt werden soll.

Gültige Werte sind:

*YES - Ein vorhandenes PDF-Dokument wird ersetzt
*NO - Ein vorhandenes PDF-Dokument wird nicht ersetzt

CCSID für CSV Indexwerte (CSVCCSID) - Hier wird festgelegt, welche CCSID für die CSV Datei verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Der Vorgabewert *JOB führt im Regelfall dazu, dass die Datei von einem PC-Programm nicht lesbar ist. Ihre CCSID ist dann 273 oder 1141, womit PCs meist nichts anfangen können.

Empfohlene Werte

819 - Latin-1 countries or regions (ISO 8859-1
1252 -Windows ** Latin-1

Weitere Hinweise zu CCSID: https://www.ibm.com/support/pages/ifs-stmf-ccsids-1252-437-and-819

Eine Liste der CCSID: https://www.ibm.com/docs/en/rdfi/9.6.0?topic=reference-ccsid-values

Das Ergebnis des EXPARCDOC-Befehls kann so aussehen:

Der Dateiname (letzter Teil des Parameters OBJ) bestimmt die Namen, der im IFS-Verzeichnis abgelegten Dokumente.

  • Das erste Dokument hat genau diesen Namen. Alle weiteren werden mit einer fortlaufenden Nummer in Klammern versehen.

Es wird eine CSV-Datei mit den Indexdaten aller exportierten Dokumente abgelegt. Pfad und Name dieser Datei ist im Parameter CSVIDXIOBJ anzugeben.

Befehl UPDIDXRCD Indexwerte ändern

Mit dem Befehl UPDIDXRCD können die Indexwerte eines bereits archivierten Dokuments abgeändert werden.

Befehl UPDIDXRCD Indexwerte ändern

Archiv - Name des Archivs, in dem ein Indexwert geändert werden soll.

Dokument ID - Eingabe der Dokument ID, für das der Indexwert geändert werden soll. Die Dokument ID steht in den Eigenschaften des archivierten Dokumentes.

Sonderwert *FILTER - Es kann dann eine Filterauswahl angegeben werden, die das/die Dokument(e) eingrenzt, die geändert werden sollen.

Filter - Index/Wert-Paare zum Filtern der Dokumente, wenn bei Dokunment-ID *FILTER angegeben ist

Mehrere Datensätze ändern - Verhalten, wenn mehrere Dokumente gefunden werden (Sonderwert *FILTER)

Gültige Werte sind:

*NO - erfolgt eine Fehlermeldung, wenn der Filter mehr als einen Treffer ergibt. So kann verhindert werden, dass „versehentlich" mehrere Datensätze geändert werden.
*YES - Mehrere Datensätze können geändert werden.

Neue Indexwerte - Index/Wert-Paare die dem oder den Dokument(en) zuzuordnen sind

CCSID für CSV Indexwerte - Hier wird festgelegt, welche CCSID für die CSV Datei verwendet werden soll. Standardmäßig wird die CCSID des Jobs verwendet.

Befehl ADDIDXRCD Indexeintrag erstellen

Mit dem Befehl ADDIDXRCD können weitere Indexeinträge für ein bereits archiviertes Dokument erstellt werden.

Befehl ADDIDXRCD Indexeintrag erstellen

Archiv - Name des Archivs, in dem ein Indexeintrag erstellt werden soll.

Dokument ID - Eingabe der Dokument ID, für das der Indexeintrag erstellt werden soll. Die Dokument ID steht in den Eigenschaften des archivierten Dokumentes.

Index Werte - Index/Wert-Paare die dem Dokument im Archiv hinzugefügt werden sollen

CCSID für CSV IndexwerteHier wird festgelegt, welche CCSID für die CDV Datei verwendet werden soll. Standardmäßig wird die CCSID des Jobs verwendet.

Befehl EDTARCDOC Archivdokument editieren

Mit dem Befehl EDTARCDOC können über directmedia Archivdokumente editiert und als neue Version wieder abgelegt werden. Da es im Archiv keine UPDATE-Funktion sondern nur eine DELETE- bzw. WRITE-Funktion gibt, werden bei einem REPLACE die Notizen/Zugriffe mit auf das neue Dokument gelegt.

Wenn das Dokument nicht geändert wird, so erfolgt auch keine erneute Archivierung.

Für diesen Befehl muss das Toolmaker-Produkt directmedia auf dem PC installiert sein.


Befehl EDTARCDOC Archivdokument editieren Seite 1

Archiv - Name des Archivs, in dem ein Dokument editiert werden soll.

Dokument ID - Eingabe der Dokument ID, das editiert werden soll. Die Dokument ID steht in den Eigenschaften des archivierten Dokumentes.

Weitere gültige Werte sind:

*FIRST - Das zuerst archivierte Dokument basierend auf den Filter
*LAST - Das zuletzt archivierte Dokument basierend auf den Filter
*ONLY - Das einzige Dokument basierend auf den Filter (bei mehreren Treffern erfolgt eine Fehlermeldung)

Archivdokument ersetzen - Wird ein Archivdokument editiert, so erfolgt hier die Steuerung wie die Ablage des editierten Dokumentes sein soll.

Gültige Werte sind:

*YES - Das Dokument wird nach Änderung ersetzt (Altversion wird gelöscht, die neue Version archiviert)
*NO - Das Dokument wird nicht ersetzt, sondern erneut archiviert.

Suchtext - Durch Eingabe eines Suchtextes kann die Trefferliste eingeschränkt werden.

Index / Wert -Eingabe von einem oder mehreren Indizes mit zugehörigem Wert für die zu suchenden Dokumente

Archivdatum vom - Hier wird festgelegt, ab welchem Datum die Trefferliste angezeigt werden soll. Dieser Parameter kann mit dem Parameter Archivdatum bis kombiniert werden. Eingabe im Format TT.MM.JJJJ.

Archivdatum bis - Hier wird festgelegt, bis zu welchem Datum die Trefferliste angezeigt werden soll. Dieser Parameter kann mit dem Parameter Archivdatum vom kombiniert werden. Eingabe im Format TT.MM.JJJJ.

Befehl EDTARCDOC Archivdokument editieren Seite 2

Volltextsuche - Hier kann eine Zeichenfolge für die Volltextsuche eingegeben werden. Damit kommen nur die Dokumente zur Anzeige, die diesen Text beinhalten.

CCSID der Indexwerte - Hier kann eine zu verwendende CCSID oder *JOB für die Indexwerte angegeben werden.

CL-Befehle für Konvertierungen

Befehl CVTPDFTXT Convert PDF to Text

Mit dem Befehl CVTPDFTXT können PDF-Dateien in Textdateien (.txt) konvertiert werden.

Befehl CVTPDFTXT

PDF Datei - Name der PDF Datei die in eine Textdatei konvertiert werden soll.

Text Datei - Name der zu erstellenden konvertierten Textdatei.

PDF Datei löschen - Dieser Parameter steuert, ob nach der Konvertierung die PDF Datei gelöscht werden soll.

Datei ersetzen - Dieser Parameter steuert, ob eine bereits vorhandene Text Datei ersetzt werden soll.

CCSID der Textdatei - Hier wird festgelegt, welche CCSID für die Konvertierung verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

Raster CPI - Eingabe eines CPI Rasters (Characters Per Inch) für die Text-Extraktion. Je größer der Wert, desto genauer ist das Ergebnis. -

Raster LPI - Eingabe eines LPI Rasters (Lines Per Inch) für die Text-Extraktion. Je größer der Wert, desto geringer ist die Textüberlagerung.

Hinweis: Mit den Defaultwerten von CPI = 20 und LPI = 10 ist das Ergebnis am besten.

Befehl CVTEMLTXT Konvert E-Mail to Text

Mit dem Befehl CVTEMLTXT können Emails in Textdateien (.txt) konvertiert werden.

Befehl CVTEMLTXT

Email-Datei - Name der Email-Datei die in eine Textdatei konvertiert werden soll..

Text Datei - Name der zu erstellenden konvertierten Textdatei.

Email-Datei löschen - Dieser Parameter steuert, ob nach der Konvertierung die Email-Datei gelöscht werden soll.

Datei ersetzen - Dieser Parameter steuert, ob eine bereits vorhandene Text Datei ersetzt werden soll.

CCSID der Textdatei - Hier wird festgelegt, welche CCSID für die Konvertierung verwendet wird. Standardmäßig wird die CCSID des Jobs verwendet.

PC-API zum Ausführen von directweb-Funktionen

Über eine URL mit entsprechenden Parametern ist es möglich, einen korrekten Request an directarchiv abzusetzen. Die URL wird am PC aufgerufen und enthält bereits eine gültige directweb Session-ID. Die gültige directweb Session-ID wird vorher mit einem Session-API erstellt/geprüft.

Es kann sowohl für ein bestimmtes Archiv als auch für ein Sammelarchiv ein Request abgesetzt werden. 

Der Aufruf erfolgt in der URL:

URL: /cgi-bin/dwcgi.pgm?pgm=DAARCAPI&APP=DIRARC&SESSID=[SESSID]

0361 – API-Aufruf DAARCAPI – ohne gültige Session-ID

API DAARCAPI – für Archive

Der URL-Aufruf für Archive erfolgt mit folgenden Parametern:

COMMAND=DSPARC (erforderlich)

ARCHIVE=[archiv] (erforderlich)

ALLOWADD=Hinzufügen von Docs erlauben (Y/N)

API DAARCAPI – für Sammelarchive

Der URL-Aufruf für Sammelarchive erfolgt mit folgenden Parametern:

COMMAND=DSPGLO (erforderlich)

GLOBAL=[global link] (erforderlich)

SHOWARC=Archivauswahl anzeigen (Y/N/P=Protected)

API DAARCAPI – für Archive oder Sammelarchive

Für Archiv- oder Sammelarchivabfrage gelten folgende Parameter:

FIND=allg. Suchtext

ARCFROM=Archivdatum von (YYYYMMDD)

ARCTO=Archivdatum bis (YYYYMMDD)

FULLTEXT=Volltextsuche

SHOWSNGHIT=Einzeltreffer in Hitliste anzeigen (Y/N)

SHOWMNU=Menübaum anzeigen (Y/N)

SHOWFLT=Filter anzeigen(Y/N/P=Protected)

IDX_[indexname]=Filterwert für Indexsuche

Archivzugriff über Schablonendefinition unter directmedia

Schablone

Name der Schablonendefinition

Tastenfolge

Eingabe der Tastenfolge über die die Schablonendefinition aufgerufen werden soll.

Pfad, Pfadliste oder Programmname

DirectWebRequester.exe https:\\192.168.100.10\cgi-bin\dwcgi.pgm?pgm=DAARCAPI&APP=DIRARC&SESSID={0}&COMMAND=DSPARC&ARCHIVE={1}&ALLOWADD=Y

0372 – Schablonendefinition für directarchiv

0374 – 1. Felddefinition

0375 – 2. Felddefinition

0373 – Auswahl der anzuzeigenden archivierten Dokumente

Indexing-Exit Programme für Archive und IFS-Monitore

Für Archive und IFS-Monitore können eigene Programme definiert werden. Diese Programme werden zum Zwecke der Indexierung aufgerufen.

Siehe auch die Hinweise zum Indexing Exit Programm:

Sie finden Beispiel-Quellen für Indexierung-Exit Programme in der Quelldatei DIRARC/QRPGLESRC, z.B. DA_SAMEXT.