Unterstützte Servervorgänge

Dieser Artikel enthält die folgenden Themen:
casm173
Dieser Artikel enthält die folgenden Themen:
Mit den folgenden unterstützten Vorgängen können Sie CA SDM-Webseiten in Ihre Webseiten integrieren:
  • CREATE_NEW
    Stellt eine Standardschnittstelle bereit, in der Anwender eine neue Zeile in einer angegebenen Tabelle erstellen können. Dabei muss der Objektname angegeben werden. Standardmäßig wird die Vorlage
    detail_xxx
    _edit.htmpl für das Objekt
    xxx
    verwendet. Sie können die .htmpl-Datei überschreiben, indem Sie die HTML-Eigenschaft angeben.
    • Erforderliche Specifier:
      FACTORY=
      object
      -
      name
    • Optionale Specifier:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL=preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=zdetailxxx_
      factory
      .htmplKEEP
      .attr_name=value
      PRESET=
      preset_expression
      PRESET_REL=
      preset expression
      SET
      .attr_name=value
      use_template=1 | 0 (0 ist der Standardwert)
    Um den HTMPL-Spezifizierer mit CREATE_NEW zu verwenden, muss das referenzierte Formular einen Namen gemäß der Konvention "zdetailxxx_
    factory
    .htmpl" aufweisen. Er muss mit der Zeichenfolge "zdetail" beginnen, gefolgt von beliebigen alphanumerischen Zeichen (einschließlich einer Null-Zeichenfolge), gefolgt von einem Unterstrich und dem Factory-Namen.
  • ENDSESSION oder LOGOUT
    Beendet die Sitzung, bei der der Anwender derzeit angemeldet ist. ENDSESSION ist der bevorzugte Vorgang.
  • GENERIC_LIST
    Bietet eine Standardschnittstelle, über die der Anwender eine Liste von jeder Tabelle in der Datenbank anzeigen kann. Dabei muss der Objektname angegeben werden. Standardmäßig wird die Vorlage list_
    xxx
    .htmpl für das Objekt
    xxx
    verwendet. Sie können die .htmpl-Datei überschreiben, indem Sie die HTML-Eigenschaft angeben.
    • Erforderliche Specifier:
      FACTORY=
      object
      -
      name
      KEEP
      .attr_name=value
  • DISPLAY_FORM
    Bietet eine Standardschnittstelle, über die der Anwender jedes beliebige angepasste Formular anzeigen kann.
    • Erforderliche Specifier:
      HTMPL=
      htmpl_file
    DISPLAY_FORM ersetzt JUST_GRONK_IT. Bestehende Implementierungen können JUST_GRONK_IT weiterhin verwenden, da die Funktionsweise dieselbe wie bei DISPLAY_FORM ist. DISPLAY_FORM ist der bevorzugte Vorgang.
  • MENU
    Zeigt die Seite mit dem Hauptmenü an, die in der Eigenschaft "Menü" der Datei "web.cfg" definiert ist
    • Optionale Specifier:
      HTMPL=
      menufile
      menufile
      ist der Name einer alternativen Hauptmenüdatei.
  • PAGE_EXTENSION
    Ermöglicht dem Webmaster, zusätzliche Erweiterungen zur Schnittstelle anzugeben.
    • Erforderliche Specifier:
      NAME=
      html_file
      html_file
      ist einer der Dateinamen, die in der Anweisung "UserPageExtensions" der Konfigurationsdatei aufgeführt wird.
    • Optionale Specifier:
      REQUIRES_LOGIN=1
      Falls vorhanden, wird eine Anmeldeseite angezeigt, sofern der Anwender derzeit nicht angemeldet ist. Fehlt dieser Spezifizierer oder ist er auf Null gesetzt, so wird die Datei angezeigt ohne zu überprüfen, ob der Anwender aktuell angemeldet ist.
  • RELOG
    Zeigt die Anmeldeseite an.
  • SEARCH
    Bietet eine Standardschnittstelle, über die in der Datenbank nach Tabellen gesucht werden kann. Bei diesem Vorgang wird davon ausgegangen, dass eine entsprechende "search_
    xxx
    .htmpl"-Datei erstellt wurde.
    xxx
    ist der
    Objektname
    wie in "bopcfg" in den .maj-Dateien des Verzeichnisses "majic" definiert.
    Weitere Informationen finden Sie in CA Service Desk Manager-Informationen zu den Referenzbefehlen. Standardmäßig werden die Ergebnisse dieser Suche in list_
    xxx
    .htmpl angezeigt. Sie kann jedoch durch Angeben der HTMPL-Eigenschaft überschrieben werden.
    • Erforderliche Specifier:
      FACTORY=
      object-name
      QBE.
      op
      .
      attr_name
      =
      value
    • Optionale Specifier:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      list_htmpl_file
      KEEP
      .attr_name=value
  • SEC_REFRESH
    Aktualisiert die Anwenderinformationen für den Zugriff im Sicherheitsuntersystem. Für diesen Vorgang wird für Anwender, die über MODIFY-Berechtigungen (für die Funktionsgruppe "admin") verfügen, im Menüfenster ein Hyperlink angegeben. Nachdem die Zugriffsrechte der Anwender mit dem Sicherheitsprogramm aktualisiert wurden, bietet dieser Vorgang die Möglichkeit, die Zugriffsinformationen zu aktualisieren. (Dadurch werden die Sicherheitsinformationen für alle Anwender aktualisiert.)
    Sicherheitsaktualisierungen stellen einen asynchronen Prozess dar. Nachdem eine Sicherheitsaktualisierung ausgeführt wurde, wird eine Meldung in der Standardprotokolldatei (stdlog) angezeigt.
  • SET_MENU
    Das Verhalten dieses Vorgangs entspricht dem Verhalten von MENU, wenn MENU mit der HTMPL-Variablen verwendet wird. Der einzige Unterschied besteht darin, dass dieser Vorgang das Standardmenüformular für das Menüformular festlegt, das in der HTMPL-Eigenschaft angegeben ist.
    • Erforderliche Specifier:
      HTMPL=
      htmpl_file
    Dieser Vorgang setzt die Einstellung für MENU in der Datei "web.cfg" außer Kraft, bis der Webservice neu gestartet wird.
  • SHOW_DETAIL
    Bietet eine Standardschnittstelle, über die der Anwender ein schreibgeschütztes Detail einer Zeile in einer angegebenen Tabelle anzeigen kann. Der permanente ID-Name muss angegeben werden (von dem der Objektname abgeleitet wurde). Standardmäßig wird die Vorlage detail_
    xxx
    _ro.htmpl für das Objekt
    xxx
    verwendet. Die .htmpl-Datei kann durch Eingabe der HTMPL-Eigenschaft überschrieben werden.
    • Erforderliche Specifier:
      PERSID=
      persistent
      -
      id
    • Optionale Specifier:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      readonly_detail_htmpl_file
  • UPDATE
    Bietet eine Standardschnittstelle für die Bearbeitung von Tabellen. Die ID und der Objektname müssen übergeben werden, damit dem Anwender ein bearbeitungsfähiges Detailformular angezeigt wird. Standardmäßig hat der Anwender zwei Minuten lang exklusiven Zugriff auf den Datensatz. Dabei wird garantiert, dass er Änderungen in die Datenbank einfügen kann, wenn er sie in diesem Zeitraum übermittelt.
    • Erforderliche Specifier:
      PERSID=
      persistent-id
      orSET.id=
      id-of-row-to-update
      FACTORY=
      object-name
    • Optionale Specifier:
      NEXT_PERSID=
      persistent
      -
      id
      (des Datensatzes, der nach der erfolgreichen Aktualisierung angezeigt wird)KEEP
      .attr_name=value
      KEY
      .attr_name=value
      HTMPL=zdetailxxx_
      factory
      .htmpl
    Um den HTMPL-Spezifizierer mit UPDATE zu verwenden, muss das referenzierte Formular einen Namen gemäß der Konvention zdetailxxx_
    factory
    .htmpl aufweisen. Er muss mit der Zeichenfolge "zdetail" beginnen, gefolgt von beliebigen alphanumerischen Zeichen (einschließlich einer Null-Zeichenfolge), gefolgt von einem Unterstrich und dem Factory-Namen.
