User Tools

Site Tools


standardimport:contract

Vertragsmanagement Import

Der Vertragsmanagement Import kann folgende Daten (zu einem Vertrag) importieren:

  • Vertragselbst
  • Vertrag-CustomAttributes
  • Vertrag Positionen
  • ConfigurationItems für Vertrag Positionen
  • Verantwortliche Benutzer



Derzeit ist es nicht möglich, Dateianhänge zu importieren.

<note important>Dieser Import steht ab Version 5.2 zur Verfügung.</note>

Beispiele

Felder im Import

Tag "serviceLevelAgreement"

Feld-NameDatentypInfoPflichtfeld
idlongDie ID eines Service Level Agreements.
Hinweis: wird nur für bestehende Verträge verwendet.
Entweder id oder number
muss übergeben werden.
numberstringDie “Vertragsnummer” eines VertragesEntweder id oder number
muss übergeben werden.
namestringDer Name des Vertrags.Beim Anlegen: Pflichtfeld
Beim aktualisieren: optional
statusintDer Status eines Service Level Agreements.
Mögliche Werte:
- 0 = “aktiv”
- 1 = “inaktiv”.
Standard-Wert: aktiv.
Optional
startDateDateDas Startdatum des Vertrags. Das Datum muss dem in der Config-Datei angegebenem “dateFormat” entsprechen.Optional
endDateDateDas Enddatum des Vertrags. Das Datum muss dem in der Config-Datei angegebenem “dateFormat” entsprechen.Optional
descriptionstringDie Beschreibung des Vertrags.Optional
companyIdlongDie (1stAnswer-interne) ID der Firma.Beim Anlegen: companyId
oder companyNumber muss
mitgeliefert werden.
Beim aktualisieren: optional
companyNumberstringDie Firmennummer einer Firma.Beim Anlegen: companyId
oder companyNumber muss
mitgeliefert werden.
Beim aktualisieren: optional
mandatorlongDie ID eines Mandanten. Das Service Level Agreement wird in diesem Mandanten angelegt.Beim anlegen: Pflichtfeld.
Beim aktualisieren: optional.
attributes-Eine Liste von CustomAttributes.
Siehe Abschnitt: Tag "serviceLevelAgreement"
Optional
positions-Eine Liste von Vertrag-Positionen.
Siehe Abschnitt: Tag "position"
Optional
responsibles-Eine Liste von Verantwortlichen.
Siehe Abschnitt: Tag "responsible" (verantwortlicher Benutzer)
Optional



Tag "attribute" (CustomAttribute)

Der XML-Tag “attribute” hat ein Attribut mit dem Namen “name”.
Der Wert dieses “name-Attributs” muss mit dem Wert einer der “attribute”-Tags aus der CustomAttributeConfig.xml übereinstimmen.

Der Inhalt des Tags ist der Wert des CustomAttributes in der Applikation.

Tag "position"

<note important>Wenn der “positions”-Tag (der Vater-Knoten eines “position”-Knotens) mitgeliefert wird (egal ob dieser leer ist oder nicht) gilt folgende Regel:
Es müssen alle Positionen angegeben werden, die entweder erstellt oder beibehalten werden sollen.
Bereits (z.B. über die Oberfläche angelegte) existierende Positionen die dem Import nicht mitgeliefert werden, werden gelöscht. Bei existierenden Positionen genügt es, entweder die “id” oder die “number” anzugeben, damit die Position nicht gelöscht wird. </note>

Felder:

Feld-NameDatentypInfoPflichtfeld
idlongDie (1stAnswer-interne) ID einer Vertrags-Position.Entweder id oder number
muss übergeben werden.
numberstringDie Positionsnummer einer Vertrags-Position.Entweder id oder number
muss übergeben werden.
namestringDer Name des Vertrags-Position.Beim Anlegen: Pflichtfeld
Beim aktualisieren: optional
statusintDer Status der Position.
Verfügbare Werte:
- 0 = “aktiv”
- 1 = “gelöscht” (in der Oberfläche nicht mehr sichtbar)
Der Standard-Wert ist “aktiv”.
Optional
priorityGrouplongDie (1stAnswer-interne) ID einer Prioritätsgruppe.Optional
prioritylongDie (1stAnswer-interne) ID einer Priorität.Optional
configurationItems-Eine Liste von ConfigurationItems. Siehe Abschnitt Tag "configurationItem" (ConfigurationItem für eine Vertrags-Position)Optional



Tag "configurationItem" (ConfigurationItem für eine Vertrags-Position)

