Guía SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO. (19 julio 2012)

Transcripción

1 Guía SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO (19 juli 2012)

2 ÍNDICE 1. DESCRIPCIÓN GENERAL INTEGRAR DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO DEFINICIÓN DE LOS MÉTODOS EJEMPLOS DE ESQUEMAS XML Descripción de elements INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO LISTA DE DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO DEFINICIÓN DEL MÉTODO EJEMPLOS DE ESQUEMAS XML Descripción de elements Resultad de la cnsulta INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO ACTUALIZAR ETIQUETAS EN BIBLIOTECAS EN DICCIONARIO DEFINICIÓN DEL MÉTODO EJEMPLOS DE ESQUEMAS XML Descripción de elements Actualización de Etiquetas Autmáticas y Manuales INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO TRASPASAR DOCUMENTOS ENTRE BIBLIOTECAS EN DICCIONARIO DEFINICIÓN DEL MÉTODO EJEMPLOS DE ESQUEMAS XML Descripción de elements Resultad del traspas INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO OBTENER DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO DEFINICIÓN DEL MÉTODO EJEMPLOS DE ESQUEMAS XML Descripción de elements Resultad de la btención INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 2 de 22

3 7. ELIMINAR DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO DEFINICIÓN DEL MÉTODO EJEMPLOS DE ESQUEMAS XML Descripción de elements Resultad de la eliminación INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO CÓDIGOS DE ERROR SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 3 de 22

4 1. DESCRIPCIÓN GENERAL En este dcument se detallan ls siguientes métds del Servici Web AuraPrtalDc cn ls que se pueden manejar dcuments en Biblitecas En Diccinari de AuraPrtal: UpladDcumentTDictinaryLibrary_Unique UpladDcumentTDictinaryLibrary_Divided GetDcDictinaryLibraryList UpdateDcDictinaryLibraryLabels TransferrerDcDictinaryLibrary GetDcDictinaryLibrary DeleteDcDictinaryLibrary Hay trs métds del mism Servici Web para manejar dcuments integrads, per ests sn ls más cmplets prque permiten realizar l siguiente: Integrar dcuments en Biblitecas en Diccinari (UpladDcumentTDictinaryLibrary Unique y Divided), especificand si además están asciads a un de ls elements siguientes: Panel de un Prces, Ficha de Familia Prpias, Ficha de Rl Persnal ó Grup de Camps dentr de un de ls elements anterires. Obtener la lista de dcuments integrads filtrand pr etiquetas (GetDcDictinaryLibraryList). Rellenar etiquetas cn metadats en el mment de integrar dcuments, y mdificarlas en dcuments que ya fuern integrads en el pasad (UpdateDcDictinaryLibraryLabel). Traspasar dcuments a Biblitecas En Diccinari cuy Almacenamient esté en File System (TransferrerDcDictinaryLibrary). Obtener dcuments en Biblitecas En Diccinari (GetDcDictinaryLibrary). Eliminar dcuments en Biblitecas En Diccinari (DeleteDcDictinaryLibrary). 2. INTEGRAR DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO Hay ds métds para integrar dcuments: UpladDcumentTDictinaryLibrary_Unique. Ingresa el dcument enter en un únic uplad. Válid para dcuments menres de 20 ó 25 MB. UpladDcumentTDictinaryLibrary_Divided. Ingresa el dcument divid en varis paquetes. Necesari para dcuments mayres de 20 ó 25 MB. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 4 de 22

5 Para la integración de ls dcuments se utilizará una estructura XML que cntendrá tda la infrmación necesaria, cncretamente: Nmbre, Bibliteca destin, Si está asciada a algún Prces element de Familia Prpia Rl Persnal, Descripción (4.000 caracteres), Etiquetas de Text de una línea (32 etiquetas), Etiquetas de Text Multi-Línea de caracteres (8 etiquetas). Una vez finalizada la integración del dcument, el servici web devlverá el resultad cn un de ls siguientes valres: En cas psitiv, devlverá el Tken que identificará el dcument integrad, pr ejempl mmy7qwfs6h8= El métd UpladDcumentTDictinaryLibrary_Divided, devlverá un númer enter para identificar el cnjunt de prcines del dcument mientras se está integrand. En cas de prducirse un errr devlverá un númer enter negativ según la cdificación mstrada en el capítul CÓDIGOS DE ERROR al final de este dcument DEFINICIÓN DE LOS MÉTODOS La definición de ls métds para acceder vía prgramación es la siguiente: UpladDcumentTDictinaryLibrary_Unique: public string UpladDcumentTDictinaryLibrary_Unique(string xmldata) Este métd se utiliza cuand el dcument es menr de MB y pr l tant puede integrase enter en una única acción. Si es mayr, cnviene utilizar el siguiente métd. UpladDcumentTDictinaryLibrary_Divided : public string UpladDcumentTDictinaryLibrary_Divided(byte[] data, string idtmpfile) Esté métd se utiliza para fichers de más de MB, prque cnviene dividirls en paquetes separads para evitar ls prblemas lógics derivads de su tamañ. Ls parámetrs que se utilizan en la estructura XML para indicar ls paquetes sn ls siguientes: byte[] data: Cada paquete de dats será una parte del ficher XML y para relacinarls entre sí, han de empezar pr un de ls siguientes flags: sta, indica que se trata del primer paquete de dats. mid, indica que se trata de un paquete de dats intermedi. end, indica que se trata del últim paquete de dats. string idtmpfile: SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 5 de 22

