Sitzungen
| CloseSession | Schließt eine Sitzung |
|---|---|
| GetSessionInfo | Ruft Informationen zu einer Sitzung ab |
| IsSessionExists | Prüft, ob eine Sitzung existiert |
| OpenSession | Öffnet eine Sitzung und legt die Rollentypen und die Station fest |
Projekte
| CloseProject | Schließt ein Projekt |
|---|---|
| GetProjects | Ruft eine Liste der auf den Application Server geladenen Projekte ab |
| GetProjectsForUser | Ruft die Datensätze mit den für den Benutzer verfügbaren Projekten ab |
| OpenProject | Öffnet ein Projekt |
Batch Types
| GetAllowedBatchTypes | Ruft eine Liste der verfügbaren Batch-Typen ab |
|---|---|
| GetBatchType | Ruft Informationen zu einem Batch-Typ ab |
| GetBatchTypes | Ruft eine Liste von Batch-Typen ab |
| GetProcessingStages | Ruft erweiterte Informationen zu Verarbeitungsstufen ab |
| HasRightsForBatchType | Prüft, ob die Benutzerrolle Zugriffsberechtigungen für einen bestimmten Batch-Typ hat |
Batches
| AddNewBatch | Fügt einen neuen Batch hinzu und gibt dessen Besitzer an |
|---|---|
| AddNewImage | Fügt einem Batch ein Bild hinzu |
| CloseBatch | Schließt einen Batch (entsperrt ihn) |
| DeleteBatch | Löscht einen Batch |
| GetBatch | Ruft Informationen zu einem Batch ab |
| GetBatches | Ruft Informationen zu Batches in einem Projekt ab |
| GetBatchIdsRange | Reserviert eine Reihe von IDs in einem Batch |
| GetBatchPercentCompleted | Ruft Informationen zur Verarbeitung eines Batches ab |
| GetFilteredBatches | Ruft die gefilterte Liste von Batches gruppenweise von einem Server ab |
| OpenBatch | Öffnet einen Batch (sperrt ihn) |
| ProcessBatch | Startet die Verarbeitung eines Batches |
| UpdateBatch | Aktualisiert den Kopfbereich des Batches |
Aufgaben
| CancelTask | Bricht eine Aufgabe ab |
|---|---|
| CloseTask | Schließt eine Aufgabe |
| CreateTask | Erstellt eine Aufgabe |
| GetAvailableTasks | Ruft die Liste der verfügbaren Aufgaben für den ausgewählten Verarbeitungsstufentyp ab. Ermöglicht es, die Auswahl der verfügbaren Batches einzuschränken. |
| GetAvailableTasksByStageId | Ruft die Liste der verfügbaren Aufgaben für die angegebenen Verarbeitungsstufen ab. Ermöglicht es, die Auswahl der verfügbaren Batches einzuschränken |
| GetAvailableQueues | Ruft die Menge der Datensätze ab, in denen die für den Benutzer verfügbaren Verarbeitungsstufen aufgelistet sind |
| GetCurrentTask | Ruft die ID der Aufgabe ab, die mit der Methode GetTask abgerufen und noch nicht verarbeitet wurde |
| GetPostponedTasks | Ruft eine Liste zurückgestellter Aufgaben ab |
| GetTask | Wählt die Aufgabe mit der höchsten Priorität in den Verarbeitungsstufen des ausgewählten Typs aus und öffnet sie zur Verarbeitung. Ermöglicht es, die Auswahl der verfügbaren Batches einzuschränken. |
| GetTaskByStageId | Wählt die Aufgabe mit der höchsten Priorität in den angegebenen Verarbeitungsstufen aus und öffnet sie zur Verarbeitung |
| GetTaskDocuments | Ruft eine Liste der Dokumente in einer Aufgabe ab |
| GetTaskInfo | Ruft erweiterte Informationen zu einer Aufgabe ab |
| OpenTask | Öffnet eine Aufgabe |
| PostponeTask | Stellt eine Aufgabe zurück |
| SendTask | Sendet die Aufgabe an die angegebene Verarbeitungsstufe |
| SendTaskToException | Sendet eine Aufgabe an Exceptions |
| SetTaskPriority | Ändert die Priorität der Aufgabe |
documents
| AddNewDocument | Fügt ein neues Dokument hinzu und legt zusätzliche Informationen fest |
|---|---|
| AddNewImage | Fügt einem Batch ein Bild hinzu |
| DeleteDocument | Löscht ein Dokument |
| GetDocument | Ruft Informationen über ein Dokument ab |
| GetDocumentResultsList | Ruft eine Liste der Dateien ab, in die die Ergebnisse der Dokumentverarbeitung exportiert wurden |
| GetDocuments | Ruft eine Liste der Dokumente in einem Batch ab |
| LoadDocumentResult | Ruft die Datei ab, in die die Ergebnisse der Dokumentverarbeitung exportiert wurden |
| SetDocumentProperties | Legt Registrierungsparameter für ein Dokument fest |
| SetDocumentPriority | Ändert die Priorität eines Dokuments |
Seiten
| AddNewPage | Fügt einem Dokument ein Seitenbild hinzu und enthält eine Beschreibung |
|---|---|
| DeletePage | Löscht eine Seite aus einem Dokument |
| ReplacePageImage | Ersetzt ein Seitenbild |
Lizenztickets
| GetNewTicket | Ruft ein neues Lizenzticket ab |
|---|---|
| ReleaseTicket | Gibt ein Lizenzticket frei |
| UpdateTicket | Aktualisiert den Status eines Lizenztickets |
Benutzer
| AddUserIfNotExist | Ruft die ID des aktuellen Benutzers ab und erstellt bei Bedarf einen Datenbankeintrag |
|---|---|
| FindUser | Ruft die Benutzer-ID und den Benutzernamen ab |
| GetAvailableQueues | Ruft die Datensätze mit den dem Benutzer verfügbaren Verarbeitungsstufen ab |
| GetAvailableUsers | Ruft eine Liste der Benutzer oder Gruppen ab, die eine angegebene Verarbeitungsstufe bearbeiten dürfen |
| GetProjectsForStationType | Findet Projekte, in denen ein Benutzer mindestens eine Rolle hat, die einem bestimmten Stationstyp zugeordnet ist |
| GetProjectsForUser | Ruft die Datensätze mit den dem Benutzer verfügbaren Projekten ab |
| GetRoles | Ruft die Liste aller Rollen im Projekt ab |
| GetUser | Ruft anhand der Benutzer-ID Informationen über den Benutzer ab |
| GetUserRoles | Ruft die Liste der IDs der Benutzerrollen ab, die dem aktuellen Benutzer im angegebenen Projekt zur Verfügung stehen |
| GetUsers | Ruft die Liste der Benutzer ab |
| GetUserStatistics | Ruft Datensätze mit der Anzahl der Batches, Dokumente und Seiten ab, deren Status in einem bestimmten Zeitraum in „verarbeitet“ geändert wurde |
| HasRightsForBatchType | Prüft, ob die Benutzerrolle Zugriffsberechtigungen für einen bestimmten Batch-Typ hat |
Dateien
| GetCustomFileNames | Ruft eine Liste der auf dem Application Server gespeicherten Benutzerdateien ab |
|---|---|
| LoadCustomFile | Lädt eine Benutzerdatei vom Application Server |
| RemoveCustomFile | Löscht eine Benutzerdatei vom Application Server |
| SaveCustomFile | Speichert eine Benutzerdatei auf dem Application Server |
Anhänge
| GetAttachmentNames | Gibt eine Liste der Anhänge auf dem Application Server zurück |
|---|---|
| LoadAttachment | Lädt einen Anhang vom Application Server |
| RemoveAttachment | Löscht einen Anhang vom Application Server |
| SaveAttachment | Speichert einen Anhang auf dem Application Server |
Dokumentdefinitionen
| GetTemplates | Ruft die Dokumentdefinitionen des Projekts ab |
|---|---|
| GetBatchTypeTemplates | Gibt die Bezeichner der dem Batch-Typ zugeordneten Dokumentdefinitionen zurück |
Protokoll
| WriteToLog | Schreibt Informationen zu Ereignissen in das Protokoll des Application Servers |
|---|
Serveranfragen
| CreateRequest | Erstellt eine Anfrage an den Application Server |
|---|---|
| DeleteRequest | Löscht eine Anfrage an den Application Server. |
| GetRequests | Ruft eine Liste der Anfragen an den Application Server in der aktuellen Sitzung ab |
| GetRequestStatus | Ruft den Status einer Anfrage an den Application Server ab |
| SetRequestStatus | Ändert den Status einer Anfrage an den Application Server |
Sonstiges
| GetSettingValue | Ruft einen benannten Parameter aus der Datenbank ab |
|---|---|
| SetSettingValue | Speichert einen benannten Parameter in der Datenbank |