<note important>Wenn der “configurationItems”-Tag (der Vater-Knoten eines “configurationItem”-Knotens) mitgeliefert wird (egal ob dieser leer ist oder nicht) gilt folgende Regel:
Es müssen alle ConfigurationItems angegeben werden, die für die jeweilige Vertrags-Position gültig sind.
Bereits (z.B. über die Oberfläche angelegte) existierende ConfigurationItem-Verknüpfungen die nicht mitgeliefert werden, werden gelöscht. </note>

  • id: Die ID (= die 1stAnswer “interne Datenbank-ID”) eines ConfigurationItems. Diese ist im Importfile (servicelevelagreements.xml) nicht zwingend erforderlich.
  • boConfigurationItemId: Die in der Oberfläche sichtbare ID eines ConfigurationItems.

<note> Um ein CI mit einer Postion zu verknüpfen müssen Sie eine der beiden Optionen im Import liefern. </note>

Tag "responsible" (verantwortlicher Benutzer)

<note important>Wenn der “responsibles”-Tag (der Vater-Knoten eines “responsible”-Knotens) mitgeliefert wird (egal ob dieser leer ist oder nicht) gilt folgende Regel:
Es müssen alle Benutzer angegeben werden, die als Verantwortliche des Vertrages eingetragen werden sollen.
Bereits (z.B. über die Oberfläche angelegte) existierende Verantwortlichen-Verknüpfungen die nicht mitgeliefert werden, werden gelöscht. </note>

Eines der folgenden Felder muss angegeben werden:

  • id: Die (1stAnswer-interne) ID eines Benutzers.
  • externalContactNumber: Die Ansprechpartnernummer eines Benutzers.

Zuerst wird nach der “ID” des Benutzers gesucht.
Wenn das Feld nicht mitgeliefert wird oder wenn kein Benutzer mit der angegebenen ID gefunden wird, wird nach einen Benutzer mit der mitgelieferten Ansprechpartnernummer gesucht.


Dateianhänge

<note important>Derzeit ist es nicht möglich Dateianhänge zu importieren.</note>

Konfiguration

Import-Dateien

Alle Dateien im konfigurierten Import-Verzeichnis (in der Config-Datei “importDir”), auf die der Datei-Filter (“importFileMask” - z.B: “*.xml”) zutrifft werden verarbeitet.

Nach dem Importieren werden die Dateien in das (“archiveDir”) Archiv-Verzeichnis verschoben.

Datums-Format

Das Datums-Format ist (in der Config-Datei “dateFormat”) konfigurierbar.
Dabei können sämtliche von .NET zur Verfügung stehenden Format-Platzhalter verwendet werden.
Siehe hierzu: Custom Date and Time Format Strings und Benutzerdefinierte und DateTime-Formatzeichenfolgen

Status E-Mail

Nach dem Import wird an alle konfigurierten Mail-Adressen (“to” und “bcc”) eine Status-Email (über den unter “smtpServer” angegebenen Mail-Server) verschickt.
Der Absender der Mail (“from”), Betreff der Mail (“subject”) und der Inhalt (“mailBodyPrefix” und “mailBodySuffix”) können ebenfalls konfiguriert werden.
Die Email enthält Informationen zu den Importierten Datensätzen (Fehler, Warnungen etc.)

Damit die Email richtig versendet werden kann, muss der Log-Pfad (“logFilePath” - sollte auf die Datei “ServiceLevelAgreementImportUserLog.log” verweisen) konfiguriert werden.
Der Inhalt dieser Datei wird zwischen “mailBodyPrefix” und “mailBodySuffix” geschrieben.

CustomAttribute-Zuordnung

Der Pfad zur Zuordnungs-Datei muss eingestellt werden (“customAttributeConfigFilePath”).
Diese Datei hat folgenden Aufbau (inkl. Beispiel):

<?xml version="1.0" encoding="UTF-8" ?>
<customAttributes>
	<servicelevelagreement>
            <attribute name="attribute1">23</attribute>
	</servicelevelagreement>
</customAttributes>


Hier bekommt das CustomAttribute mit der ID 23 und dem Geschäftsobjekt ServiceLevelAgreement den Namen attribute1.
Der Import kann dann folgendermaßen einen Wert für das CustomAttribute (im jeweils aktuellen Vertrag vergeben):

<?xml version="1.0" encoding="UTF-8"?>
<serviceLevelAgreements>
	<serviceLevelAgreement>
		...
		<attributes>
			<attribute name="attribute1">Beispiel-Wert Eins</attribute>
...



Weitere Informationen

  • Bei bestehenden Daten, werden Felder nur aktualisiert, wenn diese auch in der Import-Datei mitgegeben werden.
    Es wird zum Beispiel der Name eines Vertrages nicht auf einen leeren Wert gesetzt, nur weil das “name”-Feld beim aktualisieren nicht übergeben wurde.
  • Pro importiertem Datensatz muss ein Wert übergeben werden, mit dem das jeweilige Objekt identifiziert werden kann (z.B. ID oder ähnliches).
  • Felder die als “optional” markiert wurden, können leer gelassen werden. Es ist auch beim erstellen nicht notwendig diese Felder mit Werten zu füllen.
standardimport/contract.txt · Last modified: 2011/03/08 16:15 (external edit)