Versions Compared

Old Version 5

changes.mady.by.user Guillermo de Juan

Saved on

compared with

New Version 6

changes.mady.by.user Guillermo de Juan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

El resultado del alta es el identificador único del envío creado.

Signatura

public Long createIssue(ParamCreateIssue paramCreateIssue) throws InternalCoreException

...

Estos son los servicios que BENT tiene disponibles para integradores:

...

Table of Contents

Servicio IissueService

CreateIssue

El método createIssue tiene como finalidad permitir la creación de un envío dentro de bandeja de entrada, su invocación retornará un número que será el identificador del envío creado, que podrá ser utilizado posteriormente para realizar consultas sobre dicho envío. Para integrarse con este método será necesario ponerse en contacto con el equipo de desarrollo de BENT para tipificar el envío según la aplicación y dar de alta a la misma en la configuración desde el módulo administrativo (se detalla esto en el manual de administrador)

...

titleMás información

El agente de acceso ofrece un interfaz IIssueService para la preparación de envíos desde otras aplicaciones al servicio de Bandeja de Entrada. Este interfaz contiene las operaciones necesarias para la integración, a continuación se muestra un diagrama de secuencia de integración de un agente externo con Bandeja de Entrada:

Image Removed

  • Usuario: sería la persona que realiza la operación, la finalidad es preparar una serie de documentos que remitirá a bandeja de entrada para que sea enviado hasta el destinatario seleccionado.

  • Aplicación externa: es la aplicación que se va integrar con Bandeja de Entrada, se encargará de realizar las operaciones previas necesarias de creación y firma de documentos.

  • Crear documentos en CCSV: los documentos deben quedar almacenados en CCSV junto con sus firmas si estas están creadas.

  • Registro en SRT: el documento de registro es necesario para que el proceso de envío pueda realizarse, la aplicación externa deberá crear y firmar el documento de registro.

  • Bandeja de Entrada: la aplicación que se encarga de generar el envío y remitirlo hasta el destinatario.

Estos son los servicios que BENT tiene disponibles para integradores:

Servicio IissueService

...

CreateIssue

El método createIssue tiene como finalidad permitir la creación de un envío dentro de bandeja de entrada, su invocación retornará un número que será el identificador del envío creado, que podrá ser utilizado posteriormente para realizar consultas sobre dicho envío. Para integrarse con este método será necesario ponerse en contacto con el equipo de desarrollo de BENT para tipificar el envío según la aplicación y dar de alta a la misma en la configuración desde el módulo administrativo (se detalla esto en el manual de administrador)

Expand
titleMás información

Image Added

Code Block
 Code Block
 Code Block
 
 
AcceptIssue
Este método permite aceptar un envío creando una traza con la fecha de aceptación. IMPORTANTE: el integrador debe controlar si el envio esta en estado de poder ser aceptado (ultimo evento tipo 1 - envio, o 4 - reenvio y en estado 3).
Signatura
public ResultAcceptIssue acceptIssue(ParamAcceptIssue paramAcceptIssue) throws InternalCoreException
Parámetros de entrada
...
Parámetro
Tipo
Obligatorio
Descripción
...
documentList
Ejemplo de invocación
La petición createIssue de BENT tiene varias casuísticas diferenciadas principalmente por el origen del envío a crear. Este parámetro de origen tiene cuatro valores posibles y según el valor que corresponda se parametrizarán también los valores del emisor (senderDni, senderName y senderOrgCode).
Esto no afectará a los parámetros del receptor no obstante. La parametrización del receptor tiene como parámetro obligatorio el receiverOrgCode (deberá ser un organismo de la DGA con su código formateado correctamente ORGXXXXX). El otro parámetro receiverDni, es opcional y se introducirá únicamente si el envío es dirigido a la bandeja personal de un funcionario en concreto del organismo establecido en el receiverOrgCode. Dicho DNI deberá estar registrado correctamente en SIU, si no se especifica ningún dni el envío será recibido en la bandeja del organismo y se deberá crear un registro de entrada a través de SRT para que el envío pueda ser completado y visible en BENT. En caso de realizar un envío a un organismo que no tenga gestores dados de alta en BENT, la aplicación enviará una notificación a soporte para realizar las acciones pertinentes.
El parámetro issuerDni, no es obligatorio y únicamente informa del usuario que realizó la operación.
La parametrización del sender dependerá del tipo de origen del envío, por lo tanto vamos a mostrar una petición de cada tipo y como se debería parametrizar en cada caso:
  1. Origen Administración
El envío proviene de la propia administración interna y se tipificará el campo origen como 0. En este caso la parametrización del sender será igual que la del receiver. Será obligatorio indicar un senderOrgCode con el formato ORGXXXXX y opcional indicar un senderDni correspondiente a un funcionario del organismo, dependiendo si el emisor fuera una bandeja personal o la del propio organismo.
Ponemos como ejemplo una petición de la aplicación CPPC que realiza este tipo de envíos, el envío sería dirigido desde una bandeja de organismo a la bandeja de personal de un funcionario en concreto, e incluyendo dos documentos :
 Code Block