6 El parámetr idtmpfile es el identificadr tempral del cnjunt de paquetes mientras n se haya transmitid el dcument cmplet. Para btener el idtmpfile, en la primera llamada al métd se ha de incluir una cadena cn el valr 0. Cuand termine el uplad de cada paquete, se devlverá el mism idtmpfile, hasta que finalice el últim paquete, mment en el que en lugar del idtmpfile se devlverá el Tken definitiv que identifica el dcument Integrad. Ver apartad siguiente cn ejempls EJEMPLOS DE ESQUEMAS XML Adjunt a este dcument se prprcinan l siguientes fichers cn ejempls de prgramación y esquemas XML: Dc-T-Library.XML. Ejempl para integración directa en Bibliteca sin asciar ni a Prces, ni a Familia Prpia, ni a Rl Persnal. Dc-T-Family.XML. Ejempl para integración en Familia Prpia. Dc-T-PersnalRle.XML. Ejempl para integración en Rl Persnal. Dc-T-Prcess.XML. Ejempl para integración en Prces. ErrrCdes.txt. Códigs de errr devuelts pr el Servici Web. UpladDcumentTDictinaryLibrary.XSD. Ficher XSD para la validación de la estructura XML. Además, en el directri UpladDcumentTDictinaryLibrary se adjunta un Pryect.NET realizad cn Visual Studi 2010 y.net Framewrk 3.5, cn un ejempl de prgramación cmplet Descripción de elements Aunque también se detalla en ls ejempls adjunts, a cntinuación se describen brevemente ls elements que identificarán el en el ficher.xml: <Library_Name> Nmbre del Términ de la Bibliteca en el Diccinari. Es bligatri. <Integratin_Target> Destin del ingres. Si n se rellena, el dcument quedará integrad directamente en la Bibliteca sin estar asciad a ningún Prces, Familia Prpia ni Rl Persnal. Hay tres valres psibles: Prces: - <Type>Prcess</Type> Identifica que el destin es un Prces. - <Element>. Hay que añadir la Referencia Base del Prces dnde se desea integrar el dcument, pr ejempl: COM-3.1_34. Es bligatri. - <FieldGrupRegistry_Id>. Es el ID de la Línea del Grup de Camps. Sól es necesari indicarl en cas de querer integrar el dcument en alguna línea cncreta de un Grup de Camps. El nmbre del Grup de Camps n es necesari indicarl prque el Servici Web sól necesita saber el nmbre de la Bibliteca y la Referencia Base del Prces. El ID de la Línea del Grup de Camps se puede btener cn el métd PanelDatsVer del Servici Web AuraPrtalPrcess. En el XML que se devuelve al btener dich métd, se puede identificar el nmbre intern del Grup de Camps (empieza pr 6_) y el ID es el valr de la etiqueta _IdRegistr===xxx SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 6 de 22

7 Nta. Si n se indica la Línea del Grup de Camps, para que ls usuaris puedan ver ls dcuments integrads, hay que cnfigurar el camp Bibliteca en el frmulari cn la pción FILTRO DE DOCUMENTOS Según Creación Tds ls del Prces. Familia Prpia: - <Type>Family</Type> Identifica que el destin es una Familia Prpia. - <Element> Cnsiste en añadir ds númers enters separads pr un _, pr ejempl 5_78. El primer númer es el ID de la Familia Prpia y el segund (separads pr un _ del primer) es el ID del element destin del ingres. Es bligatri. - <FieldGrupRegistry_Id>. Es pcinal, sól necesari si el dcument se integra en un Grup de Camps. Rl Persnal: - <Type>Persnal Rle</Type> Identifica que el destin es un Rl Persnal. - <Element>. Hay que añadir el ID del Rl Persnal. Es bligatri. - <FieldGrupRegistry_Id>. Es pcinal, sól necesari si el dcument se integra en un Grup de Camps. <Dcument_Name> Nmbre y extensión del dcument. Es bligatri. <Dcument_Descriptin> Es la etiqueta Descripción, cn un máxim de caracteres. N es bligatria. <Label_One_Line_Text>. Etiqueta de Text de una línea, cn ds valres psibles: <Name> Obligatri que tenga un valr exact entre _Txt1, _Txt2, hasta _Txt32 (hay 32 etiquetas de text de una línea). <Value> Es el cntenid desead para esta etiqueta, máxim 255 caracteres. <Label_Multiple_Line_Text>. Etiqueta de Text Multi-Línea, cn ds valres psibles: <Name> Obligatri que tenga un valr exact entre _Txt_Multi1, _Txt_Multi2, hasta _Txt_Multi8 (hay 8 etiquetas de text Multi-Línea). <Value> Es el cntenid desead para esta etiqueta, máxim caracteres. <Cntent>. Es el cntenid binari del dcument en Base 64. Es bligatri. Ntas. Las etiquetas Autmáticas siempre se rellenarán cn ls valres del Prces, Familia Rl Persnal al que se ascien. Est es así aunque n se referencien en el esquema XML aunque se les intente pasar tr valr. Sin embarg, si el dcument se integra directamente en la Bibliteca sin asciarl a ningún Prces, Familia Rl Persnal, es decir, en el ficher XML n se indica el element <Integratin_Target>, sí que se pdrán rellenar las etiquetas Autmáticas pasándle valres, igual cm si fueran Manuales. Cualquier etiqueta que se intente rellenar cn un númer de caracteres superir a su capacidad, se rellenará sól cn l permitid (255 para Text Una Línea y para Multi- Línea). SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 7 de 22

