Integracion 05 ServiciosWeb Tomo2 APDoc APFamilias Helium 20170711

Manual
Servicios Web AuraPortal

Tomo 2
(11 julio 2017)
Esta publicación pertenece al Servicio de Documentación de AuraPortal (SDAP) y todos los

derechos están reservados. La reproducción total o parcial de este documento, así como la
entrega a terceras partes sin el permiso escrito del SDAP quedan prohibidas.
www.auraportal.com | info@auraportal.com | Skype: AuraPortal | Tel: +34 962 954 497 |
Internacional: +18 572 390 070
ÍNDICE
SERVICIOS WEB AURAPORTAL ..................................................................................................................................4
1. SERVICIO WEB AURAPORTALDOC.ASMX .............................................................................................................4
1.1 FUNCIONALIDAD .............................................................................................................................................4
1.2 CONEXIÓN ........................................................................................................................................................4
1.3 MÉTODOS .........................................................................................................................................................5
1.3.1 Ver los Elementos de una Familia (getElementsFilter) ..............................................................................9

1.3.2 Ver Campos de Filtrado de una Familia (getFilterFields) .........................................................................11
1.3.3 Ver opciones disponibles en Campo de Filtrado (getFilterFieldsOptions)................................................12
1.3.4 Ver Elementos (getElements)...................................................................................................................13
1.3.5 Ver Cuentas (getAccounts) ......................................................................................................................14
1.3.6 Crear Bibliotecas de SharePoint (createLibrary) ......................................................................................14
1.3.7 Ver Sitios Web (getWebSites) ..................................................................................................................15
1.3.8 Ubicar Bibliotecas de SharePoint (lodgeLibraryToTree) .........................................................................15
1.3.9 Ver Niveles del Árbol (getLevelsTree) ......................................................................................................16
1.3.10 Ver Estructura del Árbol (getTree)..........................................................................................................17
1.3.11 Ver Nombre de Bibliotecas de SharePoint Ubicadas (geLibraries) .......................................................17
1.3.12 Ver Nombre y Nivel de Bibliotecas de SharePoint .................................................................................17
1.3.13 Ver Bibliotecas de SharePoint no Ubicadas (getUnLodgedLibraries) ....................................................18
1.3.14 Ver Carpetas de Bibliotecas de SharePoint (getFolders) .....................................................................19
1.3.15 Ver Lista de Columnas de Biblioteca o Anexo de SharePoint (getFields)............................................19
1.3.16 Ver Lista de Opciones de un Campo de Biblioteca o Anexo de SharePoint (getFieldOptions) ...........20
1.3.17 Integrar Documento en Biblioteca de SharePoint (uploadDocumentToLibrary)....................................20
1.3.18 Eliminar Documentos de Biblioteca de SharePoint (DeleteSharePointDoc) .........................................21
1.3.19 Integrar un Documento (uploadIntegratedDocument) ............................................................................21
1.3.20 Ver los Anexos de SharePoint (getAnnexes) .........................................................................................22
1.3.21 Integrar Documentos en un Anexo de SharePoint (uploadDocumentToAnnexe) ..................................23
1.3.22 Rellenar un Anexo de Registros (fillAnnexe) ..........................................................................................24
1.3.23 Obtener Datos de Anexos (getDataAnnexe) ..........................................................................................25
1.3.24 Editar un Anexo (editAnnexe).................................................................................................................26
1.3.25 Eliminar un Anexo (deleteAnnexe) .........................................................................................................26
1.3.26 Ver Lista de Documentos Integrados (getDocIntegrados) .....................................................................26
1.3.27 Ver Lista de Documentos Enlazados (getDocEnlazados) ......................................................................27
1.3.28 Ver Documentos Integrados en XML (getArrayBitsXMLDocIntegrado) .................................................28
1.3.29 Ver Documentos Integrados en Data Set (getArrayBitsDataSetDocIntegrado) .....................................29
1.3.30 Ver Documentos Integrados en Cadena (getArrayBitsStringDocIntegrado) ..........................................29
1.3.31 Integrar Documentos en Bibliotecas en Diccionario (UploadDocumentToDictionaryLibrary_...) ...........29
1.3.32 Lista de documentos en Bibliotecas en Diccionario (GetDocDictionaryLibraryList) ...............................30
1.3.33 Actualizar Etiquetas en Bibliotecas en Diccionario (UpdateDocDictionaryLibraryLabels)......................30
1.3.34 Actualizar Etiquetas en Bibliotecas en Diccionario (UpdateDocumentDictionaryLibraryLabelsProcess)30
1.3.35 Traspasar Documentos entre Bibliotecas en Diccionario (TransferDocDictionaryLibrary) .....................30
1.3.36 Obtener Documentos en Bibliotecas en Diccionario ..............................................................................30
1.3.37 Eliminar Documentos en Bibliotecas en Diccionario ..............................................................................30
1.3.38 Crear Fichero de Configuración (Crear_AuraPortalDocConfigXML) ......................................................30
1.3.39 Comprobar Acceso a AuraPortal (isValidAccess) ..................................................................................31
2. SERVICIO WEB AURAPORTALFAMILIAS.ASMX ..................................................................................................31
2.1 FUNCIONALIDAD ...........................................................................................................................................31
SERVICIOS WEB – TOMO 2 Página 2 de 65

2.2 CONEXIÓN ......................................................................................................................................................31
2.3 MÉTODOS .......................................................................................................................................................32
2.3.1 Ver ID de Elementos (GetId… Empleado, Cuenta, Rol, Item, Proyecto, Ambito) ....................................35
2.3.2 Ver ID de Roles Personales (GetRole_ID) ...............................................................................................36
2.3.3 Ver Datos de Elementos (GetFicha… Empleado, Cuenta, Rol, Item, Proyecto, Ambito) ........................38
2.3.4 Crear Elementos (CreateFicha … Empleado, Cuenta, Rol, Item, Proyecto, Ambito) ..............................39
2.3.5 Crear Roles Personales (CreatePersonalRole) ........................................................................................41
2.3.6 Ver Nombre Interno de los Términos de los Roles Personales (GetPersonalRoles_Terms) ...................47
2.3.7 Exportar Roles Personales a Excel (ExportPersonalRoles_XlS) .............................................................48
2.3.8 Modificar Elementos (UpdateFicha … Empleado, Cuenta, Rol, Item, Proyecto, Ambito) ........................48
2.3.9 Modificar datos de Roles (UpdatePersonalRole) .....................................................................................50
2.3.10 Eliminar Elementos (DeleteFicha … Empleado, Cuenta, Rol, Item, Proyecto, Ambito) .........................51
2.3.11 Ver Costes e Ingresos Previstos (GetCostesPrevistos y GetIngresosPrevistos) ...................................53
2.3.12 Crear Costes e Ingresos Previstos (CreateCostesPrevistos y CreateIngresosPrevistos) .....................54
2.3.13 Eliminar Costes e Ingresos Previstos (DeleteCostesPrevistos y DeleteIngresosPrevistos) ..................55
2.3.14 Ver Ítems Enlazados (GetItems...) .........................................................................................................56
2.3.15 Enlazar Ítems en Familias (LinkItem…)..................................................................................................57
2.3.16 Eliminar Enlaces de Items (DeleteItem…)..............................................................................................58
2.3.17 Enlazar URL en Familias (LinkUrl…)......................................................................................................59
2.3.18 Para la gestión de Familias Propias .......................................................................................................60
2.3.19 Ver Cargos de Empleados (GetCargosEmpleado) ................................................................................62
2.3.20 Acceso a datos por Reporting Services (EmployeeLoginMatch) ...........................................................63
2.3.21 Comprobar un Login (AccessEmployee) ................................................................................................63
2.3.22 Comprobaciones sobre un Usuario Invitado (AccessGuestUser) ..........................................................64
2.3.23 Encontrar una Cuenta con su CIF (GetAccountByCIF) ..........................................................................64

SERVICIOS WEB AURAPORTAL
Esta documentación está dividida en 5 Tomos.
• En el Primer Tomo se incluye información detallada sobre AURAPORTALPROCESOS y

AURAPORTALTAREAS.
• Este Segundo Tomo incluye todo lo referente a AURAPORTALDOC y AURAPORTALFAMILIAS.
• El Tercer Tomo contiene información sobre generalidades y ejemplos de programación, ejecución de
un Procedimiento Almacenado y Localización de Datos en Listas de SharePoint.
• El Cuarto Tomo contiene información sobre cómo obtener datos del Panel de Procesos.
• El Quinto tomo incluye información sobre los métodos específicos para manejar Bibliotecas en
Diccionario.
1. SERVICIO WEB AURAPORTALDOC.ASMX

Para manejar documentos en AuraPortal desde programas externos está disponible el Servicio Web
AuraPortalDoc.
Además de poder diseñar programas a medida para utilizar el Servicio Web AuraPortalDoc, AuraPortal incluye
una utilidad llamada AuraPortal Ingresador que sirve para ingresar documentos en AuraPortal fácilmente
desde Windows, Outlook, Word y Excel, sin necesidad de tener una sesión iniciada de AuraPortal. El
funcionamiento de AuraPortal Ingresador está explicado dentro de la documentación AuraPortal Utilidades,
conjunto de programas que además incluye AuraPortal Avisador (anteriormente llamada Acción Bell) y los
Add-In de Outlook, Word y Excel.
A continuación, se describen todos los detalles del Servicio Web AuraPortalDoc.
1.1 Funcionalidad
Las posibles operaciones del Servicio Web son:
• Integrar y ver documentos de la Ficha de elementos de cualquier familia de AuraPortal.

