Services

ModifyExternalJob

ModifyExternalJob
Admin
  
Rückgabewert
ExternalJobId
RET
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.EXTERNALJOBID
Parameterliste
ExternalJobId
IN
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.EXTERNALJOBID
NamedValueArray
INo
NamedValue[]
  
DocumentId
INo
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.DOCUMENTID
DocumentCategoryId
INo
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.DOCUMENTCATEGORYID
ArchiveStorageId
INo
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.ARCHIVESTORAGEID
ExternalStorageId
INo
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.EXTERNALSTORAGEID
MinCreatedTS
INo
RegularTimestamp
>EXTERNALJOB.MINCREATEDTS
MaxCreatedTS
INo
RegularTimestamp
>EXTERNALJOB.MAXCREATEDTS
MinArchivedTS
INo
RegularTimestamp
>EXTERNALJOB.MINARCHIVEDTS
MaxArchivedTS
INo
RegularTimestamp
>EXTERNALJOB.MAXARCHIVEDTS
MinValidUntilTS
INo
RegularTimestamp
>EXTERNALJOB.MINVALIDUNTILTS
MaxValidUntilTS
INo
RegularTimestamp
>EXTERNALJOB.MAXVALIDUNTILTS
MinRetentionOverTS
INo
RegularTimestamp
>EXTERNALJOB.MINRETENTIONOVERTS
MaxRetentionOverTS
INo
RegularTimestamp
>EXTERNALJOB.MAXRETENTIONOVERTS
RecoverForMandant
INo
Boolean
>EXTERNALJOB. RECOVERFORMANDANT
RecoverUserAssigns
INo
Boolean
>EXTERNALJOB. RECOVERUSERASSIGNS
RecoverDocumentLinks
INo
Boolean
>EXTERNALJOB. RECOVERDOCUMENTLINKS
RecoverWorkingStorageId
INo
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB. RECOVERWORKINGSTORAGEID
RecoverArchiveStorageId
INo
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.RECOVERARCHIVESTORAGEID
JobTypeCd
INo
Enum: ExternalJobType
>EXTERNALJOB.JOBTYPECD
ReturnStruct
IN
Boolean
Struktur-Rückgabe erwünscht?
Struct
OUT
ExternalJob (Struct)
  
Kurzbeschreibung:
Dieser Service verändert einen bestehenden Eintrag in die Tabelle EXTERNALJOB.
Veränderungen sind nur auf Einträgen mit Status ‚ENTERED’ erlaubt!
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 der ExternalJob über die ExternalJobId nicht gefunden wird (1)
  • Wenn sich der ExternalJob nicht mehr im Status ‚ENTERED’ befindet (2)
  • Wenn das verknüpfte Dokument nicht existiert (3)
  • Wenn die verknüpfte Dokumentkategorie nicht existiert (4)
  • Wenn das verknüpfte Archiv-Storage nicht exisitiert (5)
  • Wenn das verknüpfte Archiv-Storage nicht vom Typ ARCHIVE ist (6)
  • Wenn das verknüpfte externe Storage nicht existiert (7)
  • Wenn das verknüpfte externe Storage nicht vom Typ EXTERNAL ist (8)
  • Wenn das verknüpfte Recovery-Working-Storage nicht existiert (9)
  • Wenn das verknüpfte Recovery-Working-Storage nicht vom Typ WORKING ist (10)
  • Wenn das verknüpfte Recovery-Archiv-Storage nicht existiert (11)
  • Wenn das verknüpfte Recovery-Archiv-Storage nicht vom Typ ARCHIVE ist (12)
  • Wenn versucht wird den JobStatus über diese Methode zu verändern (13)
  • Wenn ‚EXPORT’ ohne ein externes Storage versucht wird (14)
  • Wenn ‚EXPORT’ mit einem Storage versucht wird, welches den Status ‚DESTROYED’ besitzt (15)
  • Wenn ‚RELEASE_ARCHIVE’ oder ‚RELEASE_EXTERNAL’ ohne entsprechendes Storage versucht wird (16)
  • Wenn ‚RELEASE_ARCHIVE’ oder ‚RELEASE_EXTERNAL’ mit einem Storage versucht wird, welches nicht den Status ‚DESTROYED’ besitzt (17)
  • Wenn ‚RECOVER’ ohne ein externes Storage versucht wird (18)
  • Wenn ‚RECOVER’ mit einem Storage versucht wird, welches den Status ‚DESTROYED’ besitzt (19)
  • Wenn WithoutStorage = true gesetzt ist und der ExternalJobType nicht ‚REMOVE’ ist (20)
  • Wenn ‚REMOVE’ mit WithoutStorage = true und ArchiveStorageId oder ExternalStorageId angegeben wird (21)
  • Wenn ‚REMOVE’ mit WithoutStorage = false und das angegebene ArchiveStorageId ‚DESTROYED’ ist (22)
  • Wenn ‚REMOVE’ mit WithoutStorage = false und das angegebene ExternalStorageId ‚DESTROYED’ ist (23)
  • Wenn ‚REMOVE’ mit WithoutStorage = false und das MaxRetentionOverTS nicht angegeben ist (24)
Dass beim ‚REMOVE’ nicht aus Versehen alle Dokumente mit RetentionOverTS <= now aus dem System entfernt werden, wird explizit das MaxRetentionOverTS verlangt!
Bemerkungen:
VD: siehe Validator-Fehler
(1): ModExtJobNEx
(2): ModExtJobBlkWrongState
(3): ModExtJobAsgDocNEx
(4): ModExtJobAsgDocCatNEx
(5): ModExtJobAsgArcStrgNEx
(6): ModExtJobAsgArcStrgWrongType
(7): ModExtJobAsgExtStrgNEx
(8): ModExtJobAsgExtStrgWrongType
(9): ModExtJobAsgRecWrkStrgNEx
(10): ModExtJobAsgRecWrkStrgWrongType
(11): ModExtJobAsgRecArcStrgNEx
(12): ModExtJobAsgRecArcStrgWrongType
(13): ModExtJobStateUpdBlkWrongSrv
(14): ModExtJobExpBlkNoStrg
(15): ModExtJobExpBlkStrgDestr
(16): ModExtJobRsBlkNoStrg
(17): ModExtJobRsBlkStrgNotDestr
(18): ModExtJobRecBlkNoStrg
(19): ModExtJobRecBlkStrgDestr
(20): ModExtJobBlkWhtStrgTrue
(21): ModExtJobRemBlkWhtStrg
(22): ModExtJobRemBlkDestrArcStrg
(23): ModExtJobRemBlkDestrExtStrg
(24): ModExtJobRemBlkMaxRetenOverTSMs