ModifyDocument

ModifyDocument
Main
History-Relevant
Rückgabewert
DocumentId
RET
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.DOCUMENTID
Parameterliste
DocumentId
IN
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.DOCUMENTID
NamedValueArray
INo
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
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
FolderId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.FOLDERID
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
MediaBaseTypeId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.MEDIABASETYPEID
ExcludeFromIndex
INo
BOOLEAN
>DOCUMENT.EXCLUDEFROMINDEX
ReturnStruct
IN
Boolean
Struktur-Rückgabe erwünscht?
Struct
OUT
Document (Struct)
 
Kurzbeschreibung:
Dieser Service verändert einen bestehenden Eintrag in der Tabelle DOCUMENT.
(Key: DocumentId)
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 Document über die DocumentId nicht gefunden wird (1)
  • Wenn die SecurityZone über SecurityZoneId nicht gefunden wird (2)
  • Wenn die SecurityZone inaktiv ist (3)
  • Wenn der Folder über FolderId nicht gefunden wird, oder aber hinter dem Defined User leer ist (4)
  • Wenn der Folder inaktiv ist (5)
  • Wenn der Owner als User nicht existiert (6)
  • Wenn der Owner inaktiv ist (7)
  • Wenn für die SecurityZone keine Modify-Berechtigung vorliegt (8) **
  • Wenn das Dokument bereits ausgecheckt ist, dies aber nicht von diesem ContextUser (9)
  • Wenn versucht wird den DocumentStateCd über diese Methode zu setzen (10)
  • Wenn versucht wird den AutoPostProcessingStateCd über diese Methode zu setzen (11)
  • Wenn versucht wird den ManualPostProcessingStateCd über diese Methode zu setzen (12)
  • Wenn der Owner geändert werden möchte, die nötige Berechtigung dazu aber fehlt (11)
  • Wenn die Visibility geändert werden möchte, die nötige Berechtigung dazu aber fehlt (12)
  • Wenn ExcludeFromIndex geändert werden möchte, die nötige Berechtigung dazu aber fehlt (13)
  • Wenn der Archivierungsstatus auf ‚PENDING’, ‚PROCESSING’ oder ‚ARCHIVED’ steht; sich das Dokument also bereits in der Archivierung befindet oder bereits archiviert ist und versucht wird Attribute zu ändern welche in diesem Zustand logisch gesperrt sind (14) ***
  • Wenn der Archivierungsstatus auf ‚INITIATED’ steht und der ArchivePendingTS bereits verstrichen ist (15)
  • Wenn die ExternalTag eindeutig sein müsste, es aber nicht ist (16)
  • Wenn der Medienbasistyp gesetzt werden möchte, der Medienbasistyp aber nicht existiert (17)
  • Wenn der Medienbasistyp gesetzt werden möchte, der Medienbasistyp aber inaktiv ist (18)
  • Wenn der Medienbasistyp gesetzt werden möchte, bereits aber ein Medienbasistyp verknüpft ist (19)
  • Wenn der Medienbasistyp entfernt werden möchte (20)
  • Wenn die Medienverwaltung nicht lizenziert ist, aber dennoch versucht wird den Medienbasistyp zu verändern (21)
Notiz
Notiz
AutoVersRef wird vom Agent für die AutoVersionierung benutzt und sollte nicht manuell genutzt werden.
SourceCd wird für die OutlookAddOn-Erkennung benutzt und sollte nicht manuell genutzt werden.
Bemerkungen:
(1): ModDocNEx
(2): ModDocAsgSecZoneNEx
(3): ModDocAsgSecZoneIsIn
(4): ModDocAsgFdrNEx
(5): ModDocAsgFdrIsIn
(6): ModDocAsgOwnerNEx
(7): ModDocAsgOwnerIsIn
(8): ModDocInsuffPriv
(9): ModDocCheckoutUsrMsm
(10): ModDocStateUpdBlkWrongSrv
(11): ModDocAutoPostProcUpdBlkWrongSrv
(12): ModDocManualPostProcUpdBlkWrongSrv
(13): ModDocOwnerUpdBlkInsuffPriv
(14): ModDocVisUpdBlkInsuffPriv
(15): ModDocExclFromIdxUpdBlkInsuffPriv
(16): ModDocUpdBlkWrongArcState
(17): ModDocUpdBlkOutdatedArcState
(18): ModDocExtTagUpdBlkNUq
(19): ModDocAsgMdaBaseTypeNEx
(20): ModDocAsgMdaBaseTypeIsIn
(21): ModDocAsgMdaBaseTypeNCha
(22): ModDocAsgMdaBaseTypeNRem
(23): ModDocMdaBaseTypeNWhtMdaOpn
** Handelt es sich um ein Dokument im Archivierungsstatus „INITIATED“ so wird zusätzlich das Admin-Recht auf der Sicherheitszone benötigt!
*** Logisch gesperrt werden mit der Archivierung die Attribute: Title, Subtitle, Description, DocumentTS, Author, SourceCd, LangShortCut, ExternalTag, Free01..Free30 und Remark