• Integrar y ver documentos de una Biblioteca de Documentos que esté ubicada en el árbol de
documentos de AuraPortal.
• Cumplimentar Anexos en AuraPortal y ver datos de Anexos ya existentes.
• Manejar Documentos Integrados en Bibliotecas en Diccionario.
1.2 Conexión
Para iniciar el servicio hace falta especificar los siguientes valores:
• URL del servicio (http://host.dominio.com/Home/webservice/AuraPortaldoc.asmx)
(“host.dominio.com” depende de cada instalación)
• Usuario / Contraseña (el usuario debe estar dado de alta en AuraPortal y en SharePoint)
El usuario indicado será el que se muestre como CREADOR del documento en AuraPortal. Debe ser un usuario
con permisos para ingresar contenido en el destino de AuraPortal elegido (Biblioteca, Anexo, Ficha), es decir:

• En Tareas Libres y Programadas (No Personales de Proceso, que tienen sus propios Servicios Web):
El usuario ha de ser el Asignado de la tarea y ésta no ha de estar Terminada.
• En Empleados, Cuentas, Ítems, Proyectos y Áreas: El usuario ha de tener el permiso de Edición en

la Clase de la familia de AuraPortal correspondiente (Estructura – Empleados – Grupos –
Autorizados en Clases).
• En Bibliotecas y Anexos: El usuario ha de tener permiso Agregar Elementos de SharePoint en la

Biblioteca o Lista.
1.3 Métodos
Para ver los métodos del Servicio Web AuraPortalDoc hay teclear la URL del Servicio Web:
http://host.dominio.com/Home/webservice/AuraPortaldoc.asmx
y obtendremos la página con la lista de métodos del Servicio Web AuraPortalDoc, semejante a la de la
siguiente imagen:
Si pulsamos sobre el link Service Description (o añadimos ?WSDL a la URL) obtendremos la descripción del
Servicio Web o WSDL (Web Service Description Language) en formato XML.
Si pulsamos sobre uno de los métodos, por ejemplo getAnnexes, método que sirve para ver los Anexos de un
determinado elemento, obtendremos el siguiente resultado:

Si estamos trabajando desde el propio servidor de AuraPortal tendremos la posibilidad de poner valores en las
dos casillas de parámetros: family, elementId, y en <soap:Body> veremos el tipo de valor que requiere cada
parámetro, en este caso:
<family>Empleado or Tarea or Documento or Cuenta or Item or Proyecto or Ambito </family> =

Corresponde a la familia de la que queremos ver los Anexos, exactamente escritas como está mostrado,
respetando mayúsculas y minúsculas, es decir, Empleado, Tarea, Documento, Cuenta, Item, Proyecto o
Ambito.
- <elementId>int</elementId > = Número entero que corresponde al ID del elemento del cual
queremos ver sus Anexos.
Para mejor comprensión de cómo se pueden utilizar los métodos del Servicio Web AuraPortalDoc, primero
mostramos esquemáticamente las funcionalidades en general, y después todos los detalles de los métodos en
apartados específicos para cada uno:
VER ELEMENTOS DE UNA FAMILIA
Para ver elementos de todas las familias excepto Documentos (Empleados, Tareas Libres y Programadas (No
Personales de Proceso), Cuentas, Ítems, Proyectos y Áreas) está el método:
- getElementsFilter, que, indicando ciertas condiciones en los campos de filtrado, se muestran los
elementos encontrados.
Los campos para hacer filtrados son tres: ID, Nombre y Código ERP, excepto en Tareas que son dos (no hay
Código ERP).
En previsión de ampliaciones futuras se han desarrollado dos métodos complementarios, llamados:
- getFilterFields, para ver los campos de filtrado disponibles.

- getFilterFieldsOptions que obtiene las opciones disponibles de los campos de filtrado obtenidos
con el método getFilterFields.
También están disponibles otros dos métodos adicionales para ver elementos, con menos condiciones de
filtrado que getFilterFields, pero que son válidos por su sencillez. Son el getElements y el getAccounts:
- getElements: La principal diferencia es que los campos de búsqueda son fijos; siempre son la
Familia, el Nombre, el Código ERP y el ID:
- getAccounts: Está orientado sólo a Cuentas y sólo tiene disponibles dos campos fijos de búsqueda:
Nombre y Código ERP.
CREAR BIBLIOTECAS DE SHAREPOINT
Para la creación y manejo de Bibliotecas de SharePoint (en este apartado, siempre que se hable de Bibliotecas,
nos referimos a Bibliotecas de SharePoint) hay varios métodos:
▪ Crear bibliotecas: Con el método createLibrary se pueden crear Bibliotecas de todos los tipos (de
Imágenes, Listas Personalizadas, XML, Foros de Discusión, Encuestas, Eventos y Documentos).
▪ Obtener los Web Sites: Con getWebSites se obtienen los Web Sites de una instalación de
AuraPortal en donde se pueden crear Bibliotecas.
▪ Ubicar bibliotecas en árbol. Con lodgeLibraryToTree se ubican bibliotecas en el árbol. Sus

parámetros necesitan los siguientes métodos.
▪ Ver Niveles del árbol: Con getLevelsTree se obtienen los niveles del árbol de Bibliotecas.
▪ Ver estructura del árbol: Con getTree se obtiene la estructura completa del árbol, esto es, los
Niveles (igual que con getLevelsTree) y además las Bibliotecas ubicadas.
▪ Ver Bibliotecas Ubicadas: Hay dos métodos para ver las Bibliotecas ubicadas en el árbol: Con
getLibraries se obtiene sólo la lista de nombres de Bibliotecas, y con getLodgedLibraries se
obtienen los nombres y además el Nivel en donde están ubicadas.
▪ Ver Bibliotecas no Ubicadas: Con getUnLodgedLibraries se obtiene las Bibliotecas pendientes de

ubicar en el árbol.
INTEGRAR DOCUMENTOS EN UNA BIBLIOTECA DE SHAREPOINT
Para integrar documentos en una Biblioteca de SharePoint hay varios métodos relacionados:
▪ Ver carpetas de Bibliotecas: Con el método getFolders se obtiene la estructura de carpetas de las
Bibliotecas de SharePoint ubicadas en el árbol.
▪ Ver campos de la Biblioteca: Con el método getFields se obtiene la lista de columnas de

disponibles en una Biblioteca de SharePoint determinada.
▪ Ver opciones de los campos de una Biblioteca de SharePoint: Con el método getFieldOptions,
obtendremos la lista de opciones disponibles en las columnas de la Biblioteca determinada.
▪ Integrar documento en Bibliotecas de SharePoint: Una vez ya hemos localizado la Biblioteca, sus
columnas y opciones, finalmente podremos integrar el documento con el método
uploadDocumentToLibrary.

Además de en una Biblioteca, los documentos se pueden integrar en:
- La Ficha de un Elemento (Empleado, Tarea Libre o Programada, Cuenta, Ítem, Proyecto o Área).
- Uno de sus Anexos.
- Un Proceso.
INTEGRAR DOCUMENTOS EN LA FICHA DE UN ELEMENTO
▪ Integrar documentos en la Ficha de un elemento: Con el método uploadIntegratedDocument se

puede integrar el documento en la Ficha de cualquier elemento.
INTEGRAR DOCUMENTOS EN ANEXOS
Para integrar documentos en un Anexo, tenemos varios métodos relacionados:
▪ Ver los Anexos del elemento: Con el método getAnnexes obtendremos los Anexos que tiene
disponibles el elemento seleccionado.
▪ Ver campos de un Anexo: Con el método getFields ya comentado antes, obtendremos la lista de
columnas de SharePoint disponibles en el Anexo determinado.
▪ Ver opciones de los campos de un Anexo: Con el método getFieldOptions ya comentado antes,
obtendremos la lista de opciones disponibles en las columnas del Anexo determinado.
▪ Integrar documento en Anexo: Una vez ya hemos localizado el Anexo, sus columnas y opciones,
finalmente podremos integrar el documento con el método uploadDocumentToAnnexe.
INTEGRAR DOCUMENTOS EN PROCESOS
▪ Los métodos para manejar documentos en Procesos están en el Servicio Web AuraPortalProcesos.
Dirigirse al capítulo correspondiente en este documento para ver todos los detalles.
RELLENAR UN ANEXO SIN DOCUMENTO
▪ Si en vez de integrar un documento en un Anexo, lo que se desea es rellenar un nuevo Anexo en una
biblioteca de registros (Lista de SharePoint), es decir, sólo introducir datos sin necesidad de adjuntar
documentos, se utiliza el método fillAnnexe.
MODIFICAR UN ANEXO YA CREADO
▪ Para modificar un registro de un Anexo, se utiliza el método editAnnexe, muy parecido a fillAnnexe.
ELIMINAR UN ANEXO
▪ Para eliminar un registro de un Anexo, se utiliza el método deleteAnnexe.
VER DOCUMENTOS Y ANEXOS
La obtención de documentos y Anexos tiene los siguientes métodos específicos:
▪ Con el método getDataAnnexe se obtienen los datos de un Anexo ya rellenado.
▪ Con el método getDocIntegrados se puede visualizar un listado con los IDs y nombres de los
documentos integrados a una familia. Si la familia es una tarea, además indica cual es el principal.

▪ Con el método getDocEnlazados se puede visualizar un listado con los IDs, nombres y URLs de los
documentos enlazados a una familia. Si la familia es una tarea, además indica cual es el principal.
▪ Con el método getArrayBitsXMLDocIntegrado se obtiene el nombre y el array de bits de un

documento integrado en formato XML.
▪ Con el método getArrayBitsDataSetDocIntegrado se obtiene el nombre y el array de bits de un

documento integrado, estructurados en un DataSet.
▪ Con el método getArrayBitsStringDocIntegrado se obtiene el nombre y el array de bits de un

documento integrado, estructurado en una cadena de caracteres.
MANEJO DE DOCUMENTOS INTEGRADOS EN BIBLIOTECAS EN DICCIONARIO
Para manejar documentos integrados en Bibliotecas en Diccionario existen los siguientes métodos:
▪ Con el método UploadDocumentToDictionaryLibrary_Unique se integran documentos y permite

rellenar sus Etiquetas. Permite especificar si están asociados a uno de los elementos siguientes:
o Panel de un Proceso
o Ficha de Familia Propia
o Ficha de Rol Personal o
▪ Grupo de Campos dentro de uno de los elementos anteriores.
▪ Con el método UploadDocumentToDictionaryLibrary_Divided también se integran documentos y

permite rellenar sus Etiquetas pero permite dividir el ingreso en porciones. Recomendado cuando los
documentos son mayores de 20 o 25 MB.
▪ Con el método GetDocDictionaryLibraryList se obtiene la lista de Token de documentos filtrada por

Etiquetas.
▪ Con el método UpdateDocDictionaryLibraryLabels se pueden actualizar Etiquetas de documentos ya

existentes y rellenar etiquetas con metadatos en el momento de integrar documentos.
▪ Con el método TransferDocDictionaryLibrary, similar a la Tarea de Sistema TRASPASADOR (Traspasa

documentos entre Bibliotecas En Diccionario), se traspasan documentos entre Bibliotecas con
almacenamiento en File System.
▪ Con el método GetDocDictionaryLibrary se obtienen documentos.
▪ Con el método DeleteDocDictionaryLibrary se eliminan documentos.
Todos estos métodos se incluyen en el tomo 5 de esta documentación.
A continuación, se muestran más detalles de los métodos del Servicio Web AuraPortalDoc:
1.3.1 Ver los Elementos de una Familia (getElementsFilter)

El método para ver los elementos de la familia que cumplen las condiciones de filtrado solicitadas es
getElementsFilter, siendo sus parámetros:
Nota.
Desde AuraPortal v3.1, se ha sustituido el nombre de la Familia Ámbitos por Áreas.
Sin embargo, por compatibilidad con programas externos que hayan sido realizados

con versiones anteriores, los métodos de los Servicios Web relacionados con esta
Familia, han conservado su nombre original basado en la palabra ‘ambito’.
Parámetros Explicación
< family > (Familia) Familia sobre la que se va a efectuar la búsqueda con los criterios especificados en
el parámetro <filterValues>.
Los posibles valores son:
Empleado
Tarea
Documento (para documentos no procede este método. Utilizar getLibraries)
Cuenta
Item
Proyecto
Ambito
(Hay que respetar mayúsculas y minúsculas)
< filterValues > Hay que indicar una lista de valores (Array), según los posibles valores obtenidos
(ValorCampo[ ]) con getFilterFields, con los que se quiere hacer el filtrado. Actualmente (de
AuraPortal), la lista tendría que tener los valores siguientes:
IdCampo (obtenido con getFilterFields)

NombreCampoInterno (obtenido con getFilterFields)
Valor (entero o string indicando la condición de filtrado deseada)
Si no se indica correctamente el parámetro family (por ejemplo, porque no se han
respetado las mayúsculas y minúsculas), se obtendrá una devolución del tipo
System.ArgumentException.
Valor devuelto Explicación
Lista de elementos de AuraPortal que cumplen las condiciones de filtrado

( ElementoFamilia[ ] )
indicadas.
Este método sólo devolverá los elementos en los que el usuario que lo ejecuta tenga permisos para ingresar
documentos, es decir:
• Las Tareas Libres y Programadas (No Personales de Proceso) en las que el usuario sea el Asignado
y no estén Terminadas.
• Los Empleados, Cuentas, Ítems, Proyectos y Áreas en donde el usuario tenga permiso AuraPortal
de Edición.
• Devolverá todas las Bibliotecas, si bien finalmente sólo podrá ingresar documentos en la Biblioteca
donde el usuario tenga permiso de SharePoint de “Agregar Elementos”.
Por ejemplo, para ver las Tareas Libres se puede utilizar el método GetElementsFilter indicando Tarea en el
parámetro family y la siguiente estructura en filterValues:

<filtervalues>
<ValorCampo>
<IdCampo>0</IdCampo>
<NombreCampoInterno>Nombre</NombreCampoInterno>
<Valor></Valor>
</ValorCampo>
<ValorCampo>
<IdCampo>2</IdCampo>
<NombreCampoInterno>ID</NombreCampoInterno>
<Valor></Valor>
</ValorCampo>
</filterValues>
Este método devolverá la lista de tareas pendientes del empleado de AuraPortal que lo ejecute, y hay dos
posibles condiciones de filtrado, que son el Nombre (o parte) y el ID, cada uno indicado en el valor
correspondiente del esquema anterior. Si no se indica ningún valor, se devolverán todas las tareas del
empleado de AuraPortal que lo ejecute.
1.3.2 Ver Campos de Filtrado de una Familia (getFilterFields)

Para localizar los campos disponibles para hacer búsquedas de elementos de AuraPortal se utiliza el método
getFilterFields.
Están disponibles tres campos, que son Nombre, Código ERP e ID (en tareas sólo dos porque se omite el
Código ERP).
Los parámetros disponibles son:
Nota.
< family > (Familia) Es la Familia para la que se van a ver los campos de filtrado disponibles. Los
posibles valores son:
Empleado
Tarea
Documento (para documentos no procede este método. Utilizar getFields)
Cuenta
Item
Proyecto
Ambito

( Campo[ ] ) Lista de campos disponibles para hacer el filtrado.

Hay disponibles tres campos, que son:
Nombre
ID
Código ERP
(En tareas sólo dos, se omite el Código ERP).
Si no se indica correctamente el parámetro family (por ejemplo, porque no se han

respetado las mayúsculas y minúsculas), se obtendrá una devolución del tipo
1.3.3 Ver opciones disponibles en Campo de Filtrado (getFilterFieldsOptions)

Con el método getFilterFieldsOptions se obtienen las posibles opciones disponibles de los campos de
filtrado obtenidos con el método anterior (getFilterFields).
Actualmente no es necesario utilizar este método porque no hay opciones en los campos de filtrado. Será útil
cuando se añadan en el futuro.
Nota.
Sus parámetros son los siguientes:
< family > (Familia) Es la Familia para la que se van a ver los campos de filtrado disponibles. Los
posibles valores son:
Empleado
Tarea
Documento (para documentos no procede este método. Utilizar
getFielOptions)
Cuenta
Item
Proyecto
Ambito
Es el ID del campo del que se van a recuperar los valores. Este ID se obtiene
< fieldId > (int)
con el método getFilterFields.

( OpcionCampo[ ] ) Lista de opciones válidas del campo de filtrado solicitado.
Actualmente los campos de filtrado no tienen opciones, por lo que no se

obtendrán resultados.
Si no se indica correctamente el parámetro family (por ejemplo, porque no se

han respetado las mayúsculas y minúsculas), se obtendrá una devolución del
tipo System.ArgumentException.
Si no se indica el parámetro fielId, se obtendrá una devolución del tipo

System.FormatException.
1.3.4 Ver Elementos (getElements)

El método getElements es parecido a geElementsFilter, pero los campos de filtrado son fijos. Sus parámetros
son los siguientes:
Nota.
< family > (Familia) Familia sobre la que se va a efectuar la búsqueda con los criterios especificados
en el parámetro <filterValues>. Es un campo obligatorio para ver datos.
Empleado
Tarea
Documento (para documentos no procede este método. Utilizar
getLibraries)
Cuenta
Item
Proyecto
Ambito
Parte del Nombre del elemento que deseamos localizar. En el caso de Cuentas,
< name > (string)
es válido tanto el Nombre Comercial como la Razón Social. No es obligatorio.
< code > (string) Parte del Código ERP de la Cuenta de AuraPortal. No es obligatorio.
ID de la Cuenta de AuraPortal en la lista de SharePoint AP__CuentasFichas. Es

< id > (string)
obligatorio rellenar este valor.

Si se desea no especificar el id para ver todos los elementos, introducir el
número cero (0) en este parámetro.
Se obtendrá la lista de Cuentas que cumplen las condiciones de filtrado.
Si no se indica correctamente el parámetro family (por ejemplo, porque no se

han respetado las mayúsculas y minúsculas), se obtendrá una devolución del
( Cuenta[ ] )
tipo System.ArgumentException.
Si no se indica el parámetro id se obtendrá una devolución del tipo

System.FormatException. Para ver todos los elementos indicar el valor 0.
1.3.5 Ver Cuentas (getAccounts)

GetAccounts es un método parecido a getElements y a geElementsFilter, pero indicado sólo para Cuentas y
con menos campos de filtrado. Sus parámetros son los siguientes:
Parte del Nombre Comercial o Razón Social de una Cuenta de

< name > (string)
AuraPortal.
< code > (string) Parte del Código ERP de la Cuenta de AuraPortal.
Se obtendrá la lista de Cuentas que cumplen las condiciones de

( Cuenta[ ] )
filtrado.
1.3.6 Crear Bibliotecas de SharePoint (createLibrary)

El método utilizado para crear bibliotecas es createLibrary, siendo sus parámetros:
< WebSite > (string) Sitio Web en donde se desea crear la Biblioteca. Los Sitios Web
posibles se obtienen con el método getWebSites explicado en el
apartado siguiente.
< Name > (string) Nombre que se desea para la Biblioteca que se va a crear.
< Type > Tipo de Biblioteca que se va a crear. Los posibles valores son los
siguientes:
PictureLibrary: Biblioteca de Imágenes.

GenericList: Lista Personalizada.
XMLForm: Biblioteca de Formularios XML.
DiscussionBoard: Biblioteca de Foros de Discusión.

Survey: Biblioteca de Encuestas.
Events: Biblioteca de Agendas.
DocumentLibrary: Biblioteca de Documentos.
Es necesario respetar Mayúsculas/Minúsculas. De lo contrario se
obtendrá una devolución del tipo System.ArgumentException.
( XML ) Si la Biblioteca se ha creado correctamente devolverá el número

0.
Si hay algún problema se devolverá un número negativo, por

ejemplo:
-2: Nombre de Biblioteca incorrecto.

-3: Biblioteca ya existe.
-4 : Sitio Web incorrecto.
-9 : Problema indefinido.
o bien, una devolución del tipo System.ArgumentException (por
ejempo si no se han respetado Mayúsculas/Minúsculas en el
parámetro Type).
1.3.7 Ver Sitios Web (getWebSites)

El método utilizado para obtener los Sitios Web donde crear bibliotecas es getWebSites. Es un método sin
parámetros, que directamente devuelve los Sitios Web en el siguiente formato:
( XML ) Devuelve un documento XML con los siguientes valores:
<Name>: Nombre dado al Sitio Web en la Estructura de

AuraPortal (Estructura – FAMILIAS –Documentos – Sitios de
SharePoint).
<WebSite>: Nombre del Web Site, tal como se tiene que utilizar
en los métodos createLibrary, lodgeLibraryToTree y
getUnLodgedLibraries.
<ID>: Identificación interna.
1.3.8 Ubicar Bibliotecas de SharePoint (lodgeLibraryToTree)

El método utilizado para ubicar Bibliotecas en el árbol es lodgeLibraryToTree, siendo sus parámetros:

< LibraryName > (string) Nombre de la biblioteca que se desea ubicar. Se puede obtener con
el método getUnLodgedLibraries.
< WebSite > (string) Nombre del Web Site en donde está la biblioteca indicada en el
parámetro anterior (LibraryName), tal como se obtiene con el
método getWebSites.
< Level > (string) Nivel del árbol donde se desea ubicar la Biblioteca.
Se puede obtener con los métodos getLevelsTree (el parámetro

Level) y con getTree (el parámetro Ubicación).
Nótese que siempre acaba con punto, por ejemplo 3.1.
( XML ) Si la Biblioteca se ha creado correctamente devolverá el número 0.
Si hay algún problema se devolverá un número negativo, por

ejemplo:
-4 : Sitio Web incorrecto.

-5 : Biblioteca ya ubicada en este Nivel o Nivel incorrecto.
-6 : No existe la Biblioteca indicada.
-9 : Nivel erróneo o problema indefinido.
o bien una devolución del tipo System.ArgumentException si se ha
introducido algún valor incorrecto.
1.3.9 Ver Niveles del Árbol (getLevelsTree)

Hay dos métodos para ver los Niveles del árbol de documentos, que son getLevelsTree y getTree. La
diferencia entre ambos es que el primero únicamente muestra los Niveles del árbol, mientras que el segundo
muestra toda la estructura, incluido los documentos ubicados.
GetLevelsTree no tiene parámetros y al invocarlo devuelve los siguientes valores:
<IdLevelSup>: Identificación del Nivel Superior. Vacío si no hay

Nivel superior.
<Level>: Es el nivel en el árbol y por tanto, valor del parámetro

Level del método LodgeLibraryToTree.
<LevelName>: Nivel y nombre mostrados en el árbol.

1.3.10 Ver Estructura del Árbol (getTree)
Hay dos métodos para ver los Niveles del árbol de documentos, que son GetLevelsTree y getTree. La
diferencia entre ambos es que el primero únicamente muestra los Niveles del árbol, mientras que el segundo
muestra toda la estructura, incluido los documentos ubicados.
GetTree no tiene parámetros y al invocarlo devuelve los siguientes valores:

<Title>: Nombre mostrado en el árbol.
<Ubicacion>: Es el nivel en el árbol y por tanto, valor que interesa
en el parámetro Level del método LodgeLibraryToTree.
<IdNivelSup>: Identificación del Nivel Superior. -1 si no hay Nivel
superior
<OrdenNivel>: Uso interno.
1.3.11 Ver Nombre de Bibliotecas de SharePoint Ubicadas (geLibraries)

El método utilizado para ver la lista de bibliotecas ubicadas en el árbol de documentos de AuraPortal es
getLibraries, con un sólo parámetro:
< libraryName > (string) Parte del Nombre de la biblioteca que se está buscando. Si no se
rellena se obtiene la lista completa de bibliotecas ubicadas en el
árbol de documentos de AuraPortal.
( XML ) Devuelve un documento XML con el ID y Nombre de las

Bibliotecas ubicadas en el árbol de documentos de AuraPortal, que
cumplen las condiciones de filtrado. Corresponde a la lista de
SharePoint AP__BibliotecasArbol.
El ID obtenido será utilizado en otros métodos, como por ejemplo

el getFolders para ver las carpetas que contengan las bibliotecas.
Hay un método muy similar, llamado getLodgedLibraries, que

además de los nombres de las Bibliotecas también muestra el Nivel
en donde están ubicadas y su Sitio Web.
1.3.12 Ver Nombre y Nivel de Bibliotecas de SharePoint

Para, además de obtener la lista de nombres de bibliotecas ubicadas en el árbol, obtener también el Nivel en
donde están ubicadas, está el método getLodgedLibraries, siendo sus parámetros:

< libraryName > (string) Parte del Nombre de la biblioteca que se está buscando. Si no se
rellena se obtiene la lista completa de bibliotecas ubicadas en el
árbol de documentos de AuraPortal.
( XML ) Devuelve un documento XML con el ID, Nivel, Nombre y Sitio

Web de las Bibliotecas ubicadas en el árbol de documentos de
AuraPortal, que cumplen las condiciones de filtrado. Corresponde
a la lista de SharePoint AP__BibliotecaArbol.
<ID> : Identificación interna de la biblioteca.

<Level> : Nivel donde está ubicada en el árbol.
<LibraryName> Nombre de la biblioteca.
<WebSite> Sitio Web donde está la biblioteca.
El ID obtenido será utilizado en otros métodos, como por ejemplo
en getFolders para ver las carpetas que contengan las bibliotecas.
Hay un método similar, llamado getLibraries, que sólo muestra los

nombres de las Bibliotecas ubicadas.
1.3.13 Ver Bibliotecas de SharePoint no Ubicadas (getUnLodgedLibraries)

El método utilizado para obtener la lista de bibliotecas no ubicadas en el árbol de Documentos de AuraPortal
es getUnLodgedLibraries, siendo sus parámetros:
< WebSite > (string) Sitio Web donde está la biblioteca que se está buscando. Los
posibles valores se obtienen en el parámetro <WebSite> del
método getWebSites.
En un campo obligatorio. Si no se indica se obtendrá el código -1.
< LibraryName > (string) Parte del Nombre de la biblioteca que se está buscando. Si no se
rellena se obtiene la lista completa de bibliotecas no ubicadas en
el árbol, del Sitio Web indicado.
( XML ) Devuelve el Nombre de las Bibliotecas que no están ubicadas en

el árbol de documentos de AuraPortal, y que cumplen las
condiciones de filtrado.
Si se produce un problema se devuelve uno de los números

negativos siguientes:
-1 : Obligatorio indicar el parámetro WebSite.

-4 : Problema en el Sitio Web indicado.
1.3.14 Ver Carpetas de Bibliotecas de SharePoint (getFolders)

El método utilizado para ver la estructura de Carpetas de las Bibliotecas es getFolders. Es un método con un
único parámetro:
Es el ID de la biblioteca de la que se quiere ver las Carpetas.

< libraryId > (Int)
Este ID se obtiene con el método anterior, getLibraries.
Devuelve un fichero XML con la estructura de Carpetas de la

DataSet (XML )
biblioteca seleccionada, en formato DataSet.
1.3.15 Ver Lista de Columnas de Biblioteca o Anexo de SharePoint (getFields)

El método utilizado para ver la lista de columnas de una Biblioteca o Anexos es getFields, siendo sus
parámetros:
< storageType > Hay dos posibles valores:
Anexo
Biblioteca
< idStorage > (int) ID del Anexo o Biblioteca de la que se quieren ver sus columnas
de SharePoint:
En el caso de Bibliotecas es el obtenido con el método

getLibraries, y se corresponde al ID en la lista de SharePoint
AP__BibliotecasArbol.
En el caso de los Anexos es el obtenido con el método

getAnnexes y corresponde al ID en la lista de SharePoint
AP__Anexos.
( Campo [ ] ) Lista de columnas de la Biblioteca o Anexo especificados.
La lista de opciones disponibles en una columna se obtiene con

el método getFieldOptions.
Si no se indica correctamente el parámetro storageType (por

ejemplo, porque no se han respetado las mayúsculas y

minúsculas), se obtendrá una devolución del tipo
1.3.16 Ver Lista de Opciones de un Campo de Biblioteca o Anexo de SharePoint

(getFieldOptions)
El método utilizado para ver la lista de opciones disponibles de un campo de una Biblioteca o Anexo de
documentos es getFieldOptions, siendo sus parámetros:
< storageType > Hay dos posibles valores:
Anexo
Biblioteca
< idStorage > (int) ID del Anexo o Biblioteca de la que se quieren ver sus columnas de
SharePoint:
En el caso de los Anexos es el obtenido con el método getAnnexes y

es el ID en la lista de SharePoint AP__Anexos.
En el caso de Bibliotecas es el obtenido con el método getLibraries, y

es el ID en la lista de SharePoint AP__BibliotecasArbol.
< internalName > (string) Nombre Interno del campo del que se quieren conocer los valores,
obtenido con el método getFields.
Lista de opciones de un campo de una biblioteca de documentos.
( OpcionCampo[ ] ) Si no se indica correctamente el parámetro storageType (por ejemplo,

porque no se han respetado las mayúsculas y minúsculas), se obtendrá
una devolución del tipo System.ArgumentException.
1.3.17 Integrar Documento en Biblioteca de SharePoint

(uploadDocumentToLibrary)
El método utilizado para integrar un documento en una biblioteca que esté ubicada el árbol de documentos
de AuraPortal es uploadDocumentToLibrary, siendo sus parámetros:
< name > (string) Nombre del documento.
< data > (base64Binary) Contenido binario del fichero.

< libraryId > (int) ID de la Biblioteca de documentos en la lista de SharePoint
Se obtiene con el método getLibraries.
<UrlDestino> (string) URL de la Biblioteca de documentos en SharePoint.
< fieldValues > (ValorCampo[ ]) Array de valores a introducir en las columnas de SharePoint
disponibles, obtenidas con el método getFields.
< overwrite > (bool) Indica si se va a sobrescribir el fichero en el caso de que exista
uno con el mismo nombre en la biblioteca de documentos.
Devuelve una cadena vacía si el documento se ha integrado

( string ) correctamente, o un mensaje en caso de producirse algún
problema.
1.3.18 Eliminar Documentos de Biblioteca de SharePoint (DeleteSharePointDoc)

El método utilizado para eliminar documentos de una biblioteca que esté ubicada el árbol de documentos de
AuraPortal es DeleteSharePointDoc, siendo sus parámetros:
<Doc_Name > (string) Nombre completo del documento o parte de él con comodines.
< library_ID > (int) ID de la Biblioteca de documentos en la lista de SharePoint

Se obtiene con el método getLibraries.
( string ) Devuelve los siguientes códigos:
0 : Correcto, ningún documento borrado.

>0 : Correcto, número de documentos borrados.
-1 : No se encontró la biblioteca.
-2 : No tiene permisos en la biblioteca.
-3 : Nombre de documento vacío.
-4 : El nombre del documento contiene caracteres no válidos.
1.3.19 Integrar un Documento (uploadIntegratedDocument)

El método utilizado para integrar un documento en la Ficha de un elemento de AuraPortal es
uploadIntegratedDocument, siendo sus parámetros:

< family > (Familia) Familia a la que pertenece el elemento al que se va a integrar el
documento.
< elementId > (int) ID del elemento (Empleado, Tarea, Cuenta, Ítem, Proyecto o Área) al
que se va a integrar el documento, obtenido con los métodos
getElementFilter, getElements o getAccounts.
< overwrite > (bool) Indica si se va a sobrescribir el fichero en el caso de que exista uno con
el mismo nombre en la biblioteca de documentos.
Devuelve una cadena vacía si el documento se ha integrado

( string )
correctamente, o un mensaje en caso de producirse algún problema.
1.3.20 Ver los Anexos de SharePoint (getAnnexes)

El método para ver los Anexos rellenados en un elemento de una familia determinada es getAnnexes, siendo
sus parámetros:
Nota.
< family > (Familia) Familia sobre la que se va a efectuar la búsqueda con el parámetro
<elementId>. Es un campo obligatorio para ver datos.
Empleado
Tarea
Documento (para documentos no procede este método)
Cuenta
Item
Proyecto
Ambito
< elementId > (int) ID del elemento (Empleado, Tarea, Cuenta, Ítem, Proyecto o Área) del que se
están buscando sus Anexos, obtenido con los métodos getElementFilter,

getElements o getAccounts.
Es un dato obligatorio, pero si se indica el valor 0 o un ID inexistente, se

devolverán los Anexos comunes para Todas las Clases, opción que se
configura en Estructura – Anexos.
< RefAnexo > Se obtiene una lista de IDs y Nombres de Anexos que cumplen las
condiciones de filtrado, correspondientes a la lista de SharePoint AP__Anexos.
Si se indica el valor 0 o un ID inexistente, se obtendrá la lista de los Anexos

comunes para Todas las Clases (opción que se configura en Estructura –
Anexos).
Si no se indica correctamente el parámetro family (por ejemplo, porque no

se han respetado las mayúsculas y minúsculas), se obtendrá una devolución
del tipo System.ArgumentException.
Si no se indica el parámetro elementid se obtendrá una devolución del tipo

System.FormatException.
1.3.21 Integrar Documentos en un Anexo de SharePoint

(uploadDocumentToAnnexe)
El método utilizado para integrar documentos a un Anexo es uploadDocumentToAnnexe, siendo sus
parámetros:
Nota.
< family > (Familia) Familia a la que pertenece el elemento en el que se va a ingresar
un documento en Anexo.
Empleado
Tarea
Cuenta
Item

Proyecto
Ambito
< elementId > (int) ID del elemento (Empleado, Tarea, Cuenta, Ítem, Proyecto o
Área) al que se va a Anexar el documento, obtenido con los
métodos getElementFilter, getElements o getAccounts.
< annexeId > (int) ID del Anexo al que se va a ingresar el documento, obtenido con
el método getAnnexes.
< overwrite > (bool) Indica si se va a sobrescribir el fichero en el caso de que exista
uno con el mismo nombre en la biblioteca de documentos.
Sólo es aplicable para Anexos de tipo Biblioteca de Documentos.

En Bibliotecas de Registros (Listas de SharePoint), es indiferente
lo que se indique.
( string ) Devuelve una cadena vacía si el documento se ha integrado

correctamente, o un mensaje en caso de producirse una
incidencia.
Si no se indica correctamente el parámetro family (por ejemplo,

porque no se han respetado las mayúsculas y minúsculas), se
1.3.22 Rellenar un Anexo de Registros (fillAnnexe)

Para rellenar un Anexo en una biblioteca de registros (Lista de SharePoint), es decir, sólo introducir datos sin
necesidad de adjuntar documentos, se utiliza el método fillAnnexe.
Si lo que se desea es ingresar un documento en un Anexo, hay que utilizar el método

uploadDocumentToAnnexe.
Nota.
Los parámetros del método fillAnnexe son los siguientes:
< family > (Familia) Familia a la que pertenece el elemento en el que se va a rellenar
el Anexo.

Es un campo obligatorio y los posibles valores son:
Empleado
Tarea
Cuenta
Item
Proyecto
Ambito
< elementId > (int) ID del elemento (Empleado, Tarea, Cuenta, Ítem, Proyecto o Área)
al que pertenece el Anexo, obtenido con los métodos
getElementFilter, getElements o getAccounts.
< annexeId > (int) ID del Anexo que se va a rellenar, obtenido con el método
getAnnexes.
Devuelve una cadena vacía si el Anexo se ha rellenado

correctamente, o un mensaje en caso de producirse un problema.
( string ) Si no se indica correctamente el parámetro family (por ejemplo,

porque no se han respetado las mayúsculas y minúsculas), se
1.3.23 Obtener Datos de Anexos (getDataAnnexe)

El método para ver datos de Anexos ya rellenos es getDataAnnexe, siendo sus parámetros:
< elementId (int) > ID del elemento (Empleado, Tarea, Cuenta, Ítem, Proyecto o Área)
al que pertenece el Anexo que queremos visualizar, obtenido con
los métodos getElementFilter, getElements o getAccounts.
Dado que un Anexo no puede pertenecer a dos familias, no es

necesario indicar la familia. El ID del elemento, sin indicar la
familia, combinado con el annexeId, filtrará el registro adecuado.
Es un campo obligatorio.
< annexeId (int) > ID del Anexo del cual queremos ver sus datos, obtenido con el
método getAnnexes.
Es un campo obligatorio.

DataSet con los datos del Anexo solicitado.
< DataSet > Si no se indica el parámetro elementId o annexeId, se obtendrá

una devolución del tipo System.FormatException.
1.3.24 Editar un Anexo (editAnnexe)

Para editar un Anexo se utiliza el método editAnnexe, con los parámetros siguientes:
< annexeId > (int) ID del Anexo que se va a modificar, obtenido con el método
getAnnexes.
< registerId > (int) ID del registro que se va a modificar, obtenido con el método
getDataAnnexe. En Anexos Mono-registro sólo habrá el 1.
< campos > (ValorCampo[ ]) Array de valores que se van a modificar en las columnas de
SharePoint disponibles, obtenidas con el método getFields.
Devuelve una cadena vacía si el Anexo se ha modificado

( string ) correctamente, o una devolución en caso de producirse un
problema.
1.3.25 Eliminar un Anexo (deleteAnnexe)

Para eliminar un Anexo se utiliza el método deleteAnnexe, con los parámetros siguientes:
< annexeId > (int) ID del Anexo que se va a eliminar, obtenido con el método
getAnnexes.
< registerId > (int) ID del registro que se va a eliminar, obtenido con el método
getDataAnnexe.
( string ) Devuelve los siguientes códigos:
0 : Anexo eliminado correctamente.

-1 : El Anexo indicado no existe.
1.3.26 Ver Lista de Documentos Integrados (getDocIntegrados)

El método utilizado para visualizar los documentos integrados pertenecientes a una familia de AuraPortal es
getDocIntegrados, siendo sus parámetros:

< Familia > (int) A diferencia de otros métodos, en este la Familia se indica con un
número entero según los siguientes valores:
1 : Empleados
2 : Tareas
3 : Cuentas
4 : Ítems
5 : Proyectos
6 : Áreas
< IdElemento > (int) ID del elemento, obtenido con los métodos getElementFilter,
( XmlDocument ) Documento XML estructurado con los IDs y Nombre de los

documentos, y en el caso de la Tarea si está marcado como
Principal.
Si no se tienen suficientes permisos en el elemento, se obtendrá

este documento:
<?xml version="1.0" encoding="utf-8" ?>

<Errores>
<Error>-4</Error>
</Errores>
Si el elemento no existe, se obtendrá el documento anterior pero
con el código -8.
Si no hay ningún documento integrado se obtendrá el

documento anterior pero con el código -9.
1.3.27 Ver Lista de Documentos Enlazados (getDocEnlazados)

El método utilizado para visualizar los documentos enlazados pertenecientes a una familia de AuraPortal es
getDocEnlazados, siendo sus parámetros:
<Familia> (int) A diferencia de otros métodos, en este, la Familia se indica con un

número entero según los siguientes valores:
1 : Empleados
2 : Tareas
3 : Cuentas
4 : Ítems
5 : Proyectos

6 : Áreas
<IdElemento> (int) ID del elemento, obtenido con los métodos getElementFilter,

( XmlDocument ) Documento XML estructurado con el ID, Nombre y URL de los

documentos enlazados, y en el caso de la Tarea si está marcado
como Principal.
Si no se tienen permisos para visualizar el documento, devuelve

este documento:

<Errores>
<Error>-4</Error>
</Errores>
Si el elemento no existe, se obtendrá el documento anterior pero
con el código -8.
Si no hay ningún documento enlazado se obtendrá el documento

anterior pero con el código -9.
1.3.28 Ver Documentos Integrados en XML (getArrayBitsXMLDocIntegrado)

El método utilizado para ver el array de bits de un documento integrado es getArrayBitsXMLDocIntegrado
estructurado en un documento XML, siendo sus parámetros:
ID del Documento que se quiere visualizar, obtenido con el

< IdDocumento > (int)
método getDocIntegrados.
( XmlDocument ) Se obtiene un documento XML estructurado con el Nombre, y el

Array de bits del documento.
Si no se tienen permisos para visualizar el documento, devuelve el

siguiente documento:

<Errores>
<Table1>
<Error>-4</Error>
</Table1>
</Errores>
Si el documento no existe se devolverá el mismo documento pero
con el código -8.

1.3.29 Ver Documentos Integrados en Data Set (getArrayBitsDataSetDocIntegrado)
El método utilizado para ver el array de bits de un documento integrado es
getArrayBitsDataSetDocIntegrado estructurado en un DataSet, siendo sus parámetros:
< IdDocumento > (int) ID del Documento que se quiere visualizar, obtenido con el método
getDocIntegrados.
( DataSet ) Se obtiene un DataSet con el Nombre y el Array de bits del

documento.
Si no se tiene permisos para visualizar el documento se obtiene un

DataSet con el código -4.
Si no existe el documento indicado, se obtiene un DataSet con el

código -8.
1.3.30 Ver Documentos Integrados en Cadena (getArrayBitsStringDocIntegrado)

El método utilizado para ver el array de bits de un documento integrado es getArrayBitsStringDocIntegrado
estructurado en una cadena de caracteres, siendo sus parámetros:
ID del Documento que se quiere visualizar, obtenido con el

< IdDocumento > (int)
método getDocIntegrados.
( String ) Se obtiene un String con el Nombre y el Array de bits del

documento.
Si no se tienen suficientes permisos para visualizar el documento,

se obtiene la siguiente cadena de caracteres:
<Errores> <Table1> <Error>-4</Error> </Table1> </Errores>
Si no existe el documento que se quiere visualizar, se obtiene la

siguiente cadena de caracteres:
<Errores> <Table1> <Error>-8</Error> </Table1> </Errores>
1.3.31 Integrar Documentos en Bibliotecas en Diccionario

(UploadDocumentToDictionaryLibrary_...)
Nota.
Todos los detalles de este método pueden consultarse en el Tomo 5 de esta
documentación.

1.3.32 Lista de documentos en Bibliotecas en Diccionario
(GetDocDictionaryLibraryList)
Nota.
documentación.
1.3.33 Actualizar Etiquetas en Bibliotecas en Diccionario

(UpdateDocDictionaryLibraryLabels)
Nota.
documentación.
1.3.34 Actualizar Etiquetas en Bibliotecas en Diccionario

(UpdateDocumentDictionaryLibraryLabelsProcess)
Nota.
documentación.
1.3.35 Traspasar Documentos entre Bibliotecas en Diccionario

(TransferDocDictionaryLibrary)
Nota.
documentación.
1.3.36 Obtener Documentos en Bibliotecas en Diccionario

Nota.
documentación.
1.3.37 Eliminar Documentos en Bibliotecas en Diccionario

Nota.
documentación.
MÉTODOS ACCESORIOS
Hay unos métodos accesorios, que son los siguientes:
1.3.38 Crear Fichero de Configuración (Crear_AuraPortalDocConfigXML)

Este método es de uso interno y no hace falta utilizarlo.

1.3.39 Comprobar Acceso a AuraPortal (isValidAccess)
El método utilizado para comprobar si un usuario se puede conectar a AuraPortal es isValidAccess, siendo sus
parámetros:
< siteUrl > (string) URL del AuraPortal en el que se van a comprobar los permisos.
< user > (string) Nombre del usuario que se quiere comprobar.
< password > (string) Contraseña del usuario que se quiere comprobar.
< domain > (string) Dominio de Windows (o nombre servidor) donde está el usuario.
Devuelve si el usuario tiene permiso para conectarse al AuraPortal

( bool )
determinado.
2. SERVICIO WEB AURAPORTALFAMILIAS.ASMX

AuraPortalFamilias es un Servicio Web que posibilita que programas externos realizados a medida realicen
operaciones con elementos de las Familias de AuraPortal Empleados, Cuentas, Ítems, Proyectos y Áreas.
Las otras dos familias restantes, Tareas y Documentos, tienen sus propios Servicios Web ya comentados en
esta documentación (AuraPortalTareas y AuraPortalDoc).
2.1 Funcionalidad
Las posibles operaciones del Servicio Web AuraPortalFamilias son las siguientes:
• Crear un elemento nuevo de las familias de Empleado, Cuenta, Ítem, Proyecto y Área.
• Ver los datos de cualquier elemento de dichas Familias de AuraPortal.
• Modificar los datos de cualquier elemento de dichas Familias de AuraPortal
• Eliminar cualquier elemento de dichas Familias de AuraPortal.
• Gestionar los Roles Personales de Cuentas.
• Gestionar Familias Propias.
2.2 Conexión
Para iniciar el servicio hace falta especificar los siguientes valores:
• URL del servicio (http://host.dominio.com/Home/webservice/AuraPortalfamilias.asmx)
• Usuario / contraseña (el usuario debe estar dado de alta en AuraPortal y en SharePoint)
El usuario indicado en la conexión es el que se mostrará cómo Creador o Modificador de los elementos de
las familias que se creen o modifiquen en AuraPortal.

Nota.
El usuario indicado debe pertenecer a un Grupo de Empleados de AuraPortal con los
permisos necesarios en la Clase del elemento, para realizar la acción (Estructura –
Empleados – Grupos - Autorizados en Clases).
2.3 Métodos
Para ver los métodos del Servicio Web AuraPortalFamilias hay teclear la URL del Servicio Web:
http://host.dominio.com/Home/webservice/AuraPortalfamilias.asmx
y obtendremos una página similar a la de la siguiente imagen, con la lista de métodos del Servicio Web
AuraPortalFamilias:

Si pulsamos sobre el link Service Description (o añadimos ?WSDL a la URL) obtendremos la descripción del
Servicio Web o WSDL (Web Service Description Language) en formato XML.
Si pulsamos sobre uno de los métodos, por ejemplo getFichaCuenta, método que sirve para ver los datos de
un Cuenta determinada, obtendremos el siguiente resultado:
Si estamos trabajando desde el propio servidor de AuraPortal tendremos la posibilidad de poner un valor en
la casilla IdCuenta.
En <soap:Body> vemos el tipo de valor que requiere el parámetro IdCuenta, en este caso int, es decir, un
número entero que corresponde con el ID de la Cuenta cuyos datos se quieren obtener.
Si lo introducimos e invocamos el Servicio Web obtendremos un documento con los datos de la Cuenta, como
por ejemplo el siguiente:

A continuación se comentan los detalles de los métodos del Servicio Web AuraPortalFamililas, agrupados en
apartados según su funcionalidad:
2.3.1 Ver ID de Elementos (GetId… Empleado, Cuenta, Rol, Item, Proyecto, Ambito)
Los métodos para ver el ID de los elementos en AuraPortal son GetId… (donde ‘…’ es Empleado, Cuenta,
Item, Proyecto o Ambito) y GetRole_ID. Hay uno por familia:
Para ver los ID de las Fichas de Empleados, Cuentas, Ítems, Proyectos y Áreas, cada Familia tiene su propio
método (GetIdTareas está en el Servicio Web AuraPortalTareas):
- GetIdEmpleado para ver el ID de la Ficha de Empleados.

- GetIdCuenta para ver el ID de la Ficha de Cuentas.
- GetRole_ID para ver el ID de la Ficha de los Roles Personales.
- GetIdItem para ver el ID de la Ficha de Ítems.
- GetIdProyecto para ver el ID de la Ficha de Proyectos.
- GetIdAmbito para ver el ID de la Ficha de Áreas.
Nota.

<NombreEmpleado> (string) o Nombre o parte del nombre de los elementos de los que se
quieren ver sus IDs.
<NombreCuenta> (string) o
Normalmente el nombre de un elemento es un campo único,
<NombreItem> (string) o
excepto en tres casos:
<NombreProyecto> (string) o
Empleados: El método busca en Nombre, Apellido1 y Apellido2
<NombreAmbito> (string) Cuentas: El método busca tanto el Nombre Comercial como en

la Razón Social.
Roles: Ver tabla más adelante con todos sus detalles.
(Para GetIRole_ID ver detalles Para ver todos los nombres dejar el campo en blanco.
específicos más adelante en este
apartado.)
< IdClaseCuenta > (int) o Es obligatorio, y es el ID de la Clase del elemento a visualizar.
< IdClaseItem > (int) o Para ver todas las Clases introducir el número 0.
< IdClaseProyecto > (int) o Obsérvese que los Empleados no tienen Clase, por lo que este
parámetro no procede en GetIdEmpleado.
< IdClaseAmbito > (int) o
( XmlDocument ) Se obtiene un documento XML con el ID y Nombre de los

elementos, y el ID y Nombre de su Clase, de todos los elementos
que cumplan las condiciones de filtrado.
En el caso de las Cuentas también se mostrará el Nombre

Comercial. El Nombre corresponde a la Razón Social.
Si ningún elemento cumple las condiciones de filtrado, el XML

estará vacío.
El ID identifica al elemento en las listas de SharePoint

correspondientes a cada familia (AP__EmpleadosFichas,
AP__CuentasFichas, AP__ItemsFichas, AP__ProyectosFichas, y
AP__AmbitosFichas).
2.3.2 Ver ID de Roles Personales (GetRole_ID)

Los Roles Personales (antes Contactos) de las Cuentas desde AuraPortal v3.1 han cambiado su estructura
para ser más flexibles y potentes. Ahora es posible realizar una ficha de Rol Personal totalmente personalizada
con los datos deseados, y se guardan directamente en MS SQL en lugar de en listas de SharePoint,
concretamente en la base de datos de BPMS, en la tabla AP_Dyn_Contactos. Por este motivo, los métodos del
Servicio Web AuraPortalFamilias relacionados con los Roles Personales de las Cuentas, han sido sustituidos. A
continuación, se muestran los detalles del GetRole_ID, método para obtener el ID de los Roles Personales de
las Cuentas, necesario para el uso de otros métodos descritos después (como GetPersonalRole y
UpdatePersonalRole).

Parámetros de GetRole_ID Explicación
< Account_ID > (string) Es el ID de la Cuenta del Rol del que se quiere obtener su ID.
Para no limitar la búsqueda se puede dejar el campo en blanco.
<Role_Name> (string) Nombre o parte del nombre de los roles de los que se quiere
obtener su ID.
<Login> (string) Login o parte del Login de los roles de los que se quiere obtener
su ID.
<Security_Level> (string) Nivel de Seguridad de los roles de los que se quiere ver su ID.
<User_Type> (string) Es el Tipo de Usuario de AuraPortal de los roles de los que se

quiere ver su ID.
Los posibles valores son los siguientes:
1 : Externo
2 : Invitado
3 : No Usuario
<Role_Email> (string) E-mail o parte del E-mail de los roles de los que se quiere obtener
su ID. Para no limitar la búsqueda se puede dejar el campo en
blanco.
<Legal_ID> Es el ID legal del Rol.
Valor devuelto con GetRole_ID Explicación
( XmlDocument ) Se obtendrá un documento XML con los siguientes datos de todos

los Roles Personales que cumplen las condiciones de filtrado:
<ID> (ID del Rol, necesario para otros métodos)

<Nombre> (Nombre del Rol)
<IdCuenta> (ID de la Cuenta a la que pertenece el Rol)
<TipoUsuarioAP> (Tipo de Usuario. Ver códigos en (*) al final).
<IdUsuario> (Dato interno)
<NivelSeguridad> (Nivel de Seguridad del Rol)
<Login> (Login del Rol)
<NombreCuenta> (Razón Social de la Cuenta)
<NombreComercialCuenta> (Nombre Comercial de la Cuenta)
(*) 1 = Externo, 2 = Invitado, 3 = No Usuario.

Permisos.
Obtendrán datos con los métodos GetId… los siguientes usuarios:
- AdminPortal.
- Administrador Delegado (perteneciente al grupo).
- Los pertenecientes a un Grupo de Empleados con permisos de VER elementos de la Clase
indicada en las condiciones de filtrado.
2.3.3 Ver Datos de Elementos (GetFicha… Empleado, Cuenta, Rol, Item, Proyecto,
Ambito)
Los métodos para ver los datos de las Fichas de elementos en AuraPortal son GetFicha… (donde ‘…’ es
Empleado, Cuenta, Item, Proyecto o Ambito) y GetPersonalRole. Hay uno por familia:
Para ver los datos de las Fichas de Empleados, Cuentas, Roles Personales, Ítems, Proyectos y Áreas, hay un
método:
• GetFichaEmpleado para ver datos de la Ficha de Empleados.

• GetFichaCuenta para ver datos de la Ficha de Cuentas.
• GetPersonalRole para ver datos de la Ficha de Roles.
• GetFichaItem para ver datos de la Ficha de Ítems.
• GetFichaProyecto para ver datos de la Ficha de Proyectos.
• GetFichaAmbito para ver datos de la Ficha de Áreas
Nota.
< IdEmpleado > (int) o Número entero que corresponde al ID del elemento del que se
quieren ver sus datos.
< IdCuenta > (int) o
Este ID se puede obtener con el método GetId… de este Servicio
<Role_ID > (string) o
Web AuraPortalFamilias, o con los métodos getElementFilter,
< IdItem > (int) o getElements o getAccounts del Servicio Web AuraPortalDoc.
< IdProyecto > (int) o Corresponde al ID único que identifica el elemento, en las listas de
SharePoint correspondientes a cada familia (AP__EmpleadosFichas,
< IdAmbito > (int) AP__CuentasFichas, AP__ItemsFichas, AP__ProyectosFichas, y
AP__AmbitosFichas), excepto en el caso de Roles, que está en la
tabla de la Base de Datos SQL de BPMS, AP__Dyn_Contactos.
( XmlDocument ) Se obtiene un documento XML estructurado con los datos del

elemento solicitado. Esta estructura es, básicamente, la que

necesitan los métodos CreateFicha… y UpdateFicha… explicados
más adelante, con pequeñas diferencias que se explican en cada
método.
Si no se tienen permisos para ver el elemento se obtiene este

documento:

<Errores>
<Error>-4</Error>
</Errores>
Si el elemento no existe, se obtiene el mismo documento pero con
el Código -8, excepto en el caso particular de los Roles, que si no
hay ningún elemento que cumpla las condiciones de filtrado, se
devuelve un documento XML vacío.
Para comprender el significado de cada campo obtenido en el

documento XML, conviene leer el Capítulo LOCALIZACIÓN DE LOS
DATOS EN LISTAS DE SHAREPOINT más adelante en este
documento.
Permisos.
Obtendrán datos con los métodos GetFicha… los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de VER elementos de la Clase a la
que pertenece el elemento indicado.
2.3.4 Crear Elementos (CreateFicha … Empleado, Cuenta, Rol, Item, Proyecto,

Ambito)
Los métodos para crear nuevos elementos en AuraPortal son CreateFicha… (donde ‘…’ es Empleado, Cuenta,
Item, Proyecto o Ambito) y CreatePersonalRole.
Hay uno por familia:
• CreateFichaEmpleado para crear Empleados.

• CreateFichaCuenta para crear Cuentas.
• CreatePersonalRole para crear Roles.
• CreateFichaItem para crear Ítems.
• CreateFichaProyecto para crear Proyectos.
• CreateFichaAmbito para crear Áreas.
Las Familias de Tareas y Documentos (incluidos Anexos), tienen sus propios Servicios Web.
Nota.

< xmlDatos > (XmlDocument) Hay que proporcionar un documento XML con los datos del
elemento que se quiera crear, según la misma estructura que se
obtiene al ejecutar los métodos GetFicha…, explicados
anteriormente, pero con las siguientes diferencias:
No hay que proporcionar los campos siguientes ni el Campo ni el

Valor, ya que el método los creará automáticamente. Si se
(Para CreatePersonalRole ver detalles proporcionan se obtendrá un código de devolución:
apartado) <ID> : es el ID en la lista de SharePoint correspondiente.
<Created> : es la fecha de creación.
<Author> : es el usuario creador.
<Modified> : es la fecha de modificación.
<Editor> : es el último usuario que ha modificado el elemento.
Los campos obligatorios son Title y Clase… (donde ‘…’ es
Empleado, Cuenta, Item, Proyecto o Ambito).
En la lista de SharePoint de las Familias el campo Title está

renombrado como Nombre, y en el caso de Empleados como
NombreAcceso. Ver más detalles en Capítulo LOCALIZACIÓN DE
DATOS EN LISTAS DE SHAREPOINT.
Los demás campos son opcionales.
Nota.
CreateFichaEmpleado tiene dos campos más:
<DominioAcceso> : Indica el Dominio del Login indicado.

<Licencia> : 1 para licencia Concurrente y 0 para Nominativa.
( int ) Si se obtiene un número mayor que 0, corresponde al ID del

elemento creado con éxito.
Los posibles Problemas son números negativos, y son los

siguientes:
-1 : Nombre de algún campo no válido.

-2 : Problema Indefinido.
-3 : Faltan datos en campos obligatorios (Nombre o Clase…)
-4 : Permisos insuficientes para crear.
-5 : La Clase… indicada no existe.
-18 : Tipo de licencia incorrecto.

Permisos.
Podrán crear elementos con los métodos CreateFicha… los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de CREAR elementos de las
Clases indicadas en el documento XML.
2.3.5 Crear Roles Personales (CreatePersonalRole)

AuraPortal Helium permite realizar una ficha de Rol Personal totalmente personalizada desde Estructura –
FAMILIAS – Cuentas – Árbol y Clases – Roles Personales - Ficha Roles Personales.
Además de poder crear Roles desde el interface de usuario de AuraPortal (en la opción Roles de Cuentas de
la Ficha de la Cuenta), también es está disponible el método CreatePersonalRole (del Servicio Web
AuraPortalFamilias) para crear Roles Personales desde programas externos.
Los datos se guardan directamente en MS SQL en lugar de en listas de SharePoint, concretamente en la tabla
AP_Dyn_Contactos de la base de datos BPMS.
En este apartado se muestran todos los detalles para poder crear Roles Personales a través del método
CreatePersonalRole del Servicio Web AuraPortalFamilias.
El método CreatePersonalRole tiene los siguientes parámetros:
Parámetros CreatePersonalRole Explicación
< Account_ID > (string) Número entero que corresponde al ID de la Cuenta para la que se
quiere crear el Rol.
Este ID se puede obtener con el método GetIdCuenta de este

Servicio Web AuraPortalFamilas, o con los métodos
getElementFilter, getElements o getAccounts del Servicio Web
AuraPortalDoc.
Corresponde al ID único que identifica el elemento, en las listas de

SharePoint AP__CuentasFichas.
<User_Type > (string) Número que corresponde al tipo de usuario del Rol en AuraPortal.
1 : Usuario Externo
2 : Usuario Invitado
3 : No Usuario
4 : NoDefinido
< Data > (string) En este parámetro se introducen los datos del Rol Personal, según
la estructura descrita en el apartado siguiente.
< License_Type > (string) Número que corresponde al tipo de licencia en AuraPortal.

0: NaturalezaNominativas
1: NaturalezaConcurrentes
(XML) Si el usuario se crea correctamente, se obtendrá el número 0. En

caso contrario, el Servicio Web devolverá un número negativo con
uno de los códigos de devolución siguientes:
-1 : Formato incorrecto
-3 : Login incorrecto
-4: Permisos incorrectos
-6 : Login vacío
-7 : Tipo usuario incorrecto
-8 : No existe la cuenta
-9 : Problema inesperado
-10 : Actualizar rol
-12 : Creando Usuario Externo
-13 : Guardando Datos Auxiliares
-15 : Password incorrecto
-16 : Creando Usuario Invitado
-17 : Leer Licencia
-18 : Tipo Licencia incorrecto
-19 : Licencia caducada
-20 : Límite de Licencias superado
-21 : Permisos incorrectos en SharePoint
-22 : Creando registro Rol
-23 : Creando Rol Personal
-26 : Identificación Legal existente
-36 : No existe la Clase
Formato del parámetro <Datos> de CreatePersonalRole

Tal como se ha comentado, el método CreatePersonalRole del Servicio Web AuraPortalFamilias, requiere tres
parámetros: <Account_ID>, <User_Type> y <Data>. En este apartado se describe el formato de datos
necesario para el parámetro < Data >.
Por defecto, el formulario de Roles tiene varios campos de sistema, que son:
• _PeRoleName: Es obligatorio, y es el nombre del Usuario.
• _SecurityLevel: Nivel de Seguridad para Recintos Seguros.
• _Email: Dirección de correo electrónico.

• _SendEmail: tiene varias utilidades. Por ejemplo, para configurar el Envío en la Tarea de Sistema
NOTIFICADOR (Notifica por Email), se tiene en cuenta si el valor de este campo es sí o no.
• _Language: Define el idioma que se aplica al Rol correspondiente.

• _LegalID: Se utiliza para contener la identificación legal para inicios de sesión con Certificado Digital,
por ejemplo, con DNI Digital.
• _Login: tiene varias utilidades. Por ejemplo:

- El Aviso de Tarea para Usuarios Invitados se enviará a la dirección registrada en el campo
_Email. Y en el caso de que _Email esté vacío o no sea un email, se enviará al campo _Login.
- Ubicado en la ficha del rol, muestra el login de Invitados y Externos.
• _UserNature: Muestra la Naturaleza del Rol (Usuario Externo, Usuario Invitado o No Usuario).
• _Password: Muestra el Password de los Usuarios Invitados.

A estos campos se le añadirán los que se hayan diseñado desde la Ficha de Roles Personales en Estructura –
FAMILIAS – Cuentas – Árbol y Clases – Roles Personales - Ficha de roles Personales.
Para introducir datos en el parámetro <Data> del método CreatePersonalRole hay que conocer el Nombre
Interno de sus Campos. En el caso de los campos de sistema comentados, el Nombre Interno es el ya indicado
(_ PeRoleName), _SecurityLevel, _Email, etc…, pero los creados en la personalización del formulario
dependen de varias cosas. Hay dos maneras de conocerlos:
• Desde el diseño de la Ficha Roles Personales: En la LISTA DE CAMPOS SELECCIONADOS, se

muestran los Nombres Internos de todos los campos, por ejemplo:
• A través del método GetPersonalRoles_Terms: En el Servicio Web AuraPortalFamilias hay un método

GetPersonalRoles_Terms con el que se pueden obtener los Nombres Internos, por ejemplo:

Nota Importante.
El nombre que se le pasa tiene que ser igual que el nombre interno del campo, se
crean como (tipodetermino_Nombredelcampo).
Una vez conocido el Nombre Interno, los datos se introducen en el parámetro <Data> con el siguiente
formato:
[[[NombreInternoTérmino:::Valor]]][[[NombreInternoTérmino:::Valor]]]…
Detalles:
• Los ‘triples corchetes’ separan los diferentes campos: [[[…]]]

• Entre campo y campo no puede haber espacios: …]]][[[…
• El Nombre Interno del Término y su Valor se separan con ‘triples dos puntos’:
NombreInternoTérmino:::Valor
• El formato del Valor se detalla en el seguidamente.

Tipo de Término Formato del Valor Descripción
_PeRoleName Cualquier texto. De Sistema. Es el nombre del Rol
_SecurityLevel Números enteros entre 1 y 98, ambos De Sistema. Es el Nivel de Seguridad

inclusive. para Recintos Seguros
_Login NO se puede introducir desde el De Sistema. Sólo válido para Roles

Servicio Web. de tipo Usuario (Externo o Invitado).
_Password NO se puede introducir desde el De Sistema. Sólo válido para Roles

Servicio Web. de tipo Usuario (Externo o Invitado).
_SendEmail De Sistema. Sólo válido para Roles

0/1. 0=No, 1=Sí.
de tipo Usuario (Externo o Invitado).
_Language Formato ISO internacional: ES-es, EN- De Sistema. Sólo válido para Roles
us, etc… de tipo Usuario (Externo o Invitado).
_LegalID De Sistema. Sólo válido para Roles

Cualquier texto.
_UserNature De Sistema. Sólo válido para Roles

Texto Una Línea Cualquier texto.
Texto Multilínea Cualquier texto.
Texto Multilínea Rico Cualquier texto.
Número Entero Cualquier número entero.
Cualquier número entero o decimal, En la base de datos siempre se

Número Decimal
separado con ‘coma’ o con ‘punto’. introducirá con ‘coma’.
Fecha en formato ISO 18000, es decir

Fecha
aa-mm-dd (año-mes-día)
Fecha y Hora en formato ISO 18000, es

decir aa-mm-dd hh:mm:ss (año-mes-
Fecha y Hora día hora:minuto:segundo).
Si no se indica hh:mm:ss se rellenará

con 00:00:00.
Sí/No Acepta True/False y 1/0
ID = ID del Término en el
Diccionario. Se muestra en el
Selección Simple ID###Nombre momento de crearlo en el
Diccionario de Términos o a través
del método

GetPersonalRoles_Terms.
Nombre = Idem que ID.
Igual que Selección Simple, pero las

Selección Múltiple ID###Nombre;;;ID###Nombre diferentes opciones se separan con
;;;
Formato del Valor del parámetro <Data>
En el formato de introducción de datos ya comentado, hay que sustituir Valor por el dato deseado en cada
caso:
[[[NombreInternoTérmino:::Valor]]][[[NombreInternoTérmino:::Valor]]]…
El formato del Valor según el tipo de Término se indica más arriba:
Si se desea hacer una prueba manual con este método CreatePersonalRole, sin necesidad de un programa
externo, proceder de la siguiente manera:
1. Desde una sesión del servidor donde está instalado AuraPortal, dirigirse a Estructura – GENERAL –
Servicios Web – Lista y pulsar sobre el Servicio Web AuraPortalFamilias.
2. Seleccionar el método CreatePersonalRole y se abrirá una ventana como la siguiente:
Nota.
Esta operación tiene que realizarse desde una sesión de Windows del servidor donde
está instalado AuraPortal. De lo contrario no estará disponible la introducción manual
de parámetros y en su lugar aparecerá el mensaje: El formulario de prueba sólo está
disponible para solicitudes del equipo local.
3. Los valores que hay que introducir en estos parámetros son los siguientes:

• Account_ID: Hay que indicar el ID que tiene la Cuenta a la que pertenecerá el Rol, en la Lista de
SharePoint AP__CuentasFichas.
Los ID de las Cuentas de AuraPortal se pueden obtener de dos maneras:
- Directamente en la ficha de cada Cuenta desde el interface de usuario de AuraPortal.

- A través del método GetIdCuenta del Servicio Web AuraPortalFamilias (ver más detalles
en el capítulo correspondiente de este documento).
- A través del método GetElements del Servicio Web AuraPortalDoc (ver más detalles en el
capítulo correspondiente de este documento).
• User_Type: Los posibles valores son:
- 1 : Usuario Externo
- 2 : Usuario Invitado
- 3 : No Usuario
• Data: En este parámetro se introducen los datos del Rol en el formato que se ha detallado antes, que
siguiendo este ejemplo podría ser el siguiente:
Data:
[[[_PeRoleName:::Andrea.Palacios]]][[[_Login:::hola@hotmail.com]]][[[_Password:::12
3]]]
Cuando estén los datos deseados en los parámetros, pulsar el botón Invocar, y se obtendrá una página XML
como la siguiente:
Si se ha producido un problema, devolverá un número negativo, si no, el id del rol personal creado.
2.3.6 Ver Nombre Interno de los Términos de los Roles Personales

(GetPersonalRoles_Terms)
Como se ha comentado en el método CreatePersonalRole , para conocer los Nombres Internos de los
campos de la ficha de Roles está el método GetPersonalRoles_Terms.
No tiene parámetros, basta con invocarlo y se obtendrá un documento XML con varios datos de los campos
del formulario de Roles, entre ellos el Nombre Interno, que es necesario conocer para el parámetro <Data>
del método CreatePersonalRole .
Un ejemplo del documento XML obtenido al ejecutar este método es el siguiente, que se muestra
parcialmente:

2.3.7 Exportar Roles Personales a Excel (ExportPersonalRoles_XlS)
Para exportar los datos de los Roles Personales a fichero Excel está el método ExportPersonalRoles_XlS.
2.3.8 Modificar Elementos (UpdateFicha … Empleado, Cuenta, Rol, Item, Proyecto,

Ambito)
Los métodos para editar los datos de las Fichas de elementos en AuraPortal son UpdateFicha… (donde ‘…’ es
Empleado, Cuenta, Rol, Item, Proyecto o Ambito). Hay uno por familia:
Para editar (modificar) fichas de Empleados, Cuentas, Roles, Ítems, Proyectos y Áreas, hay un método:

• UpdateFichaEmpleado para editar Fichas de Empleados.
• UpdateFichaCuenta para editar Fichas de Cuentas.
• UpdatePersonalRole para editar Fichas de Roles Personales.
• UpdateFichaItem para editar Fichas de Ítems.
• UpdateFichaProyecto para editar Fichas de Proyectos.
• UpdateFichaAmbito para editar Fichas de Áreas.
Las Familias de Tareas y Documentos (incluido Anexos), tienen sus propios Servicios Web.
Nota.
< IdEmpleado > (int) o Número entero que corresponde al ID del elemento del que se
quieren modificar sus datos.
Este ID se puede ver con los métodos getElementFilter,
< IdItem > (int) o
getElements o getAccounts del Servicio Web AuraPortalDoc.
< IdProyecto > (int) o Corresponde al ID único que identifica el elemento, en las listas de
< IdAmbito > (int) SharePoint correspondientes a cada familia (AP__EmpleadosFichas,

AP__CuentasFichas, AP__ItemsFichas, AP__ProyectosFichas, y
AP__AmbitosFichas).
(Para UpdatePersonalRole ver detalles

apartado)
< xmlDatos > (XmlDocument) Hay que proporcionar un documento XML con los datos que se
quieran modificar, según la misma estructura que se obtiene al
ejecutar los métodos GetFicha…, explicados anteriormente, pero
con las siguientes diferencias:
No hay que proporcionar los campos siguientes, ni el Campo ni el

Valor, ya que el método los creará automáticamente. Si se
proporcionan se obtendrá una incidencia:
<ID> : es el ID en la lista de SharePoint correspondiente.

<Created> : es la fecha de creación.
<Author> : es el usuario creador.
<Modified> : es la fecha de modificación.
<Editor> : es el último usuario que ha modificado el elemento.
Aquellos datos que no se desea modificar no han de estar en el
documento XML proporcionado, ni el Campo ni el Valor, es decir,

sólo se modificarán los valores de los campos proporcionados,
manteniéndose los que no hayan sido incluidos.
Nota.
UpdateFichaEmpleado tiene dos campos más:
<DominioAcceso> : Indica el Dominio del Login indicado.

<Licencia> : 1 para licencia Concurrente y 0 para Nominativa.
( int ) Si se obtiene el número 0, es que el elemento se ha actualizado

con éxito.
Los códigos de devolución son números negativos si hubo algún

problema, y son los siguientes:

-4 : Permisos insuficientes para modificar.
-5 : La Clase… indicada no existe.
-8 : El elemento indicado no existe.
-18: Tipo de Licencia incorrecto.
Permisos.
Podrán modificar elementos con los métodos UpdateFicha… los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de EDITAR elementos de las Clases
indicadas en el documento XML.
2.3.9 Modificar datos de Roles (UpdatePersonalRole)

Para modificar datos de la ficha de un Rol está el método UpdatePersonalRole, muy parecido a
CreatePersonalRole , con la diferencia que en vez de indicar el ID de la Cuenta, hay que indicar el ID del Rol a
modificar:
< Role_ID > (string) Número entero que corresponde al ID del Rol del que se quiere
modificar la ficha.
Este ID se puede obtener con el método GetRole_ID de este

Servicio Web.
Corresponde al ID único que identifica el elemento, en la tabla de

SQL AP_Dyn_Contactos.
<User_Type > (string) Número que corresponde al tipo de usuario del Rol en AuraPortal.

1 : Usuario Externo
2 : Usuario Invitado
3 : No Usuario
< Data > (string) En este parámetro se introducen los datos del Rol, según la misma
estructura descrita en el método CreatePersonalRole. Dirigirse al
apartado correspondiente para ver todos los detalles.
(XML) Si el usuario se modifica correctamente, se obtendrá el número 0.

En caso contrario, el Servicio Web devolverá un número negativo
con uno de los siguientes códigos de devolución:
-1 : Problema en Formato.
-3 : Login incorrecto.
-4 : Problema de permisos.
-6 : El Login está vacío.
-7 : Tipo de usuario incorrecto.
-8 : La Cuenta indicada no existe.
2.3.10 Eliminar Elementos (DeleteFicha … Empleado, Cuenta, Rol, Item, Proyecto,

Ambito)
Los métodos para eliminar los datos de las Fichas de elementos en AuraPortal son DeleteFicha… (donde ‘…’
es Empleado, Cuenta, Rol, Item, Proyecto, o Ambito).
Estos métodos también eliminan sus datos asociados (Documentos Integrados, Documentos Asociados,
Costes e Ingresos Previstos, etc…)
Hay uno por familia, y uno para los Roles:
- DeleteFichaEmpleado para eliminar Empleados.

- DeleteFichaCuenta para eliminar Cuentas.
- DeletePersonalRole para eliminar Roles.
- DeleteFichaItem para eliminar Ítems.
- DeleteFichaProyecto para eliminar Proyectos.
- DeteleFichaAmbito para eliminar Áreas.
La familia de Tareas y Documentos (incluidos Anexos), tienen su propio Servicio Web.
Nota.

< IdEmpleado > (int) o Número entero que corresponde al ID del elemento que se
quiere eliminar.
Este ID se puede ver con los métodos GetId… de este Servicio
< Role_ID > (int)
Web o con los métodos getElementFilter, getElements o
< IdItem > (int) o getAccounts del Servicio Web AuraPortalDoc.
< IdProyecto > (int) o Corresponde al ID único que identifica el elemento, en las listas
de SharePoint correspondientes a cada familia
< IdAmbito > (int) o (AP__EmpleadosFichas, AP__CuentasFichas, AP__ItemsFichas,
AP__ProyectosFichas, y AP__AmbitosFichas).
En el caso de los Roles, corresponde al ID en la tabla de SQL

AP_Dyn_Contactos.
( int ) Si se obtiene el número 0, es que el elemento se ha eliminado

con éxito.
Los posibles Problemas devuelven números negativos, y son los

siguientes:
-2 : Problema Indefinido.
-4 : Permisos insuficientes para eliminar.
-8 : El elemento indicado no existe.
Permisos.
Podrán modificar elementos con los métodos UpdateFicha… los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de EDITAR elementos de la Clase a la
que pertenece el elemento indicado a eliminar.
Nota.
Es posible crear Empleados con el Servicio Web AuraPortalFamilas, pero las siguientes
opciones NO es posible completarlas:
- No es posible crear un nuevo Cargo en el árbol de Empleados ni asignar un Cargo
existente a un Empleado.
- Se puede indicar que un Empleado es Administrador Delegado (campo
Configurador), pero no agregarlo al Grupo Administrador Delegado de SharePoint.
Esto se realiza automáticamente cuando se configura el Empleado como
Administrador Delegado desde el FAP de AuraPortal (Estructura – GENERAL –
AdminPortal - Administradores Delegados).
- Se puede indicar el Login de Windows que tendrá el Empleado en el campo Title
(renombrado como NombreAcceso en la lista de SharePoint), pero si se realiza desde
el FAP de AuraPortal se realizan cambios importantes, como por ejemplo añadirlo a

los Grupos de Sitio Empleados y Empleados_Lectura y cambiar su Nombre para
Mostrar de SharePoint con la combinación de Nombre + Apellido1 + Apellido2.
Por lo tanto, si se desean dar de alta Empleados a través del Servicio Web
AuraPortalFamilas, hay tener en cuenta las siguientes indicaciones:
- Title (NombreAcceso.) Dejarlo en blanco. Posteriormente dirigirse a las opciones del
FAP para asignarle un Login de Windows (Estructura – GENERAL – Sesiones de
Usuarios – Logins, o en Ficha del Empleado – Editar – Login).
- Configurador: False. Posteriormente dirigirse a Estructura – GENERAL –
AdminPortal - Administradores Delegados.
- Sin Acceso: True. Posteriormente dirigirse a las opciones del FAP para asignarle un
Login de Windows (Estructura – GENERAL – Sesiones de Usuarios – Logins, o en Ficha
del Empleado – Editar – Login).
- PendienteCargo: True. Posteriormente dirigirse a las opciones del FAP para
asignarle un Cargo y ubicarlo en el árbol de Empleados (Estructura – FAMILIAS –
Empleados – Árbol y Empleados).
2.3.11 Ver Costes e Ingresos Previstos (GetCostesPrevistos y GetIngresosPrevistos)

Hay unos métodos específicos para ver los datos de los Costes e Ingresos Previstos de las Cuentas, Proyectos
y Áreas:
• GetCostesPrevistos para ver los Costes Previstos.

• GetIngresosPrevistos para ver los Ingresos Previstos.
< Familia > (int) Número entero que indica la Familia a la que pertenece el elemento
del que queremos ver sus Costes o Ingresos Previstos, según la tabla
siguiente:
1 : Cuentas
2 : Proyectos
3 : Áreas
<IdElemento> (int) Número entero que indica el ID del elemento (Cuenta, Proyecto o
Área) del que queremos ver sus Costes o Ingresos Previstos.
Este ID se corresponde con el de las listas de SharePoint AP_...Fichas

(… según la familia) y se puede obtener con los métodos GetId… de
este Servicio Web AuraPortalFamilias, o con los métodos
AuraPortalDoc.
( XmlDocument ) Se obtendrá un documento XML estructurado con todos los datos

del Coste o Ingreso.
Si no se tienen suficientes permisos para ver los Costes o Ingresos

Previstos, se obtendrá el siguiente documento con el Código -4:

<Errores>
<Error>-4</Error>
</Errores>
Si la Familia no es correcta (número entre el 1 y el 3), se obtendrá el
mismo documento pero con el Código -7.
Si el elemento indicado no existe, se obtendrá el mismo documento

pero con el Código -8.

documento.
Permisos.
Podrán ver Costes o Ingresos Previstos con los métodos Get…Previstos los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de VER elementos de las Clases a la
que pertenecen los elementos indicados en las condiciones de filtrado.
2.3.12 Crear Costes e Ingresos Previstos (CreateCostesPrevistos y

CreateIngresosPrevistos)
Hay unos métodos específicos para crear los Costes e Ingresos Previstos de las Cuentas, Proyectos y Áreas:
• CreateCostesPrevistos para crear Costes Previstos.

• CreateIngresosPrevistos para crear Ingresos Previstos.
< xmlDatos > (XmlDocument) Se tiene que proporcionar un documento XML con los datos del
elemento a crear, según la estructura que se obtiene con los
métodos GetCostesPrevistos y GetIngresosPrevistos de este
Servicio Web, pero con la siguiente diferencia:
No hay que proporcionar el campo <ID>, ni el Campo ni el Valor,

ya que el método lo creará automáticamente. Si se proporciona se
obtendrá un código de devolución.
( int ) Si se obtiene el número 0, es que el Coste o Ingreso se ha creado

correctamente y corresponde al ID en la lista de SharePoint

AP__CostesPrevision o AP__IngresosPrevision.
Los posibles problemas devuelven números negativos, y son los

siguientes:

-4 : Permisos insuficientes para crear el Coste o Ingreso.
-7 : La Familia indicada no es válida.
Permisos.
Podrán introducir Costes o Ingresos Previstos con los métodos Create…Previstos los siguientes
usuarios:
- AdminPortal.
a la que pertenecen los elementos indicados en el documento XML.
2.3.13 Eliminar Costes e Ingresos Previstos (DeleteCostesPrevistos y

DeleteIngresosPrevistos)
Hay unos métodos específicos para eliminar los datos de los Costes e Ingresos Previstos de las Cuentas,
Proyectos y Áreas:
• DeleteCostesPrevistos para eliminar los Costes Previstos.

• DeleteIngresosPrevistos para eliminar los Ingresos Previstos.
< IdCoste > (int) o Número entero que corresponde al ID del Coste o Ingreso Previsto
que queremos eliminar, en las listas de SharePoint
< IdIngreso > (int)
AP__CostesPrevision o AP__IngresosPrevision.
Este ID se puede ver con los métodos GetCostesPrevistos y

GetIngresosPrevistos de este mismo Servicio Web, explicados
antes.
( int ) Si se obtiene el número 0, es que el Coste o Ingreso Previsto se ha

eliminado correctamente.

siguientes:


-7 : La Familia indicada no es válida.
-8 : El Coste o Ingreso Previsto indicado no existe, o alguno de
los campos IDUsuarioInserAsc, IdItemAsc o IdElemento es 0
(esta es la comprobación que realiza el método para asegurarse
de que el registro existe para eliminarlo).
Permisos.
Podrán eliminar Costes o Ingresos Previstos con el método Delete…Previstos los siguientes
usuarios:
- AdminPortal.
a la que pertenecen el Coste o Ingreso Previsto indicado en el parámetro <IdCoste> o
<IdIngreso>.
2.3.14 Ver Ítems Enlazados (GetItems...)

Hay unos métodos específicos para ver los Ítems enlazados en las fichas de Empleados, Cuentas, Proyectos y
Áreas:
• GetItemsEmpleado para ver los Ítems de Empleados.

• GetItemsCuenta para ver los Ítems de Cuentas.
• GetItemsProyectos para ver los Ítems de Proyectos.
• GetItemsAmbito para ver los Ítems de Áreas.
< IdEmpleado > (int) o Número entero que indica el ID del elemento (Empleado, Cuenta,
Proyecto o Área) del que se quieren ver sus Ítems enlazados.
< IdProyecto > (int) o (… según la familia) y se puede obtener con los métodos GetId… de
< IdAmbito> (int) o este Servicio Web AuraPortalFamilias, o con los métodos
AuraPortalDoc.
( XmlDocument ) Se obtendrá un documento XML estructurado con los siguientes

datos de los Ítems enlazados al elemento indicado en el parámetro:
<ID> : Identificador del elemento en la lista de SharePoint

AP_ItemsEnlazadosFichas.
<Title>: Familia a la que pertenece el enlace. Los posibles valores
son Empleados, Cuentas, Proyectos y Ambitos.
<IdElementoAsc> : ID del elemento de la familia indicada en el

parámetro Title.
<IdItemAsc> : ID del Item enlazado, correspondiente a la lista de
SharePoint AP__ItemsFichas.
<IdInserAsc> : ID del empleado que enlazó el Item,
correspondiente a la lista de SharePoint AP_EmpleadosFichas.
Si no se tienen suficientes permisos para ver los Costes o Ingresos
Previstos, se obtendrá el siguiente documento con el Código -4:

<Errores>
<Error>-4</Error>
</Errores>
Si el elemento indicado no existe, se obtendrá el mismo documento
pero con el Código -8.

documento.
Permisos.
Podrán obtener elementos con los métodos GetItems… los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de VER elementos de las Clases de
los elementos indicados.
En el caso de Empleados, además podrán obtener los Items enlazados a un empleado los
siguientes:
- Todos los empleados que estén por encima en el árbol de empleados (organigrama).
- Los pertenecientes a un Grupo de Empleados con permisos de VER ENLACES Y PLANNING.
2.3.15 Enlazar Ítems en Familias (LinkItem…)

Hay unos métodos específicos para enlazar Ítems en las fichas de Empleados, Cuentas, Proyectos y Áreas:
• LinkItemEmpleado para enlazar Ítems en las Fichas de Empleados.

• LinkItemCuenta para enlazar Ítems en las Fichas de Cuentas.
• LinkItemProyectos para enlazar Ítems en las Fichas de Proyectos.
• LinkItemAmbito para enlazar Ítems en las Fichas de Áreas.
< IdEmpleado > (int) o Número entero que indica el ID del elemento (Empleado, Cuenta,
Proyecto o Área) en el que se quiere enlazar el Ítem.

< IdProyecto > (int) o (… según la familia) y se puede obtener con los métodos GetId… de
< IdAmbito> (int) o getElementFilter, getElements o getAccounts del Servicio Web
AuraPortalDoc.
< IdItem > (Int) Número entero que indica el ID del Ítem que se quiere enlazar
correspondiente en la lista de SharePoint AP_ItemsFichas.
Se puede obtener con los métodos GetIdItem de este Servicio Web

AuraPortalFamilias, o con los métodos getElementFilter o
getElements del Servicio Web AuraPortalDoc.
( int ) Si se obtiene el número 0, es que el Ítem se ha enlazado

correctamente. Se habrá creado un registro en la lista de SharePoint

siguientes:

-8 : El elemento indicado en el parámetro <Id…> no existe.
-9 : El Item indicado en <IdItem> no existe.
-10 : El Item indicado ya está enlazado en este elemento.
-11 : El Item indicado es de Naturaleza Material Único y ya está
enlazado en otro elemento de esta familia.
Permisos.
Podrán enlazar Ítems con los métodos LinkItem… los siguientes usuarios:
- AdminPortal.
de los elementos indicados.
2.3.16 Eliminar Enlaces de Items (DeleteItem…)

Hay unos métodos específicos para eliminar Ítems enlazados en las fichas de Empleados, Cuentas, Proyectos y
Áreas:
• DeleteItemEmpleado para eliminar los Ítems enlazados en Empleados.

• DeleteItemCuenta para eliminar los Ítems enlazados en Cuentas.
• DeleteItemProyectos para eliminar los Ítems enlazados en Proyectos.
• DeleteItemAmbito para eliminar los Ítems enlazados en Áreas.
Su parámetro es el siguiente:

< IdEnlace > (int) Número entero que indica el ID del Enlace en la lista de SharePoint
Este ID se puede obtener con los métodos GetItems… de este

Servicio Web AuraPortalFamilias.
( int ) Si se obtiene el número 0, es que el enlace del Ítem se ha eliminado

correctamente.

siguientes:
-1 : Problema indefinido al intentar eliminar el enlace.

-4 : Permisos insuficientes para eliminar el enlace.
-8 : El Ítem indicado en el parámetro <IdEnlace> no existe.
-9 : El Ítem indicado en <IdItem> existe, pero no está enlazado
en este elemento.
Permisos.
Podrán desenlazar Items con los métodos DeleteItem… los siguientes usuarios:
- AdminPortal.
- Los pertenecientes a un Grupo de Empleados con permisos de EDITAR elementos de la Clase a
la que pertenece el elemento en donde está enlazado el Item indicado en <IdEnlace>.
2.3.17 Enlazar URL en Familias (LinkUrl…)

Hay unos métodos específicos para enlazar URLs en los Documentos Asociados de las fichas de Empleados,
Cuentas, Ítems, Proyectos y Áreas:
- LinkUrlEmpleado para enlazar URLs en las Fichas de Empleados.

- LinkUrlCuenta para enlazar URLs en las Fichas de Cuentas.
- LinkUrlItem para enlazar URLs en las Fichas de Ítems.
- LinkUrlProyectos para enlazar URLs en las Fichas de Proyectos.
- LinkUrlAmbito para enlazar URLs en las Fichas de Áreas.
< IdEmpleado > (int) o

Número entero que indica el ID del elemento (Empleado, Cuenta,
< IdCuenta > (int) o Item, Proyecto o Área) en el que se quiere enlazar la URL.
< IdItem > (int) o Este ID se corresponde con el de las listas de SharePoint AP_...Fichas
(… según la familia) y se puede obtener con los métodos GetId… de
< IdProyecto > (int) o
< IdAmbito> (int) o getElementFilter, getElements o getAccounts del Servicio Web

AuraPortalDoc.
< UrlDoc > (Int) Es la URL que se quiere enlazar en la ficha del elemento indicado en
el parámetro anterior. Es obligatorio.
< Name > (string) Nombre que será visible en el Data Grid de Documentos Asociados
de la Ficha en donde se va a enlazar. Si no se introduce, se copiará la
URL indicada en el parámetro anterior.
( int ) Si se obtiene el número 0, es que la URL se ha enlazado

correctamente. Se habrá creado un registro en

siguientes:
-3 : Problema actualizando el contador de Doc. Enlazados.

-4 : Permisos insuficientes para enlazar la URL.
-8 : El elemento indicado en el parámetro <Id…> no existe.
-9 : El parámetro UrlDoc está vacío y es obligatorio.
Permisos.
Podrán enlazar URL con los métodos LinkUrl… los siguientes usuarios:
- AdminPortal.
de los elementos indicados.
2.3.18 Para la gestión de Familias Propias

Los métodos son los siguientes:
GetUserFamilyTree. Obtiene el árbol de Clases de una Familia Propia a partir del único parámetro siguiente:
UserFamily_ID.
GetUserFamily. No tiene parámetros. Devuelve la lista de Familias Propias existentes y sus IDs con los valores
UserFamily_ID y UserFamily_Name.
GetUserFamilyClass. Introduciendo el parámetro <UserFamily_ID> devuelve la lista de Clases de esa

familia con los valores Class_ID y Class_Name.
- Código de devolución: -1: Parámetros incorrectos (el parámetro está en blanco o no es un valor
numérico).
GetUserFamilyElementList. Introduciendo los parámetros <UserFamily_ID> y <Class_ID> (opcional),

devuelve la lista de Elementos de esa familia, con los valores Element_ID, Element_Name y Class_ID de cada
uno.

- Código de devolución: -1: Parámetros incorrectos (el parámetro está en blanco o no es un valor
numérico).
GetUserFamily_Terms. Introduciendo el parámetro <UserFamily_ID> devuelve la lista de Nombres Internos

de los Términos de Diccionario de esa familia que se pueden utilizar para crear nuevos elementos.
GetUserFamilyElement. Introduciendo los parámetros <UserFamily_ID> y <Element_ID> devuelve los datos

de la ficha de ese elemento.
- Código de devolución: -1 = Parámetros incorrectos (algún parámetro está vacío o no es un valor

numérico).
GetSecureRooms. Obtiene la lista de Recintos Seguros. Los parámetros posibles para invocarlo son:
<Chapter_Name>. Nombre del Capítulo en el árbol de Recintos Seguros donde está ubicado.
<SecureRoom_Name>. Nombre del Recinto Seguro.
CreateUserFamilyClass. Crea una Clase de Familia Propia. Los parámetros necesarios son:
<UserFamily_ID>. ID de la Familia Propia que se obtiene con el método GetUserFamily.

<Class_Name>. Nombre para crear la nueva Clase.
<SecureRoom_ID>. ID del Recinto Seguro asignado a la Clase. Si no se indica, se asigna el Recinto Seguro
_Abierto.
Si la Clase se crea correctamente, se devuelve su ID con un número entero. Si hay alguna incidencia se
devuelve uno de los códigos negativos siguientes:
- Códigos de devolución:
- 28 = La Familia Propia indicada no existe.

- 29 = Ya existe una Clase con ese nombre.
- 30 = El Recinto Seguro indicado no existe.
- 31 = Nombre de la Clase vacío o incorrecto.
CreateUserFamilyElement. Introduciendo los parámetros <UserFamily_ID>, <Class_ID> y <Data> se crean
nuevos elementos dentro de la Familia indicada.
El parámetro <Data> utiliza la estructura habitual en otros métodos, con nombres internos de términos con
separadores especiales.
- ID = Si se crea correctamente devuelve el ID del nuevo elemento.

- -1 = Parámetros incorrectos (alguno de los parámetros está en blanco o es incorrecto).
- -2 = No existe la Familia indicada.
- -3 = No existe la Clase indicada.
- -4 = La Clase indicada existe pero no pertenece a esta Familia.
- -5 = Ocurrió un problema descomponiendo la cadena de datos.
- -6 = Se produjo un problema al actualizar el valor de cualquier campo, por ejemplo porque el
valor es incompatible.
DeleteUserFamilyElement. Introduciendo los parámetros <UserFamily_ID> y <Element_ID> se elimina el
elemento.

- ID = Si se elimina correctamente devuelve su ID.

- -1 = Parámetros incorrectos (alguno de los parámetros está en blanco o no es un valor
numérico).
- -3 = No existe el elemento indicado.
UpdateUserFamilyElement. Introduciendo los parámetros <UserFamily_ID>, <Data> y <Element_ID> se
actualizan los datos del elemento indicado.
- ID = Si se actualiza correctamente devuelve su ID.

- -1 = Parámetros incorrectos (algún parámetro está vacío o no es un valor numérico).
- -3 = No existe el elemento indicado.
- -4 = Se produjo un problema al actualizar el valor de cualquier campo, por ejemplo porque el
valor es incompatible.
- -5 = Ocurrió un problema descomponiendo la cadena de datos.
LodgeUserFamilyClass. Ubica una Clase de Familia Propia en una Rama existente del árbol de Clases. Los
parámetros para invocarlo son:
<UserFamily_ID. ID de la Familia Propia que se obtiene con el método GetUserFamily.

<Class_ID>. Se obtiene con el método GetUserFamilyClass ya existente en versiones anteriores.
<Level>. Se obtiene con el método anterior, por ejemplo 1.4.
Si la Clase se ubica correctamente se devuelve el número entero 0. Si hay algún problema se devuelve uno de
los códigos negativos siguientes:
- -32 = Problema indefinido al ubicar la Clase.

- -33 = Clase ya ubicada en otra Rama.
- -34 = Nivel Incorrecto.
- -35 = No existe la Clase.
MÉTODOS ACCESORIOS
Hay un método accesorio que es el siguiente:
2.3.19 Ver Cargos de Empleados (GetCargosEmpleado)

GetCargosEmpleado es un método específico para ver el Nombre y el GUID de los Cargos de Empleados de
AuraPortal.
< IdEmpleado > (int) Número entero que corresponde al ID del Empleado del que

queremos ver sus Cargos.
Este ID se puede ver con los métodos getElementFilter y

getElements del Servicio Web AuraPortalDoc.
( XmlDocument ) Se obtendrá un documento XML con el Nombre y GUID de los

cargos del Empleado indicado.
2.3.20 Acceso a datos por Reporting Services (EmployeeLoginMatch)

EmployeeLoginMatch es un método específico para comprobar si el Login y el ID proporcionados
pertenecen al mismo Empleado.
< EmployeeId > (int) Se indica el ID de un Empleado.
< Login> Se indica un Login.
Los parámetros de devolución son los siguientes:
- +1. El ID y el Login pertenecen al mismo empleado.

- +2. El ID y el Login no pertenecen al mismo empleado pero están en el mismo Grupo de Empleados.
- -1. El ID y el Login no pertenecen al mismo empleado ni están en el mismo Grupo de Empleados.
Nota.
En referencia al acceso a datos a través de Reporting Services, la AP_REPORTING.DLL
incorpora la function EmployeeLoginMatch, que conecta con el Servicio Web anterior
para que Reporting Services pueda actuar en consecuencia.
Existe un fichero AP_Reporting.Config.XML con los parámetros de configuración de
las llamadas al Servicio Web (URL, usuario...). Por defecto lo buscará en
C:\AP_Reporting, pero se le puede pasar la ruta completa del fichero al método
EmployeeLoginMatch como tercer parámetro opcional.
2.3.21 Comprobar un Login (AccessEmployee)

AccessEmployee es un método específico para comprobar si un determinado Login pertenece a un Empleado
con acceso a AuraPortal.
Los parámetros de devolución son los siguientes:
-1. Acceso no Autorizado.

El ID del empleado en la lista de SharePoint. Será un número entero.

2.3.22 Comprobaciones sobre un Usuario Invitado (AccessGuestUser)
AccessGuestUser es un método mediante el cual se puede obtener información de la existencia y validez los
Usuarios Invitados.
Tiene dos parámetros de entrada:
• Login
• Password
El servicio web devuelve los valores siguientes:
+1 = Login correcto, está asociado a un Usuario Invitado y está activo. (Este código se devuelve cuando no
se ha indicado el Password.)
+2 = Login y Password correctos.
-1 = Login no asociado a ningún Usuario Invitado.
-2 = Login está asociado a un Usuario Invitado pero está inactivo.
-3 = Password incorrecto. (Las comprobaciones del Login son correctas y el usuario está activo, pero el
password no es correcto.)
-4 = Error indefinido.
2.3.23 Encontrar una Cuenta con su CIF (GetAccountByCIF)

El método GetAccountIdByCIF es específico para conseguir una Cuenta proporcionando todo o parte de su
CIF.
El único parámetro de entrada es parte del CIF de la Ficha de la Cuenta.
El único parámetro de devolución es un número entero con las siguientes características:
Si es un número positivo quiere decir que solo existe una coincidencia y es el ID de la Cuenta.
-1 = Hay más de una coincidencia.

-2 = No hay ninguna coincidencia.
-3 = Error indefinido.


Integracion 05 ServiciosWeb Tomo2 APDoc APFamilias Helium 20170711

Cargado por

Información del documento

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Integracion 05 ServiciosWeb Tomo2 APDoc APFamilias Helium 20170711

Cargado por

Copyright:

Formatos disponibles

Manual

Servicios Web AuraPortal

Esta publicación pertenece al Servicio de Documentación de AuraPortal (SDAP) y todos los

1.3.1 Ver los Elementos de una Familia (getElementsFilter) ..............................................................................9

SERVICIOS WEB – TOMO 2 Página 2 de 65

SERVICIOS WEB – TOMO 2 Página 3 de 65

• En el Primer Tomo se incluye información detallada sobre AURAPORTALPROCESOS y

1. SERVICIO WEB AURAPORTALDOC.ASMX

A continuación, se describen todos los detalles del Servicio Web AuraPortalDoc.

• Integrar y ver documentos de la Ficha de elementos de cualquier familia de AuraPortal.

• URL del servicio (http://host.dominio.com/Home/webservice/AuraPortaldoc.asmx)

(“host.dominio.com” depende de cada instalación)

SERVICIOS WEB – TOMO 2 Página 4 de 65

• En Empleados, Cuentas, Ítems, Proyectos y Áreas: El usuario ha de tener el permiso de Edición en

• En Bibliotecas y Anexos: El usuario ha de tener permiso Agregar Elementos de SharePoint en la

(“host.dominio.com” depende de cada instalación)

SERVICIOS WEB – TOMO 2 Página 5 de 65

<family>Empleado or Tarea or Documento or Cuenta or Item or Proyecto or Ambito </family> =

VER ELEMENTOS DE UNA FAMILIA

En previsión de ampliaciones futuras se han desarrollado dos métodos complementarios, llamados:

- getFilterFields, para ver los campos de filtrado disponibles.

SERVICIOS WEB – TOMO 2 Página 6 de 65

CREAR BIBLIOTECAS DE SHAREPOINT

▪ Ubicar bibliotecas en árbol. Con lodgeLibraryToTree se ubican bibliotecas en el árbol. Sus

▪ Ver Bibliotecas no Ubicadas: Con getUnLodgedLibraries se obtiene las Bibliotecas pendientes de

INTEGRAR DOCUMENTOS EN UNA BIBLIOTECA DE SHAREPOINT

▪ Ver campos de la Biblioteca: Con el método getFields se obtiene la lista de columnas de

SERVICIOS WEB – TOMO 2 Página 7 de 65

▪ Integrar documentos en la Ficha de un elemento: Con el método uploadIntegratedDocument se

INTEGRAR DOCUMENTOS EN ANEXOS

Para integrar documentos en un Anexo, tenemos varios métodos relacionados:

INTEGRAR DOCUMENTOS EN PROCESOS

RELLENAR UN ANEXO SIN DOCUMENTO

MODIFICAR UN ANEXO YA CREADO

▪ Para eliminar un registro de un Anexo, se utiliza el método deleteAnnexe.

VER DOCUMENTOS Y ANEXOS

La obtención de documentos y Anexos tiene los siguientes métodos específicos:

▪ Con el método getDataAnnexe se obtienen los datos de un Anexo ya rellenado.

SERVICIOS WEB – TOMO 2 Página 8 de 65

▪ Con el método getArrayBitsXMLDocIntegrado se obtiene el nombre y el array de bits de un

▪ Con el método getArrayBitsDataSetDocIntegrado se obtiene el nombre y el array de bits de un

▪ Con el método getArrayBitsStringDocIntegrado se obtiene el nombre y el array de bits de un

MANEJO DE DOCUMENTOS INTEGRADOS EN BIBLIOTECAS EN DICCIONARIO

▪ Con el método UploadDocumentToDictionaryLibrary_Unique se integran documentos y permite

▪ Con el método UploadDocumentToDictionaryLibrary_Divided también se integran documentos y

▪ Con el método GetDocDictionaryLibraryList se obtiene la lista de Token de documentos filtrada por

▪ Con el método UpdateDocDictionaryLibraryLabels se pueden actualizar Etiquetas de documentos ya

▪ Con el método TransferDocDictionaryLibrary, similar a la Tarea de Sistema TRASPASADOR (Traspasa

▪ Con el método GetDocDictionaryLibrary se obtienen documentos.

▪ Con el método DeleteDocDictionaryLibrary se eliminan documentos.

Todos estos métodos se incluyen en el tomo 5 de esta documentación.

1.3.1 Ver los Elementos de una Familia (getElementsFilter)

SERVICIOS WEB – TOMO 2 Página 9 de 65

Los posibles valores son:

IdCampo (obtenido con getFilterFields)

Valor devuelto Explicación

Lista de elementos de AuraPortal que cumplen las condiciones de filtrado

SERVICIOS WEB – TOMO 2 Página 10 de 65

1.3.2 Ver Campos de Filtrado de una Familia (getFilterFields)

Los parámetros disponibles son:

SERVICIOS WEB – TOMO 2 Página 11 de 65

( Campo[ ] ) Lista de campos disponibles para hacer el filtrado.

Si no se indica correctamente el parámetro family (por ejemplo, porque no se han

1.3.3 Ver opciones disponibles en Campo de Filtrado (getFilterFieldsOptions)