Hércules

Árbol de páginas

Versiones comparadas

Versión anterior 5

changes.mady.by.user Usuario desconocido (alicia.alvarez)

Guardado el

comparado con

Nueva versión Actual

changes.mady.by.user Usuario desconocido (alicia.alvarez)

Guardado el

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.


...

Tabla de contenidos

...

Sistema de Gestión Económica de Protección Industrial e Intelectual

Entidades

Hay entidades que se reutilizan del modelo de Ejecución económica del SGE y pero se repiten aquí por claridad aunque ya están descritas en el API del SGE: SGI - ESB - SGE - Ejecución económica.

Entidades

EntidadDescripción
DatoEconomico

Entidad que representa cualquier dato económico. Tendrá que venir identificado por un identificador único, por el proyecto al que pertenece, anualidad, partida presupuestaria y un código económico (opcional en algunos de los casos).

El resto de campos del dato económico se tratarán como columnas dinámicas. Se indicará por cada columna el identificador del campo, el nombre del campo y si es una columna sobre la que se tiene que hacer una suma para mostrarlo en el SGI como un campo totalizador.

Columna

Contiene el listado de columnas que serán mostradas en las pantallas del SGI dependiendo de la pantalla en la que se

esta: Ejecución presupuestaria, detalle de operaciones, validación de gastos, etc...

esté: gastos o repartos.

Por cada columna se tendrá el identificador del campo, el nombre del campo

y

, si es una columna sobre la que se tiene que hacer una suma para mostrarlo en el SGI como un campo totalizador, que, a los efectos de esta integración para las invenciones, equivaldría a identificar dicha columna como de tipo numéricos y si es la columna (solo puede haber una) que se ha de utilizar para hacer el cálculo del importe a deducir en los repartos de regalías.

DatoEconomicoDetalle

Entidad que representa el detalle de un dato económico con todos sus campos para mostrarlo en una pantalla de consulta del dato económico.

Tendrá unos campos fijos (identificador único, identificador del proyecto al que pertenece, anualidad, partida presupuestaria y un código económico) y unos campos dinámicos. Por cada campo se detallará el nombre y el valor del campo para mostrarlo en la pantalla del SGI

Campo

Contiene el listado de campos dinámicos que serán mostradas en las pantallas de detalle de un dato económico.

Por cada campo se tendrá el el nombre y el valor del campo

Invencion

Entidad que representa a la invención cara a poder ser presentada en listas de valores con su títuloDocumentoEntidad que representa los documentos que pueda tener relacionados un dato económico (en este caso los gastos).

Enumerados

EntidadDescripción
TipoDatoEconomico

Puede tomar los siguientes valores:

  • Ingreso
  • Gasto
TipoOperacion

Puede tomar los siguientes valores:

  • GAS
  • REP

Modelo lógico

Image Added

API

Características generales que todas las API REST deben de cumplir:

Definición de los objetos

Hay objetos que se reutilizan del modelo de Ejecución económica del SGE y por tanto no se repiten aquí, están descritos en el API del SGE:  UM - SGI - ESB - SGE - Ejecución económica.

Invencion

NombreTipoDescripción
idStringIdentificador único de la invención.
tituloString

Título de la invención.

DatoEconomico

NombreTipoDescripción
idStringIdentificador del dato económico. Tiene que ser un identificador único.
tipoString

Dos valores:

  • Gasto
  • Ingreso
columnasMap[clave,valor]

Mapa de propiedades.

El valor será un String salvo en aquellas columnas que sean acumulables (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI).

DatoEconomicoDetalle

NombreTipoDescripción
idStringIdentificador del dato económico. Tiene que ser un identificador único.
camposdocumentosLista[CampoDocumento]

Lista de campos, por cada campo se define el nombre y el valor del campodocumentos asociados al gasto (sin el contenido binario del fichero).

Columna

NombreTipoDescripción
idStringIdentificador de la columna
.
nombreStringNombre de la columna
.
acumulableBoolean

Indica

si se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI

si la columna se puede sumar y por extensión, además indica que es numérica.

Dos valores:

  • true
  • false
importeRepartoBoolean

Indica que la columna se corresponde con el importe que se quiere tener en cuenta a la hora de calcular el reparto de regalías. SOLO UNA COLUMNA PODRÁ TENER ESTE CAMPO ACTIVO.

Dos valores:

  • true
  • false

Documento (se reutilizaría el mismo que el definido en UM - SGI - ESB - SGE - Ejecución económica)

NombreTipoDescripción
idStringIdentificador único del documento
nombreStringNombre del documento a mostrar

nombreFichero

StringNombre del fichero con extensión
Método

Servicios

...

URL

...

Parámetros

...

Respuesta

...

q+s (query + sort)

La query estará formada por:

  • invencionId

Lista[Columna]

...

Listado con las columnas que va a devolver la llamada /gastos-invencion.

Por cada columna se indica un id, nombre, si es una columna acumulable (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI).

Por defecto, devolverá las siguientes columnas:

  • Fecha
  • Referencia
  • Concepto
  • Tipo (Honorarios, Tasa, ...)
  • Importe (acumulable = Sí)

