Services

AddDocument

AddDocument
Main
History-Relevant
Rückgabewert
DocumentId
RET
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.DOCUMENTID
Parameterliste
NamedValueArray
IN*
NamedValue[]
  
Owner
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.OWNER
VisibilityCd
INo
Enum: Visibility
>DOCUMENT.VISIBILITYCD
Description
INo
EXTRALONG_STRING
>DOCUMENT.DESCRIPTION
Remark
INo
EXTRALONG_STRING
>DOCUMENT.REMARK
Title
INo*
REGULAR_STRING
>DOCUMENT.TITLE
Subtitle
INo
REGULAR_STRING
>DOCUMENT.SUBTITLE
LangShortCut
INo
SHORT_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.LANGSHORTCUT
Author
INo
REGULAR_STRING
>DOCUMENT.AUTHOR
ExternalTag
INo
LONG_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.EXTERNALTAG
MofSyncID
INo
REGULAR_STRING
>DOCUMENT.MOFSYNCID
DocumentTS
INo
REGULAR_DATE
>DOCUMENT.DOCUMENTTS
RetentionPeriod
INo
SHORT_NUMERIC_IDENTIFIER
>DOCUMENT.RETENTIONPERIOD 0..99
ValidUntilTS
INo
REGULAR_DATE
>DOCUMENT.VALIDUNTILTS
SecurityZoneId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.SECURITYZONEID
DocumentCategoryId
INo*
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.DOCUMENTCATEGORYID
FolderId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.FOLDERID
MediaBaseTypeId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.MEDIABASETYPEID
Template
INo
BOOLEAN
>DOCUMENT.TEMPLATE
Free01..Free03
INo
SHORT_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.FREE01..FREE03
Free04..Free09
INo
SHORT_STRING
>DOCUMENT.FREE04..FREE09
Free10..Free28
INo
REGULAR_STRING
>DOCUMENT.FREE10..FREE28
Free29..Free30
INo
EXTRALONG_STRING
>DOCUMENT.FREE29..FREE30
AutoVersRef
INo
REGULAR_STRING
>DOCUMENT.AUTOVERSREF
SourceCd
INo
Enum: DocumentSource
>DOCUMENT.SOURCECD
RefSessionId
INo
REGULAR_STRING
>DOCUMENT.REFSESSIONID
RefSessionExpTS
INo
REGULAR_TIMESTAMP
>DOCUMENT.REFSESSIONEXPTS
TemplateId
IN
LONG_NUMERIC_IDENTIFIER
DOCUMENTID des Template
ReturnStruct
IN
Boolean
Struktur-Rückgabe erwünscht?
Struct
OUT
Document (Struct)
  
Kurzbeschreibung:
Dieser Service erstellt einen neuen Eintrag in die Tabelle DOCUMENT sowie in die Tabelle VERSION.
(Ist TemplateId ungleich 0 so wird dieses Dokument als Basis für die Erstellung des neuen Dokuments verwendet. In dem Fall sind auch der Titel und die Dokumentkategorie nicht zwingend da auch dies vom Template-Dokument übernommen wird).
Fehlerhandling/Plausibilisierung:
Generell gelten die Regeln (PK, AK, FK, Unique, NotNull) der Datenbank. Die zusätzlichen Fehler sind:
  • Aufgrund von Validator-Prüfungen (VD)
  • Wenn das Template nicht exisitert (1)
  • Wenn die DocumentCategory nicht existiert (2)
  • Wenn die DocumentCategory inaktiv ist (3)
  • Wenn die SecurityZone nicht existiert (4)
  • Wenn die SecurityZone inaktiv ist (5)
  • Wenn der Folder nicht existiert, oder aber hinter dem Defined User leer ist (6)
  • Wenn der Folder inaktiv ist (7)
  • Wenn der Medienbasistyp nicht existiert (8)
  • Wenn der Medienbasistyp inaktiv ist (9)
  • Wenn die Medienverwaltung nicht lizenziert ist, aber dennoch versucht wird einen Medienbasistyp zu verknüpfen (10)
  • Wenn der Owner als User nicht exisiert (11)
  • Wenn der Owner inaktiv ist (12)
  • Wenn die Version nicht erzeugt werden kann (13)
  • Wenn die Datei-Gefässe der MediaSubTypes mit Erstellungstyp AUTOMATIC nicht erzeugt werden können (14)
  • Wenn über die SecurityZone keine Create-Berechtigung vorliegt (15)
  • Wenn die ExternalTag eindeutig sein muss, es aber nicht ist (16)
  • Wenn die MofSyncId nicht eindeutig ist (17)
Hinweis:
AutoVersRef wird vom Agent für die AutoVersionierung benutzt und sollte NICHT manuell genutzt werden!
Bemerkungen:
VD: siehe Validator-Fehler
(1): AddDocTempNEx
(2): AddDocAsgDocCatNEx
(3): AddDocAsgDocCatIsIn
(4): AddDocAsgSecZoneNEx
(5): AddDocAsgSecZoneIsIn
(6): AddDocAsgFdrNEx
(7): AddDocAsgFdrIsIn
(8): AddDocAsgMdaBaseTypeNEx
(9): AddDocAsgMdaBaseTypeIsIn
(10): AddDocMdaBaseTypeNWhtMdaOpn
(11): AddDocAsgOwnerNEx
(12): AddDocAsgOwnerIsIn
(13): AddDocVrsNCreated
(14): AddDocFilesNCreated
(15): AddDocInsuffPriv
(16): AddDocExtTagNUq
(17): AddDocMofSyncIdNUq
Defaultwerte:
  • Owner: ContextUserId
  • VisibilityCd: PERSONAL
  • LangShortCut: leer
  • Template: false
  • DocumentTS: Tagesdatum ..ab Version V15.10
  • SecurityZoneId: (ab DocumentCategory)
  • FolderId: (ab DocumentCategory)
  • RetentionPeriod: (ab DocumentCategory)
  • CreatorPass: 1 (sofern der Creator über das Admin-Recht auf der Sicherheitszone verfügt!)
  • AutoVersRef: leer
  • SourceCd : NOT_SPECIFIED
  • UniqueFileNames: (ab DocumentCategory)
Defaultwerte (wenn ab Template erstellt):
  • Owner: ContextUserId
  • AutoVersRef: leer
  • SourceCd : NOT_SPECIFIED
  • Template: false
  • VisibilityCd: (ab Template)
  • LangShortCut: (ab Template)
  • Description: (ab Template)
  • Remark: (ab Template)
  • Title: (ab Template)
  • Subtitle: (ab Template)
  • Author: (ab Template)
  • DocumentTS: (ab Template) ..bis vor Version V15.10
  • ValidUntilTS: (ab Template)
  • DocumentCategoryId: (ab Template)
  • Free01..Free30: (ab Template)
  • MediaBaseTypeId: (ab Template)
  • SecurityZoneId: (ab DocumentCategory von Template)
  • FolderId: (ab DocumentCategory von Template)
  • RetentionPeriod: (ab DocumentCategory von Template)
  • CreatorPass: 1 (sofern der Creator über das Admin-Recht auf der Sicherheitszone verfügt!)
  • UniqueFileNames: (ab DocumentCategory von Template)