8 2.3. INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO Aunque el pryect.net (cn ejempl para el us de ests métds del Servici Web) adjunt a esta dcumentación, tiene cmetaris en el prpi códig, a cntinuación se adjuntan instruccines adicinales para facilitar la cmpresión. En el directri del pryect UpladDcumentTDictinaryLibrary se encuentra un ficher ejecutable para pruebas, cncretamente está en /bin/debug/auraprtal_upladdctdictinarylibrary.exe Al ejecutarl se abrirá el siguiente interface: En el mism directri se encuentran ls siguientes fichers, necesaris para su ejecución, que sn: Dcument_Template.XML. Plantilla XML a partir de la cual se creará el ficher Dcument_Test.XML que el prgrama utilizará para invcar al Servici Web. Esta plantilla tiene que cntener tds ls elements de la estructura XML que se requieren para la integración, tal cm se han descrit en el apartad 2.2 antes en este dcument. Indicar ls valres crrects de User, Passwrd, Dmain y URL WS, Al pulsar el btón [Prepare Dcument] y seleccinar un dcument, se btendrá su cdificación Base 64 y autmáticamente se generará el ficher Dcument_Test.XML. Si se utiliza el ficher Dcument_Template.XML tal cm está, sól se rellenará el element <Cntent>, per se pueden utilizar cualquiera de ls ejempls XML adjunts (Dc-T-Library.XML, Dc-T-Family.XML, Dc-T-PersnalRle.XML y Dc-T- Prcess.XML). Simplemente habrá que cpiar el ejempl desead renmbrándl cm Dcument_Test.XML y asignar valres a ls elements. Dcument_Test.XML. Al pulsar el btón [Uplad] se invcará el Servici Web cn el ficher Dcument_Test.XML, se cmprbará su integridad y si es válid se integrará el dcument, devlviend su Tken. UpladDcumentTDictinaryLibrary.XSD. Esquema XSD que se utiliza para validar la estructura del ficher Dcument_Test.xml antes de invcar el Servici Web. Este ficher está cmentad internamente para facilitar su cmprensión. 3. LISTA DE DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO En este Capítul se describe el métd GetDcDictinaryLibraryList del Servici Web AuraPrtalDc cn el que se puede cnsultar Biblitecas En Diccinari para btener la lista de sus dcuments y metadats. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 8 de 22

9 Para realizar la cnsulta de dcuments se utilizará una estructura XML que cntendrá tda la infrmación necesaria para lcalizarls, cncretamente: Nmbre de la Bibliteca En Diccinari, Si el dcument fue integrad directamente desde la Bibliteca, desde un Prces, element de Familia Prpia Rl Persnal, Nmbre del dcument, Descripción del dcument, Cntenid de Etiquetas de Text de una línea, Cntenid de Etiquetas de Text Multi-Línea. Una vez realizada la cnsulta, el Servici Web devlverá el resultad en un ficher.xml cn ls siguientes dats: Númer ttal de dcuments encntrads, Identificación, Tken, Nmbre, Descripción, Etiquetas de Text de una línea (32 etiquetas), Etiquetas de Text Multi-Línea de caracteres (8 etiquetas). Si se prduce un errr, se devlverá un númer enter negativ según la cdificación mstrada en el Capítul CÓDIGOS DE ERROR al final de este dcument DEFINICIÓN DEL MÉTODO La definición del métd GetDcDictinaryLibraryList para acceder vía prgramación es la siguiente: public string getdcdictinarylibrary_list(string xmldata) El únic parámetr del métd admite una estructura XML que deberá cntener ls dats necesaris para realizar la cnsulta. Ver apartad siguiente cn ejempls EJEMPLOS DE ESQUEMAS XML Adjunt a este dcument se prprcinan ls siguientes fichers cn ejempls de prgramación y esquemas XML: Query-Dcs-Library.XML. Ejempl para la cnsulta de dcuments Integrads directamente en la Bibliteca sin estar asciads ni a Prces, ni a Familia Prpia, ni a Rl Persnal. Query-Dcs-Family.XML. Ejempl para la cnsulta de dcuments Integrads en Familia Prpia. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 9 de 22