<arg0>
            <applicationId>APP_CODE</applicationId>
            <csvMaindoc>CSVJ529Y7L77G1W0BENT</csvMaindoc>
            <description>envío origen administración interna</description>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSVJ529Y7L77G1W0BENT</csv>
            </documentList>
            <documentList>
               <applicationId>CPPC</applicationId>
               <csv>CSVGK37WVC2761V0BENT</csv>           
            </documentList>
            <insertRegistry>N</insertRegistry>
            <issuerDni>00000000T</issuerDni>
            <origen>0</origen>
            <receiverDni>00000000T</receiverDni>
            <receiverOrgCode>ORG07464</receiverOrgCode>
            <senderOrgCode>ORG07458</senderOrgCode>
</arg0>
  1. Origen Ciudadano
El envío proviene de un ciudadano y se tipificará el campo origen como 1. En este caso en la parametrización del sender se deberá informar un senderDni y un senderName, con los datos del solicitante. El campo senderOrgCode quedará nulo.
Ponemos como ejemplo una petición de la aplicación TTO que realiza envíos de este tipo:
 Code Block
<arg0>
            <applicationId>APP_CODE</applicationId>
            <csvMaindoc>CSVV21UZAF88L1M0BENT</csvMaindoc>
            <description>prueba </description>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSVV21UZAF88L1M0BENT</csv>            
            </documentList>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSV5U2UDSD48F1E0BENT</csv>             
            </documentList>
            <origen>1</origen>
            <receiverOrgCode>ORG06670</receiverOrgCode>
            <senderDni>73133419C</senderDni>
            <senderName>DIEGO PATRICIO GONZALEZ PARAMO</senderName>
</arg0>
  1. Administracion Externa
El envío proviene de una administración externa a la dga y el campo origen se puede tipificar con el valor 2 (caso de que el envío sea una comunicación) o 3 (caso de que el envío sea una notificación). En este caso se informará como en el caso anterior el senderDni y el senderName, pero en este caso con el dni del gestor y el nombre del organismo.
Ponemos como ejemplo una petición de la aplicación SETA que realiza envíos de este tipo:
 Code Block
<arg0>
            <applicationId>APP_CODE</applicationId>
            <csvMaindoc>CSVJ529Y7L77G1W0BENT</csvMaindoc>
            <description>prueba </description>
            <documentList>
               <applicationId>APP_CODE</applicationId>
               <csv>CSVJ529Y7L77G1W0BENT</csv>              
            </documentList>
            <!-- 2 Comunicacion - 3 Notificacion -->
            <origen>2</origen>
            <receiverOrgCode>ORG06670</receiverOrgCode>
            <senderDni>00000000T</senderDni>
            <senderName>Organismo Externo</senderName>		  
</arg0>
AcceptIssue
Este método permite aceptar un envío creando una traza con la fecha de aceptación
Signatura
...
paramAcceptIssue
ParamAcceptIssue
SI
...
Lista con los documentos del envío, La clase Document extiende BaseData, deben informarse los campos:
  • csv: string
  • applicationId: id de la aplicación integradora