...

q+s (query + sort)

La query estará formada por:

  • invencionId

Lista[DatoEconomico]

...

Listado de todos los gastos asociados a una invención.

Para cada gasto se devolverán los siguientes datos:

  • Identificador del gasto
  • Mapa de columnas de clave - valor (donde la clave será los id definidos en la llamada /gastos-invencion/columnas y el valor será el valor de la columna. El valor será un String salvo en aquellas columnas que sean acumulables, esto es, se puedan manejar como un importe y hacer operaciones numéricas con ella en el SGI, donde será de tipo Numérico (sin separador de miles y como separador decimal el punto).

...

DatoEconomicoDetalle

...

Detalle de un gasto.

Para cada gasto se devolverán los siguientes datos:

  • Identificador del gasto
  • Listado de documentos (identificador, nombre del documento y nombre del fichero, sin el contenido)

...

q+s (query + sort)

La query estará formada por:

  • invencionId

Lista[Columna]

...

Listado con las columnas que va a devolver la llamada /ingresos-invencion.

Por cada columna se indica un id, nombre, si es una columna acumulable (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI).

Por defecto, devolverá las siguientes columnas:

  • Fecha
  • Referencia
  • Importe (acumulable = Sí)
  • Nº interno de contrato
  • Entidad pagadora

...

q+s (query + sort)

La query estará formada por:

  • invencionId

Lista[DatoEconomico]

...

Listado de todos los ingresos asociados a una invención (la asociación se realizará a través de contratos de CSP), que se corresponderán con las facturas emitidas.

Para cada ingreso se devolverán los siguientes datos:

  • Identificador del ingreso
  • Mapa de columnas de clave - valor (donde la clave será los id definidos en la llamada /ingresos-pii/columnas y el valor será el valor de la columna. El valor será un String salvo en aquellas columnas que sean acumulables, esto es, se puedan manejar como un importe y hacer operaciones numéricas con ella en el SGI, donde será de tipo Numérico (sin separador de miles y como separador decimal el punto).
Info
Para componer la URL llamada completa, se debe anteponer a lo indicado en la columna URL lo siguiente: {HOST}/api/sge-pii, donde {HOST} de deberá sustituir el dominio correspondiente al entorno al que se está accediendo y dicho acceso será por http o https según el caso.

Hay servicios a los que no se hace mención en este API porque la funcionalidad que los precisa, por ejemplo, la recuperación del binario de cada documento asociado a un gasto, ha de reutilizar los que ya están definidos en el modelo de Ejecución económica del SGE y por tanto no se repiten aquí, están descritos en el API del SGE: UM - SGI - ESB - SGE - Ejecución económica.

Informe de propiedades de página
firstcolumnServicio
headingsMétodo, URL, Parámetros, Respuesta, Descripción
cqllabel = "servicios" and space = currentSpace() and ancestor = currentContent()

...

Columnas Gastos

idnombreacumulabledescripción
1

Fecha

false
A completar con UMU
Fecha de emisión
2ReferenciafalseNº / año factura
3ConceptofalseDescripción de factura
4Tipo
(Honorarios, Tasa, ...)
falseTipo de gasto
5ImportetrueBase imponible

Columnas Ingresos

idnombreacumulabledescripción
1

Fecha

falseA completar con UMUFecha de emisión
2ReferenciafalseSerie-Nº factura / año factura
3ImportetrueBase imponible
3Nº interno de contratofalseIdentificador del contrato del SGI asociado al ingreso
4Entidad pagadorafalseNombre del tercero pagador de la factura emitida

Ejemplos

Columnas de gastos (/gastos-invencion/columnas)

Bloque de código
themeRDark
titleRespuesta
[
 {
   "id": "1"
   "nombre":"Fecha"
   "acumulable": "false"
  },
  {
   "id":"2",
   "nombre":"Referencia",
   "acumulable": "false"
  },
  {
   "id":"3",
   "nombre":"Concepto",
   "acumulable": "false"
  },
  {
   "id":"4",
   "nombre":"Tipo",
   "acumulable": "false"
  },
  {
   "id":"5",
   "nombre":"Importe",
   "acumulable": "true"
  }

]

Gastos (/gastos-invencion)

Bloque de código
themeRDark
titleRespuesta
[
{
	"id":"1",
	"tipo":"Gasto",
	"columnas": {
     	"1":,
     	"2":"F123456",
     	"3":"Informe de patentabilidad",
     	"4":"Honorarios",
     	"5":55.99
     	}
 
},
{
	"id":"2",
	"tipo":"Gasto",
	"columnas": {
     	"1":,
     	"2":"F123457",
     	"3":"Solicitud de patente",
     	"4":"Tasa",
     	"5":99.99
     	}
}
]

Detalle gasto (/gastos-invencion/{id})

Bloque de código
themeRDark
titleRespuesta
"id":"2",
"documentos":[
  {
   "id": "11",  
   "nombre":"Factura",
   "nombreFichero":"factura.pdf"
  },
  {
    "id": "12", 
    "nombre":"Otro documento",
    "nombreFichero":"otroDocumento.pdf"
  }
]

...