10 Query-Dcs-PersnalRle.XML. Ejempl para la cnsulta de dcuments Integrads en Rl Persnal. Query-Dcs-Prcess.XML. Ejempl para la cnsulta de dcuments Integrads en Prces. GetDcDictinaryLibraryList.XSD. Ficher XSD para la validación de la estructura XML. GetDcDictinaryLibraryList.XSD. Esquema XSD que se utiliza para validar la estructura del ficher XML seleccinad para realizar la cnsulta. Es necesari para la ejecución del prgrama de ejempl y su cmprbación se realiza antes de invcar el Servici Web. Este ficher está cmentad internamente para facilitar su cmpresión. ResultDcDictinaryLibraryList.XSD. Esquema XSD que se utiliza para cmprbar el ficher XML resultad de la cnsulta. Result.XML. Ejempl de resultad btenid en una cnsulta. Además, en el directri GetDcDictinaryLibraryList se adjunta un Pryect.NET realizad cn Visual Studi 2010 y.net Framewrk 3.5, cn un ejempl de prgramación cmplet Descripción de elements Aunque en el interir de ls fichers.xml adjunts cn ejempls hay cmentaris, a cntinuación se describen brevemente ls elements dispnibles: <Library_Name> Nmbre del Términ de la Bibliteca en el Diccinari. Es bligatri. <Integratin_Filter> Indica desde dónde fue integrad el dcument. N es bligatri y en cas de n incluirse la cnsulta btendrá tds ls dcuments de la Bibliteca indicada sin tener en cuenta desde dónde se integrarn, es decir, sl hay que utilizar este element si se desean btener sól ls dcuments que se integrarn desde Prcess, Familia Prpia, Rl Persnal directamente desde la Bibliteca. Pr l tant hay cuatr valres psibles: Prces: - <Type>Prcess</Type> Identifica que fue integrad desde un Prces. - <Element>. Hay que añadir la Referencia Base del Prces en el que se desea cnsultar ls dcuments Integrads, pr ejempl: COM-3.1_34. Es bligatri. Familia Prpia: - <Type>Family</Type> Identifica que fue integrad desde una Familia Prpia. - <Element> Cnsiste en añadir ds númers enters separads pr un _, pr ejempl 5_78. El primer númer es el ID de la Familia Prpia y el segund (separad pr un _ del primer) es el ID del element destin del ingres. Es bligatri. Rl Persnal: - <Type>Persnal Rle</Type> Identifica que fue integrad desde un Rl Persnal. - <Element>. Hay que añadir el ID del Rl Persnal. Es bligatri. Bibliteca: - <Type>Library</Type> Identifica que se integró directamente en la Bibliteca, sin pasar pr ningún tr element (Prces, Familia Prpia Rl Persnal). - <Element>. En este cas se indica el <Type>Library</Type> per n hay que rellenar el <Element>, ya que la Bibliteca será la que se haya indicad en <Library_Name>. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 10 de 22

11 <Dcument_Name> Nmbre y extensión del dcument. N es bligatri. Ls valres psibles sn: <Value> Valr para filtrar pr nmbre de dcument. <CmparisnOperatr> N bligatri. Admite 2 valres: - EqualT, es el valr pr defect y btendrá ls dcuments cuy nmbre sea idéntic al indicad en <Value>. - Like, btendrá ls dcuments que parte de su nmbre esté indicad en <Value>. <Dcument_Descriptin> Se refiere al cntenid de la etiqueta Descripción, cn un máxim de caracteres. N es bligatri. Hay ds psible valres: <Value> Valr para filtrar pr la descripción de dcument. <CmparisnOperatr> N bligatri. Admite 2 valres: - EqualT, es el valr pr defect y btendrá ls dcuments cuya descripción sea idéntica a la indicada en <Value>. - Like, btendrá ls dcuments que parte de su descripción esté indicada en <Value>. <Label_One_Line_Text>. Etiqueta de Text de una línea. N es bligatri. Ls valres psibles sn: <Name> Obligatri que tenga un valr exact cn el nmbre intern de la etiqueta, entre _Txt1, _Txt2, hasta _Txt32 (hay 32 etiquetas de text de una línea). <Value> Es el cntenid pr el que se filtrarán ls dcuments en la cnsulta, máxim 255 caracteres. <CmparisnOperatr> N bligatri. Admite 2 valres: - EqualT, es el valr pr defect y btendrá ls dcuments en ls que el cntenid de la etiqueta referenciada en <Name> sea idéntic al valr indicad en <Value>. - Like, btendrá ls dcuments en ls que parte del cntenid de la etiqueta referenciada en <Name> esté indicada en <Value>. <Label_Multiple_Line_Text>. Etiqueta de Text Multi-Línea. N es bligatri. Ls valres psibles sn: <Name> Obligatri que tenga un valr exact cn el nmbre intern de la etiqueta, entre _Txt_Multi1, _Txt_Multi2, hasta _Txt_Multi8 (hay 8 etiquetas de text Multi-Línea). <Value> Es el cntenid desead para esta etiqueta, máxim caracteres. <CmparisnOperatr> N bligatri. Admite 2 valres: - EqualT, es el valr pr defect y btendrá ls dcuments en ls que el cntenid de la etiqueta referenciada en <Name> sea idéntic al valr indicad en <Value>. - Like, btendrá ls dcuments en ls que parte del cntenid de la etiqueta referenciada en <Name> esté indicada en <Value>. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 11 de 22

12 Resultad de la cnsulta Cuand se realice una cnsulta a este métd del Servici Web, devlverá una estructura XML cn la siguiente infrmación: <TtalDcuments>. Indica el númer ttal de dcuments btenids pr la cnsulta. <Dcument>. Indica el cmienz de una estructura que cntendrá la infrmación de un dcument. Para cada dcument btenid pr la cnsulta encntrarems un element de este tip y su crrespndiente element de cierre </Dcument>, que cntendrán el rest de elements cn la infrmación del dcument. <Identificatin>. Identificación del dcument y si está Firmad. <Tken>. Tken que identifica el dcument. <Name>. Nmbre del dcument. Adicinalmente, y sól en el cas de haber utilizad Etiquetas para filtrar la cnsulta, también se devlverán éstas cn sus valres: <Label_One_Line_Text>. Etiqueta de Text de una línea. Cntendrá ds valres: <Name> Se mstrará el nmbre intern de la Etiqueta (_Txt1, _Txt2, hasta _Txt32). Sól se mstrarán las que se han utilizad en la cnsulta aunque n se indicara nada en <Value>. <Value> Mstrará el cntenid de la etiqueta. < Label_Multiple_Line_Text>. Etiqueta de Text Multi-Línea. Cntendrá ds valres: <Name> Se mstrará el nmbre intern de la Etiqueta (_Txt_ Multi1, _Txt_ Multi1, hasta _Txt_ Multi8). Sól se mstrarán las que se han utilizad en la cnsulta aunque n se indicara nada en <Value>. <Value> Mstrará el cntenid de la etiqueta. Nta. Si en la cnsulta se indican Etiquetas en <Name>, per su <Value> se deja vací, n actuará cm filtrad per en el resultad se btendrá su cntenid INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO Aunque el pryect.net (cn ejempl para el us de ests métds del Servici Web) adjunt a esta dcumentación, tiene cmentaris en el prpi códig, a cntinuación se adjuntan instruccines adicinales para facilitar la cmpresión. En el directri del pryect GetDcDictinaryLibraryList se encuentra un ficher ejecutable para pruebas, cncretamente en: /bin/debug/auraprtal_getdcdictinarylibrarylist.exe Al ejecutarl se abrirá el siguiente interface: SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 12 de 22