(IMPORTANTE: los documentos que estén en estado borrador no serán añadidos al envío)
...
csvMaindoc
...
String
...
SI
...
CSV del documento principal, este csv debe estar incluido en el parametro de listado de documentos
...
description
...
String
...
SI
...
Descripción del envío
...
insertRegistry
...
String
...
NO
...
Insertar registro en organismos intermedios (valores aceptados: S/N, por defecto N o nulo)
...
viewDetail
...
String
...
NO
...
Ver detalle en organismo intermedios (valores aceptados: S/N, por defecto N o nulo)
...
viewTrace
...
String
...
NO
...
Ver traza en organismo intermedios (valores aceptados: S/N, por defecto N o nulo)
...
senderDni
...
String
...
NO
...
DNI del remitente
...
senderName
...
String
...
NO
...
Nombre del remitente
...
senderOrgCode
...
String
...
NO
...
Código del Organismo remitente
...
receiverDni
...
String
...
NO
...
DNI del receptor
...
receiverOrgCode
...
String
...
SI
...
Código del Organismo receptor
...
inmediateSend
...
Boolean
...
NO
...
Realiza el envío si este no requiere registro si la preparación se ha realizado desde Bandeja de Entrada. En otro caso el parámetro es ignorado. (por defecto nulo)
...
registryInNumber
...
String
...
NO
...
CSV del documento que va a ser justificante de registro. (por defecto nulo)
...
issuerDni
...
String
...
NO
...
DNI de la persona que realiza la creación del evento de envío
...
origen
...
String
...
SI
...
Origen del envío (valores aceptados: 
0 = ADMINISTRACION
1 = INTERESADO (CIUDADANO)
2 = ADMINISTRACION EXTERNA (Comunicacion)
3 = ADMINISTRACION EXTERNA (Notificacion)
...
numAsientoRegfia
...
String
...
NO
...
Código del envío en REGFIA (sólo para importaciones de REGFIA, uso interno)
...
isRegfiaImport
...
String
...
NO
...
Indica si el nuevo envio está importado desde REGFIA (sólo para importaciones de REGFIA, uso interno)
...
regfiaRegisterType
...
String
...
NO
...
Tipo de registro en REGFIA (sólo para importaciones de REGFIA, uso interno)
...
*applicationId
...
String
...
SI
...
*(Heredado de BaseData), en el caso de createIssue la aplicación debe estar añadida como aplicación integradora en el admin de BENT. Consultar CAU o al equipo de BENT.
Parámetros de salida
...
Parametro
...
Tipo
...
Descripción
...
idIssue
...
Long
...
Id del envío recién creado en la plataforma de Bandeja de Entrada
Códigos de error
Este método lanza una excepción de tipo InternalCoreException. A continuación se muestra una tabla con los códigos de error que puede contener la excepción lanzada.
...
Código de error
...
Descripción
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_01
...
El parámetro de entrada es obligatorio
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_03
...
Los csv de los documentos que van dentro del sobre son obligatorios
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_04
...
El índice del documento principal seleccionado no es válido
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_05
...
El documento principal no es de tipo PDF
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_06
...
El documento principal debe estar firmado
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_07
...
El documento con CSV {0} no es de tipo PDF, todos los documentos de la solicitud deben ser de este formato (aunque se mantiene el codigo no aplica en realidad ya que se elimino esta restricción)
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_08
...
El documento con CSV {0} no está firmado, todos los documentos de la solicitud deben estar firmados
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_09
...
No se pueden enviar documentos que registren al documento principal.
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_10
...
La aplicación integradora no tiene un tipo de aportador válido
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_11
...
La aplicación no está dada de alta en BENT como apliación integradora
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_12
...
No se puede realizar un envío solo con documentos en estado borrador
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_13
...
Error de almacenamiento en uno de los documentos del envio
...
WSVALIDATION_VALIDATEPARAMCREATEISSUE_14
...
Se ha señalado como documento principal un documento en estado borrador
...
CREATEISSUE_VALUE_INCORRECT
...
Error de validación al crear el envío en los parámetros
...
CCSVINTEGRATION_GETDOCUMENT
...
Error en el repositorio documental. Se ha producido un error al recuperar el documento
...
DOCUMENTDAOIMPL_SAVEDOCUMENT
...
Se ha producido un error al guardar el documento
...
CREATEISSUE_INVALID_SENDERDNI
...
Error de validación al crear el envío, el dni del emisor no es correcto
...
CREATEISSUE_INVALID_SENDERORGCODE
...
Error de validación al crear el envío, el código de organismo emisor debe empezar por ORG
...
CREATEISSUE_INVALID_RECEIVERDNI
...
Error de validación al crear el envío, el dni del receptor no es correcto
...
CREATEISSUE_INVALID_RECEIVERORGCODE
...
Error de validación al crear el envío, el código de organismo receptor debe empezar por ORG
...
ISSUEDAOIMPL_FINFISSUEBYID
...
Se ha producido un error al recuperar el envío
...
ISSUEEVENTDAOIMPL_SAVEISSUEEVENT
...
Se ha producido un error al guardar el evento del envío
...
TRACEDAOIMPL_SAVETRACE
...
Se ha producido un error al guardar la traza
Objeto donde están encapsulados los datos relativos al envío que queremos aceptar
Parámetros de salida
Parámetro
Tipo
Descripción
acceptIssue
ResultAcceptIssue
Objeto que contiene un código con el valor que indica cómo terminó el proceso
Ejemplo de invocación
 Code Block
ParamAcceptIssue paramAcceptIssue = new ParamAcceptIssue();
 
paramAcceptIssue.setIssueId(Long.parseLong(issueId));
paramAcceptIssue.setUserNif(userNif));
paramAcceptIssue.setOrganismMap(organismMap);
paramAcceptIssue.setNotes(notes);
 
ResultAcceptIssue result = issueManager.getiIssueService().acceptIssue(paramAcceptIssue);
 
if (BENTCoreConstants.SendResult.ISSUE_ACCEPTED == result.getResult()) {
    log.info("Issue aceptado");
} else {
    log.error("Issue no aceptado");
}


 
ImportRegfiaEntry
Este método permite realizar la importación de un asiento de REGFIA en BENT
Signatura
public ResultImportRegfiaEntry importRegfiaEntry(ParamImportRegfiaEntry paramImportRegfiaEntry)
Parámetros de entrada
Parámetro
Tipo
Obligatorio
Descripción
paramImportRegfiaEntry
ParamImportRegfiaEntry
SI
Objeto donde están encapsulados los datos relativos al asiento a importar
Parámetros de salida
Parámetro
Tipo
Descripción
resultImportRegfiaEntry
ResultImportRegfiaEntry
Objeto que contiene el id de envio generado en BENT, o la informacion del error producido
Ejemplo de invocación
 Code Block
ParamImportRegfiaEntry arg6 = new ParamImportRegfiaEntry();

// parametros obtenidos del asiento de REGFIA
arg6.setApplicationId("BENT");
arg6.setAsunto("Programa emprendedores autónomos");
arg6.setCodOrganismoDestino("ORG06670");
arg6.setCodOrganismoOrigen(null);
arg6.setDsOrganismoOrigen(null);
arg6.setIdentificadorAgente("17756357N");
arg6.setNombreCompletoAgente("Mª Jose Montesa Letosa");
arg6.setNumeroRegistro("E20140015950");
arg6.setTipoAsiento("E");

// el asiento de REGFIA contiene un listado de objetos document de REGFIA, solo se pasa un listado de String con los csvs
List<String> csvList = new ArrayList<String>();
csvList.add("CSVO33FKMM3S6AE01PFI");
arg6.setCsvList(csvList);
 