Informationen zu "web.cfg" finden Sie unter Konfigurieren der Webschnittstelle.
Vorgangsvariablen
In der folgenden Tabelle sind die Variablen aufgeführt, die für jeden der Vorgänge in der vorherigen Tabelle festgelegt werden können:
Variablen
Beschreibung
Betrieb
ALG_PRESET
ALG_PRESET_REL
Gibt Werte für ein oder mehrere Attribute des Aktivitätsprotokolls an, das als Ergebnis der CREATE_ALG-Variablen geschaffen wurde. Wenn CREATE_ALG nicht angegeben ist, werden ALG_PRESET und ALG_PRESET_REL ignoriert.
CREATE_NEWSEARCHSHOW_DETAIL
CREATE_ALG
Gibt den Aktivitätsprotokolltyp eines Aktivitätsprotokolls an, das als Nebeneffekt des Vorgangs erstellt wird. Verwenden Sie die Variablen ALG_PRESET und ALG_PRESET, um Werte für die Attribute des neuen Aktivitätsprotokolls anzugeben.
Wie lange das Erstellen des Aktivitätsprotokolls dauert, hängt vom Vorgang ab, wie im Folgenden aufgeführt:
CREATE_NEW
Das Aktivitätsprotokoll wird erstellt, wenn der neue Datensatz gespeichert wird. Wenn der neue Datensatz nicht gespeichert wird, wird auch kein Aktivitätsprotokoll erstellt.
SEARCH
Das Aktivitätsprotokoll wird erstellt, wenn ein Datensatz im Listenformular ausgewählt wird. Wenn der Datensatz nicht ausgewählt, sondern angezeigt wird (d. h., wenn der Anwender explizit den Befehl „Ansicht“ im Mouseover-Menü des Listenformulars auswählt), wird kein Aktivitätsprotokoll erstellt.
SHOW_DETAIL
Das Aktivitätsprotokoll wird erstellt, bevor der Datensatz angezeigt wird.
CREATE_NEWSEARCHSHOW_DETAIL
FACTORY
Gibt die Objektklasse an, nach der gesucht bzw. die erstellt oder aktualisiert werden soll. Sie können einen beliebigen als OBJECT angegebenen Namen in den *.maj-Dateien in "$NX_ROOT/bopcfg" verwenden, wie in CA Service Desk Manager-Informationen zu den Referenzbefehlen aufgeführt.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
HTMPL
Ermöglicht dem HTMPL-Autor, die Standardkonventionen für die Benennung von Vorlagen außer Kraft zu setzen, und gibt explizit die HTMPL-Datei an, die angezeigt werden soll und nicht die Standardvorlage.
Hinweis:
Wenn der HTMPL-Spezifizierer mit CREATE_NEW oder UPDATE verwendet wird, muss der Name des referenzierten Formulars der Namenskonvention "zdetailxxx_factory.htmpl" entsprechen, wobei xxx beliebige Zeichen sind und
factory
dem Herstellernamen entspricht.
CREATE_NEWDISPLAY_FORMJUST_GRONK_ITMENUSEARCHSET_MENUSHOW_DETAIL
UPDATE
KEEP.
name
Gibt den Wert an, der gespeichert und zwischen Seiten übergeben werden kann.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
KEY.
attr_name
Entspricht SET.
attr_name
mit der Ausnahme, dass dies eine Suche für
attr_name
angibt, wobei es sich um einen Verweis auf eine andere Tabelle oder ein anderes Objekt handeln muss.
UPDATE
NEXT_PERSID
Gibt die permanente ID des Datensatzes an, der als nächstes angezeigt werden soll.
UPDATE
PERSID
Gibt die permanente ID des anzuzeigenden Datensatzes an. Sie können dies auf eine der folgenden Arten angeben:
Direkt mit einer permanenten ID, die aus einem Herstellernamen, einem Doppelpunkt (:) und einer eindeutigen Datenbank-ID (Ganzzahl) besteht. Beispiel: PERSID=chg:1234 gibt den Change mit der Datenbank-ID 1234 an.
Indirekt mit einer permanenten ID, die aus einem Herstellernamen, einem Doppelpunkt (:), einem Attributnamen, einem zweiten Doppelpunkt (:), und einem Wert besteht. Diese Form von PERSID gibt den Datensatz der angegebenen Factory an, die über ein Attribut des angegebenen Wertes verfügt. Beispiel:PERSID=chg:chg_ref_num:demo:3 gibt den Change mit der Referenznummer demo:3 an.
SHOW_DETAILUPDATE
PRESET
PRESET_REL
Gibt Werte für ein oder mehrere Attribute des Datensatzes an, der als Ergebnis der CREATE_NEW-Variablen erstellt wurde. Wenn CREATE_NEW nicht angegeben ist, wird PRESET ignoriert.
CREATE_NEW
QBE.
op
.
attr_name
Gibt die Werte an, die beim Durchführen einer Suche verwendet werden. Diese Werte werden mit einem QBE-Schlüsselwort identifiziert, wobei
attr_name
einen beliebigen Attributnamen auf einem Ticket identifiziert, der eingerichtet werden kann, und
op
angibt, wo nach dem Attribut zu suchen ist:
EQ ist gleich dem Wert
NE ist ungleich dem Wert
GT ist größer als der Wert
LT ist kleiner als der Wert
GE ist größer als oder gleich dem Wert
LE ist kleiner als oder gleich dem Wert
NU ist null
NN ist nicht null.
IN entspricht dem Ausdruck SQL LIKE
KY enthält den eingegebenen Text
Wenn Sie keine QBE-Variablen definieren, wird das Standardsuchfenster angezeigt.
SEARCH
SET.
attr_name
Gibt einen Attributnamen an, der beim Erstellen eines Tickets verwendet werden soll, wobei
attr_Name
ein beliebiges Attribut in einem Ticket kennzeichnet, das festgelegt werden kann. Die Attributnamen variieren in Abhängigkeit vom zu Grunde liegenden Objekt. Alle Objekte und ihre Attribute sind in den *.maj-Dateien im Majic-Verzeichnis in "bopcfg" zu finden, wie in CA Service Desk Manager-Informationen zu den Referenzbefehlen aufgeführt.
CREATE_NEWUPDATE
SET.
id
Gibt die Datenbank-ID der zu aktualisierenden Zeile an.
UPDATE
SKIPLIST
Wenn diese Variable auf 1 eingestellt ist, wird bei Suchvorgängen mit 1 Treffer keine Ergebnisliste angezeigt. Stattdessen wird das schreibgeschützte Detail direkt angezeigt.
SEARCH
use_template
Wenn diese Variable auf 1 eingestellt ist, gibt der SEARCH-Vorgang eine Liste mit Vorlagen zurück. Die von Ihnen in der Liste ausgewählte Vorlage wird in dem CREATE_NEW-Vorgang verwendet, um einen neuen Datensatz auszufüllen. Diese Variable ist für Changes, Issues und Requests gültig.
CREATE_NEWSEARCH
Syntax von PRESET, PRESET_REL, ALG_PRESET und ALG_PRESET_REL
Die Schlüsselwörter PRESET, PRESET_REL, ALG_PRESET und ALG_PRESET_REL in dem URL geben Anfangswerte für Attribute des Tickets bzw. Aktivitätsprotokolls an. Es gibt zwei mögliche Formate:
  • [ALG_]PRESET=
    attr
    :
    value
    Zeigt an, dass für das angegebene Attribut des Tickets oder Aktivitätsprotokolls der angegebene Wert definiert werden soll. Beispiel: Mit der folgenden Spezifikation wird die Beschreibung des neuen Tickets auf „Hello:“ festgelegt.
    PRESET=description:Hello
  • [ALG_]PRESET_REL=attr:obj.relattr:testattr:value
    Zeigt an, dass für das angegebene Attribut des Tickets oder Aktivitätsprotokolls ein Wert definiert werden soll, der aus einer anderen Datenbanktabelle kopiert wird. Der Wert wird aus dem
    relattr
    -Attribut des
    Objekts
    kopiert, dessen
    testattr
    über den angegebenen
    Wert
    verfügt. Beispiel: Die folgende Spezifikation legt für das analyst-Attribut des neuen Tickets die ID des Kontakts mit der Anwender-ID xyz123 fest:
    PRESET_REL=analyst:cnt.id:userid:xyz123
    Wenn dieses Format verwendet wird, muss die implizierte Abfrage einen einmaligen Datensatz abrufen. Wenn mehrere Kontakte (oder keiner) die Anwender-ID xyz123 aufweisen, hat die Spezifikation PRESET in dem Beispiel keine Auswirkung.
