Services

GetDocumentTaggedFile

GetDocumentTaggedFile
Main
History-Relevant
Rückgabewert
FileId
RET
LONG_NUMERIC_IDENTIFIER
>FILE.FILEID
Parameterliste
ExternalTag
IN
REGULAR_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.EXTERNALTAG
DocumentCategoryNo
INo
LONG_NUMERIC_IDENTIFIER
.. Reload für DocumentCategoryId
Kurzbeschreibung:
Dieser Service retourniert eine FileId oder 0 sofern kein passendes File gefunden worden ist! Gesucht wird das neueste Dokument (Dokument mit der höchsten Dokumentnummer) bei dem der ExternalTag übereinstimmt und welches allenfalls der Dokumentkategorie genügt.
Einschränkungen über ExternalTag sind möglich
Einschränkungen über DocumentCategoryNo (bewusst nicht Id, da von ausserhalb!) sind möglich
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 ExternalTag leer übergeben wird (1)
  • Wenn die Dokumentkategorie über die DocumentCategoryNo nicht gefunden wird (2)
  • Wenn keine relevante Version vorliegt welche zur Ermittlung des File verwendet werden kann (3)
Bemerkungen:
VD: siehe Validator-Fehler
(1): GetDocTaggedFileExtTagMs
(2): GetDocCatNFndByDocCatNo
(3): GetDocVrsFileListRvtVrsNEx
Die relevante Version ist:
  • bei einem ausgecheckten Dokument die CheckoutVersion (sofern CheckoutUserId = Checkout)
  • die Current- oder wenn diese nicht sichtbar ist, die Released-Version des Dokuments