ResultImportRegfiaEntry result = bentClient.importRegfiaEntry(arg6);
 
if (result.getError()) {
    log.error("Error: " + result.getErrorMsg());
} else {
    log.info("OK: " + result.getIssueId()");
}


 
ParamImportRegfiaEntry
La clase ParamImportRegfiaEntry encapsula los parametros del asiento de REGFIA que son necesario para realizar la importacion en BENT tal y como los devuelve esta aplicacion en el metodo getRegistry.
 Ver detalles
Parámetro
Tipo
Obligatorio
Descripción
asunto
String
SI
Asunto del asiento a importar
codOrganismoDestino
String
SI
codigo del organismo receptor de la importación. Debe ser un codigo valido de SIU
codOrganismoOrigen
String
NO*
codigo del organismo origen de la importación
dsOrganismoOrigen
String
NO*
descripcion del organismo emisor de la importación
numeroRegistro
String
SI
numero de registro del asiento
tipoAsiento
String
SI
Debe ser “E” solo se permiten importar asientos de entrada
identificadorAgente
String
NO*
identificador del primer interesado del asiento
nombreCompletoAgente
String
NO*
nombre completo del primer interesado del asiento
csvList
List<String>
SI
listado de csvs del asiento. BENT comprueba y elimina los documentos en estado borrador. En el caso de que todos sean borradores el envio fallará.
( * ) deben introducirse los datos del organismo origen, o del agente interesado obligatoriamente. En cualquier caso estos parametros se deben rellenar siempre con lo que venga informado en el asiento de REGFIA: organismoOrigen e interesados (el primero del listado).
ResultImportRegfiaEntry
La clase ResultImportRegfiaEntry contiene el resultado de la importación.
 Ver detalles
Parámetro
Tipo
Descripción
errorCode
String
Codigo de error producido
errorMsg
String
Mensaje de error producido
error
boolean
valor booleano que indica si la importacion se ha realizado correctamente o no
issueId
Long
devuelve el id de envio creado en la importación
 
FindIssueTrayAdvanced
Método que devuelve una lista de envíos correspondientes de la bandeja de recibidos con filtros avanzados
Signatura
public ResultTrayListAdvanced findIssueTray(ParamFindTrayAdvanced paramTraySearch) throws InternalCoreException
Parámetros de entrada
Parámetro
Tipo
Obligatorio
Descripción
paramTraySearch
ParamFindTrayAdvanced
SI
Objeto donde están encapsulados los datos para realizar la búsqueda de envíos recibidos
Parámetros de salida
Parámetro
Tipo
Descripción
resultTrayList
ResultTrayListAdvanced
Objeto donde se encuentran encapsulados la lista de envíos correspondientes a la bandeja y su tamaño
Excepciones
Tipo de excepción
Descripción
InternalCoreException
Error en una operación del núcleo
Ejemplo de invocación
 Code Block
ResultTrayListAdvanced resultTrayList = new ResultTrayListAdvanced();
ParamFindTrayAdvanced paramTraySearch = new ParamFindTrayAdvanced();
 
paramTraySearch.setIssueId(Long.parseLong(issueId));
paramTraySearch.setFromIndex(-1);
paramTraySearch.setReceiverDni(user.getNif());
paramTraySearch.setReceiverOrgCode(user.getOrganismCode());
 
resultTrayList = issueManager.getiIssueService().findIssueTrayAdvanced(paramTraySearch);


ParamFindTrayAdvanced
La clase ParamFindTrayAdvanced es la que contiene los parámetros para la obtención de los listados que se muestran en las bandejas que ve el usuario, se la bandeja de usuario o la de organismo, tanto para entrada como para salida, con filtros adicionales.
 Ver detalles
Parámetro
Tipo
Obligatorio
Descripción
senderDni
String
NO
DNI del remitente
senderName
String
NO
Nombre del remitente
receiverDni
String
NO
DNI del destinatario
receiverName
String
NO
Nombre del destinatario
origin
String
NO
Origen de creación del envío
adminFileNumber
String
NO
Número del expediente
issueId
Long
NO
Identificador del envío
status
Long
NO
Estado en el que se encuentra el envío
acceptanceNif
String
NO
NIF de la persona que realiza la aceptación del envío
description
String
NO
Descripción del envío
entryDateFrom
Date
NO
Fecha inicial para el rango de fechas de entrada del envío en el sistema
entryDateTo
Date
NO
Fecha final para el rango de fecha de entrada del envío en el sistema
receptionDateFrom
Date
NO
Fecha inicial para el rango de fechas de recepción del envío
receptionDateTo
Date
NO
Fecha final para el rango de fechas de recepción del envío
viewIfIntermediate
Boolean
NO
Incluir o no en el resultado los envíos en los que el organismo es un organismo intermedio en la ruta de remisión
fromIndex
int
NO
Para consultas paginadas recuperar desde el registro con el número indicado en fromIndex
toIndex
int
NO
Para consultas paginadas recuperar hasta el registro con el número indicado en toIndex
maxResults
int
NO
Para consultas paginadas indica el número máximo de registros a retornar
sortColumn
String
NO
Columna por la cual se van a ordenar los resultados
ascending
Boolean
NO
Ordenación ascendente (true) o descendente (false) de los resultados
userSentNif
String
NO
NIF del usuario que realiza el envío, aplicable sólo para envíos remitidos a otro usuario/organismo
userOrgCode
String
NO
Código del organismo desde el que se realiza el envío, aplicable sólo para envíos remitidos a otro usuario/organismo
acceptedIssue
String
NO
Estado de aceptación de un envío
editableDocs
String
NO
Documentos que hay que editar el código de procedimiento
origen
String
NO
Parámetro que indica el origen del envío
procNum
Long
NO
Codigo de procedimiento
eventCause
Long
NO
Causa del evento del envio*
regInNumber
String
NO
Numero de registro de entrada*
regOutNumber
String
NO
Numero de registro de salida*
regInDateFrom
Date
NO
Fecha de registro de entrada*
regOutDateFrom
Date
NO
Fecha de registro de salida*
regInCsv
String
NO
Csv del documento de registro de entrada*
regOutCsv
String
NO
Csv del documento de registro de salida*
( * ) Estos filtros serán habilitados en la siguiente version 4.17.0
 
ResultTrayListAdvanced
La clase ResultTrayListAdvanced contiene el resultado de buscar la lista de trazas de un envío.
 Ver detalles
Parámetro
Tipo
Descripción
list
List<ParamReceivedTrayAdvanced>
Lista que contiene uno o varios objetos ParamReceivedTrayAdvanced
size
int
Número de objetos que contiene la lista
 
ParamReceivedTrayAdvanced
La clase ParamReceivedTrayAdvanced contiene los datos a mostrar en el listado de la bandeja de recibidos.
 Ver detalles
Parámetro
Tipo
Descripción
issueId
Long
Identificador del envío
issueEventId
Long
Identificador del evento de envío
acceptanceNif
String
NIF del usuario que realiza la aceptación del envío
adminFileNumber
String
Número de expediente
entryDate
Date
Fecha de entrada del envío
receptionDate
Date
Fecha de recepción del envío
senderDni
String
DNI del usuario que remite el envío
senderName
String
Nombre del usuario que remite el envío
receiverDni
String
DNI del usuario que se va consultar la bandeja de elementos recibidos
description
String
Descripción del envío
origin
String
Origen del envío, ver códigos en “Tipos de origen de creación del envío”
state
Integer
Estado en el que se encuentra el registro, ver “Valores del campo status”
senderOrgName
String
Nombre del organismo del remitente
sender
String
Nombre del remitente completo
acceptedIssue
String
Estado de aceptación del issue
editableDocs
String
Documentos que hay que editar el código de procedimiento
origen
String
Parámetro que indica el origen del documento
receiverOrgCode
String
Código del organismo del receptor
eventCause
String
Causa del evento del envío
procNum
Long
Codigo de procedimiento del evio
regInNumber
String
numero de registro de entrada*
regOutNumber
String
numero de registro de salida*
regInDate
Date
fecha de registro de entrada*
regOutDate
Date
fecha de registro de salida*
regInCsv
String
csv del documento de registro de entrada*
regOutCsv
String
csv del documento de registro de salida*
( * ) Estos parametros se habilitarán en la siguiente versión 4.17.0
FindSentTrayListAdvanced
Método que devuelve una lista de envíos correspondientes con la bandeja de enviados con filtros adicionales
Signatura
public ResultSentTrayAdvanced findSentTrayListAdvanced(ParamFindTrayAdvanced paramTraySearch) throws InternalCoreException
Parámetros de entrada
Parámetro
Tipo
Obligatorio
Descripción
paramAcceptIssue
paramTraySearch
ParamAcceptIssue
ParamFindTrayAdvanced
SI
Objeto donde están encapsulados los datos 
 relativos al envío que queremos aceptar
para realizar la búsqueda de envíos enviados
Parámetros de salida
Parámetro
Tipo
Descripción
acceptIssue
resultSentTray
ResultAcceptIssue
Objeto que contiene un código con el valor que indica cómo terminó el proceso
ResultSentTrayAdvanced
Objeto donde se encuentran encapsulados la lista de envíos correspondientes a la bandeja y su tamaño
Excepciones
Tipo de excepción
Descripción
InternalCoreException
Error en una operación del núcleo
Ejemplo de invocación
 Code Block
ParamAcceptIssue
ResultSentTrayAdvanced 
paramAcceptIssue
resultSentTray =
 new ParamAcceptIssue
 new ResultSentTrayAdvanced();

 
paramAcceptIssue.setIssueId(Long.parseLong(issueId));
paramAcceptIssue.setUserNif(userNif));
paramAcceptIssue.setOrganismMap(organismMap);
paramAcceptIssue.setNotes(notes
ResultTrayListAdvanced resultTrayList = new ResultTrayListAdvanced();
Integer state = null;
ParamFindTray paramFindTray = new ParamFindTray();
 
paramFindTray.setIssueId(Long.parseLong(issueId));
paramFindTray.setFromIndex(-1);
paramFindTray.setUserSentNif(user.getNif());
paramFindTray.setUserOrgCode(user.getOrganismCode());
 

ResultAcceptIssue result
resultSentTray = issueManager.getiIssueService().
acceptIssue
findSentTrayListAdvanced(
paramAcceptIssue
paramFindTray);
 
if (
BENTCoreConstants.SendResult.ISSUE_ACCEPTED == result.getResult()) {
    log.info("Issue aceptado");
} else {
    log.error("Issue no aceptado"
resultSentTray.getSentTrayList() != null) {
    state = resultSentTray.getSentTrayList().get(0).getState();
}

 
...

ParamFindTrayAdvanced
La clase ParamAcceptIssue se utiliza para realizar el envío de un registro desde el origen al destino, este envío se selecciona mediante el identificador del envío que se quiere procesar. El resto de campos de este objeto se utilizan para definir el tratamiento que se va a realizar con el registro seleccionadoParamFindTrayAdvanced es la que contiene los parámetros para la obtención de los listados que se muestran en las bandejas que ve el usuario, se la bandeja de usuario o la de organismo, tanto para entrada como para salida, con filtros adicionales.
 Ver detalles
Parámetro
Tipo
Obligatorio
Descripción
issueId
senderDni
Long
String
SI
NO
Identificador 
DNI del 
 envío a remitir
remitente
abortIfRegister
senderName
BooleanBoolean
String
NO
Abortar el proceso de remisión si este requiere registro en SRT en alguno de los pasos
passToPending
Nombre del remitente
receiverDni
String
NO
Dejar el estado del documento en pendiente
csv
DNI del destinatario
receiverName
String
NO
Código CSV 
Nombre del 
 documento
destinatario
userNif
origin
String
NO
NIF 
Origen de creación del 
 usuario
envío
userOrganismCode
adminFileNumber
String
NO
Código del organismo del usuario
notes
String
NO
Notas a asociar con el evento de envío
newForwardReceiver
Número del expediente
issueId
Long
NO
Identificador del envío
status
Long
NO
Estado en el que se encuentra el envío
acceptanceNif
String
NO
Nuevo receptor para reenviar el 
NIF de la persona que realiza la aceptación del envío
organismMap
description
Map<String, String>
String
NO
Mapa de organismos del usuario
 
ResultAcceptIssue
La clase ResultAcceptIssue contiene el resultado de la remisión de un envío. El resultado de la remisión contiene un código con el valor que indica cómo terminó el proceso. Adicionalmente y para identificar el envío con el que ha trabajado el proceso se incluyen los identificadores de envío y de evento correspondientes.
 Ver detalles
...
Parámetro
...
Tipo
...
Descripción
...
result
...
int
...
Valor con el resultado del proceso de remisión
...
issueId
...
Long
...
Identificador del envío que se ha procesado
...
issueEventId
...
Long
...
Identificador del evento correspondiente al envío que se ha procesado
...
postProcessEvent
...
boolean
...
Campo que valida si se procesa el evento
Servicio OrganismManagerService
GetEmailListByOrgCode
Este método del servicio organismManager permite recuperar el listado de los emails de los usuarios dados de alta en BENT en una bandeja de organismo concreta. BENT únicamente almacena los dnis de los usuarios en su base de datos, recuperando el email a través de SIU. Si un usuario implicado en la búsqueda no tuviera un email registrado el servicio simplemente no lo añadirá al listado de resultados.
...
titleMás información
Signatura
public List<String> getEmailListByOrgCode(ParamOrganismManager paramOrganismManager) throws InternalCoreException
Parámetros de entrada: ParamOrganismManager
...
Parámetro
...
Tipo
...
Obligatorio
...
Descripción
...
orgCode
...
String
...
SI
...
Código del organismo del cual se quieren recuperar los emails de los usuarios de BENT
...
*applicationId
...
String
...
SI
...
*(Heredado de BaseData), en el caso de createIssue la aplicación debe estar añadida como aplicación integradora en el admin de BENT. Consultar CAU o al equipo de BENT.
Parámetros de salida
...
Parametro
...
Tipo
...
Descripción
...
emailList
...
List<String>
...
Listado de los emails de la bandeja especificada
Codigos de error
...
Tipo de excepción
...
Descripción
...
InternalCoreException
...
Error en una operación del núcleo
Ejemplo de invocación
...
Descripción del envío
entryDateFrom
Date
NO
Fecha inicial para el rango de fechas de entrada del envío en el sistema
entryDateTo
Date
NO
Fecha final para el rango de fecha de entrada del envío en el sistema
receptionDateFrom
Date
NO
Fecha inicial para el rango de fechas de recepción del envío
receptionDateTo
Date
NO
Fecha final para el rango de fechas de recepción del envío
viewIfIntermediate
Boolean
NO
Incluir o no en el resultado los envíos en los que el organismo es un organismo intermedio en la ruta de remisión
fromIndex
int
NO
Para consultas paginadas recuperar desde el registro con el número indicado en fromIndex
toIndex
int
NO
Para consultas paginadas recuperar hasta el registro con el número indicado en toIndex
maxResults
int
NO
Para consultas paginadas indica el número máximo de registros a retornar
sortColumn
String
NO
Columna por la cual se van a ordenar los resultados
ascending
Boolean
NO
Ordenación ascendente (true) o descendente (false) de los resultados
userSentNif
String
NO
NIF del usuario que realiza el envío, aplicable sólo para envíos remitidos a otro usuario/organismo
userOrgCode
String
NO
Código del organismo desde el que se realiza el envío, aplicable sólo para envíos remitidos a otro usuario/organismo
acceptedIssue
String
NO
Estado de aceptación de un envío
editableDocs
String
NO
Documentos que hay que editar el código de procedimiento
origen
String
NO
Parámetro que indica el origen del envío
procNum
Long
NO
Codigo de procedimiento
eventCause
Long
NO
Causa del evento del envio
regInNumber
String
NO
Numero de registro de entrada
regOutNumber
String
NO
Numero de registro de salida
regInDateFrom
Date
NO
Fecha de registro de entrada
regOutDateFrom
Date
NO
Fecha de registro de salida
regInCsv
String
NO
Csv del documento de registro de entrada
regOutCsv
String
NO
Csv del documento de registro de salida
 
ResultSentTrayAdvanced
La clase ResultSentTrayAdvanced contiene el resultado de buscar la lista de trazas de un envío.
 Ver detalles
Parámetro
Tipo
Descripción
list
List<ParamSentTrayAdvanced>
Lista que contiene uno o varios objetos ParamSentTrayAdvanced
size
int
Número de objetos que contiene la lista
 
ParamSentTrayAdvanced
La clase ParamSentTrayAdvanced contiene los datos a mostrar en el listado de la bandeja de enviados. Sus datos son los siguientes:
 Ver detalles
Parámetro
Tipo
Descripción
issueId
Long
Identificador del envío
issueEventId
Long
Identificador del evento de envío
previousIssueEventId
Long
Identificador del evento de envío anterior al indicado por el campo issueEventId, de esta forma se puede obtener el evento del que proviene el actual
acceptanceNif
String
NIF del usuario que realiza la aceptación del envío
adminFileNumber
String
Número del expediente
outDate
Date
Fecha de creación del evento correspondiente del envío
listSenderDni
String
DNI del remitente del evento de envío
listSenderName
String
Nombre y apellidos del remitente del evento de envío
listSenderOrgCode
String
Código del organismo remitente del evento de envío
listSenderOrgName
String
Nombre del organismo remitente del evento de envío
listReceiverDni
String
DNI del destinatario del evento de envío
listReceiverName
String
Nombre y apellidos del destinatario del evento de envío
listReceiverOrgCode
String
Código del organismo destinatario del evento de envío
listReceiverOrgName
String
Nombre del organismo destinatario del evento de envío
senderDni
String
DNI del usuario que realiza la consulta
senderOrgCode
String
Código del organismo del usuario que realiza la consulta
description
String
Descripción del envío
origin
String
Origen del envío, ver códigos en “Tipos de origen de creación del envío”
state
Integer
Estado en el que se encuentra el registro, ver “Valores del campo status”
acceptedIssue
String
Estado del envío
editableDocs
String
Documentos que hay que editar el código de procedimiento
origen
String
Parámetro que indica el origen del envío
procNum
Long
Codigo de procedimiento del envío
regInNumber
String
Numero de registro de entrada*
regOutNumber
String
Numero de registro de salida*
regInDate
Date
Fecha de registro de entrada*
regOutDate
Date
Fecha de registro de salida*
regInCsv
String
csv del documento de registro de entrada*
regOutCsv
String
csv del documento de registro de salida*
eventCause
Long
codigo de causa de evento del envio*
cause
String
descripcion de causa de evento del envio*
( * ) Estos parametros se habilitarán en la siguiente versión 4.17.0
 
FindRegfiaIssuesAdvanced
Este método recupera el listado de envíos de REGFIA con filtros y parametros adicionales
Signatura
public ResultFindRegfiaIssuesAdvanced findRegfiaIssues(ParamFindRegfiaIssuesAdvanced paramFindRegfiaIssues)
Parámetros de entrada
Parámetro
Tipo
Obligatorio
Descripción
paramFindRegfiaIssues
ParamFindRegfiaIssuesAdvanced
SI
Objeto que contiene los valores de los filtros que se van a aplicar a la consulta de envíos DIR3
Parámetros de salida
Parámetro
Tipo
Descripción
resultFindRegfiaIssues
ResultFindRegfiaIssuesAdvanced
Objeto que contiene el listado de envíos
Ejemplo de invocación
 Code Block
ParamFindRegfiaIssuesAdvanced paramFindRegfiaIssues = new ParamFindRegfiaIssuesAdvanced();
 
paramFindRegfiaIssues.setApplicationId(BENTCoreConstants.BENT);
paramFindRegfiaIssues.setImportRegfiaIssues(BENTCoreConstants.ISSUE_IMPORTED_FROM_REGFIA);
paramFindRegfiaIssues.setOrganismCodeSearch(orgCode);
paramFindRegfiaIssues.setIssueId(issueIdAux);
paramFindRegfiaIssues.setRegistryNumber(filterNumRegister);
// para filtrar importaciones de REGFIA
paramFindRegfiaIssues.setImportRegfiaIssues(BENTCoreConstants.ISSUE_IMPORTED_FROM_REGFIA);
paramFindRegfiaIssues.setSirIssues(null);
 
ResultFindRegfiaIssuesAdvanced resultFindRegfiaIssues = new ResultFindRegfiaIssuesAdvanced();
regfiaIssueList = new ArrayList<>();
resultFindRegfiaIssues = issueManager.getiIssueService().findRegfiaIssuesAdvanced(paramFindRegfiaIssues);
if (resultFindRegfiaIssues != null && resultFindRegfiaIssues.getListRegfiaIssues() != null && !resultFindRegfiaIssues.getListRegfiaIssues().isEmpty()) {
    regfiaIssueList = resultFindRegfiaIssues.getListRegfiaIssues();
} else {
    log.info("No se ha recuperado ningún envío");
}


ParamFindRegfiaIssuesAdvanced
La clase ParamFindRegfiaIssuesAdvanced contiene los parametros de una importación de REGFIA
Ver detalles
Parámetro
Tipo
Descripción
issueID
long
identidicador del envío asociado a la importación
issueEventId
long
identificador del evento del envío
registryNumber
String
numero de registro del asiento
registryReceiverOrgName
String
nombre del organismo destino del asiento
registryDate
String
fecha de registro del asiento
registryState
String
descripcion del estado del asiento
registryIdIntercambio
String
id de intercambio del asiento
registryType
String
tipo de asiento, entrada o salida
sirIssues
String
indica si es un envio SIR*
importRegfiaIssues
String
indica si es una importacion de REGFIA*
organismCodeSearch
String
codigo de organismo de la bandeja donde se ha importado, deberia ser el de destino del asiento
filterDateFrom
String
filtro para la fecha de creacion del evento de importacion en BENT
filterDateTo
String
filtro para la fecha de creacion del evento de importacion en BENT
procNum
Long
Numero de procedimiento asociado
( * ) Obligatorio informar uno de los dos parametros con el valor correspondiente.
 
ResultFindRegfiaIssuesAdvanced
La clase ResultFindRegfiaIssues se utiliza para indicar los valores de los filtros que se van a aplicar a la consulta de envíos DIR3
 Ver detalles
Parámetro
Tipo
Descripción
listRegfiaIssues
List<ParamFindRegfiaIssuesAdvanced>
Lista con los valores de los filtros que se van a aplicar a la consulta de envíos DIR3
size
int
numero de resultados devueltos
 
FindIssueDetailByEventAdvanced
 
Este método recupera los detalles de un envío dados el identificador del envio y un evento en concreto. Esta ideado para visualizar la informacion de un envio segun el estado del mismo afectando a una bandeja en concreto, dicho de otra manera esta pensado para ser invocado con los datos que devuelven los metodos de consulta de bandeja que se detallan mas arriba.
Signatura
public ResultFindIssueDetailAdvanced findIssueDetailbyEventAdvanced(ParamFindIssueAdvanced paramFindIssue) throws InternalCoreException {
Parámetros de entrada
Parámetro
Tipo
Obligatorio
Descripción
paramFindIssue
ParamFindIssueAdvanced
SI
Objeto que contiene los parametros de busqueda
Parámetros de salida
Parámetro
Tipo
Descripción
resultFindIssue
ResultFindIssueDetailAdvanced
Objeto que contiene el resultado de la consulta
Ejemplo de invocación
 Code Block
ParamFindIssueAdvanced paramFindIssueAdvanced= new ParamFindIssueAdvanced();
 
paramFindIssueAdvanced.setApplicationId(BENTCoreConstants.BENT);
paramFindIssueAdvanced.setIssueId(issueId);
paramFindIssueAdvanced.setIssueEventId(issueEventId);
paramFindIssueAdvanced.setFindIssueEvents(true);
paramFindIssueAdvanced.setFindIssueTrace(false);
 
ResultFindIssueDetailAdvanced resultFindIssueDetailAdvanced = new ResultFindIssueDetailAdvanced ();
resultFindIssueDetailAdvanced = issueManager.getiIssueService().findIssueDetailbyEventAdvanced(paramFindIssueAdvanced);


 
ParamFindIssueAdvanced

La clase ParamFindIssueAdvanced contiene los parametros de busqueda del envío
Ver detalles
Parámetro
Tipo
Obligatorio
Descripción
issueId
Long
SI
identidicador del envío
issueEventId
Long
SI
identificador del evento del envío
findIssueEvents
Boolean
SI
indica si se quieren recuperar los eventos del envio
findIssueTrace
Boolean
SI
indica si se quieren recuperar las trazas del envío
 
ResultFindIssueDetailAdvanced
La clase ResultFindIssueDetailAdvanced se utiliza para indicar los valores del envio correspondiente
 Ver detalles
Parámetro
Tipo
Descripción
issueEventId
Long
identificador del evento
issueId
Long
identificador del envio
description
String
descripcion del envio
origin
String
origen del envio
state
String
estado del envio
originalSender
ParamIssueEvent
evento original del envío
previousSender
ParamIssueEvent
evento anterior al consultado
lastSender
ParamIssueEvent
evento ultimo del envio
pararmIssueEvent
ParamIssueEvent
evento consultado
procNum
Long
numero de procedimiento del envío
 
 
Servicio OrganismManagerService
...
GetEmailListByOrgCode
Este método del servicio organismManager permite recuperar el listado de los emails de los usuarios dados de alta en BENT en una bandeja de organismo concreta. BENT únicamente almacena los dnis de los usuarios en su base de datos, recuperando el email a través de SIU. Si un usuario implicado en la búsqueda no tuviera un email registrado el servicio simplemente no lo añadirá al listado de resultados.