13 Indicar ls valres crrects de User, Passwrd, Dmain y URL WS, y al pulsar el btón [Select Query] se muestra un diálg para seleccinar el ficher XML que cntiene la cnsulta. Una vez seleccinad el ficher XML pulsar el btón [Send Query] y se enviará el ficher XML seleccinad al Servici Web, y el prgrama quedará en espera de respuesta. En el mism directri han de estar ls siguientes fichers: GetDcDictinaryLibraryList.xsd. Esquema XSD que se utiliza para validar la estructura del ficher XML seleccinad para realizar la cnsulta. Es necesari para la ejecución del prgrama de ejempl y su cmprbación se realiza antes de invcar el Servici Web. Este ficher está cmentad internamente para facilitar su cmpresión. ResultDcDictinaryLibraryList.xsd. Esquema XSD que se utiliza para cmprbar el ficher XML resultad de la cnsulta. 4. ACTUALIZAR ETIQUETAS EN BIBLIOTECAS EN DICCIONARIO En este Capítul se describe el métd UpdateDcDictinaryLibraryLabels del Servici Web AuraPrtalDc cn el que se puede actualizar Etiquetas de dcuments de Biblitecas En Diccinari. Para realizar la actualización de metadats se utilizará una estructura XML que cntendrá tda la infrmación necesaria. Cncretamente: Tken del dcument (que se habrá btenid cn el métd GetDcDictinaryLibraryList cmentad en el Capítul anterir. Descripción del dcument, Etiquetas de Text de una línea, Etiquetas de Text Multi-Línea. Una vez realizada la actualización, el Servici Web devlverá el resultad cn un de ls siguientes valres: En cas psitiv, devlverá el Tken que identifica el dcument integrad, pr ejempl mmy7qwfs6h8= Si se prduce un errr, se devlverá un númer enter negativ según la cdificación mstrada en el Capítul CÓDIGOS DE ERROR al final de este dcument. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 13 de 22

14 4.1. DEFINICIÓN DEL MÉTODO La definición del métd UpdateDcDictinaryLibraryLabels para acceder vía prgramación es la siguiente: public string updatedcdictinarylibrarylabels(string xmldata) El únic parámetr del métd admite una estructura XML que cntendrá ls dats necesaris para realizar la actualización de ls metadats. Ver el apartad siguiente cn ejempls EJEMPLOS DE ESQUEMAS XML Adjunt a este dcument se prprcinan ls siguientes fichers cn ejempls de prgramación y esquemas XML: Update-Labels.XML. Ejempl para la actualización de las Etiquetas de un dcument Integrad. UpdateDcDictinaryLibraryLabels.XSD. Ficher XSD para la validación de la estructura XML utilizada para la actualización de Etiquetas. Además, en el directri UpdateDcDictinaryLibraryLabels se adjunta un Pryect.NET realizad cn Visual Studi 2010 y.net Framewrk 3.5, cn un ejempl de prgramación cmplet Descripción de elements Aunque en el interir de ls fichers.xml adjunts cn ejempls hay cmentaris, a cntinuación se describen ls elements dispnibles: <Dcument_Tken> Tken que identifica el dcument Integrad. Es bligatri. <Dcument_Descriptin> Es la etiqueta Descripción, cn un máxim de caracteres. N es bligatri. Su valr se indica en el parámetr siguiente: <Value> Cntenid para actualizar la descripción de dcument. <Label_One_Line_Text>. Etiqueta de Text de una línea. N es bligatri. Ls psibles valres se indican en ls parámetrs siguientes: <Name> Obligatri que tenga un valr exact entre _Txt1, _Txt2, hasta _Txt32 (hay 32 etiquetas de text de una línea). <Value> Cntenid para actualizar la etiqueta de Text de una línea, máxim 255 caracteres. <Label_Multiple_Line_Text>. Etiqueta de Text Multi-Línea. N es bligatri. Ls psibles valres se indican en ls parámetrs siguientes: <Name> Obligatri que tenga un valr exact entre _Txt_Multi1, _Txt_Multi2, hasta _Txt_Multi8 (hay 8 etiquetas de text Multi-Línea). <Value> Cntenid para actualizar la etiqueta de Text Multi-Línea, máxim caracteres. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 14 de 22

15 Actualización de Etiquetas Autmáticas y Manuales La frma de actualizar las Etiquetas de dcuments dependerá de si sn Autmáticas Manuales y desde dónde fuern integrads. En general, se actualizarán cn el valr del element <Value> del.xml que se utilice para invcar el Servici Web, except en el cas de que sean Autmáticas y que ls dcuments hayan sid Integrads desde Prcess, Familias Prpias Rl Persna: Integrad desde Autmática Manual Prces, Familia Prpia, ó Rl Persnal La Etiqueta se actualizará autmáticamente cn el valr que tenga el camp de Panel asciad, en el mment de invcar el Servici Web. N se tendrá en cuenta el valr del element <Value> del.xml que se utilice para invcar el Servici Web. La Etiqueta se actualizará cn el valr del element <Value> del.xml que se utilice para invcar el Servici Web. Si <Value>está vací se vaciará la Etiqueta. Directamente desde la Bibliteca La Etiqueta se actualizará cn el valr del element <Value> del.xml que se utilice para invcar el Servici Web. Si <Value>está vací se vaciará la Etiqueta. La Etiqueta se actualizará cn el valr del element <Value> del.xml que se utilice para invcar el Servici Web. Si <Value>está vací se vaciará la Etiqueta. Nta. Cm se puede bservar, las Etiquetas sól pueden ser Autmáticas cuand ls dcuments se integran desde frmularis desde ls cuales se pueden btener autmáticamente ls valres de ls camps, es decir, desde Prcess, Familias Prpias y Rles Persnales. Pr este mtiv, si se utilizan Etiquetas Autmáticas al integrar dcuments directamente desde la Bibliteca, al n haber camps desde dnde btener ls dats, se cmprtan cm Manuales, prprcinand la prtunidad al usuari de intrducir su valr INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO Aunque el pryect.net (cn ejempl para el us de ests métds del Servici Web) adjunt a esta dcumentación, tiene cmetaris en el prpi códig, a cntinuación se adjuntan instruccines adicinales para facilitar la cmpresión. En el directri del pryect NET-UpladDcDictinaryLibraryList se encuentra un ficher ejecutable para pruebas, cncretamente está en: /bin/debug/auraprtal_upladdcdictinarylibrarylables.exe Al ejecutarl se abrirá el siguiente interface: SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 15 de 22

16 Indicar ls valres crrects de User, Passwrd, Dmain y URL WS, y al pulsar el btón [Select Query] se muestra un diálg para seleccinar el ficher XML que cntiene ls nuevs dats para actualizar Etiquetas. Una vez seleccinad el ficher XML pulsar el btón [Send Query] y se enviará el ficher XML seleccinad al Servici Web, y el prgrama quedará en espera de respuesta. En el mism directri ha de estar el siguiente ficher: UpdateDcDictinaryLibraryLabels.XDS. Esquema XSD que se utiliza para validar la estructura del ficher XML seleccinad para la actualización. Es necesari para la ejecución del prgrama de ejempl y su cmprbación se realiza antes de invcar el Servici Web. Este ficher está cmentad internamente para facilitar su cmpresión. 5. TRASPASAR DOCUMENTOS ENTRE BIBLIOTECAS EN DICCIONARIO En este Capítul se describe el métd TransferrerDcDictinaryLibrary del Servici Web AuraPrtalDc cn el que se pueden traspasar dcuments a Biblitecas En Diccinari cuy Almacenamient sea File System. Su función es similar a la que hace la Tarea de Sistema TRASPASADOR (Traspasa entre Biblitecas En Diccinari). Para realizar el traspas se utilizará una estructura XML que cntendrá tda la infrmación necesaria. Cncretamente: Bibliteca En Diccinari destin del traspas (la rigen n es necesari indicarla), Lista de Tken de ls dcuments que se desean traspasar. Ls Tken se habrá btenid cn el métd GetDcDictinaryLibraryList cmentad en tr Capítul. Una vez realizad el traspas, el Servici Web devlverá un.xml cn ls siguientes valres: Númer de dcuments traspasads crrectamente y su lista de Tken, Númer de dcuments n traspasads y su lista de Tken DEFINICIÓN DEL MÉTODO La definición del métd TransferrerDcDictinaryLibrary para acceder vía prgramación es la siguiente: public String transferrerdcdictinarylibrary(string xmldata) El únic parámetr del métd admite una estructura XML que cntendrá ls dats necesaris para realizar el traspas de dcuments. Ver el apartad siguiente cn ejempl. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 16 de 22

17 5.2. EJEMPLOS DE ESQUEMAS XML Adjunt a este dcument se prprcinan ls siguientes fichers cn ejempls de prgramación y esquemas XML: TransferrerDcDictinaryLibrary.XSD. Ficher XSD para la validación de la estructura XML utilizada para el traspas de dcuments. TransferrerDcuments-Test.XML. Ficher de ejempl para realizar un traspas. Result.XML. Ejempl del resultad que se btendrá de realizar el traspas. ResultDcDictinaryLibraryTransferrer.XSD. Ficher XSD para la validación de la estructura XML btenida cm resultad del traspas. Además, en el directri TransferrerDcDictinaryLibrary se adjunta un Pryect.NET realizad cn Visual Studi 2010 y.net Framewrk 3.5, cn un ejempl de prgramación cmplet Descripción de elements Aunque en el interir de ls fichers.xml adjunts cn ejempls hay cmentaris, a cntinuación se describen brevemente ls elements dispnibles en el ficher XML: <Library_Name> Nmbre de la Bibliteca En Diccinari destin del traspas. Es bligatri. La Bibliteca rigen n es necesari indicarla. Nta. La Bibliteca indicada cm destin es bligatri que su Almacenamient sea File System y n Base de Dats. <Dcument_Tken> Una etiqueta pr cada Tken de cada dcument que se quiere traspasar. Es bligatri. Ls Tken de ls dcuments se btienen cn el métd GetDcDictinaryLibraryList cmentad en tr Capítul Resultad del traspas Cuand se realice el traspas, el Servici Web devlverá una estructura XML cn el númer ttal de dcuments traspasads y su lista de Tken (2 en el ejempl siguiente), y el númer de ls n traspasads y su lista de Tken (0 en el ejempl siguiente): <SuccessfullyMvedDcuments> <TtalDcuments>235</TtalDcuments> <Tken>z0ZRT4SEvjs=</Tken> <Tken>mBf38pnHRXY2i8gZYQ1ag==</Tken> </SuccessfullyMvedDcuments> <ErrrMvingDcuments> <TtalDcuments>0</TtalDcuments> </ErrrMvingDcuments> SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 17 de 22

18 5.3. INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO Aunque el pryect.net (cn ejempl para el us de ests métds del Servici Web) adjunt a esta dcumentación, tiene cmentaris en el prpi códig, a cntinuación se adjuntan instruccines adicinales para facilitar la cmpresión. En el directri del pryect TransferrerDcDictinaryLibrary se encuentra un ficher ejecutable para pruebas, cncretamente en: /bin/debug/auraprtal_transferrerdcdictinarylibrary.exe Al ejecutarl se abrirá el siguiente interface: Indicar ls valres crrects de User, Passwrd, Dmain y URL WS, y al pulsar el btón [Select Query] se muestra un diálg para seleccinar el ficher XML que cntiene la cnsulta. Una vez seleccinad el ficher XML pulsar el btón [Send Query] y se enviará el ficher XML seleccinad al Servici Web, y el prgrama quedará en espera de respuesta. En el mism directri han de estar ls siguientes fichers: TransferrerDcDictinaryLibrary.XSD. Ficher XSD para la validación de la estructura XML utilizada para el traspas de dcuments. Es necesari para la ejecución del prgrama de ejempl y su cmprbación se realiza antes de invcar el Servici Web. Este ficher está cmentad internamente para facilitar su cmpresión. ResultDcDictinaryLibraryTransferrer.XSD. Ficher XSD para la validación de la estructura XML btenida cm resultad del traspas. 6. OBTENER DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO En este Capítul se describe el métd GetDcDictinaryLibrary del Servici Web AuraPrtalDc cn el que se puede btener dcuments de Biblitecas En Diccinari. Para realizar la btención se utilizará una estructura XML que cntendrá el Tken del dcument que se desea btener. Ls Tken se habrán btenid cn el métd GetDcDictinaryLibraryList cmentad en tr Capítul. El Servici Web devlverá un.xml cn ls siguientes valres del dcument: Identificadr, Tken, Nmbre, Descripción y Etiquetas, Cntenid del dcument cdificad en Base 64. En cas de prducirse un errr devlverá un númer enter negativ según la cdificación mstrada en el capítul CÓDIGOS DE ERROR al final de este dcument. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 18 de 22

19 6.1. DEFINICIÓN DEL MÉTODO La definición del métd GetDcDictinaryLibrary para acceder vía prgramación es la siguiente: public String getdcdictinarylibrary(string xmldata) El únic parámetr del métd admite una estructura XML que cntendrá ls dats necesaris para la btención del dcument. Ver el apartad siguiente cn ejempl EJEMPLOS DE ESQUEMAS XML Adjunt a este dcument se prprcinan ls siguientes fichers cn ejempls de prgramación y esquemas XML: GetDcDictinaryLibrary.XSD. Ficher XSD para la validación de la estructura XML utilizada para la btención de dcuments. GetDcumentDictinaryLibrary-Test.XML. Ficher de ejempl para realizar la btención de un dcument. Result.XML. Ejempl del resultad que se btendrá cn la btención de un dcument. ResultGetDcDictinaryLibrary.XSD. Ficher XSD para la validación de la estructura XML btenida cm resultad de la btención de un dcument Descripción de elements Aunque en el interir de ls fichers.xml adjunts cn ejempls hay cmentaris, a cntinuación se describen brevemente ls elements dispnibles en el ficher XML: <Dcument_Tken> Una etiqueta cn el Tken del dcument que se quiere btener. Es bligatri. Ls Tken de ls dcuments se btienen cn el métd GetDcDictinaryLibraryList cmentad en tr Capítul Resultad de la btención Para la btención del dcument el Servici Web cmprbará el estad actual del dcument asciad cn el Tken indicad. Es psible que el dcument haya sid firmad desde que se btuv su Tken hasta el mment de la btención, siempre se btendrá el dcument más actualizad, es decir, en cas de que haya sid firmad se btendrá su última firma. Cuand se realice una cnsulta a este métd del Servici Web, devlverá una estructura XML cn la siguiente infrmación: <Dcument>. Indica el cmienz de una estructura que cntendrá la infrmación de un dcument, cntendrán el rest de elements cn la infrmación del dcument. <Identificatin>. Identificación del dcument y si está Firmad. <Tken>. Tken que identifica el dcument. <Name>. Nmbre del dcument. También se incluyen las Etiquetas que cntengan valr: <Label_One_Line_Text>. Etiqueta de Text de una línea. Cntendrá ds valres: SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 19 de 22

20 <Name> Se mstrará el nmbre intern de la Etiqueta (_Txt1, _Txt2, hasta _Txt32). <Value> Mstrará el cntenid de la etiqueta. < Label_Multiple_Line_Text>. Etiqueta de Text Multi-Línea. Cntendrá ds valres: <Name> Se mstrará el nmbre intern de la Etiqueta (_Txt_ Multi1, _Txt_ Multi1, hasta _Txt_ Multi8). <Value> Mstrará el cntenid de la etiqueta. < Cntent>. Es el cntenid binari del dcument en Base INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO N hay ejempl específic para este métd prque sigue la misma estructura que ls anterires. Ver tds ls detalles en ls ejempls crrespndientes de ls trs métds. 7. ELIMINAR DOCUMENTOS EN BIBLIOTECAS EN DICCIONARIO En este Capítul se describe el métd DeleteDcDictinaryLibrary del Servici Web AuraPrtalDc cn el que se puede eliminar dcuments de Biblitecas En Diccinari. Para realizar la eliminación se utilizará una estructura XML que cntendrá el Tken del dcument que se desea btener. Ls Tken se habrán btenid cn el métd GetDcDictinaryLibraryList cmentad en tr Capítul. El Servici Web devlverá ls siguientes valres: Númer Enter 1 si el dcument se ha eliminad crrectamente, En cas de prducirse un errr devlverá un númer enter negativ según la cdificación mstrada en el capítul CÓDIGOS DE ERROR al final de este dcument DEFINICIÓN DEL MÉTODO La definición del métd DeleteDcDictinaryLibrary para acceder vía prgramación es la siguiente: public String deletedcdictinarylibrary(string xmldata) El únic parámetr del métd admite una estructura XML que cntendrá ls dats necesaris para la btención del dcument. Ver el apartad siguiente cn ejempl EJEMPLOS DE ESQUEMAS XML Adjunt a este dcument se prprcinan ls siguientes fichers cn ejempls de prgramación y esquemas XML: DeleteDcDictinaryLibrary.XSD. Ficher XSD para la validación de la estructura XML utilizada para la eliminación de dcuments. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 20 de 22

21 DeleteDcumentDictinaryLibrary-Test.XML. Ficher de ejempl para realizar la eliminación de un dcument Descripción de elements Aunque en el interir de ls fichers.xml adjunts cn ejempls hay cmentaris, a cntinuación se describen brevemente ls elements dispnibles en el ficher XML: <Dcument_Tken> Una etiqueta cn el Tken del dcument que se quiere eliminar. Es bligatri. Ls Tken de ls dcuments se btienen cn el métd GetDcDictinaryLibraryList cmentad en tr Capítul. <DeleteAllSignedAndVersins> Indica si se han de eliminar tdas las versines y firmas del dcument. Admite el valr True False. Es pcinal en cuy cas el valr predeterminad será False Resultad de la eliminación Para la eliminación del dcument el Servici Web cmprbará el estad actual del dcument asciad cn el Tken indicad. Es psible que el dcument haya sid versinad firmad desde que se btuv su Tken hasta el mment de la eliminación, se cmprbará que el Tken crrespnde cn el estad del dcument actualmente. El Servici Web devlverá ls siguientes valres: Númer Enter 1 si el dcument se ha eliminad crrectamente, En cas de prducirse un errr devlverá un númer enter negativ según la cdificación mstrada en el capítul CÓDIGOS DE ERROR al final de este dcument INSTRUCCIONES PARA EL CODIGO.NET DE EJEMPLO N hay ejempl específic para este métd prque sigue la misma estructura que ls anterires. Ver tds ls detalles en ls ejempls crrespndientes de ls trs métds. 8. CÓDIGOS DE ERROR Cuand un dcument se ingrese crrectamente, el Servici Web devlverá el Tken que identificará el dcument integrad, pr ejempl mmy7qwfs6h8=. En cas de que se prduzca un errr, el Servici Web devlverá un númer enter negativ según la siguiente cdificación: Códig -1 Descripción El usuari indicad en la cnfiguración del almacenamient, n tiene permiss de acces al File System. -2 La ruta del almacenamient es demasiad larga -3 El usuari indicad en la cnfiguración del almacenamient, n tiene permiss para crear directris en el File System. -4 El usuari indicad en la cnfiguración del almacenamient, n SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 21 de 22

22 tiene permiss para leer el dcument en File System. -5 El dcument indicad n existe en el File System. -6 La ruta del almacenamient n existe. -7 La ruta del dcument n existe. -8 El usuari indicad en la cnfiguración del almacenamient, n tiene permiss para grabar el dcument en File System. -9 El XML n es válid. -10 Errr al btener el Términ de Bibliteca En Diccinari indicad. -11 Errr al btener el Prces indicad. -12 Errr al btener la Familia Prpia indicada. -13 Errr al btener el Element de Familia Prpia indicad. -14 Errr al btener el Rl Persnal indicad. -15 Errr al btener el dcument Integrad mediante el Tken. -16 Dcument Firmad, n se puede mdificar La Bibliteca indicada cm destin del traspas n tiene su Almacenamient en File System. El Dcument ha sid versinad firmad y n se puede eliminar. -19 N se ha encntrad el Dcument crrespndiente al Tken. SERVICIOS WEB PARA BIBLIOTECAS EN DICCIONARIO Página 22 de 22