Sesiones
| Método | Descripción |
|---|---|
| CloseSession | Cierra una sesión |
| GetSessionInfo | Obtiene información de una sesión |
| IsSessionExists | Comprueba si existe una sesión |
| OpenSession | Abre una sesión y especifica los tipos de rol y la estación |
| OpenSessionEx | Abre una sesión (versión extendida de OpenSession) |
Proyectos
| Método | Descripción |
|---|---|
| CloseProject | Cierra un proyecto |
| GetProjects | Obtiene una lista de proyectos cargados en el Application Server |
| GetProjectsForUser | Obtiene el conjunto de registros con la lista de proyectos disponibles para el usuario |
| OpenProject | Abre un proyecto |
Tipos de lote
| Método | Descripción |
|---|---|
| GetAllowedBatchTypes | Obtiene una lista de los tipos de lote disponibles |
| GetBatchType | Obtiene información sobre un tipo de lote |
| GetBatchTypes | Obtiene una lista de tipos de lote |
| GetProcessingStages | Obtiene una lista de etapas de procesamiento |
| GetProcessingStagesExt | Obtiene información ampliada sobre las etapas de procesamiento |
| HasRightsForBatchType | Comprueba si el rol del usuario tiene permisos de acceso a un tipo de lote determinado |
Lotes
| Método | Descripción |
|---|---|
| AddNewBatch | Añade un nuevo lote y especifica su propietario |
| AddNewBatchExt | Añade un nuevo lote y especifica su propietario (versión extendida de AddNewBatch) |
| AddNewImage | Añade una imagen a un lote |
| CloseBatch | Cierra (desbloquea) un lote |
| DeleteBatch | Elimina un lote |
| GetBatch | Obtiene información sobre un lote |
| GetBatches | Obtiene información sobre los lotes de un proyecto |
| GetBatchesExt | Obtiene información sobre los lotes de un proyecto (versión extendida de GetBatches) |
| GetDetailedBatch | Obtiene información detallada sobre un lote |
| GetDetailedBatches | Obtiene información detallada sobre los lotes de un proyecto |
| GetDetailedBatches2 | Obtiene información detallada sobre los lotes disponibles para un usuario |
| GetBatchIdsRange | Reserva un conjunto de ID en un lote |
| GetBatchPercentCompleted | Obtiene información sobre el procesamiento de un lote |
| GetFilteredBatches | Obtiene del servidor la lista filtrada de lotes en grupos |
| OpenBatch | Abre (bloquea) un lote |
| ProcessBatch | Inicia el procesamiento de un lote |
| UpdateBatch | Actualiza el encabezado del lote |
Tareas
| Método | Descripción |
|---|---|
| CancelTask | Cancela una tarea |
| CloseTask | Cierra una tarea |
| CloseTaskEx | Devuelve una tarea para su posterior procesamiento (versión extendida de CloseTask) |
| CreateTask | Crea una tarea |
| GetAvailableTasks | Obtiene la lista de tareas disponibles para el tipo de etapa seleccionado. Permite restringir el conjunto de lotes disponibles. |
| GetAvailableTasksExt | Obtiene la lista de tareas disponibles para un tipo de etapa (versión extendida) |
| GetAvailableTasksByStageId | Obtiene la lista de tareas disponibles para las etapas de procesamiento especificadas. Permite restringir el conjunto de lotes disponibles |
| GetAvailableTasksByStageIdExt | Obtiene la lista de tareas disponibles para las etapas de procesamiento especificadas (versión extendida) |
| GetAvailableQueues | Obtiene el conjunto de registros que contiene las etapas de procesamiento disponibles para el usuario |
| GetCurrentTask | Obtiene el ID de la tarea obtenida con el método GetTask y que aún no se ha procesado |
| GetPostponedTasks | Obtiene una lista de tareas aplazadas |
| GetTask | Selecciona la tarea de mayor prioridad en las etapas de procesamiento del tipo seleccionado y la abre para su procesamiento. Permite restringir el conjunto de lotes disponibles. |
| GetTaskExt | Selecciona y abre la tarea de mayor prioridad (versión extendida de GetTask) |
| GetTaskByStageId | Selecciona la tarea de mayor prioridad en las etapas de procesamiento especificadas y la abre para su procesamiento |
| GetTaskByStageIdExt | Selecciona y abre la tarea de mayor prioridad en las etapas especificadas (versión extendida) |
| GetTaskDocuments | Obtiene una lista de documentos de una tarea |
| GetTaskInfo | Obtiene información sobre una tarea |
| GetTaskInfoExt | Obtiene información detallada sobre una tarea |
| OpenTask | Abre una tarea |
| PostponeTask | Aplaza una tarea |
| SendTask | Envía la tarea a la etapa de procesamiento especificada |
| SendTaskToException | Envía una tarea a Excepciones |
| SetTaskPriority | Cambia la prioridad de la tarea |
Documentos
| Método | Descripción |
|---|---|
| AddNewDocument | Añade un documento nuevo y especifica información adicional |
| AddNewDocumentEx | Añade un documento desde un archivo de imagen (versión extendida de AddNewDocument) |
| AddNewEmptyDocument | Añade un documento vacío a un lote |
| AddNewImage | Añade una imagen a un lote |
| DeleteDocument | Elimina un documento |
| GetDocument | Obtiene información sobre un documento |
| GetDocument2 | Obtiene información sobre un documento (versión extendida de GetDocument) |
| GetDocumentResultsList | Obtiene una lista de los archivos a los que se exportaron los resultados del procesamiento de documentos |
| GetDocuments | Obtiene una lista de documentos de un lote |
| GetDocuments2 | Obtiene una lista de documentos de un lote (versión extendida de GetDocuments) |
| LoadDocumentResult | Obtiene el archivo al que se exportaron los resultados del procesamiento de documentos |
| SetDocumentProperties | Especifica los parámetros de registro de un documento |
| SetDocumentPriority | Cambia la prioridad del documento |
Páginas
| Método | Descripción |
|---|---|
| AddNewPage | Agrega la imagen de una página a un documento e incluye una descripción |
| AddNewPageEx | Agrega la imagen de una página a un documento (versión extendida de AddNewPage) |
| DeletePage | Elimina una página de un documento |
| ReplacePageImage | Reemplaza la imagen de una página |
Tickets de licencia
| Método | Descripción |
|---|---|
| GetNewTicket | Obtiene un nuevo ticket de licencia |
| ReleaseTicket | Libera un ticket de licencia |
| UpdateTicket | Actualiza el estado de un ticket de licencia |
Usuarios
| Método | Descripción |
|---|---|
| AddUserIfNotExist | Obtiene el ID del usuario actual y crea un registro en la base de datos si es necesario |
| FindUser | Obtiene el ID y el nombre del usuario |
| GetAvailableQueues | Obtiene el conjunto de registros con la lista de las etapas de procesamiento disponibles para el usuario |
| GetAvailableUsers | Obtiene una lista de usuarios o grupos autorizados para procesar una etapa especificada |
| GetProjectsForStationType | Encuentra proyectos en los que un usuario tiene al menos un rol asociado a un tipo de estación determinado |
| GetProjectsForUser | Obtiene el conjunto de registros con la lista de los proyectos disponibles para el usuario |
| GetRoles | Obtiene la lista de todos los roles del proyecto |
| GetUser | Obtiene información sobre el usuario a partir del ID de usuario |
| GetUserRoles | Obtiene la lista de ID de los roles de usuario disponibles para el usuario actual en el proyecto especificado |
| GetUsers | Obtiene la lista de usuarios |
| GetUserStatistics | Obtiene un conjunto de registros con la cantidad de lotes, documentos y páginas cuyo estado cambió a “procesado” durante un período determinado |
| HasRightsForBatchType | Comprueba si el rol del usuario tiene permisos de acceso a un determinado tipo de lote |
Archivos
| Método | Descripción |
|---|---|
| GetCustomFileNames | Obtiene la lista de archivos de usuario almacenados en el Application Server |
| LoadCustomFile | Carga un archivo de usuario desde el Application Server |
| RemoveCustomFile | Elimina un archivo de usuario del Application Server |
| SaveCustomFile | Guarda un archivo de usuario en el Application Server |
Archivos adjuntos
| Método | Descripción |
|---|---|
| GetAttachmentNames | Obtiene la lista de archivos adjuntos del Application Server |
| LoadAttachment | Carga un archivo adjunto desde el Application Server |
| RemoveAttachment | Elimina un archivo adjunto del Application Server |
| SaveAttachment | Guarda un archivo adjunto en el Application Server |
Definiciones de Document
| Método | Descripción |
|---|---|
| GetTemplates | Obtiene el conjunto de Definiciones de Document del proyecto |
| GetBatchTypeTemplates | Devuelve el conjunto de identificadores de las Definiciones de Document asociadas al tipo de lote |
Registro
| Método | Descripción |
|---|---|
| WriteToLog | Escribe información sobre eventos en el registro de Application Server |
Solicitudes al servidor
| Método | Descripción |
|---|---|
| CreateRequest | Crea una solicitud al Application Server |
| DeleteRequest | Elimina una solicitud al Application Server. |
| GetRequests | Obtiene una lista de solicitudes al Application Server en la sesión actual |
| GetRequestStatus | Obtiene el estado de una solicitud al Application Server |
| SetRequestStatus | Cambia el estado de una solicitud al Application Server |
Otros
| Método | Descripción |
|---|---|
| GetSettingValue | Obtiene un parámetro identificado por nombre de la base de datos |
| SetSettingValue | Guarda un parámetro identificado por nombre en la base de datos |