Services

AddExternalJob

AddExternalJob
Admin
  
Rückgabewert
ExternalJobId
RET
LONG_NUMERIC_IDENTIFIER
>EXTERNALJOB.EXTERNALJOBID
Parameterliste
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
WithoutStorage
INo
Boolean
>EXTERNALJOB.WITHOUTSTORAGE
ReturnStruct
IN
Boolean
Struktur-Rückgabe erwünscht?
Struct
OUT
ExternalJob (Struct)
  
Kurzbeschreibung:
Dieser Service erstellt einen neuen Eintrag in die Tabelle EXTERNALJOB.
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 verknüpfte Dokument nicht existiert (1)
  • Wenn die verknüpfte Dokumentkategorie nicht existiert (2)
  • Wenn das verknüpfte Archiv-Storage nicht exisitiert (3)
  • Wenn das verknüpfte Archiv-Storage nicht vom Typ ARCHIVE ist (4)
  • Wenn das verknüpfte externe Storage nicht existiert (5)
  • Wenn das verknüpfte externe Storage nicht vom Typ EXTERNAL ist (6)
  • Wenn das verknüpfte Recovery-Working-Storage nicht existiert (7)
  • Wenn das verknüpfte Recovery-Working-Storage nicht vom Typ WORKING ist (8)
  • Wenn das verknüpfte Recovery-Archiv-Storage nicht existiert (9)
  • Wenn das verknüpfte Recovery-Archiv-Storage nicht vom Typ ARCHIVE ist (10)
  • Wenn ‚EXPORT’ ohne ein externes Storage versucht wird (11)
  • Wenn ‚EXPORT’ mit einem externen Storage versucht wird, welches den Status ‚DESTROYED’ besitzt (12)
  • Wenn ‚RELEASE_ARCHIVE’ oder ‚RELEASE_EXTERNAL’ ohne entsprechendes Storage versucht wird (13)
  • Wenn ‚RELEASE_ARCHIVE’ oder ‚RELEASE_EXTERNAL’ mit einem Storage versucht wird, welches nicht den Status ‚DESTROYED’ besitzt (14)
  • Wenn ‚RECOVER’ ohne ein externes Storage versucht wird (15)
  • Wenn ‚RECOVER’ mit einem externen Storage versucht wird, welches den Status ‚DESTROYED’ besitzt (16)
  • Wenn WithoutStorage = true gesetzt ist und der ExternalJobType nicht ‚REMOVE’ ist (17)
  • Wenn ‚REMOVE’ mit WithoutStorage = true und ArchiveStorageId oder ExternalStorageId angegeben wird (18)
  • Wenn ‚REMOVE’ mit WithoutStorage = false und das angegebene ArchiveStorageId ‚DESTROYED’ ist (19)
  • Wenn ‚REMOVE’ mit WithoutStorage = false und das angegebene ExternalStorageId ‚DESTROYED’ ist (20)
  • Wenn ‚REMOVE’ mit WithoutStorage = false und das MaxRetentionOverTS nicht angegeben ist (21)
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): AddExtJobAsgDocNEx
(2): AddExtJobAsgDocCatNEx
(3): AddExtJobAsgArcStrgNEx
(4): AddExtJobAsgArcStrgWrongType
(5): AddExtJobAsgExtStrgNEx
(6): AddExtJobAsgExtStrgWrongType
(7): AddExtJobAsgRecWrkStrgNEx
(8): AddExtJobAsgRecWrkStrgWrongType
(9): AddExtJobAsgRecArcStrgNEx
(10): AddExtJobAsgRecArcStrgWrongType
(11): ModExtJobExpBlkNoStrg
(12): ModExtJobExpBlkStrgDestr
(13): ModExtJobRsBlkNoStrg
(14): ModExtJobRsBlkStrgNDestr
(15): ModExtJobRecBlkNoStrg
(16): ModExtJobRecBlkStrgDestr
(17): ModExtJobBlkWhtStrgTrue
(18): ModExtJobRemBlkWhtStrg
(19): ModExtJobRemBlkDestrArcStrg
(20): ModExtJobRemBlkDestrExtStrg
(21): ModExtJobRemBlkMaxRetenOverTSMs
Defaultwerte:
  • JobTypeCd: EXPORT
  • JobStateCd: ENTERED (internal)
  • ExternalJobTS: null (internal)
  • RecoverForMandant: false [nur für RECOVER verwendet: Mandanten-Prüfung beim Recovery?]
  • RecoverUserAssigns: false [nur für RECOVER verwendet: User-Verknüpfungen wiederherstellen?]
  • RecoverDocumentLinks: false [nur für RECOVER verwendet: DocumentLinks wiederherstellen?]
  • RecoverWorkingStorageId: 0 [nur für RECOVER verwendet: WorkingStorage bei autom. neu DocCategory]
  • RecoverArchiveStorageId: 0 [nur für RECOVER verwendet: ArchiveStorage bei autom. neu DocCategory]