Die Schlüsselwörter PRESET, PRESET_REL, ALG_PRESET und ALG_PRESET_REL können so oft wie gewünscht im URL verfügbar sein, so dass mehrere Attribute eingestellt werden können. Alternativ kann ein einzelner Schlüsselwort-Operand mehrere Werte durch @@ getrennt angeben. Wenn der Separator „@@“ verwendet wird, können Sie Werteformate für die Schlüsselwörter [ALG_]PRESET und [ALG_]PRESET_REL nicht vermischen. Im folgenden Beispiel werden zwei unterschiedliche Arten für die Angabe von Werten für Ticketbeschreibung, -zusammenfassung und -analytiker gezeigt:
PRESET=description:Hello+PRESET=summary:HelloThere+PRESET_REL=analyst:cnt.id:userid:xyz123 PRESET=description:[email protected]@summary:HelloThere+PRESET_REL=analyst:cnt.id:userid:xyz123
Für Requests, Issues, Incidents, Probleme und Changes unterstützen PRESET und PRESET_REL das Schlüsselwortattribut ASSET, um ein Objekt mit einem Asset zu verknüpfen. Das ASSET-Attribut aktualisiert das affected_resource-Attribut eines Request, Incident oder Issue oder die Asset LREL eines Incidents oder eines Change.
Verknüpfungen – Beispiele
Die folgenden Verknüpfungsbeispiele schließen den Pfad zu CA SDM nicht ein. Alle CA SDM-URLs beginnen mit einem Code in folgendem Format:
http:/
/hostname
[:
port
]/CAisd/pdmweb.exe
Dabei entspricht
hostname
dem Namen Ihres Servers und
port
(optional) der Portnummer, wenn Sie Tomcat verwenden. Dieser Code wird in den folgenden URL-Beispielen als eine Ellipse (…) angezeigt:
  • Um einen Request mit einem betroffenen Endanwender mit der Anwender-ID "tooda01" zu erstellen, geben Sie beispielsweise die URL ein:
    ...?OP=CREATE_NEW+FACTORY=cr+PRESET_REL=customer:cnt.id:userid:tooda01
  • Um eine Liste aller Requests von Anwender "tooda01" anzuzeigen, geben Sie beispielsweise folgende URL an:
    ...?OP=SEARCH+FACTORY=cr+QBE.EQ.assignee.userid=tooda01
  • Um das Detailformular für den Request "1234" anzuzeigen, geben Sie beispielsweise folgende URL an:
    ...?OP=SHOW_DETAIL+FACTORY=cr+PERSID=cr:ref_num:1234 (read-only view) ...?OP=UPDATE+FACTORY=cr+PERSID=cr:ref_num:1234 (update view)
Wenn Sie Webservices für die Authentifizierung verwenden, können Sie die Anmeldeaufforderung umgehen. Informationen zur getBopsid()-Methode finden Sie in CA Service Desk Manager-Informationen zu den Referenzbefehlen.