From aedacd2855b80f34e21c8ac08210076ff45bcfe1 Mon Sep 17 00:00:00 2001 From: nojhamster Date: Fri, 20 Sep 2024 12:40:51 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20ezpaarse?= =?UTF-8?q?-project/ezpaarse@b82f1ca579f33f4417c6662a0426c2ddd80628e9=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 6 +-- assets/js/{24.7631bd45.js => 24.a6e1caca.js} | 2 +- assets/js/{26.ce71f6da.js => 26.d0fdfd51.js} | 2 +- assets/js/{27.97322374.js => 27.848aaf73.js} | 2 +- assets/js/{28.276432b9.js => 28.63fc1787.js} | 2 +- assets/js/{29.34fd85a8.js => 29.4fe31c6f.js} | 2 +- assets/js/{30.f3081c1d.js => 30.a80afc28.js} | 2 +- assets/js/{31.30fc0b1b.js => 31.3e90b977.js} | 2 +- assets/js/{33.2cee94c5.js => 33.f2c5ec41.js} | 2 +- assets/js/{34.9e3fb16d.js => 34.7054c336.js} | 2 +- assets/js/{36.5f487fa4.js => 36.794a1d81.js} | 2 +- assets/js/{37.3db5b10d.js => 37.68916dff.js} | 2 +- assets/js/{42.e7be060e.js => 42.7e8124c2.js} | 2 +- assets/js/{43.cd83dd52.js => 43.b9d1be6f.js} | 2 +- assets/js/{44.f0c059c5.js => 44.bfaa562f.js} | 2 +- assets/js/{46.536ff2d2.js => 46.5715f2a1.js} | 2 +- assets/js/{49.5544d25f.js => 49.2727bf95.js} | 2 +- assets/js/{50.ecfdb7f7.js => 50.d0c5a129.js} | 2 +- assets/js/{52.807626b8.js => 52.f1fe7bda.js} | 2 +- assets/js/{54.0a92cd35.js => 54.ab538ec6.js} | 2 +- assets/js/{55.b57d2b25.js => 55.8d718162.js} | 2 +- assets/js/{61.92cbd66a.js => 61.db62c4b0.js} | 2 +- assets/js/{62.198c71df.js => 62.4c85a727.js} | 2 +- assets/js/{63.13715b95.js => 63.b9acfde7.js} | 2 +- assets/js/{64.fc785f26.js => 64.4a12aa64.js} | 2 +- assets/js/{65.fc03d9cf.js => 65.a53c2eb8.js} | 2 +- assets/js/{66.c3fda473.js => 66.cda92232.js} | 2 +- assets/js/{67.45776dec.js => 67.b19aabb3.js} | 2 +- assets/js/{68.f6dbdb14.js => 68.52fbf80a.js} | 2 +- assets/js/{70.cb9b1a7e.js => 70.7a681db8.js} | 2 +- assets/js/{74.34da6244.js => 74.9c25c103.js} | 2 +- assets/js/{75.e4819a28.js => 75.79e79b9d.js} | 2 +- assets/js/{82.4c717610.js => 82.93b00592.js} | 2 +- assets/js/{83.de0febc9.js => 83.6479f989.js} | 2 +- assets/js/{85.8b6d43c9.js => 85.8ce7a313.js} | 2 +- assets/js/{86.8b2f013f.js => 86.bf46a2dc.js} | 2 +- assets/js/{88.5bc91476.js => 88.23cd9043.js} | 2 +- assets/js/89.4b6b4d35.js | 1 + assets/js/89.5deda291.js | 1 - assets/js/{91.1b7debe3.js => 91.8a8bad1c.js} | 2 +- assets/js/app.0cb71576.js | 16 ++++++ assets/js/app.70ea8c29.js | 16 ------ config/index.html | 6 +-- configuration/config.html | 6 +-- configuration/parametres.html | 6 +-- development/admin.html | 6 +-- development/core.html | 6 +-- development/doc.html | 6 +-- development/makefile.html | 6 +-- development/middlewares.html | 6 +-- development/multilinguisme.html | 6 +-- development/platforms.html | 6 +-- development/routes.html | 6 +-- development/tools.html | 52 ++----------------- development/tree.html | 6 +-- essential/ec-attributes.html | 6 +-- essential/formats.html | 6 +-- essential/knowledge-base.html | 6 +-- essential/report.html | 6 +-- essential/updates.html | 6 +-- features/alerts.html | 6 +-- features/doubleclick.html | 6 +-- features/exclusions.html | 6 +-- features/geolocalisation.html | 6 +-- features/metadata-enrichment.html | 6 +-- features/outputfields.html | 6 +-- features/qualification.html | 6 +-- guide/index.html | 6 +-- guide/using-vue.html | 6 +-- index.html | 4 +- middlewares/anonymizer/README.html | 4 +- middlewares/bot-ua-detector/README.html | 4 +- middlewares/crossref/README.html | 4 +- middlewares/cut/README.html | 4 +- middlewares/datacite/README.html | 4 +- middlewares/deduplicator/README.html | 4 +- middlewares/ebscohost/README.html | 4 +- middlewares/enhancer/README.html | 4 +- middlewares/eprints/README.html | 4 +- middlewares/ezunpaywall/README.html | 4 +- middlewares/field-splitter/README.html | 4 +- middlewares/filter/README.html | 4 +- middlewares/geolocalizer/README.html | 4 +- middlewares/hal/README.html | 4 +- middlewares/host-chain/README.html | 4 +- middlewares/istex/README.html | 4 +- middlewares/labelize/README.html | 4 +- middlewares/ncbi/README.html | 4 +- middlewares/omeka/README.html | 4 +- middlewares/omekas/README.html | 4 +- middlewares/on-campus-counter/README.html | 4 +- middlewares/panist/README.html | 4 +- middlewares/parser/README.html | 4 +- middlewares/populate/README.html | 4 +- middlewares/qualifier/README.html | 4 +- middlewares/robots/README.html | 4 +- middlewares/session-id/README.html | 4 +- middlewares/sudoc/README.html | 4 +- middlewares/throttler/README.html | 4 +- middlewares/trackcode-generator/README.html | 4 +- middlewares/unpaywall/README.html | 4 +- middlewares/user-agent-parser/README.html | 4 +- middlewares/zotero/README.html | 4 +- start/install.html | 6 +-- start/requirements.html | 6 +-- start/uninstall.html | 6 +-- start/usage.html | 53 ++++++++++++++++++-- troubleshooting/core-dumped.html | 6 +-- troubleshooting/mongodb-connection.html | 6 +-- 109 files changed, 272 insertions(+), 269 deletions(-) rename assets/js/{24.7631bd45.js => 24.a6e1caca.js} (99%) rename assets/js/{26.ce71f6da.js => 26.d0fdfd51.js} (95%) rename assets/js/{27.97322374.js => 27.848aaf73.js} (97%) rename assets/js/{28.276432b9.js => 28.63fc1787.js} (97%) rename assets/js/{29.34fd85a8.js => 29.4fe31c6f.js} (95%) rename assets/js/{30.f3081c1d.js => 30.a80afc28.js} (96%) rename assets/js/{31.30fc0b1b.js => 31.3e90b977.js} (95%) rename assets/js/{33.2cee94c5.js => 33.f2c5ec41.js} (96%) rename assets/js/{34.9e3fb16d.js => 34.7054c336.js} (97%) rename assets/js/{36.5f487fa4.js => 36.794a1d81.js} (97%) rename assets/js/{37.3db5b10d.js => 37.68916dff.js} (96%) rename assets/js/{42.e7be060e.js => 42.7e8124c2.js} (96%) rename assets/js/{43.cd83dd52.js => 43.b9d1be6f.js} (97%) rename assets/js/{44.f0c059c5.js => 44.bfaa562f.js} (96%) rename assets/js/{46.536ff2d2.js => 46.5715f2a1.js} (95%) rename assets/js/{49.5544d25f.js => 49.2727bf95.js} (95%) rename assets/js/{50.ecfdb7f7.js => 50.d0c5a129.js} (95%) rename assets/js/{52.807626b8.js => 52.f1fe7bda.js} (95%) rename assets/js/{54.0a92cd35.js => 54.ab538ec6.js} (95%) rename assets/js/{55.b57d2b25.js => 55.8d718162.js} (96%) rename assets/js/{61.92cbd66a.js => 61.db62c4b0.js} (99%) rename assets/js/{62.198c71df.js => 62.4c85a727.js} (99%) rename assets/js/{63.13715b95.js => 63.b9acfde7.js} (99%) rename assets/js/{64.fc785f26.js => 64.4a12aa64.js} (99%) rename assets/js/{65.fc03d9cf.js => 65.a53c2eb8.js} (98%) rename assets/js/{66.c3fda473.js => 66.cda92232.js} (99%) rename assets/js/{67.45776dec.js => 67.b19aabb3.js} (96%) rename assets/js/{68.f6dbdb14.js => 68.52fbf80a.js} (99%) rename assets/js/{70.cb9b1a7e.js => 70.7a681db8.js} (64%) rename assets/js/{74.34da6244.js => 74.9c25c103.js} (98%) rename assets/js/{75.e4819a28.js => 75.79e79b9d.js} (99%) rename assets/js/{82.4c717610.js => 82.93b00592.js} (98%) rename assets/js/{83.de0febc9.js => 83.6479f989.js} (93%) rename assets/js/{85.8b6d43c9.js => 85.8ce7a313.js} (95%) rename assets/js/{86.8b2f013f.js => 86.bf46a2dc.js} (98%) rename assets/js/{88.5bc91476.js => 88.23cd9043.js} (97%) create mode 100644 assets/js/89.4b6b4d35.js delete mode 100644 assets/js/89.5deda291.js rename assets/js/{91.1b7debe3.js => 91.8a8bad1c.js} (98%) create mode 100644 assets/js/app.0cb71576.js delete mode 100644 assets/js/app.70ea8c29.js diff --git a/404.html b/404.html index 05f67336..dcf82ccf 100644 --- a/404.html +++ b/404.html @@ -11,13 +11,13 @@ - + -

404

How did we get here?
+ - + diff --git a/assets/js/24.7631bd45.js b/assets/js/24.a6e1caca.js similarity index 99% rename from assets/js/24.7631bd45.js rename to assets/js/24.a6e1caca.js index cf853347..e4e8e105 100644 --- a/assets/js/24.7631bd45.js +++ b/assets/js/24.a6e1caca.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{301:function(a,e,t){a.exports=t.p+"assets/img/install-warning-mongo.766cddbd.png"},302:function(a,e,t){a.exports=t.p+"assets/img/install-result.94c91ea7.png"},407:function(a,e,t){"use strict";t.r(e);var s=t(10),r=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"installation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[a._v("#")]),a._v(" Installation")]),a._v(" "),e("p",[a._v("Make sure you fulfilled the "),e("RouterLink",{attrs:{to:"/start/requirements.html"}},[a._v("requirements")]),a._v(" before going any further.")],1),a._v(" "),e("p",[a._v("For an ezPAARSE installation on a "),e("strong",[a._v("Windows")]),a._v(" OS, you will have to use a dockerized container. Please see "),e("RouterLink",{attrs:{to:"/start/install.html#docker-and-compose"}},[a._v("below")]),a._v(".")],1),a._v(" "),e("h2",{attrs:{id:"ezpaarse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse"}},[a._v("#")]),a._v(" ezPAARSE")]),a._v(" "),e("h3",{attrs:{id:"with-source-code"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#with-source-code"}},[a._v("#")]),a._v(" With source code")]),a._v(" "),e("ol",[e("li",[a._v("Clone the repository")])]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" clone https://github.com/ezpaarse-project/ezpaarse\n")])])]),e("ol",{attrs:{start:"2"}},[e("li",[a._v("Open the ezPAARSE directory and get the latest stable version")])]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("cd")]),a._v(" ezpaarse\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" checkout "),e("span",{pre:!0,attrs:{class:"token variable"}},[e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("`")]),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" describe "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--tags")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--abbrev")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("`")])]),a._v("\n")])])]),e("ol",{attrs:{start:"2"}},[e("li",[a._v("Use the command "),e("strong",[a._v("make")]),a._v(" to install.")])]),a._v(" "),e("p",[a._v("This command will check whether your server has all the necessary prerequisites and download all dependencies and resources to enable ezPAARSE to work properly.")]),a._v(" "),e("p",[a._v("If you're planning to use ezPAARSE only from the command line and don't need the web interface, you can set the "),e("code",[a._v("EZPAARSE_NO_WEB_CLIENT")]),a._v(" environment variable to prevent client side dependencies from being installed.")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Full setup")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("make")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Setup without web client")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("EZPAARSE_NO_WEB_CLIENT")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("make")]),a._v("\n")])])]),e("blockquote",[e("p",[a._v("[!NOTE]"),e("br"),a._v("\nThere may be an error saying that it is impossible to connect to mongodb. If there is only this error, it still means that ezPAARSE has been installed correctly, but that no mongoDB is installed.")])]),a._v(" "),e("p",[e("img",{attrs:{src:t(301),alt:"image"}})]),a._v(" "),e("p",[a._v("At the end of the command, you should see this type of result.")]),a._v(" "),e("p",[e("img",{attrs:{src:t(302),alt:"image"}})]),a._v(" "),e("h3",{attrs:{id:"with-docker"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#with-docker"}},[a._v("#")]),a._v(" With docker")]),a._v(" "),e("p",[a._v("ezPAARSE is available as a "),e("a",{attrs:{href:"https://registry.hub.docker.com/r/ezpaarseproject/ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("docker image"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("p",[a._v("To run it with docker, you will need to install "),e("a",{attrs:{href:"https://docs.docker.com/engine/install/",target:"_blank",rel:"noopener noreferrer"}},[a._v("Docker"),e("OutboundLink")],1),a._v(" and "),e("a",{attrs:{href:"https://docs.docker.com/compose/install/",target:"_blank",rel:"noopener noreferrer"}},[a._v("Docker-Compose"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("p",[a._v("Then, you can either grab the "),e("code",[a._v("docker-compose.yml")]),a._v(" file alone:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("mkdir")]),a._v(" ezpaarse/\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("wget")]),a._v(" https://raw.githubusercontent.com/ezpaarse-project/ezpaarse/master/docker-compose.yml\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("test")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" config.local.json "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("||")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{}'")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" config.local.json\n")])])]),e("p",[a._v("or clone the github repository:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" clone https://github.com/ezpaarse-project/ezpaarse.git\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("cd")]),a._v(" ezpaarse\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("test")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" config.local.json "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("||")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{}'")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" config.local.json\n")])])]),e("blockquote",[e("p",[a._v("[!NOTE]"),e("br"),a._v("\nIf you install ezPAARSE with docker compose, there's no need to install mongodb in addition.")])]),a._v(" "),e("h2",{attrs:{id:"mongodb"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mongodb"}},[a._v("#")]),a._v(" MongoDB")]),a._v(" "),e("p",[a._v("ezPAARSE needs a mongodb to work, it can store the admin account, PKBs cache and processing history.\nby default,\nezPAARSE tries to connect to a mongodb which is available on port 27017.")]),a._v(" "),e("blockquote",[e("p",[a._v("[!NOTE]"),e("br"),a._v("\nezPAARSE loads PKBs on mongodb. As of mongodb version 6, this feature is no longer available.")])]),a._v(" "),e("h3",{attrs:{id:"official-packages"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#official-packages"}},[a._v("#")]),a._v(" Official packages")]),a._v(" "),e("p",[a._v("You can install mongodb on your server via "),e("a",{attrs:{href:"https://www.mongodb.com/docs/manual/installation/",target:"_blank",rel:"noopener noreferrer"}},[a._v("official packages"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("h3",{attrs:{id:"docker"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#docker"}},[a._v("#")]),a._v(" Docker")]),a._v(" "),e("p",[a._v("It's easier to install mongodb at the right version with docker.")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create mongodb image.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# You can use other versions but this may have an impact on PKB.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v(" run "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-p")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("27017")]),a._v(":27017 "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--name")]),a._v(" ezpaarse-db "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" mongo:3.6.23\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Start mongodb.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v(" start ezpaarse-db\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Stop mongodb.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v(" stop ezpaarse-db\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{301:function(a,e,t){a.exports=t.p+"assets/img/install-warning-mongo.766cddbd.png"},302:function(a,e,t){a.exports=t.p+"assets/img/install-result.94c91ea7.png"},406:function(a,e,t){"use strict";t.r(e);var s=t(10),r=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"installation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[a._v("#")]),a._v(" Installation")]),a._v(" "),e("p",[a._v("Make sure you fulfilled the "),e("RouterLink",{attrs:{to:"/start/requirements.html"}},[a._v("requirements")]),a._v(" before going any further.")],1),a._v(" "),e("p",[a._v("For an ezPAARSE installation on a "),e("strong",[a._v("Windows")]),a._v(" OS, you will have to use a dockerized container. Please see "),e("RouterLink",{attrs:{to:"/start/install.html#docker-and-compose"}},[a._v("below")]),a._v(".")],1),a._v(" "),e("h2",{attrs:{id:"ezpaarse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse"}},[a._v("#")]),a._v(" ezPAARSE")]),a._v(" "),e("h3",{attrs:{id:"with-source-code"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#with-source-code"}},[a._v("#")]),a._v(" With source code")]),a._v(" "),e("ol",[e("li",[a._v("Clone the repository")])]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" clone https://github.com/ezpaarse-project/ezpaarse\n")])])]),e("ol",{attrs:{start:"2"}},[e("li",[a._v("Open the ezPAARSE directory and get the latest stable version")])]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("cd")]),a._v(" ezpaarse\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" checkout "),e("span",{pre:!0,attrs:{class:"token variable"}},[e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("`")]),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" describe "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--tags")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--abbrev")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("`")])]),a._v("\n")])])]),e("ol",{attrs:{start:"2"}},[e("li",[a._v("Use the command "),e("strong",[a._v("make")]),a._v(" to install.")])]),a._v(" "),e("p",[a._v("This command will check whether your server has all the necessary prerequisites and download all dependencies and resources to enable ezPAARSE to work properly.")]),a._v(" "),e("p",[a._v("If you're planning to use ezPAARSE only from the command line and don't need the web interface, you can set the "),e("code",[a._v("EZPAARSE_NO_WEB_CLIENT")]),a._v(" environment variable to prevent client side dependencies from being installed.")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Full setup")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("make")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Setup without web client")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("EZPAARSE_NO_WEB_CLIENT")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("make")]),a._v("\n")])])]),e("blockquote",[e("p",[a._v("[!NOTE]"),e("br"),a._v("\nThere may be an error saying that it is impossible to connect to mongodb. If there is only this error, it still means that ezPAARSE has been installed correctly, but that no mongoDB is installed.")])]),a._v(" "),e("p",[e("img",{attrs:{src:t(301),alt:"image"}})]),a._v(" "),e("p",[a._v("At the end of the command, you should see this type of result.")]),a._v(" "),e("p",[e("img",{attrs:{src:t(302),alt:"image"}})]),a._v(" "),e("h3",{attrs:{id:"with-docker"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#with-docker"}},[a._v("#")]),a._v(" With docker")]),a._v(" "),e("p",[a._v("ezPAARSE is available as a "),e("a",{attrs:{href:"https://registry.hub.docker.com/r/ezpaarseproject/ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("docker image"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("p",[a._v("To run it with docker, you will need to install "),e("a",{attrs:{href:"https://docs.docker.com/engine/install/",target:"_blank",rel:"noopener noreferrer"}},[a._v("Docker"),e("OutboundLink")],1),a._v(" and "),e("a",{attrs:{href:"https://docs.docker.com/compose/install/",target:"_blank",rel:"noopener noreferrer"}},[a._v("Docker-Compose"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("p",[a._v("Then, you can either grab the "),e("code",[a._v("docker-compose.yml")]),a._v(" file alone:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("mkdir")]),a._v(" ezpaarse/\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("wget")]),a._v(" https://raw.githubusercontent.com/ezpaarse-project/ezpaarse/master/docker-compose.yml\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("test")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" config.local.json "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("||")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{}'")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" config.local.json\n")])])]),e("p",[a._v("or clone the github repository:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" clone https://github.com/ezpaarse-project/ezpaarse.git\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("cd")]),a._v(" ezpaarse\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("test")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-f")]),a._v(" config.local.json "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("||")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v("'{}'")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" config.local.json\n")])])]),e("blockquote",[e("p",[a._v("[!NOTE]"),e("br"),a._v("\nIf you install ezPAARSE with docker compose, there's no need to install mongodb in addition.")])]),a._v(" "),e("h2",{attrs:{id:"mongodb"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mongodb"}},[a._v("#")]),a._v(" MongoDB")]),a._v(" "),e("p",[a._v("ezPAARSE needs a mongodb to work, it can store the admin account, PKBs cache and processing history.\nby default,\nezPAARSE tries to connect to a mongodb which is available on port 27017.")]),a._v(" "),e("blockquote",[e("p",[a._v("[!NOTE]"),e("br"),a._v("\nezPAARSE loads PKBs on mongodb. As of mongodb version 6, this feature is no longer available.")])]),a._v(" "),e("h3",{attrs:{id:"official-packages"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#official-packages"}},[a._v("#")]),a._v(" Official packages")]),a._v(" "),e("p",[a._v("You can install mongodb on your server via "),e("a",{attrs:{href:"https://www.mongodb.com/docs/manual/installation/",target:"_blank",rel:"noopener noreferrer"}},[a._v("official packages"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("h3",{attrs:{id:"docker"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#docker"}},[a._v("#")]),a._v(" Docker")]),a._v(" "),e("p",[a._v("It's easier to install mongodb at the right version with docker.")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Create mongodb image.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# You can use other versions but this may have an impact on PKB.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v(" run "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-p")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("27017")]),a._v(":27017 "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--name")]),a._v(" ezpaarse-db "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-d")]),a._v(" mongo:3.6.23\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Start mongodb.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v(" start ezpaarse-db\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Stop mongodb.")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v(" stop ezpaarse-db\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/26.ce71f6da.js b/assets/js/26.d0fdfd51.js similarity index 95% rename from assets/js/26.ce71f6da.js rename to assets/js/26.d0fdfd51.js index efff3482..c74833da 100644 --- a/assets/js/26.ce71f6da.js +++ b/assets/js/26.d0fdfd51.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{305:function(t,a,e){t.exports=e.p+"assets/img/admin-interface.dfe0d0c7.png"},306:function(t,a,e){t.exports=e.p+"assets/img/process-interface.4838532b.png"},411:function(t,a,e){"use strict";e.r(a);var s=e(10),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"bot-ua-detector"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bot-ua-detector"}},[t._v("#")]),t._v(" bot-ua-detector")]),t._v(" "),a("p",[t._v("Mark ECs as robots if their user-agent string match a regex in the COUNTER "),a("a",{attrs:{href:"https://raw.githubusercontent.com/atmire/COUNTER-Robots/master/generated/COUNTER_Robots_list.txt",target:"_blank",rel:"noopener noreferrer"}},[t._v("robot list"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("robot")]),t._v(" "),a("td",[t._v("boolean")]),t._v(" "),a("td",[t._v("Is robot or not.")])])])]),t._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),a("p",[a("strong",[t._v("You must use bot-ua-detector after filter, parser, deduplicator middleware.")])]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("robot-refresh-timeout")]),t._v(" : Robot refresh time "),a("em",[t._v("(default: 5000ms)")])])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove bot-ua-detector by default to all your enrichments. To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(305),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use bot-ua-detector for an enrichment process.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(306),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("p",[t._v("You can use bot-ua-detector for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),a("OutboundLink")],1),t._v(" like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: bot-ua-detector"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: bot-ua-detector"')]),t._v(" \n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("p",[t._v("You can use bot-ua-detector for an enrichment process with curl like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: bot-ua-detector"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{311:function(t,a,e){t.exports=e.p+"assets/img/admin-interface.dfe0d0c7.png"},312:function(t,a,e){t.exports=e.p+"assets/img/process-interface.4838532b.png"},414:function(t,a,e){"use strict";e.r(a);var s=e(10),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"bot-ua-detector"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bot-ua-detector"}},[t._v("#")]),t._v(" bot-ua-detector")]),t._v(" "),a("p",[t._v("Mark ECs as robots if their user-agent string match a regex in the COUNTER "),a("a",{attrs:{href:"https://raw.githubusercontent.com/atmire/COUNTER-Robots/master/generated/COUNTER_Robots_list.txt",target:"_blank",rel:"noopener noreferrer"}},[t._v("robot list"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("robot")]),t._v(" "),a("td",[t._v("boolean")]),t._v(" "),a("td",[t._v("Is robot or not.")])])])]),t._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),a("p",[a("strong",[t._v("You must use bot-ua-detector after filter, parser, deduplicator middleware.")])]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("robot-refresh-timeout")]),t._v(" : Robot refresh time "),a("em",[t._v("(default: 5000ms)")])])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove bot-ua-detector by default to all your enrichments. To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(311),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use bot-ua-detector for an enrichment process.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(312),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("p",[t._v("You can use bot-ua-detector for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),a("OutboundLink")],1),t._v(" like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: bot-ua-detector"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: bot-ua-detector"')]),t._v(" \n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("p",[t._v("You can use bot-ua-detector for an enrichment process with curl like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: bot-ua-detector"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/27.97322374.js b/assets/js/27.848aaf73.js similarity index 97% rename from assets/js/27.97322374.js rename to assets/js/27.848aaf73.js index 069a6668..12ad4da6 100644 --- a/assets/js/27.97322374.js +++ b/assets/js/27.848aaf73.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{307:function(e,t,r){e.exports=r.p+"assets/img/admin-interface.3eace1ad.png"},308:function(e,t,r){e.exports=r.p+"assets/img/process-interface.dffd82d4.png"},412:function(e,t,r){"use strict";r.r(t);var s=r(10),a=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"crossref"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crossref"}},[e._v("#")]),e._v(" crossref")]),e._v(" "),t("p",[e._v("Fetches "),t("a",{attrs:{href:"http://search.crossref.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("crossref"),t("OutboundLink")],1),e._v(" data from their "),t("a",{attrs:{href:"http://search.crossref.org/help/api",target:"_blank",rel:"noopener noreferrer"}},[e._v("API"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("This middleware is activated by default.")])]),e._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[e._v("#")]),e._v(" Enriched fields")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("publication_title")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Name of publication.")])]),e._v(" "),t("tr",[t("td",[e._v("title")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Title of publication.")])]),e._v(" "),t("tr",[t("td",[e._v("type")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("type of document (journal-article, book-chapter, conference-paper, dissertation, report, dataset etc.)")])]),e._v(" "),t("tr",[t("td",[e._v("rtype")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Variation of type")])]),e._v(" "),t("tr",[t("td",[e._v("publication_date")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Date of resource.")])]),e._v(" "),t("tr",[t("td",[e._v("publisher_name")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Name of publisher.")])]),e._v(" "),t("tr",[t("td",[e._v("print_identifier")]),e._v(" "),t("td",[e._v("Number")]),e._v(" "),t("td",[e._v("ISBN or ISSN.")])]),e._v(" "),t("tr",[t("td",[e._v("online_identifier")]),e._v(" "),t("td",[e._v("Number")]),e._v(" "),t("td",[e._v("EISBN or EISSN.")])]),e._v(" "),t("tr",[t("td",[e._v("subject")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("subject, thematic of publication")])]),e._v(" "),t("tr",[t("td",[e._v("doi")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("DOI of publication.")])]),e._v(" "),t("tr",[t("td",[e._v("license")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Licence.")])])])]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("Your EC needs a DOI or alternative ID (any other identifier a publisher may have provided) for enrichment.")]),e._v(" "),t("p",[t("strong",[e._v("You must use crossref after filter, parser, deduplicator middleware.")])]),e._v(" "),t("h2",{attrs:{id:"recommendation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recommendation"}},[e._v("#")]),e._v(" Recommendation")]),e._v(" "),t("p",[e._v("You can use ezunpaywall with crossreft by placing it in front. This will save you processing time.")]),e._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("crossref-enrich")]),e._v(" : Set to "),t("code",[e._v("false")]),e._v(" to disable crossref enrichment. Enabled by default.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-cache")]),e._v(" : Enable/Disable cache.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-license")]),e._v(" : Set to "),t("code",[e._v("true")]),e._v(" to get the "),t("code",[e._v("license")]),e._v(" field as JSON. Disabled by default.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-ttl")]),e._v(" : Lifetime of cached documents, in seconds. Defaults to "),t("code",[e._v("7 days (3600 * 24 * 7)")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-throttle")]),e._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),t("code",[e._v("200")]),e._v("ms.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-paquet-size")]),e._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),t("code",[e._v("50")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-buffer-size")]),e._v(" : Maximum number of memorised access events before sending a request. Defaults to "),t("code",[e._v("1000")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-max-tries")]),e._v(" : Maximum number of attempts if an enrichment fails. Defaults to "),t("code",[e._v("5")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-on-fail")]),e._v(" : Strategy to adopt if an enrichment reaches the maximum number of attempts. Can be either of "),t("code",[e._v("abort")]),e._v(", "),t("code",[e._v("ignore")]),e._v(" or "),t("code",[e._v("retry")]),e._v(". Defaults to "),t("code",[e._v("abort")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-base-wait-time")]),e._v(" : Time to wait before retrying after a query fails, in milliseconds. Defaults to "),t("code",[e._v("1000")]),e._v("ms. This time "),t("code",[e._v("doubles")]),e._v(" after each attempt.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-plus-api-token")]),e._v(" : If you signed up for the "),t("code",[e._v("Plus")]),e._v(" service, put your token in this header.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-user-agent")]),e._v(" : Specify what to send in the "),t("code",[e._v("User-Agent")]),e._v(" header when querying Crossref. Defaults to "),t("code",[e._v("ezPAARSE (https://readmetrics.org; mailto:ezteam@couperin.org)")]),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),t("p",[e._v("You can add crossref by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),t("p",[t("img",{attrs:{src:r(307),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),t("p",[e._v("You can use crossref for an enrichment process. You just add the middleware.")]),e._v(" "),t("p",[t("img",{attrs:{src:r(308),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),t("p",[e._v("You can use crossref for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),t("OutboundLink")],1),e._v(" like this:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: crossref"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: crossref"')]),e._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),t("p",[e._v("You can use crossref for an enrichment process with curl like this:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: crossref"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{305:function(e,t,r){e.exports=r.p+"assets/img/admin-interface.3eace1ad.png"},306:function(e,t,r){e.exports=r.p+"assets/img/process-interface.dffd82d4.png"},411:function(e,t,r){"use strict";r.r(t);var s=r(10),a=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"crossref"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crossref"}},[e._v("#")]),e._v(" crossref")]),e._v(" "),t("p",[e._v("Fetches "),t("a",{attrs:{href:"http://search.crossref.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("crossref"),t("OutboundLink")],1),e._v(" data from their "),t("a",{attrs:{href:"http://search.crossref.org/help/api",target:"_blank",rel:"noopener noreferrer"}},[e._v("API"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("This middleware is activated by default.")])]),e._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[e._v("#")]),e._v(" Enriched fields")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("publication_title")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Name of publication.")])]),e._v(" "),t("tr",[t("td",[e._v("title")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Title of publication.")])]),e._v(" "),t("tr",[t("td",[e._v("type")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("type of document (journal-article, book-chapter, conference-paper, dissertation, report, dataset etc.)")])]),e._v(" "),t("tr",[t("td",[e._v("rtype")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Variation of type")])]),e._v(" "),t("tr",[t("td",[e._v("publication_date")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Date of resource.")])]),e._v(" "),t("tr",[t("td",[e._v("publisher_name")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Name of publisher.")])]),e._v(" "),t("tr",[t("td",[e._v("print_identifier")]),e._v(" "),t("td",[e._v("Number")]),e._v(" "),t("td",[e._v("ISBN or ISSN.")])]),e._v(" "),t("tr",[t("td",[e._v("online_identifier")]),e._v(" "),t("td",[e._v("Number")]),e._v(" "),t("td",[e._v("EISBN or EISSN.")])]),e._v(" "),t("tr",[t("td",[e._v("subject")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("subject, thematic of publication")])]),e._v(" "),t("tr",[t("td",[e._v("doi")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("DOI of publication.")])]),e._v(" "),t("tr",[t("td",[e._v("license")]),e._v(" "),t("td",[e._v("String")]),e._v(" "),t("td",[e._v("Licence.")])])])]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("Your EC needs a DOI or alternative ID (any other identifier a publisher may have provided) for enrichment.")]),e._v(" "),t("p",[t("strong",[e._v("You must use crossref after filter, parser, deduplicator middleware.")])]),e._v(" "),t("h2",{attrs:{id:"recommendation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recommendation"}},[e._v("#")]),e._v(" Recommendation")]),e._v(" "),t("p",[e._v("You can use ezunpaywall with crossreft by placing it in front. This will save you processing time.")]),e._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("crossref-enrich")]),e._v(" : Set to "),t("code",[e._v("false")]),e._v(" to disable crossref enrichment. Enabled by default.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-cache")]),e._v(" : Enable/Disable cache.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-license")]),e._v(" : Set to "),t("code",[e._v("true")]),e._v(" to get the "),t("code",[e._v("license")]),e._v(" field as JSON. Disabled by default.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-ttl")]),e._v(" : Lifetime of cached documents, in seconds. Defaults to "),t("code",[e._v("7 days (3600 * 24 * 7)")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-throttle")]),e._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),t("code",[e._v("200")]),e._v("ms.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-paquet-size")]),e._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),t("code",[e._v("50")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-buffer-size")]),e._v(" : Maximum number of memorised access events before sending a request. Defaults to "),t("code",[e._v("1000")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-max-tries")]),e._v(" : Maximum number of attempts if an enrichment fails. Defaults to "),t("code",[e._v("5")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-on-fail")]),e._v(" : Strategy to adopt if an enrichment reaches the maximum number of attempts. Can be either of "),t("code",[e._v("abort")]),e._v(", "),t("code",[e._v("ignore")]),e._v(" or "),t("code",[e._v("retry")]),e._v(". Defaults to "),t("code",[e._v("abort")]),e._v(".")]),e._v(" "),t("li",[t("strong",[e._v("crossref-base-wait-time")]),e._v(" : Time to wait before retrying after a query fails, in milliseconds. Defaults to "),t("code",[e._v("1000")]),e._v("ms. This time "),t("code",[e._v("doubles")]),e._v(" after each attempt.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-plus-api-token")]),e._v(" : If you signed up for the "),t("code",[e._v("Plus")]),e._v(" service, put your token in this header.")]),e._v(" "),t("li",[t("strong",[e._v("crossref-user-agent")]),e._v(" : Specify what to send in the "),t("code",[e._v("User-Agent")]),e._v(" header when querying Crossref. Defaults to "),t("code",[e._v("ezPAARSE (https://readmetrics.org; mailto:ezteam@couperin.org)")]),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),t("p",[e._v("You can add crossref by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),t("p",[t("img",{attrs:{src:r(305),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),t("p",[e._v("You can use crossref for an enrichment process. You just add the middleware.")]),e._v(" "),t("p",[t("img",{attrs:{src:r(306),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),t("p",[e._v("You can use crossref for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),t("OutboundLink")],1),e._v(" like this:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: crossref"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: crossref"')]),e._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),t("p",[e._v("You can use crossref for an enrichment process with curl like this:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: crossref"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/28.276432b9.js b/assets/js/28.63fc1787.js similarity index 97% rename from assets/js/28.276432b9.js rename to assets/js/28.63fc1787.js index 4834bbd3..37d8a111 100644 --- a/assets/js/28.276432b9.js +++ b/assets/js/28.63fc1787.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{309:function(t,a,s){t.exports=s.p+"assets/img/admin-interface.c1d5eba9.png"},310:function(t,a,s){t.exports=s.p+"assets/img/process-interface.12eeba02.png"},413:function(t,a,s){"use strict";s.r(a);var e=s(10),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"cut"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cut"}},[t._v("#")]),t._v(" cut")]),t._v(" "),a("p",[t._v("Separates any unique field into two or more distinct fields, based on a given separator or regular expression.")]),t._v(" "),a("p",[a("strong",[t._v("This middleware is activated by default.")]),t._v("\nNo config is set by default.")]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("destinationFields")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("custom fields")])])])]),t._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),a("p",[t._v("Your EC needs sourceField that exist.")]),t._v(" "),a("p",[a("strong",[t._v("You must use cut after filter, parser, deduplicator middleware.")])]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("extract")]),t._v(" : This header takes 3 parameters which are "),a("code",[t._v("sourceField")]),t._v(", "),a("code",[t._v("expression")]),t._v(" and "),a("code",[t._v("destinationFields")]),t._v(", e.g: "),a("code",[t._v("sourceField=>expression=>destinationFields")])])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove cut by default to all your enrichments. To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:s(309),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use cut for an enrichment process.")]),t._v(" "),a("p",[a("img",{attrs:{src:s(310),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("p",[t._v("You can use cut for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),a("OutboundLink")],1),t._v(" like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with split function")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: email => split(@) => identifiant,domainName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: email => split(@) => identifiant,domainName"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with regex")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: login => /^([a-z]+)\\.([a-z]+)$/ => lastName,firstName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: login => /^([a-z]+)\\.([a-z]+)$/ => lastName,firstName"')]),t._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("p",[t._v("You can use cut for an enrichment process with curl like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with split function")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: email => split(@) => identifiant,domainName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with regex")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: login => /^([a-z]+)\\.([a-z]+)$/ => lastName,firstName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{307:function(t,a,s){t.exports=s.p+"assets/img/admin-interface.c1d5eba9.png"},308:function(t,a,s){t.exports=s.p+"assets/img/process-interface.12eeba02.png"},412:function(t,a,s){"use strict";s.r(a);var e=s(10),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"cut"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cut"}},[t._v("#")]),t._v(" cut")]),t._v(" "),a("p",[t._v("Separates any unique field into two or more distinct fields, based on a given separator or regular expression.")]),t._v(" "),a("p",[a("strong",[t._v("This middleware is activated by default.")]),t._v("\nNo config is set by default.")]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("destinationFields")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("custom fields")])])])]),t._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),a("p",[t._v("Your EC needs sourceField that exist.")]),t._v(" "),a("p",[a("strong",[t._v("You must use cut after filter, parser, deduplicator middleware.")])]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("extract")]),t._v(" : This header takes 3 parameters which are "),a("code",[t._v("sourceField")]),t._v(", "),a("code",[t._v("expression")]),t._v(" and "),a("code",[t._v("destinationFields")]),t._v(", e.g: "),a("code",[t._v("sourceField=>expression=>destinationFields")])])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove cut by default to all your enrichments. To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:s(307),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use cut for an enrichment process.")]),t._v(" "),a("p",[a("img",{attrs:{src:s(308),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("p",[t._v("You can use cut for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),a("OutboundLink")],1),t._v(" like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with split function")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: email => split(@) => identifiant,domainName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: email => split(@) => identifiant,domainName"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with regex")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: login => /^([a-z]+)\\.([a-z]+)$/ => lastName,firstName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: login => /^([a-z]+)\\.([a-z]+)$/ => lastName,firstName"')]),t._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("p",[t._v("You can use cut for an enrichment process with curl like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with split function")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: email => split(@) => identifiant,domainName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Use with regex")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: cut"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"extract: login => /^([a-z]+)\\.([a-z]+)$/ => lastName,firstName"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/29.34fd85a8.js b/assets/js/29.4fe31c6f.js similarity index 95% rename from assets/js/29.34fd85a8.js rename to assets/js/29.4fe31c6f.js index 6f1be750..6410b089 100644 --- a/assets/js/29.34fd85a8.js +++ b/assets/js/29.4fe31c6f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{313:function(t,a,e){t.exports=e.p+"assets/img/admin-interface.a54672bf.png"},314:function(t,a,e){t.exports=e.p+"assets/img/process-interface.0cfe332b.png"},415:function(t,a,e){"use strict";e.r(a);var s=e(10),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"datacite"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#datacite"}},[t._v("#")]),t._v(" datacite")]),t._v(" "),a("p",[t._v("Fetches metadata from the API "),a("a",{attrs:{href:"https://datacite.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("datacite"),a("OutboundLink")],1)]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("publication_title")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("Name of publication.")])]),t._v(" "),a("tr",[a("td",[t._v("publication_date")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("Date of publication.")])]),t._v(" "),a("tr",[a("td",[t._v("publisher_name")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("Name of publisher.")])])])]),t._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),a("p",[t._v("Your EC needs a DOI for enrichment.")]),t._v(" "),a("p",[a("strong",[t._v("You must use datacite after filter, parser, deduplicator middleware.")])]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("datacite-cache")]),t._v(" : Enable/Disable cache.")]),t._v(" "),a("li",[a("strong",[t._v("datacite-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("datacite-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[t._v("100")]),t._v("ms.")]),t._v(" "),a("li",[a("strong",[t._v("datacite-paquet-size")]),t._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),a("code",[t._v("50")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("datacite-buffer-size")]),t._v(" : Maximum number of memorised access events before sending a request. Defaults to "),a("code",[t._v("1000")]),t._v(".")])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove datacite by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(313),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use datacite for an enrichment process. You just add the middleware.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(314),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: datacite"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: datacite"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: datacite"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{309:function(t,a,e){t.exports=e.p+"assets/img/admin-interface.a54672bf.png"},310:function(t,a,e){t.exports=e.p+"assets/img/process-interface.0cfe332b.png"},413:function(t,a,e){"use strict";e.r(a);var s=e(10),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"datacite"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#datacite"}},[t._v("#")]),t._v(" datacite")]),t._v(" "),a("p",[t._v("Fetches metadata from the API "),a("a",{attrs:{href:"https://datacite.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("datacite"),a("OutboundLink")],1)]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("publication_title")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("Name of publication.")])]),t._v(" "),a("tr",[a("td",[t._v("publication_date")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("Date of publication.")])]),t._v(" "),a("tr",[a("td",[t._v("publisher_name")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td",[t._v("Name of publisher.")])])])]),t._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),a("p",[t._v("Your EC needs a DOI for enrichment.")]),t._v(" "),a("p",[a("strong",[t._v("You must use datacite after filter, parser, deduplicator middleware.")])]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("datacite-cache")]),t._v(" : Enable/Disable cache.")]),t._v(" "),a("li",[a("strong",[t._v("datacite-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("datacite-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[t._v("100")]),t._v("ms.")]),t._v(" "),a("li",[a("strong",[t._v("datacite-paquet-size")]),t._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),a("code",[t._v("50")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("datacite-buffer-size")]),t._v(" : Maximum number of memorised access events before sending a request. Defaults to "),a("code",[t._v("1000")]),t._v(".")])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove datacite by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(309),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use datacite for an enrichment process. You just add the middleware.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(310),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: datacite"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: datacite"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: datacite"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/30.f3081c1d.js b/assets/js/30.a80afc28.js similarity index 96% rename from assets/js/30.f3081c1d.js rename to assets/js/30.a80afc28.js index fc998aa4..c49e8665 100644 --- a/assets/js/30.f3081c1d.js +++ b/assets/js/30.a80afc28.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{315:function(e,t,s){e.exports=s.p+"assets/img/admin-interface.2a603d21.png"},316:function(e,t,s){e.exports=s.p+"assets/img/process-interface.b2b5a498.png"},416:function(e,t,s){"use strict";s.r(t);var a=s(10),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"deduplicator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deduplicator"}},[e._v("#")]),e._v(" deduplicator")]),e._v(" "),t("p",[e._v("Removes duplicate consultation events, based on the COUNTER algorithm for double-clicks.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://ezpaarse-project.github.io/ezpaarse/features/doubleclick.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("See this"),t("OutboundLink")],1),e._v(" for more details.")]),e._v(" "),t("p",[t("strong",[e._v("This middleware is activated by default.")])]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[t("strong",[e._v("You must use deduplicator after filter middleware.")])]),e._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Double-Click-Removal")]),e._v(": COUNTER deduplication activated (true by default). If this header is used, it means the deduplication is not activated (with the false value) and the other Double-Click- headers are useless.")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-HTML")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to an HTML resource (10 by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-PDF")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to a PDF resource (30 by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-MISC")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to a MISC resource (neither HTML, nor PDF) (20 by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-MIXED")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to a resource, whatever its format (ie. the access to a same resource in HTML then in PDF can be considered as a double-click). The delays set for each format are then ignored.")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-Strategy")]),e._v(": the strategy (in the form of a sequence of ordered letters) used to define the uniqueness of the user accessing a resource. The fields are searched sequentially. If one field is lacking, the following one is used. The letter C corresponds to the field containing the cookie (or session ID). The letter L corresponds to the login of the user. The letter I corresponds to the IP address contained in the host field. (CLI by default)\n"),t("ul",[t("li",[t("strong",[e._v("Double-Click-C-field")]),e._v(": field name that will be looked for in the logs. This field coming from the custom log format parameters will be used to trace the cookie identifying the user (or its session ID). By default, it is not possible for ezPAARSE to know the field if it's not specified in the custom log format parameter. (ignored by default)")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-L-field")]),e._v(": field name that will be looked for in the logs to identify the user login (corresponds to %u in the log format syntax). (%u by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-I-field")]),e._v(": field name that will be looked for in the logs to identify the user host (corresponds to %h in the log format syntax). (%h by default).")])])])]),e._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),t("p",[e._v("You can add or remove deduplicator by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),t("p",[t("img",{attrs:{src:s(315),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),t("p",[e._v("You can use deduplicator for an enrichment process. You just add the middleware.")]),e._v(" "),t("p",[t("img",{attrs:{src:s(316),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: deduplicator"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: deduplicator"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: deduplicator"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{313:function(e,t,s){e.exports=s.p+"assets/img/admin-interface.2a603d21.png"},314:function(e,t,s){e.exports=s.p+"assets/img/process-interface.b2b5a498.png"},415:function(e,t,s){"use strict";s.r(t);var a=s(10),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"deduplicator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deduplicator"}},[e._v("#")]),e._v(" deduplicator")]),e._v(" "),t("p",[e._v("Removes duplicate consultation events, based on the COUNTER algorithm for double-clicks.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://ezpaarse-project.github.io/ezpaarse/features/doubleclick.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("See this"),t("OutboundLink")],1),e._v(" for more details.")]),e._v(" "),t("p",[t("strong",[e._v("This middleware is activated by default.")])]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[t("strong",[e._v("You must use deduplicator after filter middleware.")])]),e._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Double-Click-Removal")]),e._v(": COUNTER deduplication activated (true by default). If this header is used, it means the deduplication is not activated (with the false value) and the other Double-Click- headers are useless.")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-HTML")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to an HTML resource (10 by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-PDF")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to a PDF resource (30 by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-MISC")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to a MISC resource (neither HTML, nor PDF) (20 by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-MIXED")]),e._v(": sets the minimum delay (in seconds) between two requests considered identical to a resource, whatever its format (ie. the access to a same resource in HTML then in PDF can be considered as a double-click). The delays set for each format are then ignored.")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-Strategy")]),e._v(": the strategy (in the form of a sequence of ordered letters) used to define the uniqueness of the user accessing a resource. The fields are searched sequentially. If one field is lacking, the following one is used. The letter C corresponds to the field containing the cookie (or session ID). The letter L corresponds to the login of the user. The letter I corresponds to the IP address contained in the host field. (CLI by default)\n"),t("ul",[t("li",[t("strong",[e._v("Double-Click-C-field")]),e._v(": field name that will be looked for in the logs. This field coming from the custom log format parameters will be used to trace the cookie identifying the user (or its session ID). By default, it is not possible for ezPAARSE to know the field if it's not specified in the custom log format parameter. (ignored by default)")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-L-field")]),e._v(": field name that will be looked for in the logs to identify the user login (corresponds to %u in the log format syntax). (%u by default).")]),e._v(" "),t("li",[t("strong",[e._v("Double-Click-I-field")]),e._v(": field name that will be looked for in the logs to identify the user host (corresponds to %h in the log format syntax). (%h by default).")])])])]),e._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),t("p",[e._v("You can add or remove deduplicator by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),t("p",[t("img",{attrs:{src:s(313),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),t("p",[e._v("You can use deduplicator for an enrichment process. You just add the middleware.")]),e._v(" "),t("p",[t("img",{attrs:{src:s(314),alt:"image"}})]),e._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: deduplicator"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: deduplicator"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: deduplicator"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/31.30fc0b1b.js b/assets/js/31.3e90b977.js similarity index 95% rename from assets/js/31.30fc0b1b.js rename to assets/js/31.3e90b977.js index caa69c20..09c2a912 100644 --- a/assets/js/31.30fc0b1b.js +++ b/assets/js/31.3e90b977.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{311:function(t,e,s){t.exports=s.p+"assets/img/admin-interface.a943c5a2.png"},312:function(t,e,s){t.exports=s.p+"assets/img/process-interface.ccd98d0e.png"},414:function(t,e,s){"use strict";s.r(e);var a=s(10),r=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"ebscohost"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ebscohost"}},[t._v("#")]),t._v(" ebscohost")]),t._v(" "),e("p",[t._v("Assign titles in the official "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/ebscohost/list.json",target:"_blank",rel:"noopener noreferrer"}},[t._v("short names list"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("db_title")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Title of database.")])])])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[t._v("Your EC needs a print_identifier for enrichment.")]),t._v(" "),e("p",[e("strong",[t._v("You must use ebscohost after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("ebscohost-enrich")]),t._v(" : Set to "),e("code",[t._v("false")]),t._v(" to disable ebscohost enrichment. Enabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("ebscohost-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("ebscohost-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[t._v("200")]),t._v("ms.")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add ebscohost by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:s(311),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use ebscohost for an enrichment process. You just add the middleware.")]),t._v(" "),e("p",[e("img",{attrs:{src:s(312),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use ebscohost for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: ebscohost"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: ebscohost"')]),t._v(" \n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use ebscohost for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: ebscohost"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{315:function(t,e,s){t.exports=s.p+"assets/img/admin-interface.a943c5a2.png"},316:function(t,e,s){t.exports=s.p+"assets/img/process-interface.ccd98d0e.png"},416:function(t,e,s){"use strict";s.r(e);var a=s(10),r=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"ebscohost"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ebscohost"}},[t._v("#")]),t._v(" ebscohost")]),t._v(" "),e("p",[t._v("Assign titles in the official "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/ebscohost/list.json",target:"_blank",rel:"noopener noreferrer"}},[t._v("short names list"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("db_title")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Title of database.")])])])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[t._v("Your EC needs a print_identifier for enrichment.")]),t._v(" "),e("p",[e("strong",[t._v("You must use ebscohost after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("ebscohost-enrich")]),t._v(" : Set to "),e("code",[t._v("false")]),t._v(" to disable ebscohost enrichment. Enabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("ebscohost-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("ebscohost-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[t._v("200")]),t._v("ms.")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add ebscohost by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:s(315),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use ebscohost for an enrichment process. You just add the middleware.")]),t._v(" "),e("p",[e("img",{attrs:{src:s(316),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use ebscohost for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: ebscohost"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: ebscohost"')]),t._v(" \n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use ebscohost for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: ebscohost"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/33.2cee94c5.js b/assets/js/33.f2c5ec41.js similarity index 96% rename from assets/js/33.2cee94c5.js rename to assets/js/33.f2c5ec41.js index 52bbf356..2979bec0 100644 --- a/assets/js/33.2cee94c5.js +++ b/assets/js/33.f2c5ec41.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{321:function(t,e,a){t.exports=a.p+"assets/img/admin-interface.4c41600f.png"},322:function(t,e,a){t.exports=a.p+"assets/img/process-interface.1940b849.png"},419:function(t,e,a){"use strict";a.r(e);var s=a(10),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"eprints"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#eprints"}},[t._v("#")]),t._v(" eprints")]),t._v(" "),e("p",[t._v("Fetches data from eprints platforms.\nThis middleware was designed to measure only the logs of eprint platforms.")]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("publication_title")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Name of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("publication_date")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Date of resource.")])]),t._v(" "),e("tr",[e("td",[t._v("doi")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("DOI of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("publisher_name")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Name of publisher")])]),t._v(" "),e("tr",[e("td",[t._v("language")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("language of resource")])])])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[t._v("This middleware can only be used to enrich one eprints platform per process.\nYour EC needs a domain belonging to an eprint platform and a eprints ID.")]),t._v(" "),e("p",[e("strong",[t._v("You must use eprints after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("eprints-cache")]),t._v(" : Enabled/Disabled cache")]),t._v(" "),e("li",[e("strong",[t._v("eprints-ttl")]),t._v(" : Time-to-live of cached documents")]),t._v(" "),e("li",[e("strong",[t._v("eprints-throttle")]),t._v(" : Minimum wait time before each request (in ms)")]),t._v(" "),e("li",[e("strong",[t._v("eprints-packet-size")]),t._v(" : Maximum number of article to query")]),t._v(" "),e("li",[e("strong",[t._v("eprints-buffer-size")]),t._v(" : Minimum number of ECs to keep before resolving them")]),t._v(" "),e("li",[e("strong",[t._v("eprints-domain-name")]),t._v(" : Domain name eprints platform")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add eprints by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(321),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use eprints for an enrichment process. You just add the middleware.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(322),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use eprints for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: eprints"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eprints-domain-name: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: eprints"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eprints-domain-name: "')]),t._v("\n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use eprints for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: eprints"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eprints-domain-name: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{319:function(t,e,a){t.exports=a.p+"assets/img/admin-interface.4c41600f.png"},320:function(t,e,a){t.exports=a.p+"assets/img/process-interface.1940b849.png"},418:function(t,e,a){"use strict";a.r(e);var s=a(10),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"eprints"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#eprints"}},[t._v("#")]),t._v(" eprints")]),t._v(" "),e("p",[t._v("Fetches data from eprints platforms.\nThis middleware was designed to measure only the logs of eprint platforms.")]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("publication_title")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Name of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("publication_date")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Date of resource.")])]),t._v(" "),e("tr",[e("td",[t._v("doi")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("DOI of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("publisher_name")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Name of publisher")])]),t._v(" "),e("tr",[e("td",[t._v("language")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("language of resource")])])])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[t._v("This middleware can only be used to enrich one eprints platform per process.\nYour EC needs a domain belonging to an eprint platform and a eprints ID.")]),t._v(" "),e("p",[e("strong",[t._v("You must use eprints after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("eprints-cache")]),t._v(" : Enabled/Disabled cache")]),t._v(" "),e("li",[e("strong",[t._v("eprints-ttl")]),t._v(" : Time-to-live of cached documents")]),t._v(" "),e("li",[e("strong",[t._v("eprints-throttle")]),t._v(" : Minimum wait time before each request (in ms)")]),t._v(" "),e("li",[e("strong",[t._v("eprints-packet-size")]),t._v(" : Maximum number of article to query")]),t._v(" "),e("li",[e("strong",[t._v("eprints-buffer-size")]),t._v(" : Minimum number of ECs to keep before resolving them")]),t._v(" "),e("li",[e("strong",[t._v("eprints-domain-name")]),t._v(" : Domain name eprints platform")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add eprints by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(319),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use eprints for an enrichment process. You just add the middleware.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(320),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use eprints for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: eprints"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eprints-domain-name: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: eprints"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eprints-domain-name: "')]),t._v("\n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use eprints for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: eprints"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eprints-domain-name: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/34.9e3fb16d.js b/assets/js/34.7054c336.js similarity index 97% rename from assets/js/34.9e3fb16d.js rename to assets/js/34.7054c336.js index e784017f..b5b70cc1 100644 --- a/assets/js/34.9e3fb16d.js +++ b/assets/js/34.7054c336.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{319:function(a,e,t){a.exports=t.p+"assets/img/admin-interface.e0367797.png"},320:function(a,e,t){a.exports=t.p+"assets/img/process-interface.3606ba97.png"},418:function(a,e,t){"use strict";t.r(e);var s=t(10),r=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"ezunpaywall"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezunpaywall"}},[a._v("#")]),a._v(" ezunpaywall")]),a._v(" "),e("p",[a._v("Fetches "),e("a",{attrs:{href:"https://www.unpaywall.org/",target:"_blank",rel:"noopener noreferrer"}},[a._v("unpaywall"),e("OutboundLink")],1),a._v(" metadata from "),e("a",{attrs:{href:"https://unpaywall.inist.fr/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezunpaywall"),e("OutboundLink")],1),a._v(", the Unpaywall mirror hosted by the Inist-CNRS. this data are uses to enrich EC.")]),a._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),e("table",[e("thead",[e("tr",[e("th",[a._v("Name")]),a._v(" "),e("th",[a._v("Type")]),a._v(" "),e("th",[a._v("Description")])])]),a._v(" "),e("tbody",[e("tr",[e("td",[a._v("publication_title")]),a._v(" "),e("td",[a._v("String")]),a._v(" "),e("td",[a._v("Name of publication.")])]),a._v(" "),e("tr",[e("td",[a._v("is_oa")]),a._v(" "),e("td",[a._v("Boolean")]),a._v(" "),e("td",[a._v("Is there an OA copy of this resource.")])]),a._v(" "),e("tr",[e("td",[a._v("journal_is_in_doaj")]),a._v(" "),e("td",[a._v("Boolean")]),a._v(" "),e("td",[a._v("Is this resource published in a DOAJ-indexed journal.")])]),a._v(" "),e("tr",[e("td",[a._v("journal_is_oa")]),a._v(" "),e("td",[a._v("Boolean")]),a._v(" "),e("td",[a._v("Is this resource published in a completely OA journal.")])]),a._v(" "),e("tr",[e("td",[a._v("oa_status")]),a._v(" "),e("td",[a._v("String")]),a._v(" "),e("td",[a._v("The OA status, or color, of this resource.")])]),a._v(" "),e("tr",[e("td",[a._v("updated")]),a._v(" "),e("td",[a._v("String")]),a._v(" "),e("td",[a._v("Time when the data for this resource was last updated.")])]),a._v(" "),e("tr",[e("td",[a._v("oa_request_date")]),a._v(" "),e("td",[a._v("Date")]),a._v(" "),e("td",[a._v("Date of open access information.")])])])]),a._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[a._v("#")]),a._v(" Prerequisites")]),a._v(" "),e("p",[a._v("Your EC needs a DOI for enrichment.\nYou need an API key to use this service. You can use the "),e("strong",[a._v("demo")]),a._v(" apikey but it's limited to "),e("strong",[a._v("100 000")]),a._v(" DOIs per day for everyone.\n"),e("strong",[a._v("Open access information is valid for EC generated on the same day")]),a._v(". Unpaywall data does not retain open access history.")]),a._v(" "),e("p",[e("strong",[a._v("You must use ezunpaywall after filter, parser, deduplicator middleware.")])]),a._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[a._v("#")]),a._v(" Headers")]),a._v(" "),e("ul",[e("li",[e("strong",[a._v("ezunpaywall-cache")]),a._v(" : Enable/Disable cache.")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-ttl")]),a._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[a._v("7 days (3600 * 24 * 7)")]),a._v(".")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-throttle")]),a._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[a._v("100")]),a._v("ms.")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-paquet-size")]),a._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),e("code",[a._v("100")]),a._v(".")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-buffer-size")]),a._v(" : Maximum number of memorised access events before sending a request. Defaults to "),e("code",[a._v("1000")]),a._v(".")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-api-key")]),a._v(" : apikey to use ezunpaywall.")])]),a._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),e("h3",{attrs:{id:"ezpaarse-config"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-config"}},[a._v("#")]),a._v(" ezPAARSE config")]),a._v(" "),e("p",[a._v("You can add or remove your ezunpaywall on ezpaarse config. It will be used on every process that used ezunpaywall middleware. You need to add this code on your "),e("code",[a._v("config.local.json")]),a._v(".")]),a._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[a._v('"EZPAARSE_DEFAULT_HEADERS"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[a._v('"ezunpaywall-api-key"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('""')]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),e("p",[a._v("You can add or remove ezunpaywall by default to all your enrichments, provided you have added an API key in the config. To do this, go to the middleware section of administration.")]),a._v(" "),e("p",[e("img",{attrs:{src:t(319),alt:"image"}})]),a._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),e("p",[a._v("You can use ezunpaywall for an enrichment process. You just add the middleware and enter the API key.")]),a._v(" "),e("p",[e("img",{attrs:{src:t(320),alt:"image"}})]),a._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),e("p",[a._v("You can use ezunpaywall for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),e("OutboundLink")],1),a._v(" like this:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: ezunpaywall"')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezunpaywall-api-key: "')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: ezunpaywall"')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezunpaywall-api-key: "')]),a._v("\n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),e("p",[a._v("You can use ezunpaywall for an enrichment process with curl like this:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: ezunpaywall"')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezunpaywall-api-key: "')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{321:function(a,e,t){a.exports=t.p+"assets/img/admin-interface.e0367797.png"},322:function(a,e,t){a.exports=t.p+"assets/img/process-interface.3606ba97.png"},419:function(a,e,t){"use strict";t.r(e);var s=t(10),r=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"ezunpaywall"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezunpaywall"}},[a._v("#")]),a._v(" ezunpaywall")]),a._v(" "),e("p",[a._v("Fetches "),e("a",{attrs:{href:"https://www.unpaywall.org/",target:"_blank",rel:"noopener noreferrer"}},[a._v("unpaywall"),e("OutboundLink")],1),a._v(" metadata from "),e("a",{attrs:{href:"https://unpaywall.inist.fr/",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezunpaywall"),e("OutboundLink")],1),a._v(", the Unpaywall mirror hosted by the Inist-CNRS. this data are uses to enrich EC.")]),a._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),e("table",[e("thead",[e("tr",[e("th",[a._v("Name")]),a._v(" "),e("th",[a._v("Type")]),a._v(" "),e("th",[a._v("Description")])])]),a._v(" "),e("tbody",[e("tr",[e("td",[a._v("publication_title")]),a._v(" "),e("td",[a._v("String")]),a._v(" "),e("td",[a._v("Name of publication.")])]),a._v(" "),e("tr",[e("td",[a._v("is_oa")]),a._v(" "),e("td",[a._v("Boolean")]),a._v(" "),e("td",[a._v("Is there an OA copy of this resource.")])]),a._v(" "),e("tr",[e("td",[a._v("journal_is_in_doaj")]),a._v(" "),e("td",[a._v("Boolean")]),a._v(" "),e("td",[a._v("Is this resource published in a DOAJ-indexed journal.")])]),a._v(" "),e("tr",[e("td",[a._v("journal_is_oa")]),a._v(" "),e("td",[a._v("Boolean")]),a._v(" "),e("td",[a._v("Is this resource published in a completely OA journal.")])]),a._v(" "),e("tr",[e("td",[a._v("oa_status")]),a._v(" "),e("td",[a._v("String")]),a._v(" "),e("td",[a._v("The OA status, or color, of this resource.")])]),a._v(" "),e("tr",[e("td",[a._v("updated")]),a._v(" "),e("td",[a._v("String")]),a._v(" "),e("td",[a._v("Time when the data for this resource was last updated.")])]),a._v(" "),e("tr",[e("td",[a._v("oa_request_date")]),a._v(" "),e("td",[a._v("Date")]),a._v(" "),e("td",[a._v("Date of open access information.")])])])]),a._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[a._v("#")]),a._v(" Prerequisites")]),a._v(" "),e("p",[a._v("Your EC needs a DOI for enrichment.\nYou need an API key to use this service. You can use the "),e("strong",[a._v("demo")]),a._v(" apikey but it's limited to "),e("strong",[a._v("100 000")]),a._v(" DOIs per day for everyone.\n"),e("strong",[a._v("Open access information is valid for EC generated on the same day")]),a._v(". Unpaywall data does not retain open access history.")]),a._v(" "),e("p",[e("strong",[a._v("You must use ezunpaywall after filter, parser, deduplicator middleware.")])]),a._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[a._v("#")]),a._v(" Headers")]),a._v(" "),e("ul",[e("li",[e("strong",[a._v("ezunpaywall-cache")]),a._v(" : Enable/Disable cache.")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-ttl")]),a._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[a._v("7 days (3600 * 24 * 7)")]),a._v(".")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-throttle")]),a._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[a._v("100")]),a._v("ms.")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-paquet-size")]),a._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),e("code",[a._v("100")]),a._v(".")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-buffer-size")]),a._v(" : Maximum number of memorised access events before sending a request. Defaults to "),e("code",[a._v("1000")]),a._v(".")]),a._v(" "),e("li",[e("strong",[a._v("ezunpaywall-api-key")]),a._v(" : apikey to use ezunpaywall.")])]),a._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),e("h3",{attrs:{id:"ezpaarse-config"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-config"}},[a._v("#")]),a._v(" ezPAARSE config")]),a._v(" "),e("p",[a._v("You can add or remove your ezunpaywall on ezpaarse config. It will be used on every process that used ezunpaywall middleware. You need to add this code on your "),e("code",[a._v("config.local.json")]),a._v(".")]),a._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[a._v('"EZPAARSE_DEFAULT_HEADERS"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[a._v('"ezunpaywall-api-key"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('""')]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),e("p",[a._v("You can add or remove ezunpaywall by default to all your enrichments, provided you have added an API key in the config. To do this, go to the middleware section of administration.")]),a._v(" "),e("p",[e("img",{attrs:{src:t(321),alt:"image"}})]),a._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),e("p",[a._v("You can use ezunpaywall for an enrichment process. You just add the middleware and enter the API key.")]),a._v(" "),e("p",[e("img",{attrs:{src:t(322),alt:"image"}})]),a._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),e("p",[a._v("You can use ezunpaywall for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),e("OutboundLink")],1),a._v(" like this:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: ezunpaywall"')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezunpaywall-api-key: "')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: ezunpaywall"')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezunpaywall-api-key: "')]),a._v("\n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),e("p",[a._v("You can use ezunpaywall for an enrichment process with curl like this:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: ezunpaywall"')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezunpaywall-api-key: "')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/36.5f487fa4.js b/assets/js/36.794a1d81.js similarity index 97% rename from assets/js/36.5f487fa4.js rename to assets/js/36.794a1d81.js index c5ef7815..941c67ee 100644 --- a/assets/js/36.5f487fa4.js +++ b/assets/js/36.794a1d81.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{325:function(a,t,e){a.exports=e.p+"assets/img/admin-interface.21598165.png"},326:function(a,t,e){a.exports=e.p+"assets/img/process-interface.83c903d3.png"},422:function(a,t,e){"use strict";e.r(t);var s=e(10),r=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"geocalizer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#geocalizer"}},[a._v("#")]),a._v(" geocalizer")]),a._v(" "),t("p",[a._v("Geolocalize consultation events based on an IP address.")]),a._v(" "),t("p",[t("strong",[a._v("This middleware is activated by default.")])]),a._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",[a._v("Name")]),a._v(" "),t("th",[a._v("Type")]),a._v(" "),t("th",[a._v("Description")])])]),a._v(" "),t("tbody",[t("tr",[t("td",[a._v("geoip-host")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("IP address being geolocalized")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-country")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[t("code",[a._v("2 characters code indicating the country (eg:")]),a._v("FR"),t("code",[a._v("for")]),a._v("France``)")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-region")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("2 characters code indicating the region (eg: "),t("code",[a._v("A8")]),a._v(" for "),t("code",[a._v("Île-de-France")]),a._v(")")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-city")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("complete name of the city (eg: "),t("code",[a._v("Paris")]),a._v(")")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-latitude")]),a._v(" "),t("td",[a._v("Number")]),a._v(" "),t("td",[a._v("self-explanatory")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-longitude")]),a._v(" "),t("td",[a._v("Number")]),a._v(" "),t("td",[a._v("self-explanatory")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-coordinates")]),a._v(" "),t("td",[a._v("Array")]),a._v(" "),t("td",[a._v("concatenation of latitude and longitude between brackets (eg: "),t("code",[a._v("[48.8592,2.3417]")]),a._v(")")])])])]),a._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[a._v("#")]),a._v(" Headers")]),a._v(" "),t("ul",[t("li",[t("strong",[a._v("Geoip")]),a._v(" : Geolocation data that can be added to the results (none, all, geoip-host, geoip-country, geoip-region, geoip-city, geoip-latitude, geoip-longitude, geoip-coordinates).")])]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add geolocalizer by default to all your enrichments, To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(325),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use geolocalizer for an enrichment process. You just add the middleware.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(326),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use geolocalizer for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: geolocalizer"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Geoip: all"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: geolocalizer"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Geoip: all"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use geolocalizer for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: geolocalizer"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Geoip: all"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])]),t("h3",{attrs:{id:"advanced-usage-example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-usage-example"}},[a._v("#")]),a._v(" Advanced usage example")]),a._v(" "),t("p",[a._v("This example uses the ''csv2geojson'' and ''geojsonio-cli'' librairies.")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("npm")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" csv2geojson geojsonio-cli\n")])])]),t("p",[a._v("It is then possible to directly visualize the results on a map.")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST http://127.0.0.1:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--proxy")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('""')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n --no-buffer "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n --data-binary @./test/dataset/edp.2013-01-23.log "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Geoip: geoip-latitude, geoip-longitude'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Output-Fields: -doi,-identd,-url,-status,-size,+datetime'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" csv2geojson "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--lat")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"geoip-latitude"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--lon")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"geoip-longitude"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--delimiter")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('";"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[a._v("2")]),a._v(">")]),a._v(" /dev/null "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" geojsonio\n")])])]),t("p",[a._v("That opens a web browser with the following graphical representation of the access events.")]),a._v(" "),t("h4",{attrs:{id:"video-demonstration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#video-demonstration"}},[a._v("#")]),a._v(" Video Demonstration")]),a._v(" "),t("p",[a._v("This "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=SXSIb7oczbI",target:"_blank",rel:"noopener noreferrer"}},[a._v("screencast"),t("OutboundLink")],1),a._v(" demonstrates the previous usage (ie geolocation information visualized on a map)")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{327:function(a,t,e){a.exports=e.p+"assets/img/admin-interface.21598165.png"},328:function(a,t,e){a.exports=e.p+"assets/img/process-interface.83c903d3.png"},423:function(a,t,e){"use strict";e.r(t);var s=e(10),r=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"geocalizer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#geocalizer"}},[a._v("#")]),a._v(" geocalizer")]),a._v(" "),t("p",[a._v("Geolocalize consultation events based on an IP address.")]),a._v(" "),t("p",[t("strong",[a._v("This middleware is activated by default.")])]),a._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",[a._v("Name")]),a._v(" "),t("th",[a._v("Type")]),a._v(" "),t("th",[a._v("Description")])])]),a._v(" "),t("tbody",[t("tr",[t("td",[a._v("geoip-host")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("IP address being geolocalized")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-country")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[t("code",[a._v("2 characters code indicating the country (eg:")]),a._v("FR"),t("code",[a._v("for")]),a._v("France``)")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-region")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("2 characters code indicating the region (eg: "),t("code",[a._v("A8")]),a._v(" for "),t("code",[a._v("Île-de-France")]),a._v(")")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-city")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("complete name of the city (eg: "),t("code",[a._v("Paris")]),a._v(")")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-latitude")]),a._v(" "),t("td",[a._v("Number")]),a._v(" "),t("td",[a._v("self-explanatory")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-longitude")]),a._v(" "),t("td",[a._v("Number")]),a._v(" "),t("td",[a._v("self-explanatory")])]),a._v(" "),t("tr",[t("td",[a._v("geoip-coordinates")]),a._v(" "),t("td",[a._v("Array")]),a._v(" "),t("td",[a._v("concatenation of latitude and longitude between brackets (eg: "),t("code",[a._v("[48.8592,2.3417]")]),a._v(")")])])])]),a._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[a._v("#")]),a._v(" Headers")]),a._v(" "),t("ul",[t("li",[t("strong",[a._v("Geoip")]),a._v(" : Geolocation data that can be added to the results (none, all, geoip-host, geoip-country, geoip-region, geoip-city, geoip-latitude, geoip-longitude, geoip-coordinates).")])]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add geolocalizer by default to all your enrichments, To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(327),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use geolocalizer for an enrichment process. You just add the middleware.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(328),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use geolocalizer for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: geolocalizer"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Geoip: all"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: geolocalizer"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Geoip: all"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use geolocalizer for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: geolocalizer"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Geoip: all"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])]),t("h3",{attrs:{id:"advanced-usage-example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-usage-example"}},[a._v("#")]),a._v(" Advanced usage example")]),a._v(" "),t("p",[a._v("This example uses the ''csv2geojson'' and ''geojsonio-cli'' librairies.")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("npm")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" csv2geojson geojsonio-cli\n")])])]),t("p",[a._v("It is then possible to directly visualize the results on a map.")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST http://127.0.0.1:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--proxy")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('""')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n --no-buffer "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n --data-binary @./test/dataset/edp.2013-01-23.log "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Geoip: geoip-latitude, geoip-longitude'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'Output-Fields: -doi,-identd,-url,-status,-size,+datetime'")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" csv2geojson "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--lat")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"geoip-latitude"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--lon")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"geoip-longitude"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--delimiter")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('";"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[a._v("2")]),a._v(">")]),a._v(" /dev/null "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" geojsonio\n")])])]),t("p",[a._v("That opens a web browser with the following graphical representation of the access events.")]),a._v(" "),t("h4",{attrs:{id:"video-demonstration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#video-demonstration"}},[a._v("#")]),a._v(" Video Demonstration")]),a._v(" "),t("p",[a._v("This "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=SXSIb7oczbI",target:"_blank",rel:"noopener noreferrer"}},[a._v("screencast"),t("OutboundLink")],1),a._v(" demonstrates the previous usage (ie geolocation information visualized on a map)")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/37.3db5b10d.js b/assets/js/37.68916dff.js similarity index 96% rename from assets/js/37.3db5b10d.js rename to assets/js/37.68916dff.js index 6dc31c14..247f0e28 100644 --- a/assets/js/37.3db5b10d.js +++ b/assets/js/37.68916dff.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{327:function(t,a,e){t.exports=e.p+"assets/img/admin-interface.935a8ec9.png"},328:function(t,a,e){t.exports=e.p+"assets/img/process-interface.666bf306.png"},423:function(t,a,e){"use strict";e.r(a);var s=e(10),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hal"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hal"}},[t._v("#")]),t._v(" hal")]),t._v(" "),a("p",[t._v("Fetches "),a("a",{attrs:{href:"https://hal.archives-ouvertes.fr/",target:"_blank",rel:"noopener noreferrer"}},[t._v("HAL"),a("OutboundLink")],1),t._v(" data from their "),a("a",{attrs:{href:"https://api.archives-ouvertes.fr/docs/search",target:"_blank",rel:"noopener noreferrer"}},[t._v("API"),a("OutboundLink")],1)]),t._v(" "),a("p",[a("strong",[t._v("This middleware is activated by default.")])]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("publication_title")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_consult_collection_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_endpoint_portail_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_endpoint_portail")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_redirect_portail_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_redirect_portail")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_identifiant")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_tampons")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_tampons_name")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_domains")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_redirection")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_docid")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_consult_collection")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_fulltext")]),t._v(" "),a("td"),t._v(" "),a("td")])])]),t._v(" "),a("p",[t._v("The HAL middleware uses the "),a("code",[t._v("hal-identifier")]),t._v(" found in the access events to request metadata using the "),a("a",{attrs:{href:"https://www.npmjs.com/package/methal",target:"_blank",rel:"noopener noreferrer"}},[t._v("node-hal"),a("OutboundLink")],1)]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("hal-enrich")]),t._v(" : Set to "),a("code",[t._v("true")]),t._v(" to enable HAL enrichment. Disabled by default.\nhal-cache")]),t._v(" "),a("li",[a("strong",[t._v("hal-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("hal-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[t._v("500")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("hal-paquet-size")]),t._v(" :")]),t._v(" "),a("li",[a("strong",[t._v("hal-buffer-siz")]),t._v(" :")])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove hal by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(327),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use hel for an enrichment process. You just add the middleware.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(328),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: hal"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: hal"')]),t._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("p",[t._v("You can use hal for an enrichment process with curl like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: hal"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{325:function(t,a,e){t.exports=e.p+"assets/img/admin-interface.935a8ec9.png"},326:function(t,a,e){t.exports=e.p+"assets/img/process-interface.666bf306.png"},422:function(t,a,e){"use strict";e.r(a);var s=e(10),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hal"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hal"}},[t._v("#")]),t._v(" hal")]),t._v(" "),a("p",[t._v("Fetches "),a("a",{attrs:{href:"https://hal.archives-ouvertes.fr/",target:"_blank",rel:"noopener noreferrer"}},[t._v("HAL"),a("OutboundLink")],1),t._v(" data from their "),a("a",{attrs:{href:"https://api.archives-ouvertes.fr/docs/search",target:"_blank",rel:"noopener noreferrer"}},[t._v("API"),a("OutboundLink")],1)]),t._v(" "),a("p",[a("strong",[t._v("This middleware is activated by default.")])]),t._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("publication_title")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_consult_collection_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_endpoint_portail_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_endpoint_portail")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_redirect_portail_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_redirect_portail")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_identifiant")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_tampons")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_tampons_name")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_domains")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_sid")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_redirection")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_docid")]),t._v(" "),a("td",[t._v("String")]),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_consult_collection")]),t._v(" "),a("td"),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("hal_fulltext")]),t._v(" "),a("td"),t._v(" "),a("td")])])]),t._v(" "),a("p",[t._v("The HAL middleware uses the "),a("code",[t._v("hal-identifier")]),t._v(" found in the access events to request metadata using the "),a("a",{attrs:{href:"https://www.npmjs.com/package/methal",target:"_blank",rel:"noopener noreferrer"}},[t._v("node-hal"),a("OutboundLink")],1)]),t._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("hal-enrich")]),t._v(" : Set to "),a("code",[t._v("true")]),t._v(" to enable HAL enrichment. Disabled by default.\nhal-cache")]),t._v(" "),a("li",[a("strong",[t._v("hal-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("hal-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[t._v("500")]),t._v(".")]),t._v(" "),a("li",[a("strong",[t._v("hal-paquet-size")]),t._v(" :")]),t._v(" "),a("li",[a("strong",[t._v("hal-buffer-siz")]),t._v(" :")])]),t._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),a("p",[t._v("You can add or remove hal by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(325),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),a("p",[t._v("You can use hel for an enrichment process. You just add the middleware.")]),t._v(" "),a("p",[a("img",{attrs:{src:e(326),alt:"image"}})]),t._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: hal"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: hal"')]),t._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),a("p",[t._v("You can use hal for an enrichment process with curl like this:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: hal"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/42.e7be060e.js b/assets/js/42.7e8124c2.js similarity index 96% rename from assets/js/42.e7be060e.js rename to assets/js/42.7e8124c2.js index a0ebd569..c6c8c57c 100644 --- a/assets/js/42.e7be060e.js +++ b/assets/js/42.7e8124c2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{337:function(e,a,t){e.exports=t.p+"assets/img/admin-interface.e4cdc475.png"},338:function(e,a,t){e.exports=t.p+"assets/img/process-interface.5eb2c6e9.png"},428:function(e,a,t){"use strict";t.r(a);var s=t(10),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"omeka"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#omeka"}},[e._v("#")]),e._v(" omeka")]),e._v(" "),a("p",[e._v("Fetches metadata from platforms working with "),a("a",{attrs:{href:"https://omeka.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Omeka"),a("OutboundLink")],1),e._v(". This middleware was designed for internal use at Inist-CNRS")]),e._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[e._v("#")]),e._v(" Enriched fields")]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")]),e._v(" "),a("th",[e._v("Description")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("publication_title")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("Name of publication.")])]),e._v(" "),a("tr",[a("td",[e._v("ark")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("ID ARK of this resource.")])])])]),e._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),a("p",[e._v("This middleware can only be used to enrich one omeka platform per process. One of the keys corresponding to the platform name must be selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omeka/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".\nYour EC needs a omeka ID for enrichment.\nSome platforms may have private resources, to obtain enrichments on these platforms, It is necessary to enter a pair of API keys for each platform in the ezPAARSE processing configuration.")]),e._v(" "),a("p",[a("strong",[e._v("You must use omeka after filter, parser, deduplicator middleware.")])]),e._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),a("ul",[a("li",[a("strong",[e._v("omeka-platform")]),e._v(" : name of platform selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omeka/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omeka-cache")]),e._v(" : Enable/Disable cache.")]),e._v(" "),a("li",[a("strong",[e._v("omeka-ttl")]),e._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[e._v("7 days (3600 * 24 * 7)")]),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omeka-throttle")]),e._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[e._v("200")]),e._v("ms.")]),e._v(" "),a("li",[a("strong",[e._v("omeka-base-wait-time")]),e._v(" : Time to wait before retrying after a query fails, in milliseconds. Defaults to "),a("code",[e._v("1000")]),e._v("ms. This time "),a("code",[e._v("doubles")]),e._v(" after each attempt.")]),e._v(" "),a("li",[a("strong",[e._v("omeka-max-tries")]),e._v(" : Maximum number of attempts if an enrichment fails. Defaults to "),a("code",[e._v("5")]),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omeka-key")]),e._v(" : apikey to access private resource metada.")])]),e._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),a("p",[e._v("You can add omeka by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),a("p",[a("img",{attrs:{src:t(337),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),a("p",[e._v("You can use omeka for an enrichment process. You just add the middleware.")]),e._v(" "),a("p",[a("img",{attrs:{src:t(338),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),a("p",[e._v("You can use omeka for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),a("OutboundLink")],1),e._v(" like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omeka"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-key: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omeka"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-key: "')]),e._v(" \n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),a("p",[e._v("You can use omeka for an enrichment process with curl like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omeka"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-key: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{345:function(e,a,t){e.exports=t.p+"assets/img/admin-interface.e4cdc475.png"},346:function(e,a,t){e.exports=t.p+"assets/img/process-interface.5eb2c6e9.png"},432:function(e,a,t){"use strict";t.r(a);var s=t(10),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"omeka"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#omeka"}},[e._v("#")]),e._v(" omeka")]),e._v(" "),a("p",[e._v("Fetches metadata from platforms working with "),a("a",{attrs:{href:"https://omeka.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Omeka"),a("OutboundLink")],1),e._v(". This middleware was designed for internal use at Inist-CNRS")]),e._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[e._v("#")]),e._v(" Enriched fields")]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")]),e._v(" "),a("th",[e._v("Description")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("publication_title")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("Name of publication.")])]),e._v(" "),a("tr",[a("td",[e._v("ark")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("ID ARK of this resource.")])])])]),e._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),a("p",[e._v("This middleware can only be used to enrich one omeka platform per process. One of the keys corresponding to the platform name must be selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omeka/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".\nYour EC needs a omeka ID for enrichment.\nSome platforms may have private resources, to obtain enrichments on these platforms, It is necessary to enter a pair of API keys for each platform in the ezPAARSE processing configuration.")]),e._v(" "),a("p",[a("strong",[e._v("You must use omeka after filter, parser, deduplicator middleware.")])]),e._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),a("ul",[a("li",[a("strong",[e._v("omeka-platform")]),e._v(" : name of platform selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omeka/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omeka-cache")]),e._v(" : Enable/Disable cache.")]),e._v(" "),a("li",[a("strong",[e._v("omeka-ttl")]),e._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[e._v("7 days (3600 * 24 * 7)")]),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omeka-throttle")]),e._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[e._v("200")]),e._v("ms.")]),e._v(" "),a("li",[a("strong",[e._v("omeka-base-wait-time")]),e._v(" : Time to wait before retrying after a query fails, in milliseconds. Defaults to "),a("code",[e._v("1000")]),e._v("ms. This time "),a("code",[e._v("doubles")]),e._v(" after each attempt.")]),e._v(" "),a("li",[a("strong",[e._v("omeka-max-tries")]),e._v(" : Maximum number of attempts if an enrichment fails. Defaults to "),a("code",[e._v("5")]),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omeka-key")]),e._v(" : apikey to access private resource metada.")])]),e._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),a("p",[e._v("You can add omeka by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),a("p",[a("img",{attrs:{src:t(345),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),a("p",[e._v("You can use omeka for an enrichment process. You just add the middleware.")]),e._v(" "),a("p",[a("img",{attrs:{src:t(346),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),a("p",[e._v("You can use omeka for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),a("OutboundLink")],1),e._v(" like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omeka"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-key: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omeka"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-key: "')]),e._v(" \n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),a("p",[e._v("You can use omeka for an enrichment process with curl like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omeka"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omeka-key: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/43.cd83dd52.js b/assets/js/43.b9d1be6f.js similarity index 97% rename from assets/js/43.cd83dd52.js rename to assets/js/43.b9d1be6f.js index e0aae4a9..7e83dd3a 100644 --- a/assets/js/43.cd83dd52.js +++ b/assets/js/43.b9d1be6f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{339:function(e,a,t){e.exports=t.p+"assets/img/admin-interface.7d9c9ffa.png"},340:function(e,a,t){e.exports=t.p+"assets/img/process-interface.2e06cbfd.png"},429:function(e,a,t){"use strict";t.r(a);var s=t(10),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"omekas"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#omekas"}},[e._v("#")]),e._v(" omekas")]),e._v(" "),a("p",[e._v("Fetches metadata from platforms working with "),a("a",{attrs:{href:"https://omeka.org/s/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OmekaS"),a("OutboundLink")],1),e._v(". This middleware was designed for internal use at Inist-CNRS")]),e._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[e._v("#")]),e._v(" Enriched fields")]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")]),e._v(" "),a("th",[e._v("Description")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("publication_title")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("Name of publication.")])]),e._v(" "),a("tr",[a("td",[e._v("ark")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("ID ARK of this resource.")])])])]),e._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),a("p",[e._v("This middleware can only be used to enrich one omeka-S platform per process.\nOne of the keys corresponding to the platform name must be selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omekas/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".\nYour EC needs a omekaS ID for enrichment.\nSome platforms may have private resources, to obtain enrichments on these platforms, It is necessary to enter a pair of API keys for each platform in the ezPAARSE processing configuration.")]),e._v(" "),a("p",[a("strong",[e._v("You must use omekas after filter, parser, deduplicator middleware.")])]),e._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),a("ul",[a("li",[a("strong",[e._v("omekas-platform")]),e._v(" : name of platform selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omekas/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omekas-cache")]),e._v(" : Enable/Disable cache.")]),e._v(" "),a("li",[a("strong",[e._v("omekas-ttl")]),e._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[e._v("7 days (3600 * 24 * 7)")]),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omekas-throttle")]),e._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[e._v("200")]),e._v("ms.")]),e._v(" "),a("li",[a("strong",[e._v("omekas-key-credential")]),e._v(" : Part of the key pair to access private resource metada.")]),e._v(" "),a("li",[a("strong",[e._v("omekas-key-identity")]),e._v(" : Part of the key pair to access private resource metada.")])]),e._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),a("p",[e._v("You can add omekas by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),a("p",[a("img",{attrs:{src:t(339),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),a("p",[e._v("You can use omekas for an enrichment process. You just add the middleware.\n"),a("img",{attrs:{src:t(340),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),a("p",[e._v("You can use omekas for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),a("OutboundLink")],1),e._v(" like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omekas"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-identity: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-credentials: "')]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-identity: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-credentials: "')]),e._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),a("p",[e._v("You can use omekas for an enrichment process with curl like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omekas"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-identity: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-credentials: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{337:function(e,a,t){e.exports=t.p+"assets/img/admin-interface.7d9c9ffa.png"},338:function(e,a,t){e.exports=t.p+"assets/img/process-interface.2e06cbfd.png"},428:function(e,a,t){"use strict";t.r(a);var s=t(10),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"omekas"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#omekas"}},[e._v("#")]),e._v(" omekas")]),e._v(" "),a("p",[e._v("Fetches metadata from platforms working with "),a("a",{attrs:{href:"https://omeka.org/s/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OmekaS"),a("OutboundLink")],1),e._v(". This middleware was designed for internal use at Inist-CNRS")]),e._v(" "),a("h2",{attrs:{id:"enriched-fields"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[e._v("#")]),e._v(" Enriched fields")]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")]),e._v(" "),a("th",[e._v("Description")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("publication_title")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("Name of publication.")])]),e._v(" "),a("tr",[a("td",[e._v("ark")]),e._v(" "),a("td",[e._v("String")]),e._v(" "),a("td",[e._v("ID ARK of this resource.")])])])]),e._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),a("p",[e._v("This middleware can only be used to enrich one omeka-S platform per process.\nOne of the keys corresponding to the platform name must be selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omekas/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".\nYour EC needs a omekaS ID for enrichment.\nSome platforms may have private resources, to obtain enrichments on these platforms, It is necessary to enter a pair of API keys for each platform in the ezPAARSE processing configuration.")]),e._v(" "),a("p",[a("strong",[e._v("You must use omekas after filter, parser, deduplicator middleware.")])]),e._v(" "),a("h2",{attrs:{id:"headers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),a("ul",[a("li",[a("strong",[e._v("omekas-platform")]),e._v(" : name of platform selected from this "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse-middlewares/blob/master/omekas/manifest.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("file"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omekas-cache")]),e._v(" : Enable/Disable cache.")]),e._v(" "),a("li",[a("strong",[e._v("omekas-ttl")]),e._v(" : Lifetime of cached documents, in seconds. Defaults to "),a("code",[e._v("7 days (3600 * 24 * 7)")]),e._v(".")]),e._v(" "),a("li",[a("strong",[e._v("omekas-throttle")]),e._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),a("code",[e._v("200")]),e._v("ms.")]),e._v(" "),a("li",[a("strong",[e._v("omekas-key-credential")]),e._v(" : Part of the key pair to access private resource metada.")]),e._v(" "),a("li",[a("strong",[e._v("omekas-key-identity")]),e._v(" : Part of the key pair to access private resource metada.")])]),e._v(" "),a("h2",{attrs:{id:"how-to-use"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-admin-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),a("p",[e._v("You can add omekas by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),a("p",[a("img",{attrs:{src:t(337),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezpaarse-process-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),a("p",[e._v("You can use omekas for an enrichment process. You just add the middleware.\n"),a("img",{attrs:{src:t(338),alt:"image"}})]),e._v(" "),a("h3",{attrs:{id:"ezp"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),a("p",[e._v("You can use omekas for an enrichment process with "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),a("OutboundLink")],1),e._v(" like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omekas"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-identity: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-credentials: "')]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-identity: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-credentials: "')]),e._v("\n\n")])])]),a("h3",{attrs:{id:"curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),a("p",[e._v("You can use omekas for an enrichment process with curl like this:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: omekas"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-platform: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-identity: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"omekas-key-credentials: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/44.f0c059c5.js b/assets/js/44.bfaa562f.js similarity index 96% rename from assets/js/44.f0c059c5.js rename to assets/js/44.bfaa562f.js index f925a745..b08886bc 100644 --- a/assets/js/44.f0c059c5.js +++ b/assets/js/44.bfaa562f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{341:function(a,t,s){a.exports=s.p+"assets/img/admin-interface.45373aa3.png"},342:function(a,t,s){a.exports=s.p+"assets/img/process-interface.9365e7fb.png"},430:function(a,t,s){"use strict";s.r(t);var e=s(10),r=Object(e.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"on-campus-counter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#on-campus-counter"}},[a._v("#")]),a._v(" on-campus-counter")]),a._v(" "),t("p",[a._v("This middleware adds an "),t("code",[a._v("on_campus")]),a._v(" field containing "),t("code",[a._v("Y")]),a._v(" or "),t("code",[a._v("N")]),a._v(" depending on the IP contained in the "),t("code",[a._v("host")]),a._v(" field. It also increments two counters in the report : "),t("code",[a._v("on-campus-accesses")]),a._v(" and "),t("code",[a._v("off-campus-accesses")]),a._v(".")]),a._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",[a._v("Name")]),a._v(" "),t("th",[a._v("Type")]),a._v(" "),t("th",[a._v("Description")])])]),a._v(" "),t("tbody",[t("tr",[t("td",[a._v("on_campus")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("Name of publication.")])])])]),a._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[a._v("#")]),a._v(" Prerequisites")]),a._v(" "),t("p",[a._v("By default, only "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Private_network#Private_IPv4_address_spaces",target:"_blank",rel:"noopener noreferrer"}},[a._v("private IPv4 addresses"),t("OutboundLink")],1),a._v(" are considered on-campus. More ranges can be added by providing an "),t("code",[a._v("onCampusCounter")]),a._v(" key in the ezPAARSE configuration ("),t("code",[a._v("config.local.json")]),a._v(").")]),a._v(" "),t("p",[t("code",[a._v("onCampusCounter")]),a._v(" should be an array, where each element is either a valid range string, or an object with a string property "),t("code",[a._v("label")]),a._v(" and an array property "),t("code",[a._v("ranges")]),a._v(" containing valid range strings. Ranges also accept single IPv4 addresses.")]),a._v(" "),t("p",[a._v("When a range is associated with a label, "),t("code",[a._v("on_campus")]),a._v(" will contain the label instead of "),t("code",[a._v("Y")]),a._v(".")]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-config"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-config"}},[a._v("#")]),a._v(" ezPAARSE config")]),a._v(" "),t("p",[a._v("You can add or remove your on-campus-counter on ezpaarse config. It will be used on every process that used on-campus-counter middleware. You need to add this code on your "),t("code",[a._v("config.local.json")]),a._v(".")]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"onCampusCounter"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"115.0.0.0/8"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"label"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Campus name"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"ranges"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"93.25.0.0/16"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"118.0.0.0/8"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"83.112.9.15"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add or remove on-campus-counter by default to all your enrichments. To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(341),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use on-campus-counter for an enrichment process.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(342),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use on-campus-counter for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: on-campus-counter"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: on-campus-counter"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use on-campus-counter for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: on-campus-counter"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{339:function(a,t,s){a.exports=s.p+"assets/img/admin-interface.45373aa3.png"},340:function(a,t,s){a.exports=s.p+"assets/img/process-interface.9365e7fb.png"},429:function(a,t,s){"use strict";s.r(t);var e=s(10),r=Object(e.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"on-campus-counter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#on-campus-counter"}},[a._v("#")]),a._v(" on-campus-counter")]),a._v(" "),t("p",[a._v("This middleware adds an "),t("code",[a._v("on_campus")]),a._v(" field containing "),t("code",[a._v("Y")]),a._v(" or "),t("code",[a._v("N")]),a._v(" depending on the IP contained in the "),t("code",[a._v("host")]),a._v(" field. It also increments two counters in the report : "),t("code",[a._v("on-campus-accesses")]),a._v(" and "),t("code",[a._v("off-campus-accesses")]),a._v(".")]),a._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",[a._v("Name")]),a._v(" "),t("th",[a._v("Type")]),a._v(" "),t("th",[a._v("Description")])])]),a._v(" "),t("tbody",[t("tr",[t("td",[a._v("on_campus")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("Name of publication.")])])])]),a._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[a._v("#")]),a._v(" Prerequisites")]),a._v(" "),t("p",[a._v("By default, only "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Private_network#Private_IPv4_address_spaces",target:"_blank",rel:"noopener noreferrer"}},[a._v("private IPv4 addresses"),t("OutboundLink")],1),a._v(" are considered on-campus. More ranges can be added by providing an "),t("code",[a._v("onCampusCounter")]),a._v(" key in the ezPAARSE configuration ("),t("code",[a._v("config.local.json")]),a._v(").")]),a._v(" "),t("p",[t("code",[a._v("onCampusCounter")]),a._v(" should be an array, where each element is either a valid range string, or an object with a string property "),t("code",[a._v("label")]),a._v(" and an array property "),t("code",[a._v("ranges")]),a._v(" containing valid range strings. Ranges also accept single IPv4 addresses.")]),a._v(" "),t("p",[a._v("When a range is associated with a label, "),t("code",[a._v("on_campus")]),a._v(" will contain the label instead of "),t("code",[a._v("Y")]),a._v(".")]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-config"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-config"}},[a._v("#")]),a._v(" ezPAARSE config")]),a._v(" "),t("p",[a._v("You can add or remove your on-campus-counter on ezpaarse config. It will be used on every process that used on-campus-counter middleware. You need to add this code on your "),t("code",[a._v("config.local.json")]),a._v(".")]),a._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"onCampusCounter"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"115.0.0.0/8"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"label"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Campus name"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[a._v('"ranges"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"93.25.0.0/16"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"118.0.0.0/8"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"83.112.9.15"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add or remove on-campus-counter by default to all your enrichments. To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(339),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use on-campus-counter for an enrichment process.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(340),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use on-campus-counter for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: on-campus-counter"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: on-campus-counter"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use on-campus-counter for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: on-campus-counter"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/46.536ff2d2.js b/assets/js/46.5715f2a1.js similarity index 95% rename from assets/js/46.536ff2d2.js rename to assets/js/46.5715f2a1.js index 0250f514..750e74d9 100644 --- a/assets/js/46.536ff2d2.js +++ b/assets/js/46.5715f2a1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{345:function(a,t,s){a.exports=s.p+"assets/img/admin-interface.f6160cbb.png"},346:function(a,t,s){a.exports=s.p+"assets/img/process-interface.20b478b8.png"},432:function(a,t,s){"use strict";s.r(t);var e=s(10),r=Object(e.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"parser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parser"}},[a._v("#")]),a._v(" parser")]),a._v(" "),t("p",[a._v("Parses the URL associated with a consultation event (by calling the appropriate parser).")]),a._v(" "),t("p",[t("strong",[a._v("This middleware is activated by default.")])]),a._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[a._v("#")]),a._v(" Headers")]),a._v(" "),t("ul",[t("li",[t("strong",[a._v("filter-platforms")]),a._v(" : comma-separated list of platforms to handle. Lines with a matching parser that is not specified are considered irrelevant and filtered out.")]),a._v(" "),t("li",[t("strong",[a._v("allow-domain-wildcards")]),a._v(" : set to "),t("code",[a._v("true")]),a._v(" to allow domain wildcards when looking for parsers associated with a domain. For example, a parser with "),t("code",[a._v("*.google.com")]),a._v(" in its manifest will handle "),t("code",[a._v("google.com")]),a._v(" as well as "),t("code",[a._v("www.google.com")]),a._v(".")])]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add or remove parser by default to all your enrichments, To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(345),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use parser for an enrichment process. You just add the middleware.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(346),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: parser"')]),a._v("\n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use parser for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{341:function(a,t,s){a.exports=s.p+"assets/img/admin-interface.f6160cbb.png"},342:function(a,t,s){a.exports=s.p+"assets/img/process-interface.20b478b8.png"},430:function(a,t,s){"use strict";s.r(t);var e=s(10),r=Object(e.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"parser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parser"}},[a._v("#")]),a._v(" parser")]),a._v(" "),t("p",[a._v("Parses the URL associated with a consultation event (by calling the appropriate parser).")]),a._v(" "),t("p",[t("strong",[a._v("This middleware is activated by default.")])]),a._v(" "),t("h2",{attrs:{id:"headers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[a._v("#")]),a._v(" Headers")]),a._v(" "),t("ul",[t("li",[t("strong",[a._v("filter-platforms")]),a._v(" : comma-separated list of platforms to handle. Lines with a matching parser that is not specified are considered irrelevant and filtered out.")]),a._v(" "),t("li",[t("strong",[a._v("allow-domain-wildcards")]),a._v(" : set to "),t("code",[a._v("true")]),a._v(" to allow domain wildcards when looking for parsers associated with a domain. For example, a parser with "),t("code",[a._v("*.google.com")]),a._v(" in its manifest will handle "),t("code",[a._v("google.com")]),a._v(" as well as "),t("code",[a._v("www.google.com")]),a._v(".")])]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add or remove parser by default to all your enrichments, To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(341),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use parser for an enrichment process. You just add the middleware.")]),a._v(" "),t("p",[t("img",{attrs:{src:s(342),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: parser"')]),a._v("\n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use parser for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/49.5544d25f.js b/assets/js/49.2727bf95.js similarity index 95% rename from assets/js/49.5544d25f.js rename to assets/js/49.2727bf95.js index bcb025e4..dc94a005 100644 --- a/assets/js/49.5544d25f.js +++ b/assets/js/49.2727bf95.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{352:function(e,s,a){e.exports=a.p+"assets/img/admin-interface.a3dcda31.png"},353:function(e,s,a){e.exports=a.p+"assets/img/process-interface.8ab6ded9.png"},436:function(e,s,a){"use strict";a.r(s);var t=a(10),r=Object(t.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"session-id"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#session-id"}},[e._v("#")]),e._v(" session-id")]),e._v(" "),s("p",[e._v("Generate a COUNTER compliant user ID and session ID in the fields "),s("code",[e._v("user_id")]),e._v(" and "),s("code",[e._v("session_id")]),e._v(".")]),e._v(" "),s("h2",{attrs:{id:"prerequisites"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),s("p",[e._v("The user ID can be one of the following, by order of priority :")]),e._v(" "),s("ul",[s("li",[e._v("the user login (default field: login)")]),e._v(" "),s("li",[e._v("the cookie ID (default field: cookie)")]),e._v(" "),s("li",[e._v("both the IP (default field: host) and the user agent (default field: user-agent)")])]),e._v(" "),s("p",[e._v("The session ID is generated by concatenating the date, hour of day, and user ID.")]),e._v(" "),s("p",[e._v("Default fields can be changed with the "),s("RouterLink",{attrs:{to:"/configuration/parametres.html#session-id-fields"}},[e._v("Session-ID-Fields")]),e._v(" header.")],1),e._v(" "),s("p",[e._v("Examples of generated user IDs :")]),e._v(" "),s("ul",[s("li",[e._v("john.doe")]),e._v(" "),s("li",[e._v("157.244.176.142|Opera/9.80 (X11; Linux i686; U; ru) Presto/2.8.131 Version/11.11")])]),e._v(" "),s("p",[e._v("Examples of generated session IDs :")]),e._v(" "),s("ul",[s("li",[e._v("2019-06-09|08|john.doe")]),e._v(" "),s("li",[e._v("2018-12-25|00|157.244.176.142|Opera/9.80 (X11; Linux i686; U; ru) Presto/2.8.131 Version/11.11")])]),e._v(" "),s("p",[s("strong",[e._v("You must use session-id after filter, parser, deduplicator middleware.")])]),e._v(" "),s("h2",{attrs:{id:"headers"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),s("ul",[s("li",[s("strong",[e._v("session-id-fields")]),e._v(' : custom key assigned to a value, example: "userid: userid" or "userid: iduser" or "userid: iduser, user: idaccount"')])]),e._v(" "),s("h2",{attrs:{id:"how-to-use"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),s("h3",{attrs:{id:"ezpaarse-admin-interface"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),s("p",[e._v("You can add or remove session-id by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),s("p",[s("img",{attrs:{src:a(352),alt:"image"}})]),e._v(" "),s("h3",{attrs:{id:"ezpaarse-process-interface"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),s("p",[e._v("You can use session-id for an enrichment process.")]),e._v(" "),s("p",[s("img",{attrs:{src:a(353),alt:"image"}})]),e._v(" "),s("h3",{attrs:{id:"ezp"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),s("p",[e._v("You can use session-id for an enrichment process with "),s("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),s("OutboundLink")],1),e._v(" like this:")]),e._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: session-id"')]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: session-id"')]),e._v(" \n\n")])])]),s("h3",{attrs:{id:"curl"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),s("p",[e._v("You can use session-id for an enrichment process with curl like this:")]),e._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: session-id"')]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{358:function(e,s,a){e.exports=a.p+"assets/img/admin-interface.a3dcda31.png"},359:function(e,s,a){e.exports=a.p+"assets/img/process-interface.8ab6ded9.png"},439:function(e,s,a){"use strict";a.r(s);var t=a(10),r=Object(t.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"session-id"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#session-id"}},[e._v("#")]),e._v(" session-id")]),e._v(" "),s("p",[e._v("Generate a COUNTER compliant user ID and session ID in the fields "),s("code",[e._v("user_id")]),e._v(" and "),s("code",[e._v("session_id")]),e._v(".")]),e._v(" "),s("h2",{attrs:{id:"prerequisites"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),s("p",[e._v("The user ID can be one of the following, by order of priority :")]),e._v(" "),s("ul",[s("li",[e._v("the user login (default field: login)")]),e._v(" "),s("li",[e._v("the cookie ID (default field: cookie)")]),e._v(" "),s("li",[e._v("both the IP (default field: host) and the user agent (default field: user-agent)")])]),e._v(" "),s("p",[e._v("The session ID is generated by concatenating the date, hour of day, and user ID.")]),e._v(" "),s("p",[e._v("Default fields can be changed with the "),s("RouterLink",{attrs:{to:"/configuration/parametres.html#session-id-fields"}},[e._v("Session-ID-Fields")]),e._v(" header.")],1),e._v(" "),s("p",[e._v("Examples of generated user IDs :")]),e._v(" "),s("ul",[s("li",[e._v("john.doe")]),e._v(" "),s("li",[e._v("157.244.176.142|Opera/9.80 (X11; Linux i686; U; ru) Presto/2.8.131 Version/11.11")])]),e._v(" "),s("p",[e._v("Examples of generated session IDs :")]),e._v(" "),s("ul",[s("li",[e._v("2019-06-09|08|john.doe")]),e._v(" "),s("li",[e._v("2018-12-25|00|157.244.176.142|Opera/9.80 (X11; Linux i686; U; ru) Presto/2.8.131 Version/11.11")])]),e._v(" "),s("p",[s("strong",[e._v("You must use session-id after filter, parser, deduplicator middleware.")])]),e._v(" "),s("h2",{attrs:{id:"headers"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[e._v("#")]),e._v(" Headers")]),e._v(" "),s("ul",[s("li",[s("strong",[e._v("session-id-fields")]),e._v(' : custom key assigned to a value, example: "userid: userid" or "userid: iduser" or "userid: iduser, user: idaccount"')])]),e._v(" "),s("h2",{attrs:{id:"how-to-use"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),s("h3",{attrs:{id:"ezpaarse-admin-interface"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[e._v("#")]),e._v(" ezPAARSE admin interface")]),e._v(" "),s("p",[e._v("You can add or remove session-id by default to all your enrichments, To do this, go to the middleware section of administration.")]),e._v(" "),s("p",[s("img",{attrs:{src:a(358),alt:"image"}})]),e._v(" "),s("h3",{attrs:{id:"ezpaarse-process-interface"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[e._v("#")]),e._v(" ezPAARSE process interface")]),e._v(" "),s("p",[e._v("You can use session-id for an enrichment process.")]),e._v(" "),s("p",[s("img",{attrs:{src:a(359),alt:"image"}})]),e._v(" "),s("h3",{attrs:{id:"ezp"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[e._v("#")]),e._v(" ezp")]),e._v(" "),s("p",[e._v("You can use session-id for an enrichment process with "),s("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[e._v("ezp"),s("OutboundLink")],1),e._v(" like this:")]),e._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with one file")]),e._v("\nezp process "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your file"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: session-id"')]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--out")]),e._v(" ./result.csv\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# enrich with multiples files")]),e._v("\nezp bulk "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("path of your directory"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--host")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("host of your ezPAARSE instance"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--settings")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("settings-id"),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--header")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: session-id"')]),e._v(" \n\n")])])]),s("h3",{attrs:{id:"curl"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[e._v("#")]),e._v(" curl")]),e._v(" "),s("p",[e._v("You can use session-id for an enrichment process with curl like this:")]),e._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-X")]),e._v(" POST "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-v")]),e._v(" http://localhost:59599 "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ezPAARSE-Middlewares: session-id"')]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-H")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Log-Format-Ezproxy: "')]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-F")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[e._v('"file=@"')]),e._v("\n\n")])])])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/50.ecfdb7f7.js b/assets/js/50.d0c5a129.js similarity index 95% rename from assets/js/50.ecfdb7f7.js rename to assets/js/50.d0c5a129.js index 851a9f42..a2fc0602 100644 --- a/assets/js/50.ecfdb7f7.js +++ b/assets/js/50.d0c5a129.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{358:function(t,e,a){t.exports=a.p+"assets/img/admin-interface.b5768bd4.png"},359:function(t,e,a){t.exports=a.p+"assets/img/process-interface.336b5bba.png"},439:function(t,e,a){"use strict";a.r(e);var s=a(10),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"sudoc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sudoc"}},[t._v("#")]),t._v(" sudoc")]),t._v(" "),e("p",[t._v("Fetches "),e("a",{attrs:{href:"http://www.sudoc.abes.fr",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sudoc"),e("OutboundLink")],1),t._v(" data, especially the PPN (that identify Sudoc records).")]),t._v(" "),e("p",[e("strong",[t._v("This middleware is activated by default.")])]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("sudoc-ppn")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("unique identifier used to precisely identify a bibliographic record in the Sudoc catalog.")])])])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[t._v("Your EC needs a print_identifier for enrichment.")]),t._v(" "),e("p",[e("strong",[t._v("You must use sudoc after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("sudoc-enrich")]),t._v(" : Set to "),e("code",[t._v("false")]),t._v(" to disable sudoc enrichment. Enabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("sudoc-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("sudoc-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[t._v("200")]),t._v("ms.")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add or remove sudoc by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(358),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use sudoc for an enrichment process. You just add the middleware.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(359),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use sudoc for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: sudoc"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: sudoc"')]),t._v(" \n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use sudoc for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: sudoc"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{354:function(t,e,a){t.exports=a.p+"assets/img/admin-interface.b5768bd4.png"},355:function(t,e,a){t.exports=a.p+"assets/img/process-interface.336b5bba.png"},437:function(t,e,a){"use strict";a.r(e);var s=a(10),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"sudoc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sudoc"}},[t._v("#")]),t._v(" sudoc")]),t._v(" "),e("p",[t._v("Fetches "),e("a",{attrs:{href:"http://www.sudoc.abes.fr",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sudoc"),e("OutboundLink")],1),t._v(" data, especially the PPN (that identify Sudoc records).")]),t._v(" "),e("p",[e("strong",[t._v("This middleware is activated by default.")])]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("sudoc-ppn")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("unique identifier used to precisely identify a bibliographic record in the Sudoc catalog.")])])])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[t._v("Your EC needs a print_identifier for enrichment.")]),t._v(" "),e("p",[e("strong",[t._v("You must use sudoc after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("sudoc-enrich")]),t._v(" : Set to "),e("code",[t._v("false")]),t._v(" to disable sudoc enrichment. Enabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("sudoc-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("sudoc-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[t._v("200")]),t._v("ms.")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add or remove sudoc by default to all your enrichments, To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(354),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use sudoc for an enrichment process. You just add the middleware.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(355),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use sudoc for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: sudoc"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: sudoc"')]),t._v(" \n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use sudoc for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: sudoc"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/52.807626b8.js b/assets/js/52.f1fe7bda.js similarity index 95% rename from assets/js/52.807626b8.js rename to assets/js/52.f1fe7bda.js index 62c5fc0c..5889adce 100644 --- a/assets/js/52.807626b8.js +++ b/assets/js/52.f1fe7bda.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{354:function(a,t,e){a.exports=e.p+"assets/img/admin-interface.88bfd91c.png"},355:function(a,t,e){a.exports=e.p+"assets/img/process-interface.84981494.png"},437:function(a,t,e){"use strict";e.r(t);var r=e(10),s=Object(r.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"trackcode-generator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trackcode-generator"}},[a._v("#")]),a._v(" trackcode-generator")]),a._v(" "),t("p",[a._v("Generate a random trackcode based on host field, and remove the host field. The trackcode is cached for one year.")]),a._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[a._v("#")]),a._v(" Prerequisites")]),a._v(" "),t("p",[t("strong",[a._v("You must use trackcode-generator after filter, parser, deduplicator middleware.")])]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add or remove trackcode-generator by default to all your enrichments. To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(354),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use trackcode-generator for an enrichment process.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(355),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use trackcode-generator for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: trackcode-generator"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: trackcode-generator"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use trackcode-generator for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: trackcode-generator"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{352:function(a,t,e){a.exports=e.p+"assets/img/admin-interface.88bfd91c.png"},353:function(a,t,e){a.exports=e.p+"assets/img/process-interface.84981494.png"},436:function(a,t,e){"use strict";e.r(t);var r=e(10),s=Object(r.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"trackcode-generator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trackcode-generator"}},[a._v("#")]),a._v(" trackcode-generator")]),a._v(" "),t("p",[a._v("Generate a random trackcode based on host field, and remove the host field. The trackcode is cached for one year.")]),a._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[a._v("#")]),a._v(" Prerequisites")]),a._v(" "),t("p",[t("strong",[a._v("You must use trackcode-generator after filter, parser, deduplicator middleware.")])]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add or remove trackcode-generator by default to all your enrichments. To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(352),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use trackcode-generator for an enrichment process.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(353),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use trackcode-generator for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: trackcode-generator"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: trackcode-generator"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use trackcode-generator for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: trackcode-generator"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/54.0a92cd35.js b/assets/js/54.ab538ec6.js similarity index 95% rename from assets/js/54.0a92cd35.js rename to assets/js/54.ab538ec6.js index f8f0655e..58272837 100644 --- a/assets/js/54.0a92cd35.js +++ b/assets/js/54.ab538ec6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{364:function(a,t,e){a.exports=e.p+"assets/img/admin-interface.01fb77e6.png"},365:function(a,t,e){a.exports=e.p+"assets/img/process-interface.0e7e315f.png"},442:function(a,t,e){"use strict";e.r(t);var s=e(10),r=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"user-agent-parser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-agent-parser"}},[a._v("#")]),a._v(" user-agent-parser")]),a._v(" "),t("p",[a._v("Parse the user-agent string and add a "),t("code",[a._v("ua")]),a._v(" field containing the navigator name.")]),a._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",[a._v("Name")]),a._v(" "),t("th",[a._v("Type")]),a._v(" "),t("th",[a._v("Description")])])]),a._v(" "),t("tbody",[t("tr",[t("td",[a._v("ua")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("Simplified name of user agent.")])])])]),a._v(" "),t("h3",{attrs:{id:"example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[a._v("#")]),a._v(" Example")]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add user-agent-parser by default to all your enrichments, To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(364),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use user-agent-parser for an enrichment process. You just add the middleware.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(365),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use user-agent-parser for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: user-agent-parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: user-agent-parser"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use user-agent-parser for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: user-agent-parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{362:function(a,t,e){a.exports=e.p+"assets/img/admin-interface.01fb77e6.png"},363:function(a,t,e){a.exports=e.p+"assets/img/process-interface.0e7e315f.png"},441:function(a,t,e){"use strict";e.r(t);var s=e(10),r=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"user-agent-parser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-agent-parser"}},[a._v("#")]),a._v(" user-agent-parser")]),a._v(" "),t("p",[a._v("Parse the user-agent string and add a "),t("code",[a._v("ua")]),a._v(" field containing the navigator name.")]),a._v(" "),t("h2",{attrs:{id:"enriched-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[a._v("#")]),a._v(" Enriched fields")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",[a._v("Name")]),a._v(" "),t("th",[a._v("Type")]),a._v(" "),t("th",[a._v("Description")])])]),a._v(" "),t("tbody",[t("tr",[t("td",[a._v("ua")]),a._v(" "),t("td",[a._v("String")]),a._v(" "),t("td",[a._v("Simplified name of user agent.")])])])]),a._v(" "),t("h3",{attrs:{id:"example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[a._v("#")]),a._v(" Example")]),a._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-admin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[a._v("#")]),a._v(" ezPAARSE admin interface")]),a._v(" "),t("p",[a._v("You can add user-agent-parser by default to all your enrichments, To do this, go to the middleware section of administration.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(362),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezpaarse-process-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[a._v("#")]),a._v(" ezPAARSE process interface")]),a._v(" "),t("p",[a._v("You can use user-agent-parser for an enrichment process. You just add the middleware.")]),a._v(" "),t("p",[t("img",{attrs:{src:e(363),alt:"image"}})]),a._v(" "),t("h3",{attrs:{id:"ezp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[a._v("#")]),a._v(" ezp")]),a._v(" "),t("p",[a._v("You can use user-agent-parser for an enrichment process with "),t("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[a._v("ezp"),t("OutboundLink")],1),a._v(" like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with one file")]),a._v("\nezp process "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your file"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: user-agent-parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--out")]),a._v(" ./result.csv\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# enrich with multiples files")]),a._v("\nezp bulk "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("path of your directory"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--host")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("host of your ezPAARSE instance"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--settings")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("settings-id"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--header")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: user-agent-parser"')]),a._v(" \n\n")])])]),t("h3",{attrs:{id:"curl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[a._v("#")]),a._v(" curl")]),a._v(" "),t("p",[a._v("You can use user-agent-parser for an enrichment process with curl like this:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-X")]),a._v(" POST "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-v")]),a._v(" http://localhost:59599 "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ezPAARSE-Middlewares: user-agent-parser"')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-H")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"Log-Format-Ezproxy: "')]),a._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("\\")]),a._v("\n "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-F")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v('"file=@"')]),a._v("\n\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/55.b57d2b25.js b/assets/js/55.8d718162.js similarity index 96% rename from assets/js/55.b57d2b25.js rename to assets/js/55.8d718162.js index accfbee7..5c6b7e54 100644 --- a/assets/js/55.b57d2b25.js +++ b/assets/js/55.8d718162.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{362:function(t,e,a){t.exports=a.p+"assets/img/admin-interface.f1f98e01.png"},363:function(t,e,a){t.exports=a.p+"assets/img/process-interface.2af14aca.png"},441:function(t,e,a){"use strict";a.r(e);var s=a(10),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"zotero"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#zotero"}},[t._v("#")]),t._v(" zotero")]),t._v(" "),e("p",[t._v("Enriches consultation events with [zotero]")]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("zotero_doi")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("DOI of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("zotero_issn")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Print identifier of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("zotero_title")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Title of pulication.")])])])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("zotero-enrich")]),t._v(" : Set to "),e("code",[t._v("false")]),t._v(" to disable zotero enrichment. Enabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-cache")]),t._v(" : Enable/Disable cache.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-license")]),t._v(" : Set to "),e("code",[t._v("true")]),t._v(" to get the "),e("code",[t._v("license")]),t._v(" field as JSON. Disabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("zotero-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[t._v("200")]),t._v("ms.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-paquet-size")]),t._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),e("code",[t._v("50")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("zotero-buffer-size")]),t._v(" : Maximum number of memorised access events before sending a request. Defaults to "),e("code",[t._v("1000")]),t._v(".")])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[e("strong",[t._v("You must use zotero after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add or remove zotero by default to all your enrichments. To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(362),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use zotero for an enrichment process.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(363),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use zotero for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: zotero"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: zotero"')]),t._v(" \n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use zotero for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: zotero"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{364:function(t,e,a){t.exports=a.p+"assets/img/admin-interface.f1f98e01.png"},365:function(t,e,a){t.exports=a.p+"assets/img/process-interface.2af14aca.png"},442:function(t,e,a){"use strict";a.r(e);var s=a(10),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"zotero"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#zotero"}},[t._v("#")]),t._v(" zotero")]),t._v(" "),e("p",[t._v("Enriches consultation events with [zotero]")]),t._v(" "),e("h2",{attrs:{id:"enriched-fields"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enriched-fields"}},[t._v("#")]),t._v(" Enriched fields")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("zotero_doi")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("DOI of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("zotero_issn")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Print identifier of publication.")])]),t._v(" "),e("tr",[e("td",[t._v("zotero_title")]),t._v(" "),e("td",[t._v("String")]),t._v(" "),e("td",[t._v("Title of pulication.")])])])]),t._v(" "),e("h2",{attrs:{id:"headers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#headers"}},[t._v("#")]),t._v(" Headers")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("zotero-enrich")]),t._v(" : Set to "),e("code",[t._v("false")]),t._v(" to disable zotero enrichment. Enabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-cache")]),t._v(" : Enable/Disable cache.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-license")]),t._v(" : Set to "),e("code",[t._v("true")]),t._v(" to get the "),e("code",[t._v("license")]),t._v(" field as JSON. Disabled by default.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-ttl")]),t._v(" : Lifetime of cached documents, in seconds. Defaults to "),e("code",[t._v("7 days (3600 * 24 * 7)")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("zotero-throttle")]),t._v(" : Minimum time to wait between queries, in milliseconds. Defaults to "),e("code",[t._v("200")]),t._v("ms.")]),t._v(" "),e("li",[e("strong",[t._v("zotero-paquet-size")]),t._v(" : Maximum number of identifiers to send for query in a single request. Defaults to "),e("code",[t._v("50")]),t._v(".")]),t._v(" "),e("li",[e("strong",[t._v("zotero-buffer-size")]),t._v(" : Maximum number of memorised access events before sending a request. Defaults to "),e("code",[t._v("1000")]),t._v(".")])]),t._v(" "),e("h2",{attrs:{id:"prerequisites"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[t._v("#")]),t._v(" Prerequisites")]),t._v(" "),e("p",[e("strong",[t._v("You must use zotero after filter, parser, deduplicator middleware.")])]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-admin-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-admin-interface"}},[t._v("#")]),t._v(" ezPAARSE admin interface")]),t._v(" "),e("p",[t._v("You can add or remove zotero by default to all your enrichments. To do this, go to the middleware section of administration.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(364),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezpaarse-process-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-process-interface"}},[t._v("#")]),t._v(" ezPAARSE process interface")]),t._v(" "),e("p",[t._v("You can use zotero for an enrichment process.")]),t._v(" "),e("p",[e("img",{attrs:{src:a(365),alt:"image"}})]),t._v(" "),e("h3",{attrs:{id:"ezp"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ezp"}},[t._v("#")]),t._v(" ezp")]),t._v(" "),e("p",[t._v("You can use zotero for an enrichment process with "),e("a",{attrs:{href:"https://github.com/ezpaarse-project/node-ezpaarse",target:"_blank",rel:"noopener noreferrer"}},[t._v("ezp"),e("OutboundLink")],1),t._v(" like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with one file")]),t._v("\nezp process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your file"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: zotero"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--out")]),t._v(" ./result.csv\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# enrich with multiples files")]),t._v("\nezp bulk "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("path of your directory"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--host")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("host of your ezPAARSE instance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--settings")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("settings-id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--header")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: zotero"')]),t._v(" \n\n")])])]),e("h3",{attrs:{id:"curl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#curl"}},[t._v("#")]),t._v(" curl")]),t._v(" "),e("p",[t._v("You can use zotero for an enrichment process with curl like this:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" http://localhost:59599 "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ezPAARSE-Middlewares: zotero"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-H")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Log-Format-Ezproxy: "')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-F")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"file=@"')]),t._v("\n\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/61.92cbd66a.js b/assets/js/61.db62c4b0.js similarity index 99% rename from assets/js/61.92cbd66a.js rename to assets/js/61.db62c4b0.js index 0e8a7d0e..cec0c7e6 100644 --- a/assets/js/61.92cbd66a.js +++ b/assets/js/61.db62c4b0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{381:function(e,t,a){"use strict";a.r(t);var s=a(10),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("p",[e._v("The ezPAARSE jobs can be configured using HTTP headers. Please find the list of available headers below.")]),e._v(" "),t("h3",{attrs:{id:"content-encoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#content-encoding"}},[e._v("#")]),e._v(" Content-Encoding")]),e._v(" "),t("p",[e._v("Encoding of the data sent.\n"),t("em",[e._v("(supported: gzip, deflate)")])]),e._v(" "),t("h3",{attrs:{id:"response-encoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-encoding"}},[e._v("#")]),e._v(" Response-Encoding")]),e._v(" "),t("p",[e._v("Encoding of the data sent back by server.\n"),t("em",[e._v("(supported: gzip, deflate)")])]),e._v(" "),t("h3",{attrs:{id:"accept"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#accept"}},[e._v("#")]),e._v(" Accept")]),e._v(" "),t("p",[e._v("Output format.\nSupported:")]),e._v(" "),t("ul",[t("li",[e._v("text/csv (by default)")]),e._v(" "),t("li",[e._v("text/tab-separated-values (for a TSV output: as CSV but tab-delimited)")]),e._v(" "),t("li",[e._v("application/json")]),e._v(" "),t("li",[e._v("application/jsonstream (one JSON object per line)")])]),e._v(" "),t("h3",{attrs:{id:"log-format-xxx"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#log-format-xxx"}},[e._v("#")]),e._v(" Log-Format-xxx")]),e._v(" "),t("p",[e._v("Format of the log lines in input, depends on the proxy "),t("em",[e._v("xxx")]),e._v(" used. "),t("RouterLink",{attrs:{to:"/essential/formats.html"}},[e._v("See the available formats")])],1),e._v(" "),t("h3",{attrs:{id:"date-format"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#date-format"}},[e._v("#")]),e._v(" Date-Format")]),e._v(" "),t("p",[e._v("Date format used in the logs sent. Default is: 'DD/MMM/YYYY:HH:mm:ss Z'.")]),e._v(" "),t("h3",{attrs:{id:"crypted-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crypted-fields"}},[e._v("#")]),e._v(" Crypted-Fields")]),e._v(" "),t("p",[e._v("Comma-separated list of fields that will be crypted in the results, or "),t("code",[e._v("none")]),e._v(" to disable crypting. Defaults to "),t("code",[e._v("host,login")]),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Caution")]),e._v(": each job uses a random salt for crypting, so crypted values for the same access event but from distinct jobs are not identical. Use the "),t("code",[e._v("Crypting-Salt")]),e._v(" header to change this behavior.")]),e._v(" "),t("h3",{attrs:{id:"crypting-salt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crypting-salt"}},[e._v("#")]),e._v(" Crypting-Salt")]),e._v(" "),t("p",[e._v("A specific crypting key to use if you want fields to be crypted the same way accross different jobs.")]),e._v(" "),t("h3",{attrs:{id:"crypting-algorithm"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crypting-algorithm"}},[e._v("#")]),e._v(" Crypting-Algorithm")]),e._v(" "),t("p",[e._v("The algorithm that should be used to crypt fields. It must be supported by the version of OpenSSL that is installed on the platform. On recent releases of OpenSSL, "),t("code",[e._v("openssl list -digest-algorithms")]),e._v(" will display the available algorithms.")]),e._v(" "),t("h3",{attrs:{id:"output-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#output-fields"}},[e._v("#")]),e._v(" Output-Fields")]),e._v(" "),t("p",[e._v("To specify the fields to include in the output (if the format allows it). "),t("RouterLink",{attrs:{to:"/features/outputfields.html"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"traces-level"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#traces-level"}},[e._v("#")]),e._v(" Traces-Level")]),e._v(" "),t("p",[e._v("To specify the verbosity level from ezPAARSE's feedback. The higher levels include the lower ones.")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("error")]),e._v(": blocking errors, abnormal treatment termination.")]),e._v(" "),t("li",[t("strong",[e._v("warn")]),e._v(": errors not fatal to the treatment.")]),e._v(" "),t("li",[t("strong",[e._v("info")]),e._v(": general informations (requested format, ending notification, number of access events generated...).")]),e._v(" "),t("li",[t("strong",[e._v("verbose")]),e._v(": more precise than info, gives more information about each stage of the treatment.")]),e._v(" "),t("li",[t("strong",[e._v("silly")]),e._v(": every detail of the treatment (parser not found, line ignored, unsuccessful search in a pkb...).")])]),e._v(" "),t("h3",{attrs:{id:"reject-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reject-files"}},[e._v("#")]),e._v(" Reject-Files")]),e._v(" "),t("p",[e._v("List of the reject files to create, separated by commas.")]),e._v(" "),t("p",[e._v("Possible values are:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Unknown-Formats")])]),e._v(" "),t("li",[t("code",[e._v("Ignored-Domains")])]),e._v(" "),t("li",[t("code",[e._v("Unknown-Domains")])]),e._v(" "),t("li",[t("code",[e._v("Unqualified-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Duplicate-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Unordered-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Filtered-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Ignored-Hosts")])]),e._v(" "),t("li",[t("code",[e._v("Robots-ECs")])])]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("none")]),e._v(" by default.")]),e._v(" "),t("p",[e._v("We recommend to set it to "),t("code",[e._v("all")]),e._v(" when you start using ezPAARSE, to fully understand the filtering and exclusion system.")]),e._v(" "),t("h3",{attrs:{id:"double-click-xxx"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#double-click-xxx"}},[e._v("#")]),e._v(" Double-Click-xxx")]),e._v(" "),t("p",[e._v("Parameters used for deduplication. "),t("RouterLink",{attrs:{to:"/features/doubleclick.html"}},[e._v("(More information)")]),e._v(".")],1),e._v(" "),t("h3",{attrs:{id:"request-charset"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#request-charset"}},[e._v("#")]),e._v(" Request-Charset")]),e._v(" "),t("p",[e._v("Character map used for input. "),t("a",{attrs:{href:"https://github.com/ashtuchkin/iconv-lite#supported-encodings",target:"_blank",rel:"noopener noreferrer"}},[e._v("(see supported encodings)"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"response-charset"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-charset"}},[e._v("#")]),e._v(" Response-Charset")]),e._v(" "),t("p",[e._v("Character map used for output. "),t("a",{attrs:{href:"https://github.com/ashtuchkin/iconv-lite#supported-encodings",target:"_blank",rel:"noopener noreferrer"}},[e._v("(see supported encodings)"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"max-parse-attempts"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#max-parse-attempts"}},[e._v("#")]),e._v(" Max-Parse-Attempts")]),e._v(" "),t("p",[e._v("Maximum number of lines that ezPAARSE will attempt to parse in order to check the log format.")]),e._v(" "),t("h3",{attrs:{id:"clean-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clean-only"}},[e._v("#")]),e._v(" Clean-Only")]),e._v(" "),t("p",[e._v("If set to "),t("code",[e._v("true")]),e._v(", ezPAARSE will just filter out the lines we are sure are irrelevant and output only the relevant ones.\nThe goal when using this parameter is to reduce the size of the log file, if you need to store it for further treatment.")]),e._v(" "),t("h4",{attrs:{id:"video-demonstration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#video-demonstration"}},[e._v("#")]),e._v(" Video Demonstration")]),e._v(" "),t("p",[e._v("This "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=I3D6lO4wDZo",target:"_blank",rel:"noopener noreferrer"}},[e._v("screencast"),t("OutboundLink")],1),e._v(" demonstrates the usage of the Clean-Only parameter (ie the cleaning of a log file for size reduction and ease of storage)")]),e._v(" "),t("h3",{attrs:{id:"force-parser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#force-parser"}},[e._v("#")]),e._v(" Force-Parser")]),e._v(" "),t("p",[e._v("If URLs don't have a "),t("code",[e._v("domain")]),e._v(" part, use this parameter to force the right parser to be used. Useful for Open Access logs analysis, which don't have a domain part in the URL (all URLs comes from the same domain).")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("Force-Parser: 'dspace'\n")])])]),t("p",[e._v("Can be used in conjonction with "),t("a",{attrs:{href:"#force-ecfield-publisher"}},[e._v("Force-ECField-Publisher")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"geoip"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#geoip"}},[e._v("#")]),e._v(" Geoip")]),e._v(" "),t("p",[e._v("Listing of the geolocation informations to be added to the results. By default "),t("code",[e._v("geoip-longitude, geoip-latitude, geoip-country")]),e._v(". "),t("code",[e._v("all")]),e._v(" can be used to include every fiel available, or "),t("code",[e._v("none")]),e._v(" to deactivate geolocation altogether. "),t("RouterLink",{attrs:{to:"/features/geolocalisation.html"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"ezpaarse-job-notifications"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-job-notifications"}},[e._v("#")]),e._v(" ezPAARSE-Job-Notifications")]),e._v(" "),t("p",[e._v("Listing of notifications to send when treatment is done, written as "),t("code",[e._v("action")]),e._v(" and separated by commas. Currently available: "),t("code",[e._v("mail")])]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-middlewares"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-middlewares"}},[e._v("#")]),e._v(" ezPAARSE-Middlewares")]),e._v(" "),t("p",[e._v("Insert a list of middlewares that are not present in the base configuration ("),t("code",[e._v("EZPAARSE_MIDDLEWARES")]),e._v("). The value must be a list of middleware names separated with commas, in the order of use.")]),e._v(" "),t("p",[e._v("By default, they will be inserted at the end of the chain, before "),t("code",[e._v("qualifier")]),e._v(". You can prefix the list with the mention "),t("code",[e._v("(before )")]),e._v(" or "),t("code",[e._v("(after )")]),e._v(" to insert them at a more specific place, or "),t("code",[e._v("(only)")]),e._v(" to only use the middlewares you want.")]),e._v(" "),t("p",[e._v("["),t("code",[e._v("v3.7.0")]),e._v(" and above]"),t("br"),e._v("\nIf you need to insert middlewares at different places, you can declare multiple lists separated with "),t("code",[e._v("|")]),e._v(" (see the example below).")]),e._v(" "),t("h4",{attrs:{id:"examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': 'user-agent-parser, sudoc'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(before istex) user-agent-parser'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(after sudoc) hal, istex'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(only) crossref'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(after deduplicator) crossref | (before geolocalizer) host-chain'\n")])])]),t("h3",{attrs:{id:"ezpaarse-enrich"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-enrich"}},[e._v("#")]),e._v(" ezPAARSE-Enrich")]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("false")]),e._v(" to deactivate data enrichment (geoip and knowledge bases). Any other value will leave the data enrichment active.")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-predefined-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-predefined-settings"}},[e._v("#")]),e._v(" ezPAARSE-Predefined-Settings")]),e._v(" "),t("p",[e._v("Tells ezPAARSE to use a predefined set of parameters. For example: "),t("code",[e._v("inist")]),e._v(" for INIST-CNRS parameters.")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-filter-redirects"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-filter-redirects"}},[e._v("#")]),e._v(" ezPAARSE-Filter-Redirects")]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("false")]),e._v(" to prevent lines with HTTP status codes 301, 302 from being filtered and discarded.")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-filter-status"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-filter-status"}},[e._v("#")]),e._v(" ezPAARSE-Filter-Status")]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("false")]),e._v(" to disable filtering on status codes, or provide a comma-separated list of status codes that should be kept.\nIf you provide your own list, ECs with a status of "),t("code",[e._v("401")]),e._v(" or "),t("code",[e._v("403")]),e._v(" won't be marked as denied, and will be present in the main result file.")]),e._v(" "),t("h4",{attrs:{id:"example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[e._v("#")]),e._v(" Example")]),e._v(" "),t("p",[e._v("Only keep status 200, 201 and 403")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Filter-Status': '200,201,403'\n")])])]),t("h3",{attrs:{id:"disable-filters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-filters"}},[e._v("#")]),e._v(" Disable-Filters")]),e._v(" "),t("p",[e._v("Disable filters applying to robots or arbitrary hosts/domains. (defaults to "),t("code",[e._v("none")]),e._v(").\nPossible values (separated by commas): "),t("code",[e._v("robots")]),e._v(", "),t("code",[e._v("ignored-hosts")]),e._v(", "),t("code",[e._v("ignored-domains")]),e._v(".\nSet to "),t("code",[e._v("all")]),e._v(" to disable all above filters.")]),e._v(" "),t("p",[t("strong",[e._v("NB")]),e._v(": when robots are not filtered, add the "),t("code",[e._v("robot")]),e._v(" field to the output in order to know which consultations were made by robots.")]),e._v(" "),t("h3",{attrs:{id:"force-ecfield-publisher"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#force-ecfield-publisher"}},[e._v("#")]),e._v(" Force-ECField-Publisher")]),e._v(" "),t("p",[e._v("Set the publisher_name field to a predefined value.\nFor example: Force-ECField-Publisher: 'IRevues'.")]),e._v(" "),t("h3",{attrs:{id:"session-id-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#session-id-fields"}},[e._v("#")]),e._v(" Session-ID-Fields")]),e._v(" "),t("p",[e._v("Change the fields used to generate session IDs and user IDs. By default, the generator uses either "),t("code",[e._v("login")]),e._v(", "),t("code",[e._v("cookie")]),e._v(", or a combination of "),t("code",[e._v("host")]),e._v(" and "),t("code",[e._v("user-agent")]),e._v(", and store the generated IDs in "),t("code",[e._v("session_id")]),e._v(" and "),t("code",[e._v("user_id")]),e._v(". You can customize those fields by providing a mapping separated by commas.")]),e._v(" "),t("p",[e._v("Default mapping :")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" user: login, cookie: cookie, host: host, useragent: user-agent, session: session_id, userid: user_id\n")])])]),t("p",[e._v("If your user login is in the "),t("code",[e._v("user_login")]),e._v(" field :")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" user: user_login\n")])])]),t("h3",{attrs:{id:"extract"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#extract"}},[e._v("#")]),e._v(" Extract")]),e._v(" "),t("p",[e._v("Extract values from a field and dispatch them in new fields. The syntax is the following : "),t("code",[e._v("source_field => extract_expression => destination_fields")])]),e._v(" "),t("h4",{attrs:{id:"examples-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples-2"}},[e._v("#")]),e._v(" Examples:")]),e._v(" "),t("p",[e._v("The following examples assume we have a "),t("strong",[e._v("login")]),e._v(" field with the value "),t("strong",[e._v("THEODORE_MCCLURE")]),e._v(". Here are multiple ways to create a "),t("strong",[e._v("firstname")]),e._v(" field containing "),t("strong",[e._v("THEODORE")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" field containing "),t("strong",[e._v("MCCLURE")]),e._v(".")]),e._v(" "),t("h5",{attrs:{id:"extracting-with-a-regular-expression"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#extracting-with-a-regular-expression"}},[e._v("#")]),e._v(" Extracting with a regular expression:")]),e._v(" "),t("p",[e._v("If the extract expression is a regular expression (between slashes, with optional flags after the closing slash), it's applied to the source field and the captured groups are stored in the destination fields.")]),e._v(" "),t("p",[e._v("The following expression applies the regular expression "),t("code",[e._v("/^([a-z]+)_([a-z]+)$/i")]),e._v(" on the "),t("strong",[e._v("login")]),e._v(" field, and puts the captured groups in the "),t("strong",[e._v("firstname")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" fields.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" login => /^([a-z]+)_([a-z]+)$/i => firstname,lastname\n")])])]),t("h5",{attrs:{id:"splitting-over-an-expression"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#splitting-over-an-expression"}},[e._v("#")]),e._v(" Splitting over an expression:")]),e._v(" "),t("p",[e._v("If the extract expression is "),t("strong",[e._v("split()")]),e._v(", then the source field will be splitted according to the expression between the parentheses.")]),e._v(" "),t("p",[e._v("The following splits the "),t("strong",[e._v("login")]),e._v(" field with the character "),t("code",[e._v("\\_")]),e._v(" and puts the parts in the "),t("strong",[e._v("firstname")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" fields.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'Extract': 'login => split(_) => firstname,lastname'\n")])])]),t("p",[e._v("The following splits the "),t("strong",[e._v("login")]),e._v(" field with the regular expression "),t("code",[e._v("/[\\_]+/")]),e._v(" and puts the parts in the "),t("strong",[e._v("firstname")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" fields.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'Extract': 'login => split(/[_]+/) => firstname,lastname'\n")])])]),t("h2",{attrs:{id:"metadata-enrichment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#metadata-enrichment"}},[e._v("#")]),e._v(" Metadata enrichment")]),e._v(" "),t("p",[e._v("The use of middlewares to enrich access events with metadata coming from external APIs is controlled by headers.")]),e._v(" "),t("h3",{attrs:{id:"crossref"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crossref"}},[e._v("#")]),e._v(" Crossref")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-crossref-middleware-call"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"sudoc"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sudoc"}},[e._v("#")]),e._v(" Sudoc")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-sudoc-middleware-call"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"hal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hal"}},[e._v("#")]),e._v(" HAL")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-hal-middleware-call"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"istex"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#istex"}},[e._v("#")]),e._v(" ISTEX")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-istex-middleware-call"}},[e._v("(More information)")])],1)])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{380:function(e,t,a){"use strict";a.r(t);var s=a(10),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("p",[e._v("The ezPAARSE jobs can be configured using HTTP headers. Please find the list of available headers below.")]),e._v(" "),t("h3",{attrs:{id:"content-encoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#content-encoding"}},[e._v("#")]),e._v(" Content-Encoding")]),e._v(" "),t("p",[e._v("Encoding of the data sent.\n"),t("em",[e._v("(supported: gzip, deflate)")])]),e._v(" "),t("h3",{attrs:{id:"response-encoding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-encoding"}},[e._v("#")]),e._v(" Response-Encoding")]),e._v(" "),t("p",[e._v("Encoding of the data sent back by server.\n"),t("em",[e._v("(supported: gzip, deflate)")])]),e._v(" "),t("h3",{attrs:{id:"accept"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#accept"}},[e._v("#")]),e._v(" Accept")]),e._v(" "),t("p",[e._v("Output format.\nSupported:")]),e._v(" "),t("ul",[t("li",[e._v("text/csv (by default)")]),e._v(" "),t("li",[e._v("text/tab-separated-values (for a TSV output: as CSV but tab-delimited)")]),e._v(" "),t("li",[e._v("application/json")]),e._v(" "),t("li",[e._v("application/jsonstream (one JSON object per line)")])]),e._v(" "),t("h3",{attrs:{id:"log-format-xxx"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#log-format-xxx"}},[e._v("#")]),e._v(" Log-Format-xxx")]),e._v(" "),t("p",[e._v("Format of the log lines in input, depends on the proxy "),t("em",[e._v("xxx")]),e._v(" used. "),t("RouterLink",{attrs:{to:"/essential/formats.html"}},[e._v("See the available formats")])],1),e._v(" "),t("h3",{attrs:{id:"date-format"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#date-format"}},[e._v("#")]),e._v(" Date-Format")]),e._v(" "),t("p",[e._v("Date format used in the logs sent. Default is: 'DD/MMM/YYYY:HH:mm:ss Z'.")]),e._v(" "),t("h3",{attrs:{id:"crypted-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crypted-fields"}},[e._v("#")]),e._v(" Crypted-Fields")]),e._v(" "),t("p",[e._v("Comma-separated list of fields that will be crypted in the results, or "),t("code",[e._v("none")]),e._v(" to disable crypting. Defaults to "),t("code",[e._v("host,login")]),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Caution")]),e._v(": each job uses a random salt for crypting, so crypted values for the same access event but from distinct jobs are not identical. Use the "),t("code",[e._v("Crypting-Salt")]),e._v(" header to change this behavior.")]),e._v(" "),t("h3",{attrs:{id:"crypting-salt"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crypting-salt"}},[e._v("#")]),e._v(" Crypting-Salt")]),e._v(" "),t("p",[e._v("A specific crypting key to use if you want fields to be crypted the same way accross different jobs.")]),e._v(" "),t("h3",{attrs:{id:"crypting-algorithm"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crypting-algorithm"}},[e._v("#")]),e._v(" Crypting-Algorithm")]),e._v(" "),t("p",[e._v("The algorithm that should be used to crypt fields. It must be supported by the version of OpenSSL that is installed on the platform. On recent releases of OpenSSL, "),t("code",[e._v("openssl list -digest-algorithms")]),e._v(" will display the available algorithms.")]),e._v(" "),t("h3",{attrs:{id:"output-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#output-fields"}},[e._v("#")]),e._v(" Output-Fields")]),e._v(" "),t("p",[e._v("To specify the fields to include in the output (if the format allows it). "),t("RouterLink",{attrs:{to:"/features/outputfields.html"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"traces-level"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#traces-level"}},[e._v("#")]),e._v(" Traces-Level")]),e._v(" "),t("p",[e._v("To specify the verbosity level from ezPAARSE's feedback. The higher levels include the lower ones.")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("error")]),e._v(": blocking errors, abnormal treatment termination.")]),e._v(" "),t("li",[t("strong",[e._v("warn")]),e._v(": errors not fatal to the treatment.")]),e._v(" "),t("li",[t("strong",[e._v("info")]),e._v(": general informations (requested format, ending notification, number of access events generated...).")]),e._v(" "),t("li",[t("strong",[e._v("verbose")]),e._v(": more precise than info, gives more information about each stage of the treatment.")]),e._v(" "),t("li",[t("strong",[e._v("silly")]),e._v(": every detail of the treatment (parser not found, line ignored, unsuccessful search in a pkb...).")])]),e._v(" "),t("h3",{attrs:{id:"reject-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reject-files"}},[e._v("#")]),e._v(" Reject-Files")]),e._v(" "),t("p",[e._v("List of the reject files to create, separated by commas.")]),e._v(" "),t("p",[e._v("Possible values are:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Unknown-Formats")])]),e._v(" "),t("li",[t("code",[e._v("Ignored-Domains")])]),e._v(" "),t("li",[t("code",[e._v("Unknown-Domains")])]),e._v(" "),t("li",[t("code",[e._v("Unqualified-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Duplicate-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Unordered-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Filtered-ECs")])]),e._v(" "),t("li",[t("code",[e._v("Ignored-Hosts")])]),e._v(" "),t("li",[t("code",[e._v("Robots-ECs")])])]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("none")]),e._v(" by default.")]),e._v(" "),t("p",[e._v("We recommend to set it to "),t("code",[e._v("all")]),e._v(" when you start using ezPAARSE, to fully understand the filtering and exclusion system.")]),e._v(" "),t("h3",{attrs:{id:"double-click-xxx"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#double-click-xxx"}},[e._v("#")]),e._v(" Double-Click-xxx")]),e._v(" "),t("p",[e._v("Parameters used for deduplication. "),t("RouterLink",{attrs:{to:"/features/doubleclick.html"}},[e._v("(More information)")]),e._v(".")],1),e._v(" "),t("h3",{attrs:{id:"request-charset"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#request-charset"}},[e._v("#")]),e._v(" Request-Charset")]),e._v(" "),t("p",[e._v("Character map used for input. "),t("a",{attrs:{href:"https://github.com/ashtuchkin/iconv-lite#supported-encodings",target:"_blank",rel:"noopener noreferrer"}},[e._v("(see supported encodings)"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"response-charset"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#response-charset"}},[e._v("#")]),e._v(" Response-Charset")]),e._v(" "),t("p",[e._v("Character map used for output. "),t("a",{attrs:{href:"https://github.com/ashtuchkin/iconv-lite#supported-encodings",target:"_blank",rel:"noopener noreferrer"}},[e._v("(see supported encodings)"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"max-parse-attempts"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#max-parse-attempts"}},[e._v("#")]),e._v(" Max-Parse-Attempts")]),e._v(" "),t("p",[e._v("Maximum number of lines that ezPAARSE will attempt to parse in order to check the log format.")]),e._v(" "),t("h3",{attrs:{id:"clean-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clean-only"}},[e._v("#")]),e._v(" Clean-Only")]),e._v(" "),t("p",[e._v("If set to "),t("code",[e._v("true")]),e._v(", ezPAARSE will just filter out the lines we are sure are irrelevant and output only the relevant ones.\nThe goal when using this parameter is to reduce the size of the log file, if you need to store it for further treatment.")]),e._v(" "),t("h4",{attrs:{id:"video-demonstration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#video-demonstration"}},[e._v("#")]),e._v(" Video Demonstration")]),e._v(" "),t("p",[e._v("This "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=I3D6lO4wDZo",target:"_blank",rel:"noopener noreferrer"}},[e._v("screencast"),t("OutboundLink")],1),e._v(" demonstrates the usage of the Clean-Only parameter (ie the cleaning of a log file for size reduction and ease of storage)")]),e._v(" "),t("h3",{attrs:{id:"force-parser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#force-parser"}},[e._v("#")]),e._v(" Force-Parser")]),e._v(" "),t("p",[e._v("If URLs don't have a "),t("code",[e._v("domain")]),e._v(" part, use this parameter to force the right parser to be used. Useful for Open Access logs analysis, which don't have a domain part in the URL (all URLs comes from the same domain).")]),e._v(" "),t("p",[e._v("Example:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("Force-Parser: 'dspace'\n")])])]),t("p",[e._v("Can be used in conjonction with "),t("a",{attrs:{href:"#force-ecfield-publisher"}},[e._v("Force-ECField-Publisher")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"geoip"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#geoip"}},[e._v("#")]),e._v(" Geoip")]),e._v(" "),t("p",[e._v("Listing of the geolocation informations to be added to the results. By default "),t("code",[e._v("geoip-longitude, geoip-latitude, geoip-country")]),e._v(". "),t("code",[e._v("all")]),e._v(" can be used to include every fiel available, or "),t("code",[e._v("none")]),e._v(" to deactivate geolocation altogether. "),t("RouterLink",{attrs:{to:"/features/geolocalisation.html"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"ezpaarse-job-notifications"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-job-notifications"}},[e._v("#")]),e._v(" ezPAARSE-Job-Notifications")]),e._v(" "),t("p",[e._v("Listing of notifications to send when treatment is done, written as "),t("code",[e._v("action")]),e._v(" and separated by commas. Currently available: "),t("code",[e._v("mail")])]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-middlewares"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-middlewares"}},[e._v("#")]),e._v(" ezPAARSE-Middlewares")]),e._v(" "),t("p",[e._v("Insert a list of middlewares that are not present in the base configuration ("),t("code",[e._v("EZPAARSE_MIDDLEWARES")]),e._v("). The value must be a list of middleware names separated with commas, in the order of use.")]),e._v(" "),t("p",[e._v("By default, they will be inserted at the end of the chain, before "),t("code",[e._v("qualifier")]),e._v(". You can prefix the list with the mention "),t("code",[e._v("(before )")]),e._v(" or "),t("code",[e._v("(after )")]),e._v(" to insert them at a more specific place, or "),t("code",[e._v("(only)")]),e._v(" to only use the middlewares you want.")]),e._v(" "),t("p",[e._v("["),t("code",[e._v("v3.7.0")]),e._v(" and above]"),t("br"),e._v("\nIf you need to insert middlewares at different places, you can declare multiple lists separated with "),t("code",[e._v("|")]),e._v(" (see the example below).")]),e._v(" "),t("h4",{attrs:{id:"examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': 'user-agent-parser, sudoc'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(before istex) user-agent-parser'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(after sudoc) hal, istex'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(only) crossref'\n")])])]),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Middlewares': '(after deduplicator) crossref | (before geolocalizer) host-chain'\n")])])]),t("h3",{attrs:{id:"ezpaarse-enrich"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-enrich"}},[e._v("#")]),e._v(" ezPAARSE-Enrich")]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("false")]),e._v(" to deactivate data enrichment (geoip and knowledge bases). Any other value will leave the data enrichment active.")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-predefined-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-predefined-settings"}},[e._v("#")]),e._v(" ezPAARSE-Predefined-Settings")]),e._v(" "),t("p",[e._v("Tells ezPAARSE to use a predefined set of parameters. For example: "),t("code",[e._v("inist")]),e._v(" for INIST-CNRS parameters.")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-filter-redirects"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-filter-redirects"}},[e._v("#")]),e._v(" ezPAARSE-Filter-Redirects")]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("false")]),e._v(" to prevent lines with HTTP status codes 301, 302 from being filtered and discarded.")]),e._v(" "),t("h3",{attrs:{id:"ezpaarse-filter-status"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-filter-status"}},[e._v("#")]),e._v(" ezPAARSE-Filter-Status")]),e._v(" "),t("p",[e._v("Set to "),t("code",[e._v("false")]),e._v(" to disable filtering on status codes, or provide a comma-separated list of status codes that should be kept.\nIf you provide your own list, ECs with a status of "),t("code",[e._v("401")]),e._v(" or "),t("code",[e._v("403")]),e._v(" won't be marked as denied, and will be present in the main result file.")]),e._v(" "),t("h4",{attrs:{id:"example"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[e._v("#")]),e._v(" Example")]),e._v(" "),t("p",[e._v("Only keep status 200, 201 and 403")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'ezPAARSE-Filter-Status': '200,201,403'\n")])])]),t("h3",{attrs:{id:"disable-filters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-filters"}},[e._v("#")]),e._v(" Disable-Filters")]),e._v(" "),t("p",[e._v("Disable filters applying to robots or arbitrary hosts/domains. (defaults to "),t("code",[e._v("none")]),e._v(").\nPossible values (separated by commas): "),t("code",[e._v("robots")]),e._v(", "),t("code",[e._v("ignored-hosts")]),e._v(", "),t("code",[e._v("ignored-domains")]),e._v(".\nSet to "),t("code",[e._v("all")]),e._v(" to disable all above filters.")]),e._v(" "),t("p",[t("strong",[e._v("NB")]),e._v(": when robots are not filtered, add the "),t("code",[e._v("robot")]),e._v(" field to the output in order to know which consultations were made by robots.")]),e._v(" "),t("h3",{attrs:{id:"force-ecfield-publisher"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#force-ecfield-publisher"}},[e._v("#")]),e._v(" Force-ECField-Publisher")]),e._v(" "),t("p",[e._v("Set the publisher_name field to a predefined value.\nFor example: Force-ECField-Publisher: 'IRevues'.")]),e._v(" "),t("h3",{attrs:{id:"session-id-fields"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#session-id-fields"}},[e._v("#")]),e._v(" Session-ID-Fields")]),e._v(" "),t("p",[e._v("Change the fields used to generate session IDs and user IDs. By default, the generator uses either "),t("code",[e._v("login")]),e._v(", "),t("code",[e._v("cookie")]),e._v(", or a combination of "),t("code",[e._v("host")]),e._v(" and "),t("code",[e._v("user-agent")]),e._v(", and store the generated IDs in "),t("code",[e._v("session_id")]),e._v(" and "),t("code",[e._v("user_id")]),e._v(". You can customize those fields by providing a mapping separated by commas.")]),e._v(" "),t("p",[e._v("Default mapping :")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" user: login, cookie: cookie, host: host, useragent: user-agent, session: session_id, userid: user_id\n")])])]),t("p",[e._v("If your user login is in the "),t("code",[e._v("user_login")]),e._v(" field :")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" user: user_login\n")])])]),t("h3",{attrs:{id:"extract"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#extract"}},[e._v("#")]),e._v(" Extract")]),e._v(" "),t("p",[e._v("Extract values from a field and dispatch them in new fields. The syntax is the following : "),t("code",[e._v("source_field => extract_expression => destination_fields")])]),e._v(" "),t("h4",{attrs:{id:"examples-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples-2"}},[e._v("#")]),e._v(" Examples:")]),e._v(" "),t("p",[e._v("The following examples assume we have a "),t("strong",[e._v("login")]),e._v(" field with the value "),t("strong",[e._v("THEODORE_MCCLURE")]),e._v(". Here are multiple ways to create a "),t("strong",[e._v("firstname")]),e._v(" field containing "),t("strong",[e._v("THEODORE")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" field containing "),t("strong",[e._v("MCCLURE")]),e._v(".")]),e._v(" "),t("h5",{attrs:{id:"extracting-with-a-regular-expression"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#extracting-with-a-regular-expression"}},[e._v("#")]),e._v(" Extracting with a regular expression:")]),e._v(" "),t("p",[e._v("If the extract expression is a regular expression (between slashes, with optional flags after the closing slash), it's applied to the source field and the captured groups are stored in the destination fields.")]),e._v(" "),t("p",[e._v("The following expression applies the regular expression "),t("code",[e._v("/^([a-z]+)_([a-z]+)$/i")]),e._v(" on the "),t("strong",[e._v("login")]),e._v(" field, and puts the captured groups in the "),t("strong",[e._v("firstname")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" fields.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" login => /^([a-z]+)_([a-z]+)$/i => firstname,lastname\n")])])]),t("h5",{attrs:{id:"splitting-over-an-expression"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#splitting-over-an-expression"}},[e._v("#")]),e._v(" Splitting over an expression:")]),e._v(" "),t("p",[e._v("If the extract expression is "),t("strong",[e._v("split()")]),e._v(", then the source field will be splitted according to the expression between the parentheses.")]),e._v(" "),t("p",[e._v("The following splits the "),t("strong",[e._v("login")]),e._v(" field with the character "),t("code",[e._v("\\_")]),e._v(" and puts the parts in the "),t("strong",[e._v("firstname")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" fields.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'Extract': 'login => split(_) => firstname,lastname'\n")])])]),t("p",[e._v("The following splits the "),t("strong",[e._v("login")]),e._v(" field with the regular expression "),t("code",[e._v("/[\\_]+/")]),e._v(" and puts the parts in the "),t("strong",[e._v("firstname")]),e._v(" and "),t("strong",[e._v("lastname")]),e._v(" fields.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("'Extract': 'login => split(/[_]+/) => firstname,lastname'\n")])])]),t("h2",{attrs:{id:"metadata-enrichment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#metadata-enrichment"}},[e._v("#")]),e._v(" Metadata enrichment")]),e._v(" "),t("p",[e._v("The use of middlewares to enrich access events with metadata coming from external APIs is controlled by headers.")]),e._v(" "),t("h3",{attrs:{id:"crossref"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crossref"}},[e._v("#")]),e._v(" Crossref")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-crossref-middleware-call"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"sudoc"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sudoc"}},[e._v("#")]),e._v(" Sudoc")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-sudoc-middleware-call"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"hal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hal"}},[e._v("#")]),e._v(" HAL")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-hal-middleware-call"}},[e._v("(More information)")])],1),e._v(" "),t("h3",{attrs:{id:"istex"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#istex"}},[e._v("#")]),e._v(" ISTEX")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/features/metadata-enrichment.html#configuring-istex-middleware-call"}},[e._v("(More information)")])],1)])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/62.198c71df.js b/assets/js/62.4c85a727.js similarity index 99% rename from assets/js/62.198c71df.js rename to assets/js/62.4c85a727.js index 32c95b56..4164b57d 100644 --- a/assets/js/62.198c71df.js +++ b/assets/js/62.4c85a727.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{380:function(t,a,s){"use strict";s.r(a);var e=s(10),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"administration-api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#administration-api"}},[t._v("#")]),t._v(" Administration API")]),t._v(" "),a("p",[t._v("Every function listed in this page may be used directly from the administration section in the application.")]),t._v(" "),a("h2",{attrs:{id:"create-an-administrator"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-an-administrator"}},[t._v("#")]),t._v(" Create an administrator")]),t._v(" "),a("p",[t._v("If no user has been registered yet, any attempt to connect triggers an admin creation form.")]),t._v(" "),a("p",[t._v("To create an administrator account without the help of the form, please use the following route :\n"),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/register")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td",[t._v("userid (valid mail address), password, confirm (password confirmation)")])])])]),t._v(" "),a("h4",{attrs:{id:"possible-outputs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("201 Created")]),t._v(" : The admin has been created.")]),t._v(" "),a("li",[a("strong",[t._v("400 Bad Request")]),t._v(" : Missing parameter.")]),t._v(" "),a("li",[a("strong",[t._v("409 Conflict")]),t._v(" : There's already an admin.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Creation failed.")])]),t._v(" "),a("h4",{attrs:{id:"exemple-curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"userid=foo@foo.fr&password=bar&confirm=bar"')]),t._v(" http://localhost:59599/api/admin/register\n")])])]),a("h2",{attrs:{id:"get-running-jobs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-running-jobs"}},[t._v("#")]),t._v(" Get running jobs")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/jobs")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td")])]),t._v(" "),a("p",[t._v("Outputs a JSON table with the IDs of the jobs that are currently running.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-2"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" GET "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/jobs\n")])])]),a("h2",{attrs:{id:"users-management"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#users-management"}},[t._v("#")]),t._v(" Users management")]),t._v(" "),a("h3",{attrs:{id:"list-users"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#list-users"}},[t._v("#")]),t._v(" List users")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td")])]),t._v(" "),a("p",[t._v("Outputs a JSON table with the complete list of users.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-3"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" GET "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/users\n")])])]),a("h3",{attrs:{id:"add-a-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#add-a-user"}},[t._v("#")]),t._v(" Add a user")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users/")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td",[t._v("userid (valid mail address), password, group (defaults to 'user', set to 'admin' to create an administrator)")])])]),t._v(" "),a("h4",{attrs:{id:"possible-outputs-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs-2"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("201 Created")]),t._v(" : User has been created.")]),t._v(" "),a("li",[a("strong",[t._v("400 Bad Request")]),t._v(" : Missing parameter.")]),t._v(" "),a("li",[a("strong",[t._v("409 Conflict")]),t._v(" : User name already exists.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Creation failed.")])]),t._v(" "),a("p",[t._v("When the creation succeeds, the output contains a complete information about the user in JSON format.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-4"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"userid=foo@foo.net&password=bar&group=user"')]),t._v(" http://localhost:59599/api/admin/users/\n")])])]),a("h3",{attrs:{id:"update-a-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-a-user"}},[t._v("#")]),t._v(" Update a user ###")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users/{username}")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td",[t._v("username (valid mail address), group")])])]),t._v(" "),a("h4",{attrs:{id:"possible-outputs-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs-3"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : User updated.")]),t._v(" "),a("li",[a("strong",[t._v("400 Bad Request")]),t._v(" : Missing parameter.")]),t._v(" "),a("li",[a("strong",[t._v("404 Not Found")]),t._v(" : User not found.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Update failed.")])]),t._v(" "),a("p",[t._v("When the update succeeds, the output contains the updated user in JSON format.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-5"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"group=admin"')]),t._v(" http://localhost:59599/api/admin/users/foo@foo.net\n")])])]),a("h3",{attrs:{id:"delete-a-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#delete-a-user"}},[t._v("#")]),t._v(" Delete a user ###")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users/{username}")]),t._v(" "),a("td",[t._v("DELETE")]),t._v(" "),a("td")])]),t._v(" "),a("h4",{attrs:{id:"possible-output"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-output"}},[t._v("#")]),t._v(" Possible output")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("204 No Content")]),t._v(" : User has been deleted.")]),t._v(" "),a("li",[a("strong",[t._v("404 Not Found")]),t._v(" : User not found.")]),t._v(" "),a("li",[a("strong",[t._v("403 Forbidden")]),t._v(" : The admin has tried to delete the admin account.")])]),t._v(" "),a("h4",{attrs:{id:"example-curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" DELETE "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/users/foo@foo.net\n")])])]),a("h3",{attrs:{id:"reset-a-password"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#reset-a-password"}},[t._v("#")]),t._v(" Reset a password ###")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/passwords/{username}")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td")])]),t._v(" "),a("h4",{attrs:{id:"possible-output-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-output-2"}},[t._v("#")]),t._v(" Possible output")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : The password has been reset.")]),t._v(" "),a("li",[a("strong",[t._v("404 Not Found")]),t._v(" : User not found.")])]),t._v(" "),a("h4",{attrs:{id:"example-curl-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl-2"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" DELETE "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/users/foo@foo.net\n")])])]),a("h2",{attrs:{id:"repositories-update"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#repositories-update"}},[t._v("#")]),t._v(" Repositories update")]),t._v(" "),a("p",[t._v("The URLs below allow for updating the different parts of ezPAARSE.")]),t._v(" "),a("h3",{attrs:{id:"check-the-state-of-a-repository"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#check-the-state-of-a-repository"}},[t._v("#")]),t._v(" Check the state of a repository")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("What's updated")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/app/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Core software")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/platforms/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Platforms (Parsers, PKBs, scrapers)")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/middlewares/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Middlewares")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/resources/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Resources (predefined settings, default formats...)")])])]),t._v(" "),a("h4",{attrs:{id:"possible-feedbacks"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-feedbacks"}},[t._v("#")]),t._v(" Possible feedbacks")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : Checking normally completed.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Checking failed.")])]),t._v(" "),a("h4",{attrs:{id:"response-body"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#response-body"}},[t._v("#")]),t._v(" Response body")]),t._v(" "),a("p",[t._v("The server reply with a JSON response containing various things about the git status of the given repository.")]),t._v(" "),a("p",[t._v("Example:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"current"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2.9.4-4-g9089308"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Current commit description\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"head"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2.9.4-4-g9089308"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("HEAD")]),t._v(" commit description\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"tag"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2.9.4"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Current git "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("tag")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("latest tag before the current commit"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"from-head"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"uptodate"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # State "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("HEAD")]),t._v(" compared to "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("origin")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("can be "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uptodate'")]),t._v(" or "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'outdated'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"from-tag"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"upward"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # State "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),t._v(" current tag compared to "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("origin")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("can be "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uptodate'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'outdated'")]),t._v(" or "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'upward'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"local-commits"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Is there any unpushed local commit "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"local-changes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v(" # Is there any uncommited local changes "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h4",{attrs:{id:"example-curl-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl-3"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" GET "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/platforms/status\n")])])]),a("h3",{attrs:{id:"update-a-repository"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-a-repository"}},[t._v("#")]),t._v(" Update a repository")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/app/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Core software")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/platforms/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Platforms (Parsers, PKBs, scrapers)")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/middlewares/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Middlewares")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/resources/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Resources (predefined settings, default formats...)")])])]),t._v(" "),a("h4",{attrs:{id:"example-curl-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl-4"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" PUT "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/adminplatforms/status\n")])])]),a("h4",{attrs:{id:"possible-outputs-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs-4"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : Platforms have been updated")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Update failed.")])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{379:function(t,a,s){"use strict";s.r(a);var e=s(10),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"administration-api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#administration-api"}},[t._v("#")]),t._v(" Administration API")]),t._v(" "),a("p",[t._v("Every function listed in this page may be used directly from the administration section in the application.")]),t._v(" "),a("h2",{attrs:{id:"create-an-administrator"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-an-administrator"}},[t._v("#")]),t._v(" Create an administrator")]),t._v(" "),a("p",[t._v("If no user has been registered yet, any attempt to connect triggers an admin creation form.")]),t._v(" "),a("p",[t._v("To create an administrator account without the help of the form, please use the following route :\n"),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/register")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td",[t._v("userid (valid mail address), password, confirm (password confirmation)")])])])]),t._v(" "),a("h4",{attrs:{id:"possible-outputs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("201 Created")]),t._v(" : The admin has been created.")]),t._v(" "),a("li",[a("strong",[t._v("400 Bad Request")]),t._v(" : Missing parameter.")]),t._v(" "),a("li",[a("strong",[t._v("409 Conflict")]),t._v(" : There's already an admin.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Creation failed.")])]),t._v(" "),a("h4",{attrs:{id:"exemple-curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"userid=foo@foo.fr&password=bar&confirm=bar"')]),t._v(" http://localhost:59599/api/admin/register\n")])])]),a("h2",{attrs:{id:"get-running-jobs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-running-jobs"}},[t._v("#")]),t._v(" Get running jobs")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/jobs")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td")])]),t._v(" "),a("p",[t._v("Outputs a JSON table with the IDs of the jobs that are currently running.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-2"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" GET "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/jobs\n")])])]),a("h2",{attrs:{id:"users-management"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#users-management"}},[t._v("#")]),t._v(" Users management")]),t._v(" "),a("h3",{attrs:{id:"list-users"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#list-users"}},[t._v("#")]),t._v(" List users")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td")])]),t._v(" "),a("p",[t._v("Outputs a JSON table with the complete list of users.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-3"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" GET "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/users\n")])])]),a("h3",{attrs:{id:"add-a-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#add-a-user"}},[t._v("#")]),t._v(" Add a user")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users/")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td",[t._v("userid (valid mail address), password, group (defaults to 'user', set to 'admin' to create an administrator)")])])]),t._v(" "),a("h4",{attrs:{id:"possible-outputs-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs-2"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("201 Created")]),t._v(" : User has been created.")]),t._v(" "),a("li",[a("strong",[t._v("400 Bad Request")]),t._v(" : Missing parameter.")]),t._v(" "),a("li",[a("strong",[t._v("409 Conflict")]),t._v(" : User name already exists.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Creation failed.")])]),t._v(" "),a("p",[t._v("When the creation succeeds, the output contains a complete information about the user in JSON format.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-4"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"userid=foo@foo.net&password=bar&group=user"')]),t._v(" http://localhost:59599/api/admin/users/\n")])])]),a("h3",{attrs:{id:"update-a-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-a-user"}},[t._v("#")]),t._v(" Update a user ###")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Méthode")]),t._v(" "),a("th",[t._v("Paramètres")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users/{username}")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td",[t._v("username (valid mail address), group")])])]),t._v(" "),a("h4",{attrs:{id:"possible-outputs-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs-3"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : User updated.")]),t._v(" "),a("li",[a("strong",[t._v("400 Bad Request")]),t._v(" : Missing parameter.")]),t._v(" "),a("li",[a("strong",[t._v("404 Not Found")]),t._v(" : User not found.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Update failed.")])]),t._v(" "),a("p",[t._v("When the update succeeds, the output contains the updated user in JSON format.")]),t._v(" "),a("h4",{attrs:{id:"exemple-curl-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exemple-curl-5"}},[t._v("#")]),t._v(" Exemple curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" POST "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--proxy")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"group=admin"')]),t._v(" http://localhost:59599/api/admin/users/foo@foo.net\n")])])]),a("h3",{attrs:{id:"delete-a-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#delete-a-user"}},[t._v("#")]),t._v(" Delete a user ###")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/users/{username}")]),t._v(" "),a("td",[t._v("DELETE")]),t._v(" "),a("td")])]),t._v(" "),a("h4",{attrs:{id:"possible-output"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-output"}},[t._v("#")]),t._v(" Possible output")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("204 No Content")]),t._v(" : User has been deleted.")]),t._v(" "),a("li",[a("strong",[t._v("404 Not Found")]),t._v(" : User not found.")]),t._v(" "),a("li",[a("strong",[t._v("403 Forbidden")]),t._v(" : The admin has tried to delete the admin account.")])]),t._v(" "),a("h4",{attrs:{id:"example-curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" DELETE "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/users/foo@foo.net\n")])])]),a("h3",{attrs:{id:"reset-a-password"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#reset-a-password"}},[t._v("#")]),t._v(" Reset a password ###")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/passwords/{username}")]),t._v(" "),a("td",[t._v("POST")]),t._v(" "),a("td")])]),t._v(" "),a("h4",{attrs:{id:"possible-output-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-output-2"}},[t._v("#")]),t._v(" Possible output")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : The password has been reset.")]),t._v(" "),a("li",[a("strong",[t._v("404 Not Found")]),t._v(" : User not found.")])]),t._v(" "),a("h4",{attrs:{id:"example-curl-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl-2"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-v")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" DELETE "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/users/foo@foo.net\n")])])]),a("h2",{attrs:{id:"repositories-update"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#repositories-update"}},[t._v("#")]),t._v(" Repositories update")]),t._v(" "),a("p",[t._v("The URLs below allow for updating the different parts of ezPAARSE.")]),t._v(" "),a("h3",{attrs:{id:"check-the-state-of-a-repository"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#check-the-state-of-a-repository"}},[t._v("#")]),t._v(" Check the state of a repository")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("What's updated")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/app/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Core software")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/platforms/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Platforms (Parsers, PKBs, scrapers)")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/middlewares/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Middlewares")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/resources/status")]),t._v(" "),a("td",[t._v("GET")]),t._v(" "),a("td",[t._v("Resources (predefined settings, default formats...)")])])]),t._v(" "),a("h4",{attrs:{id:"possible-feedbacks"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-feedbacks"}},[t._v("#")]),t._v(" Possible feedbacks")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : Checking normally completed.")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Checking failed.")])]),t._v(" "),a("h4",{attrs:{id:"response-body"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#response-body"}},[t._v("#")]),t._v(" Response body")]),t._v(" "),a("p",[t._v("The server reply with a JSON response containing various things about the git status of the given repository.")]),t._v(" "),a("p",[t._v("Example:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"current"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2.9.4-4-g9089308"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Current commit description\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"head"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2.9.4-4-g9089308"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("HEAD")]),t._v(" commit description\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"tag"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2.9.4"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Current git "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("tag")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("latest tag before the current commit"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"from-head"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"uptodate"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # State "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("HEAD")]),t._v(" compared to "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("origin")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("can be "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uptodate'")]),t._v(" or "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'outdated'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"from-tag"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"upward"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # State "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),t._v(" current tag compared to "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("origin")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("can be "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uptodate'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'outdated'")]),t._v(" or "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'upward'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"local-commits"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" # Is there any unpushed local commit "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"local-changes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v(" # Is there any uncommited local changes "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h4",{attrs:{id:"example-curl-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl-3"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" GET "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/admin/platforms/status\n")])])]),a("h3",{attrs:{id:"update-a-repository"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-a-repository"}},[t._v("#")]),t._v(" Update a repository")]),t._v(" "),a("table",[a("tr",[a("th",{staticStyle:{"text-align":"left",width:"140px"}},[t._v("Path")]),t._v(" "),a("th",[t._v("Method")]),t._v(" "),a("th",[t._v("Parameters")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/app/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Core software")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/platforms/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Platforms (Parsers, PKBs, scrapers)")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/middlewares/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Middlewares")])]),t._v(" "),a("tr",[a("td",[t._v("/api/admin/resources/status")]),t._v(" "),a("td",[t._v("PUT")]),t._v(" "),a("td",[t._v("Resources (predefined settings, default formats...)")])])]),t._v(" "),a("h4",{attrs:{id:"example-curl-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-curl-4"}},[t._v("#")]),t._v(" Example curl")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-X")]),t._v(" PUT "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-u")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"admin:password"')]),t._v(" http://localhost:59599/api/adminplatforms/status\n")])])]),a("h4",{attrs:{id:"possible-outputs-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-outputs-4"}},[t._v("#")]),t._v(" Possible outputs")]),t._v(" "),a("ul",[a("li",[a("strong",[t._v("200 OK")]),t._v(" : Platforms have been updated")]),t._v(" "),a("li",[a("strong",[t._v("500 Internal Server Error")]),t._v(" : Update failed.")])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/63.13715b95.js b/assets/js/63.b9acfde7.js similarity index 99% rename from assets/js/63.13715b95.js rename to assets/js/63.b9acfde7.js index bb6960e1..41db0642 100644 --- a/assets/js/63.13715b95.js +++ b/assets/js/63.b9acfde7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{379:function(e,a,t){"use strict";t.r(a);var s=t(10),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"application-core"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#application-core"}},[e._v("#")]),e._v(" Application core")]),e._v(" "),a("p",[e._v("Developper-oriented documentation for ezPAARSE's core.\nThe documentation dedicated to contributions for parsers, pkbs and scrapers can be found in "),a("RouterLink",{attrs:{to:"/development/platforms.html"}},[e._v("this section")]),e._v(".")],1),e._v(" "),a("h2",{attrs:{id:"technologies-used-by-ezpaarse"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#technologies-used-by-ezpaarse"}},[e._v("#")]),e._v(" Technologies used by ezPAARSE")]),e._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"http://nodejs.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("nodejs"),a("OutboundLink")],1),e._v(" for the core of ezPAARSE (advanced streaming capabilities and performance).")]),e._v(" "),a("li",[a("a",{attrs:{href:"http://git-scm.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("git"),a("OutboundLink")],1),e._v(" to manage knowledge bases and source code.")])]),e._v(" "),a("h2",{attrs:{id:"how-does-the-ezpaarse-engine-work"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-does-the-ezpaarse-engine-work"}},[e._v("#")]),e._v(" How does the ezPAARSE engine work?")]),e._v(" "),a("p",[e._v("Simplified schemas of the "),a("a",{attrs:{href:"https://docs.google.com/drawings/d/14YFQ799U2005c62aivbGdEIDmsJOupN1ARvAwMT8Uys/edit?usp=sharing",target:"_blank",rel:"noopener noreferrer"}},[e._v("internal architecture"),a("OutboundLink")],1),e._v(" and "),a("a",{attrs:{href:"https://docs.google.com/drawings/d/1wckvIv9BmLXT758xALE9qmNfFYBiFUwzF0F9gHjndCk/edit?usp=sharing",target:"_blank",rel:"noopener noreferrer"}},[e._v("general architecture"),a("OutboundLink")],1),e._v(" are also available.")]),e._v(" "),a("img",{attrs:{src:e.$withBase("/images/ezPAARSE-Moteur.png"),alt:"ezpaarse's engine working Schema"}}),e._v(" "),a("h2",{attrs:{id:"ezpaarse-s-monitoring"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-s-monitoring"}},[e._v("#")]),e._v(" ezPAARSE's monitoring")]),e._v(" "),a("p",[e._v("The following options can be used to run ezPAARSE.")]),e._v(" "),a("ul",[a("li",[a("code",[e._v("--memory")]),e._v(": shows the memory consumption of the ezPAARSE process every 5 seconds")]),e._v(" "),a("li",[a("code",[e._v("--lsof")]),e._v(": displays the number of open file descriptors every 5 seconds")])]),e._v(" "),a("p",[e._v("Example :")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./bin/env\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("node")]),e._v(" app.js "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--memory")]),e._v("\n")])])]),a("h2",{attrs:{id:"launching-the-ezpaarse-s-unit-tests"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#launching-the-ezpaarse-s-unit-tests"}},[e._v("#")]),e._v(" Launching the ezPAARSE's unit tests")]),e._v(" "),a("p",[e._v("Use the makefile to launch the tests:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("make")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),a("p",[e._v("To test a specific function, use mocha and indicate the path of the test file as a parameter")]),e._v(" "),a("p",[e._v("Eg for testing custom formats:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./bin/env\nmocha ./test/custom-formats-test\n")])])]),a("p",[e._v("To perform only one functionality test, use mocha and set the path of the test file as a parameter and then specify (with "),a("code",[e._v("-g")]),e._v(") the test number (two figures) like "),a("code",[e._v("@xx")]),e._v(".")]),e._v(" "),a("p",[e._v("For example, for the second test about the custom formats:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./bin/env\nmocha ./test/custom-formats-test "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" @02\n")])])]),a("h2",{attrs:{id:"generate-a-new-ezpaarse-version"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#generate-a-new-ezpaarse-version"}},[e._v("#")]),e._v(" Generate a new ezPAARSE version")]),e._v(" "),a("p",[e._v("To generate a new version of ezPAARSE you need to be member of the ezPAARSE Team.")]),e._v(" "),a("p",[e._v("If you are not a member, you can submit a "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse/pulls",target:"_blank",rel:"noopener noreferrer"}},[e._v("pull request on github"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("p",[e._v("For the ezPAARSE Team:")]),e._v(" "),a("ul",[a("li",[e._v("Check you are on the master version or run a "),a("code",[e._v("git checkout master")])]),e._v(" "),a("li",[e._v("Use npm to generate the new version by using the appropriate options to tag the version")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" version "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("newversion"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" major "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" minor "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" patch "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" premajor "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" preminor "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" prepatch "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" prerelease "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" from-git"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n")])])]),a("p",[e._v("Example :")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" version patch\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--tags")]),e._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{381:function(e,a,t){"use strict";t.r(a);var s=t(10),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"application-core"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#application-core"}},[e._v("#")]),e._v(" Application core")]),e._v(" "),a("p",[e._v("Developper-oriented documentation for ezPAARSE's core.\nThe documentation dedicated to contributions for parsers, pkbs and scrapers can be found in "),a("RouterLink",{attrs:{to:"/development/platforms.html"}},[e._v("this section")]),e._v(".")],1),e._v(" "),a("h2",{attrs:{id:"technologies-used-by-ezpaarse"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#technologies-used-by-ezpaarse"}},[e._v("#")]),e._v(" Technologies used by ezPAARSE")]),e._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"http://nodejs.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("nodejs"),a("OutboundLink")],1),e._v(" for the core of ezPAARSE (advanced streaming capabilities and performance).")]),e._v(" "),a("li",[a("a",{attrs:{href:"http://git-scm.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("git"),a("OutboundLink")],1),e._v(" to manage knowledge bases and source code.")])]),e._v(" "),a("h2",{attrs:{id:"how-does-the-ezpaarse-engine-work"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-does-the-ezpaarse-engine-work"}},[e._v("#")]),e._v(" How does the ezPAARSE engine work?")]),e._v(" "),a("p",[e._v("Simplified schemas of the "),a("a",{attrs:{href:"https://docs.google.com/drawings/d/14YFQ799U2005c62aivbGdEIDmsJOupN1ARvAwMT8Uys/edit?usp=sharing",target:"_blank",rel:"noopener noreferrer"}},[e._v("internal architecture"),a("OutboundLink")],1),e._v(" and "),a("a",{attrs:{href:"https://docs.google.com/drawings/d/1wckvIv9BmLXT758xALE9qmNfFYBiFUwzF0F9gHjndCk/edit?usp=sharing",target:"_blank",rel:"noopener noreferrer"}},[e._v("general architecture"),a("OutboundLink")],1),e._v(" are also available.")]),e._v(" "),a("img",{attrs:{src:e.$withBase("/images/ezPAARSE-Moteur.png"),alt:"ezpaarse's engine working Schema"}}),e._v(" "),a("h2",{attrs:{id:"ezpaarse-s-monitoring"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ezpaarse-s-monitoring"}},[e._v("#")]),e._v(" ezPAARSE's monitoring")]),e._v(" "),a("p",[e._v("The following options can be used to run ezPAARSE.")]),e._v(" "),a("ul",[a("li",[a("code",[e._v("--memory")]),e._v(": shows the memory consumption of the ezPAARSE process every 5 seconds")]),e._v(" "),a("li",[a("code",[e._v("--lsof")]),e._v(": displays the number of open file descriptors every 5 seconds")])]),e._v(" "),a("p",[e._v("Example :")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./bin/env\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("node")]),e._v(" app.js "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--memory")]),e._v("\n")])])]),a("h2",{attrs:{id:"launching-the-ezpaarse-s-unit-tests"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#launching-the-ezpaarse-s-unit-tests"}},[e._v("#")]),e._v(" Launching the ezPAARSE's unit tests")]),e._v(" "),a("p",[e._v("Use the makefile to launch the tests:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("make")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),a("p",[e._v("To test a specific function, use mocha and indicate the path of the test file as a parameter")]),e._v(" "),a("p",[e._v("Eg for testing custom formats:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./bin/env\nmocha ./test/custom-formats-test\n")])])]),a("p",[e._v("To perform only one functionality test, use mocha and set the path of the test file as a parameter and then specify (with "),a("code",[e._v("-g")]),e._v(") the test number (two figures) like "),a("code",[e._v("@xx")]),e._v(".")]),e._v(" "),a("p",[e._v("For example, for the second test about the custom formats:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./bin/env\nmocha ./test/custom-formats-test "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" @02\n")])])]),a("h2",{attrs:{id:"generate-a-new-ezpaarse-version"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#generate-a-new-ezpaarse-version"}},[e._v("#")]),e._v(" Generate a new ezPAARSE version")]),e._v(" "),a("p",[e._v("To generate a new version of ezPAARSE you need to be member of the ezPAARSE Team.")]),e._v(" "),a("p",[e._v("If you are not a member, you can submit a "),a("a",{attrs:{href:"https://github.com/ezpaarse-project/ezpaarse/pulls",target:"_blank",rel:"noopener noreferrer"}},[e._v("pull request on github"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("p",[e._v("For the ezPAARSE Team:")]),e._v(" "),a("ul",[a("li",[e._v("Check you are on the master version or run a "),a("code",[e._v("git checkout master")])]),e._v(" "),a("li",[e._v("Use npm to generate the new version by using the appropriate options to tag the version")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" version "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("newversion"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" major "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" minor "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" patch "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" premajor "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" preminor "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" prepatch "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" prerelease "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" from-git"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n")])])]),a("p",[e._v("Example :")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" version patch\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--tags")]),e._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/64.fc785f26.js b/assets/js/64.4a12aa64.js similarity index 99% rename from assets/js/64.fc785f26.js rename to assets/js/64.4a12aa64.js index aeea55f6..285ced1a 100644 --- a/assets/js/64.fc785f26.js +++ b/assets/js/64.4a12aa64.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{382:function(e,t,a){"use strict";a.r(t);var s=a(10),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"documentation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#documentation"}},[e._v("#")]),e._v(" Documentation")]),e._v(" "),t("p",[e._v("The documentation you are reading just now is powered by "),t("a",{attrs:{href:"https://vuepress.vuejs.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Vuepress"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#development"}},[e._v("#")]),e._v(" Development")]),e._v(" "),t("p",[e._v("You can run a live server with the following command :")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" run docs:dev\n")])])]),t("p",[e._v("Then visit "),t("a",{attrs:{href:"http://localhost:8080/",target:"_blank",rel:"noopener noreferrer"}},[e._v("http://localhost:8080/"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"deployment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#deployment"}},[e._v("#")]),e._v(" Deployment")]),e._v(" "),t("p",[e._v("To generate static assets, run :")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" run docs:build\n")])])]),t("p",[e._v("The documentation is generated in "),t("code",[e._v("doc/.vuepress/dist/")]),e._v(" and can be deployed to any static file server. However, please note that the base URL is "),t("code",[e._v("/ezpaarse/")]),e._v(", so you won't be able to serve it from root.")]),e._v(" "),t("p",[e._v("Any change to the "),t("code",[e._v("doc")]),e._v(" directory on the "),t("code",[e._v("master")]),e._v(" branch will automatically trigger a build and a deployment to "),t("code",[e._v("GitHub Pages")]),e._v(". This deployment workflow is achieved via "),t("code",[e._v("Github Actions")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[e._v("#")]),e._v(" Configuration")]),e._v(" "),t("p",[e._v("The Vuepress configuration is located in "),t("code",[e._v(".vuepress/config.js")]),e._v(". Head to this file if you need to update the "),t("code",[e._v("sidebar")]),e._v(", "),t("code",[e._v("menu")]),e._v(", "),t("code",[e._v("theme")]),e._v(", or any other option.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://vuepress.vuejs.org/config/",target:"_blank",rel:"noopener noreferrer"}},[e._v("More details"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"asssets-handling"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#asssets-handling"}},[e._v("#")]),e._v(" Asssets handling")]),e._v(" "),t("p",[e._v("Assets are stored in the "),t("code",[e._v(".vuepress/public")]),e._v(" directory. You can reference them using relative URLs.")]),e._v(" "),t("div",{staticClass:"language-markdown extra-class"},[t("pre",{pre:!0,attrs:{class:"language-markdown"}},[t("code",[t("span",{pre:!0,attrs:{class:"token tag"}},[t("span",{pre:!0,attrs:{class:"token tag"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("<")]),e._v("img")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token attr-name"}},[e._v(":src")]),t("span",{pre:!0,attrs:{class:"token attr-value"}},[t("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v('"')]),e._v("$withBase('/images/image.png')"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v('"')])]),e._v(" "),t("span",{pre:!0,attrs:{class:"token attr-name"}},[e._v("alt")]),t("span",{pre:!0,attrs:{class:"token attr-value"}},[t("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v('"')]),e._v("An image"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v('"')])]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("/>")])]),e._v("\n")])])]),t("p",[t("a",{attrs:{href:"https://vuepress.vuejs.org/guide/assets.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("More details"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"frontmatter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#frontmatter"}},[e._v("#")]),e._v(" Frontmatter")]),e._v(" "),t("p",[e._v("Markdown files can contain a YAML frontmatter block containing page-specific variables. You can set predefined variables to alter some page components (sidebar, title, previous and next buttons...), or create your own. Those variables are available to use through the "),t("code",[e._v("$frontmatter")]),e._v(" variable.")]),e._v(" "),t("div",{staticClass:"language-markdown extra-class"},[t("pre",{pre:!0,attrs:{class:"language-markdown"}},[t("code",[t("span",{pre:!0,attrs:{class:"token front-matter-block"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("---")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token front-matter yaml language-yaml"}},[e._v("title: Blogging with VuePress\nlang: en-US")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("---")])]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token title important"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("#")]),e._v(" {{ $frontmatter.title }}")]),e._v("\n\nMy blog post is written in {{ $frontmatter.language }}.\n")])])]),t("p",[t("a",{attrs:{href:"https://vuepress.vuejs.org/guide/frontmatter.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("More details"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"using-vue-in-markdown"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-vue-in-markdown"}},[e._v("#")]),e._v(" Using Vue in Markdown")]),e._v(" "),t("p",[e._v("Any "),t("code",[e._v("*.vue")]),e._v(" file found in "),t("code",[e._v(".vuepress/components")]),e._v(" is automatically registered as a global component and can be used in Markdown files. Please note that components' name must be in "),t("code",[e._v("PascalCase")]),e._v(".")]),e._v(" "),t("p",[e._v("You can also define a page-specific Vue component by writting a "),t("code",[e._v(" + (opens new window)

# Config

# foo

  • Type: string
  • Default: /

# bar

  • Type: string
  • Default: /
+ diff --git a/configuration/config.html b/configuration/config.html index f24fc6a5..3232cb76 100644 --- a/configuration/config.html +++ b/configuration/config.html @@ -11,7 +11,7 @@ - + @@ -115,7 +115,7 @@ "activationThreshold": 1000, "unknownDomainsRate": 10 } -

The properties and their values are documented in further details in the relevant section (opens new window)

+

The properties and their values are documented in further details in the relevant section (opens new window)

← →

- + diff --git a/configuration/parametres.html b/configuration/parametres.html index 68b55f17..a371923f 100644 --- a/configuration/parametres.html +++ b/configuration/parametres.html @@ -11,7 +11,7 @@ - + @@ -48,7 +48,7 @@

# Extract

Extract values from a field and dispatch them in new fields. The syntax is the following : source_field => extract_expression => destination_fields

# Examples:

The following examples assume we have a login field with the value THEODORE_MCCLURE. Here are multiple ways to create a firstname field containing THEODORE and lastname field containing MCCLURE.

# Extracting with a regular expression:

If the extract expression is a regular expression (between slashes, with optional flags after the closing slash), it's applied to the source field and the captured groups are stored in the destination fields.

The following expression applies the regular expression /^([a-z]+)_([a-z]+)$/i on the login field, and puts the captured groups in the firstname and lastname fields.

  login => /^([a-z]+)_([a-z]+)$/i => firstname,lastname
# Splitting over an expression:

If the extract expression is split(), then the source field will be splitted according to the expression between the parentheses.

The following splits the login field with the character \_ and puts the parts in the firstname and lastname fields.

'Extract': 'login => split(_) => firstname,lastname'

The following splits the login field with the regular expression /[\_]+/ and puts the parts in the firstname and lastname fields.

'Extract': 'login => split(/[_]+/) => firstname,lastname'
-

# Metadata enrichment

The use of middlewares to enrich access events with metadata coming from external APIs is controlled by headers.

# Crossref

(More information)

# Sudoc

(More information)

# HAL

(More information)

# ISTEX

(More information)

+

# Metadata enrichment

The use of middlewares to enrich access events with metadata coming from external APIs is controlled by headers.

# Crossref

(More information)

# Sudoc

(More information)

# HAL

(More information)

# ISTEX

(More information)

← →

- + diff --git a/development/admin.html b/development/admin.html index 24966d0c..efd4ee5d 100644 --- a/development/admin.html +++ b/development/admin.html @@ -11,7 +11,7 @@ - + @@ -46,7 +46,7 @@ }

# Example curl

curl -X GET -u "admin:password" http://localhost:59599/api/admin/platforms/status

# Update a repository

Path Method Parameters
/api/admin/app/status PUT Core software
/api/admin/platforms/status PUT Platforms (Parsers, PKBs, scrapers)
/api/admin/middlewares/status PUT Middlewares
/api/admin/resources/status PUT Resources (predefined settings, default formats...)

# Example curl

curl -X PUT -u "admin:password" http://localhost:59599/api/adminplatforms/status
-

# Possible outputs

+

# Possible outputs

← →

- + diff --git a/development/core.html b/development/core.html index add3c2ad..95660a46 100644 --- a/development/core.html +++ b/development/core.html @@ -11,7 +11,7 @@ - + @@ -39,7 +39,7 @@

Example :

npm version patch
 git push
 git push --tags
-

+

← →

- + diff --git a/development/doc.html b/development/doc.html index 39cb7b5d..321146fc 100644 --- a/development/doc.html +++ b/development/doc.html @@ -11,7 +11,7 @@ - + @@ -38,7 +38,7 @@ # {{ $frontmatter.title }} My blog post is written in {{ $frontmatter.language }}. -

More details (opens new window)

# Using Vue in Markdown

Any *.vue file found in .vuepress/components is automatically registered as a global component and can be used in Markdown files. Please note that components' name must be in PascalCase.

You can also define a page-specific Vue component by writting a <script> or <style> tag in the Markdown file.

More details (opens new window)

+

More details (opens new window)

# Using Vue in Markdown

Any *.vue file found in .vuepress/components is automatically registered as a global component and can be used in Markdown files. Please note that components' name must be in PascalCase.

You can also define a page-specific Vue component by writting a <script> or <style> tag in the Markdown file.

More details (opens new window)

← →

- + diff --git a/development/makefile.html b/development/makefile.html index bc58e0eb..985035a1 100644 --- a/development/makefile.html +++ b/development/makefile.html @@ -11,7 +11,7 @@ - + @@ -33,7 +33,7 @@

Runs all the non-regression tests. It is a simple way to ensure that ezPAARSE is correctly working.

The test files are located in the test/ folder and all the filenames follow the pattern, finishing with -test.js.

Note : don't forget to restart the application if the source code has been modified.

make test-pkb

Checks that the knowledge base files used by the parsers are well formed and coherent.

make test-pkb-verbose

Checks that the knowledge base files used by the parsers are well formed and coherent with a detailed output.

# Checking coding rules

make lint
-

Checks the syntax of the javascript files with the eslint utility.

The coding rules can be modified with a configuration file (.eslintrc). All the options are documented on the ESLint page (opens new window).

+

Checks the syntax of the javascript files with the eslint utility.

The coding rules can be modified with a configuration file (.eslintrc). All the options are documented on the ESLint page (opens new window).

← →

- + diff --git a/development/middlewares.html b/development/middlewares.html index 42b65b82..4797ed61 100644 --- a/development/middlewares.html +++ b/development/middlewares.html @@ -11,7 +11,7 @@ - + @@ -81,7 +81,7 @@ }); }) }; -

+

← →

- + diff --git a/development/multilinguisme.html b/development/multilinguisme.html index 00f05a77..735459d7 100644 --- a/development/multilinguisme.html +++ b/development/multilinguisme.html @@ -11,7 +11,7 @@ - + @@ -27,7 +27,7 @@ Release Notes (opens new window) GitHub - (opens new window)

# Website languages

ezPAARSE is available in french and in english.

The vue-i18n (opens new window) Vue.js plugin was chosen because it integrates well with Vue.js (opens new window), used to generate the HTML pages of ezPAARSE.

The language files are located in the "client/locales" folder in the form of json files. Those filenames follow the pattern: country_code.json (eg: fr.json (opens new window) or en.json)

The language files contain series of keys. Each key is followed by a translation in the target language.

The context matches the name of the HTML page in which the label appears.

+ (opens new window)

# Website languages

ezPAARSE is available in french and in english.

The vue-i18n (opens new window) Vue.js plugin was chosen because it integrates well with Vue.js (opens new window), used to generate the HTML pages of ezPAARSE.

The language files are located in the "client/locales" folder in the form of json files. Those filenames follow the pattern: country_code.json (eg: fr.json (opens new window) or en.json)

The language files contain series of keys. Each key is followed by a translation in the target language.

The context matches the name of the HTML page in which the label appears.

← →

- + diff --git a/development/platforms.html b/development/platforms.html index 4f6d979e..3e9d75a7 100644 --- a/development/platforms.html +++ b/development/platforms.html @@ -11,7 +11,7 @@ - + @@ -76,7 +76,7 @@ For example, if you want to test the parsers for Nature and ScienceDirect:

make test sd npg

See the ezpaarse-platforms README (opens new window) for more information.

# Description of a parser

The parser is described by a manifest.json file, located in its root directory. This file contains the following information:

# Vendors' PKBs management principles

Knowledge bases are used to:

Knowledge bases are saved as text file KBART format (opens new window) and are specific to each platform. -The platform_AllTitles.txt file contains the mappings between identifiers of a specific platform and ISSN (or other standardized identifier). The KBART field called title_id is used to establish this correspondence with the print_identifier field (for paper resources) or online_identifier (electronic resources). The list of KBART fields (opens new window) and their meaning is available.

Knowledge bases are loaded by ezPAARSE and their structure must be previously controlled by the pkbvalidator tool

More about knowledge bases

+The platform_AllTitles.txt file contains the mappings between identifiers of a specific platform and ISSN (or other standardized identifier). The KBART field called title_id is used to establish this correspondence with the print_identifier field (for paper resources) or online_identifier (electronic resources). The list of KBART fields (opens new window) and their meaning is available.

Knowledge bases are loaded by ezPAARSE and their structure must be previously controlled by the pkbvalidator tool

More about knowledge bases

← →

- + diff --git a/development/routes.html b/development/routes.html index 30248ad4..797e4bee 100644 --- a/development/routes.html +++ b/development/routes.html @@ -11,7 +11,7 @@ - + @@ -48,7 +48,7 @@
Parameters: username, password /api/admin/platforms/status GET Reports on the platforms' state
Returns: uptodate or outdated /api/admin/platforms/status PUT Updates the platforms
The body must contain uptodate /api/admin/users GET Returns the list of local users /api/admin/users/ POST Creates a local user -
Parameters: username, password /api/admin/users/{username} DELETE Deletes a local user

+
Parameters: username, password /api/admin/users/{username} DELETE Deletes a local user

← →

- + diff --git a/development/tools.html b/development/tools.html index 9031744a..1e07329d 100644 --- a/development/tools.html +++ b/development/tools.html @@ -11,7 +11,7 @@ - + @@ -27,7 +27,7 @@ Release Notes (opens new window) GitHub - (opens new window)

# Ecosystem

# pkb-cleaner

Detects and deletes duplicates in the knowledge bases.

Usage: pkb-cleaner [-nvp] [DIR_TO_CLEAN]
+     (opens new window)    
 
# Ecosystem
 
# pkb-cleaner
 
Detects and deletes duplicates in the knowledge bases.
 
Usage: pkb-cleaner [-nvp] [DIR_TO_CLEAN]
 
 Options:
   --platform, -p   Name of a platform whose PKB should be cleaned.(if provided, ignore dir path)
@@ -121,56 +121,14 @@
   --silent, -s   If provided, no output generated.
   --csv, -c      If provided, the error-output will be a csv.
   --verbose, -v  show stats of checking.
-
# ezp process
 
Let you process one or more files with an instance of ezPAARSE. If no files are provided, the command will listen to stdin. The results are printed to stdout, unless you set an output file with --out.
 
Options:
-  --output, --out, -o       Output file
-  --header, --headers, -H   Add a header to the request (ex: "`Reject-Files: all`")
-  --download, -d            Download a file from the job directory
-  --verbose, -v             Shows detailed operations.
-  --settings, -s            Set a predefined setting.
-
Examples of use :
 
# Simple case, process ezproxy.log and write results to result.csv
-ezp process ezproxy.log --out result.csv
-
-# Same as above, and download the report file
-ezp process ezproxy.log --out result.csv --download job-report.html
-
-# Download the report file with a custom path
-ezp process ezproxy.log --out result.csv --download job-report.html:./reports/report.html
-
-# Reading from stdin and redirecting stdout to file
-cat ezproxy.log | ezp process > result.csv
-
# ezp bulk
 
Process files in sourceDir and save results in destDir. If destDir is not provided, results will be stored in sourceDir, aside the source files. When processing files recursively with the -r option, destDir will mimic the structure of sourceDir. Files will use the same or Files with existing results are skipped, unless the --force flag is set. By default, the result file and the job report are downloaded, but you can get additionnal files from the job directory by using the --download option.
 
Options:
-  --header, --headers, -H   Add a header to the request (ex: "`Reject-Files: all`")
-  --settings, -s            Set a predefined setting.
-  --recursive, -r           Look for log files into subdirectories
-  --download, -d            Download a file from the job directory
-  --overwrite, --force, -f  Overwrite existing files
-  --verbose, -v             Shows detailed operations.
-  --list, -l                Only list log files in the directory
-
Examples of use :
 
# Simple case, processing files recursively from ezproxy-logs and storing results in ezproxy-results
-ezp bulk -r ezproxy-logs/ ezproxy-results/
-
-# Activating reject files and downloading unqualified log lines along results
-ezp bulk -r ezproxy-logs/ ezproxy-results/ -H "Reject-Files: all" --download lines-unqualified-ecs.log
-
A result file (.ec.csv extension) and a report in HTML format (extension.report.html) are generated in the output directory for each log file. If the destination directory is not specified, they are generated in the same directory as the file being processed.
-If an error occurs when processing a file, the incomplete result file is named with the .ko extension.
-Rejects files are not retained by ezPAARSE.
 
Inject files to ezPAARSE (for batch purpose)
-  Usage: /home/yan/ezpaarse/bin/ecbulkmaker [-rflvH] SOURCE_DIR [RESULT_DIR]
-
-Options:
-  --recursive, -r  If provided, files in subdirectories will be processed. (preserves the file tree)
-  --list, -l       If provided, only list files.
-  --force, -f      override existing result (default false).
-  --header, -H     header parameter to use.
-  --verbose, -v    Shows detailed operations.
-
-
# Video Demonstration
 
This screencast (opens new window) demonstrates the usage of ecbulkmaker (ie process a directory containing log files and outputting a mirror directory with the results)
 
# hostlocalize
 
Enriches a csv result file containing a host name with the geolocation of the IP address
 
Example:
 
./hostlocalize -f ezpaarsedata.csv > ezpaarsedatalocalised.csv
+
# hostlocalize
 
Enriches a csv result file containing a host name with the geolocation of the IP address
 
Example:
 
./hostlocalize -f ezpaarsedata.csv > ezpaarsedatalocalised.csv
 
The input file is assumed to contain a field with the ip address for the location
 
Enrich a csv with geolocalisation from host ip.
   Usage: node ./bin/hostlocalize [-s] [-f string | -k string]
 
 Options:
   --hostkey, -k  the field name containing host ip (default "host").
   --file, -f     A csv file to parse. If absent, will read from standard input.
-
  

+

← →

- + diff --git a/development/tree.html b/development/tree.html index 40cf585a..919c9245 100644 --- a/development/tree.html +++ b/development/tree.html @@ -11,7 +11,7 @@ - + @@ -96,7 +96,7 @@ │   └── multiformat ├── tmp │   └── jobs -

+

← →

- + diff --git a/essential/ec-attributes.html b/essential/ec-attributes.html index df4829d2..d1fc749e 100644 --- a/essential/ec-attributes.html +++ b/essential/ec-attributes.html @@ -11,7 +11,7 @@ - + @@ -33,7 +33,7 @@ Description

# Resources Formats (mime)

The format of a resource allows to characterize the associated access event. It can take one of the values defined in the table below (loaded from the settings of ezPAARSE (opens new window)).

Code Description -

+

← →

- + diff --git a/essential/formats.html b/essential/formats.html index 162b35da..fec242b3 100644 --- a/essential/formats.html +++ b/essential/formats.html @@ -11,7 +11,7 @@ - + @@ -33,7 +33,7 @@
**or**
%{ezproxy-session}<[a-zA-Z0-9]+>

# Example of a request

curl -X POST --proxy "" --no-buffer -H 'Log-Format-ezproxy: %h %<[-]> %u [%t] "%r" %s %b' --data-binary @test/dataset/sd.2012-11-30.300.log  http://127.0.0.1:59599 -v

# Some concrete cases

Proxy Line type Possible format
EZproxy 80.80.80.80 - oBzrStkEVAeUDeA [20/Nov/2011:17:45:50 +0100] "GET http://www.sciencedirect.com:80/science/journal/aip/00121606 HTTP/1.1" 200 162009 %h %l %u %t "%r" %s %b
[18/Nov/2012:00:00:34 +0100] 40.30.25.122 40.30.25.122 5mpcyan6 http://link.springer.com:80/article/10.1007/s00262-008-0620-4/fulltext.html 116636 liV9RqGobWNKrdD %t %h %u %U %b %{session}
Apache 50.50.50.50 - uid=aaa2561c,ou=people,dc=uep-tlfy,dc=fr [27/Mar/2012:06:52:44 +0200] "GET /http/www.sciencedirect.com/science/article/pii/S1875389212003823 HTTP/1.1" 200 45022 "-" "Mozilla/5.0 (Windows NT 5.1) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.79 Safari/535.11" - %h %l %u %t "%r" %>s %b %<.\*>
Squid 1319061710.284 2102 90.90.90.90 TCP_MISS/200 309401 GET http://www.sciencedirect.com/science/article/pii/S0166218X11003477 cousteau DIRECT/198.81.200.2 text/html %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt
istproxy.inrialpes.fr:443 123.123.123.123 - tartempion [10/Apr/2012:09:38:21 +0200] "GET http://www.sciencedirect.com/science/article/pii/S0166218X11003477 HTTP/1.1" 302 20 "-" "Mozilla/5.0 (Windows NT 6.1; rv:11.0) Gecko/20100101 Firefox/11.0" %<A:%lp %>a %ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %<.\*>

# Video Demonstration

This screencast (opens new window) demonstrate how to use the GUI to discover the log file format in order to let ezPAARSE correctly process your log files

+ %h %l %u %t "%r" %>s %b %<.\*> Squid 1319061710.284 2102 90.90.90.90 TCP_MISS/200 309401 GET http://www.sciencedirect.com/science/article/pii/S0166218X11003477 cousteau DIRECT/198.81.200.2 text/html %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt istproxy.inrialpes.fr:443 123.123.123.123 - tartempion [10/Apr/2012:09:38:21 +0200] "GET http://www.sciencedirect.com/science/article/pii/S0166218X11003477 HTTP/1.1" 302 20 "-" "Mozilla/5.0 (Windows NT 6.1; rv:11.0) Gecko/20100101 Firefox/11.0" %<A:%lp %>a %ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %<.\*>

# Video Demonstration

This screencast (opens new window) demonstrate how to use the GUI to discover the log file format in order to let ezPAARSE correctly process your log files

← →

- + diff --git a/essential/knowledge-base.html b/essential/knowledge-base.html index d62129ac..0dba7ddd 100644 --- a/essential/knowledge-base.html +++ b/essential/knowledge-base.html @@ -11,7 +11,7 @@ - + @@ -28,7 +28,7 @@ (opens new window) GitHub (opens new window)

# Knowledge bases

# What is a knowledge base?

A PKB (read Publisher Knowledge Base) is simply an organized list making the link between normalized metadata (eg. ISSN, DOI, journal title, etc.) and proprietary resource identifier(s) used by a vendor.

A PKB is composed of one or more tab separed value (opens new window) text files that conforms to the KBART format (opens new window)

The KBART field named title_id represents the vendor's identifier that will be linked to a normalized identifier like print_identifier (very often: print ISSN) or online_identifier.

The KBART files used by ezPAARSE can contain additional non-KBART fields (that will be prefixed with pkb-, like: pkb-domain), depending on the richness of the metadata available.

In order to be taken in account by ezPAARSE, the PKB files need to respect the KBART standard file naming pattern: [ProviderName]_[Region/Consortium]_[PackageName]_[YYYY-MM-DD].txt, and be located in a folder named after the platform's parser.

For example:

  • cairn/cairn_ebooks_2014-02-13.txt
  • cairn/cairn_journals_part1_2014-02-13.txt

Warning : PKB identifiers must be unique. If an identifier appears more than once (in one or more PKB files), only one occurrence will be taken in account.

# How is a Knowledge Base used?

# ezPAARSE < 2.1.0

When a resource carrying a vendor identifier title_id is met, the associated knowledge base is built from the KBART files and loaded to memory. ezPAARSE can then link the proprietary identifier with all the metadata available and add it to the access event that has been generated.

# ezPAARSE since 2.1.0

As knowledge bases are growing and take too much RAM space, ezPAARSE stores them in a mongoDB database to query the metadata associated with the proprietary identifiers. For that purpose, ezPAARSE runs CastorJS (opens new window) in the background to keep the database and PKB files synchronized. This keeps the memory footprint of ezPAARSE at a minimum, but also requires additional startup time to perform the synchronization, especially on first startup.

Please note that processing logs without waiting for the initial synchronization to be over may result in incomplete enrichment of the access events.

Warning: some ezPAARSE output formats will force you to explicitely ask for some information you are interested in. If you don't, you will only get a minimal set of information as a result. This is the case with the CSV output. -Other output formats, like JSON, will automatically return all the data available.

+Other output formats, like JSON, will automatically return all the data available.

← →

- + diff --git a/essential/report.html b/essential/report.html index 8de9b5c1..79ba7f2f 100644 --- a/essential/report.html +++ b/essential/report.html @@ -11,7 +11,7 @@ - + @@ -82,7 +82,7 @@
HTTP Request size
status 200
HTTP code sent by the server when the resource is accessed
timestamp 1384816317title_id siteindex
Vendor identifier, as determined by the parser
unitid siteindex -
Unique identifier for the resource, as determined by the parser (used for deduplicating identical resources)
url http://www.nature.com:80/siteindex/index.html

# Unknown Domains

The unknown domains are domains for which no parser gets started. If URLs correspond to a provider's platform that should be analysed by ezPAARSE, you have to check on the Analogist platform analysis website (opens new window) if the platform is already listed and you will also get an indication of how advanced its analysis is.

+

Unique identifier for the resource, as determined by the parser (used for deduplicating identical resources)
url http://www.nature.com:80/siteindex/index.html

# Unknown Domains

The unknown domains are domains for which no parser gets started. If URLs correspond to a provider's platform that should be analysed by ezPAARSE, you have to check on the Analogist platform analysis website (opens new window) if the platform is already listed and you will also get an indication of how advanced its analysis is.

← →

- + diff --git a/essential/updates.html b/essential/updates.html index d2e62933..9f78c75f 100644 --- a/essential/updates.html +++ b/essential/updates.html @@ -11,7 +11,7 @@ - + @@ -33,7 +33,7 @@ It is also possible to update ezPAARSE directly from the GUI, see this screencast (opens new window) to learn more.

# Working materials

The following commands update the materials needed by ezPAARSE. There is one distinct command per material type, see comments.

make platforms-update   # update parsers, knowledge bases, scrapers
 make exclusions-update  # update the lists of hosts identified as robots
 make resources-update   # update predefined settings, default proxy formats
-

+

← →

- + diff --git a/features/alerts.html b/features/alerts.html index 50f9c950..6436f640 100644 --- a/features/alerts.html +++ b/features/alerts.html @@ -11,7 +11,7 @@ - + @@ -28,7 +28,7 @@ (opens new window) GitHub (opens new window)

# Alerts

# Principles

When you process log files with ezPAARSE, a number of processing indicators are generated:

  • number of log lines read,
  • number of rejected log line,
  • number of recognized platforms, etc.

Those indicators can be used to detect anomalies during the processing, based on figures considered as "normal".

# How to know if alerts have been generated?

The list of alerts is available in the processing report. If the mail notification is activated, you'll also receive this list with the email that is sent when the processing has completed.

NB: the activation of the alert system needs a sufficient quantity of relevant log lines. The activation threshold is set in the config.json file, with the activationThreshold key. It can also be modified with the Alerts-Activation-Threshold header.

# Available Alerts

# Unknown Domains

This alert is generated when a domain frequently appears in the log lines but no associated parser has been found. The appearence rate is calculated with the sum of relevant log lines.

  appearance_rate = appearance_sum / (total_of_loglines - ignored_lines) * 100
-

The activation threshold is set in the config.json file, with the unknownDomainsRate key. It can also be modified with the Alerts-Unknown-Domains-Rate header.

This alert simply means that ezPAARSE is not able to work for a certain amount of log lines you are providing it with. Most of the time, it is normal behavior because there is a lot more activity in logfiles that ezPAARSE is interested in.

+

The activation threshold is set in the config.json file, with the unknownDomainsRate key. It can also be modified with the Alerts-Unknown-Domains-Rate header.

This alert simply means that ezPAARSE is not able to work for a certain amount of log lines you are providing it with. Most of the time, it is normal behavior because there is a lot more activity in logfiles that ezPAARSE is interested in.

← →

- + diff --git a/features/doubleclick.html b/features/doubleclick.html index b98a458e..d0f535f3 100644 --- a/features/doubleclick.html +++ b/features/doubleclick.html @@ -11,7 +11,7 @@ - + @@ -34,7 +34,7 @@ -H 'Double-Click-PDF: 30'\ -H 'Double-Click-MISC: 40'\ http://127.0.0.1:59599 -

+

← →

- + diff --git a/features/exclusions.html b/features/exclusions.html index f125def2..26ec09aa 100644 --- a/features/exclusions.html +++ b/features/exclusions.html @@ -11,7 +11,7 @@ - + @@ -29,7 +29,7 @@ GitHub (opens new window)

# Bot Filtering & Unrelevant Domains

ezPAARSE uses various filters (opens new window) to reduce the noise generated by the many non-pertinent log lines that are present in a typical logfile and that can represent up to 80-90% of the lines.

# Excluding the Robots' Accesses

By default, a list of IP addresses is used to recognize and exclude the accesses made by robots (spiders, indexing robots, etc.)

The log lines generated by such accesses are thus rejected.

To complete the robots' list, you just have to create a file and place it in the exclusions folder. Its name has to start with robots., and must contain one IP address per line.

# Excluding Arbitrary IP Addresses

It is also possible to filter out some distinct IP addresses. The typical use case for this is when a training session takes place and you don't want to count those accesses: you declare the IP addresses for the computers used during the training session. -The matched lines are rejected in a different file from the robots rejects.

To complete this list, you just have to create a file in the exclusions folder and its name must start with hosts., and contain one IP address per line.

# The Unrelevant Domains

Accesses to proxied domains that are of no interest for you can be ignored by ezPAARSE. Because they are not relevant to the electronic ressources usage you need to trace, they will simply be filtered out and counted as ignored. This can help slim down the rate of rejected lines.

To complete this list of unrelevant domains, you just have to create a file in the exclusions folder and name it with the domains. prefix. It must contain only one IP address per line.

By default, we already provide you with three exclusion files :

  • domains.default.txt: containing a list of domains related to Google
  • domains.cdn.txt: containing a list of Content Delivery Networks (CDN (opens new window)) subdomains
  • domains.static.txt: containing a list of subdomains serving static resources (mostly images)

+The matched lines are rejected in a different file from the robots rejects.

To complete this list, you just have to create a file in the exclusions folder and its name must start with hosts., and contain one IP address per line.

# The Unrelevant Domains

Accesses to proxied domains that are of no interest for you can be ignored by ezPAARSE. Because they are not relevant to the electronic ressources usage you need to trace, they will simply be filtered out and counted as ignored. This can help slim down the rate of rejected lines.

To complete this list of unrelevant domains, you just have to create a file in the exclusions folder and name it with the domains. prefix. It must contain only one IP address per line.

By default, we already provide you with three exclusion files :

  • domains.default.txt: containing a list of domains related to Google
  • domains.cdn.txt: containing a list of Content Delivery Networks (CDN (opens new window)) subdomains
  • domains.static.txt: containing a list of subdomains serving static resources (mostly images)

← →

- + diff --git a/features/geolocalisation.html b/features/geolocalisation.html index a8bdfa51..1c33a5a2 100644 --- a/features/geolocalisation.html +++ b/features/geolocalisation.html @@ -11,7 +11,7 @@ - + @@ -40,7 +40,7 @@ -H 'Output-Fields: -doi,-identd,-url,-status,-size,+datetime' \ | csv2geojson --lat "geoip-latitude" --lon "geoip-longitude" --delimiter ";" 2> /dev/null \ | geojsonio -

That opens a web browser with the following graphical representation :

EDP Sciences Anonyme
# Video Demonstration

This screencast (opens new window) demonstrates the previous usage (ie geolocation information visualized on a map)

+

That opens a web browser with the following graphical representation :

EDP Sciences Anonyme
# Video Demonstration

This screencast (opens new window) demonstrates the previous usage (ie geolocation information visualized on a map)

← →

- + diff --git a/features/metadata-enrichment.html b/features/metadata-enrichment.html index f880a450..a93d1c02 100644 --- a/features/metadata-enrichment.html +++ b/features/metadata-enrichment.html @@ -11,7 +11,7 @@ - + @@ -29,7 +29,7 @@ GitHub (opens new window)

# Metadata enrichment

Middlewares can be used to enrich access events by querying external APIs. By default, ezPAARSE is configured for using 4 enrichment middlewares:

  • istex
  • crossref
  • sudoc
  • hal

For more details on middlewares, you can read the dedicated section.

# Important Caveats

# Accessing external APIs: availability, authorization

When sending requests to an external API, things can go wrong and ezPAARSE will stop working after 5 failures in a row.

Firstly, the API has to be available: if it is not the case, our advice is to wait a bit and launch an ezPAARSE job again.

Secondly, your ezPAARSE instance has to be authorized reaching out to the external API. -If you work behind a proxy (the proxy being at your institution level) it should be declared in your environment variables: you have to check that HTTP_PROXY and HTTPS_PROXY (and their lowercase counterparts) are known from the machine where your ezpaarse instance is installed. Once checked, you will have to restart your instance (make stop, then make start) so they are taken in account by the crossref middleware used by ezpaarse

Less probably, if your proxy is correctly declared in the environments variables but won't let the queries go out: there is a tweak to be made at the institution proxy level. You can correctly process logs as soon as the proxy is configured to let those queries go out.

# Impact on the Speed of Processing

Using those enrichment middlewares may slow the process down, as the number of queries is limited over time.

However, the results are temporarily cached in the mongoDB database, to prevent multiple occurrences of a document from generating further requests. The actual number of requests (i.e. excluding cached ones) is available in the report under general -> <middleware>-queries. Where <middleware> is the name of the middleware involved.

# Configuring Crossref Middleware Call

The Crossref middleware uses the DOI found in access events to request metadata using the node-crossref (opens new window) module.

# Headers

  • crossref-Enrich: set to false to disable crossref enrichment. Enabled by default.
  • crossref-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7)
  • crossref-throttle: minimum time to wait between queries, in milliseconds. Defaults to 200ms
  • crossref-paquet-size: maximum number of identifiers to send for query in a single request. Defaults to 50
  • crossref-buffer-size: maximum number of memorised access events before sending a request. Defaults to 1000
  • crossref-license: set to true to get the license field as JSON. Disabled by default.

# Configuring Sudoc Middleware Call

# Headers

  • sudoc-Enrich: set to true to enable Sudoc enrichment. Disabled by default.
  • sudoc-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
  • sudoc-Throttle : minimum time to wait between queries, in milliseconds. Defaults to 500.

# Configuring HAL Middleware Call

The HAL middleware uses the hal-identifier found in the access events to request metadata using the node-hal (opens new window)

# Headers

  • HAL-Enrich: set to true to enable HAL enrichment. Disabled by default.
  • HAL-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
  • HAL-Throttle: minimum time to wait between queries, in milliseconds. Defaults to 500.

# Configuring ISTEX Middleware Call

The ISTEX middleware uses the istex-identifier found in the access events to request metadata using the node-istex

ISTEX middleware is automatically activated on ISTEX logs

# Headers

  • istex-enrich : set to true to enable ISTEX enrichment. Disabled by default.
  • istex-ttl : lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
  • istex-throttle : minimum time to wait between queries, in milliseconds. Defaults to 500.

# Configuring Unpaywall Middleware Call

The Unpaywall middleware uses the DOI found in access events to request Open Acess metadata using the Unpaywall API. Limited to 100 000 DOIs per day.

# Headers

  • unpaywall-cache: set to false to disable result caching. Enabled by default.
  • unpaywall-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7)
  • unpaywall-throttle: minimum time to wait between each packet of queries, in milliseconds. Defaults to 100ms
  • unpaywall-paquet-size: maximum number of DOIs to request in parallel. Defaults to 10
  • unpaywall-buffer-size: maximum number of memorised access events before sending requests. Defaults to 200
  • unpaywall-email: the email to use for API calls. Defaults to YOUR_EMAIL.

+If you work behind a proxy (the proxy being at your institution level) it should be declared in your environment variables: you have to check that HTTP_PROXY and HTTPS_PROXY (and their lowercase counterparts) are known from the machine where your ezpaarse instance is installed. Once checked, you will have to restart your instance (make stop, then make start) so they are taken in account by the crossref middleware used by ezpaarse

Less probably, if your proxy is correctly declared in the environments variables but won't let the queries go out: there is a tweak to be made at the institution proxy level. You can correctly process logs as soon as the proxy is configured to let those queries go out.

# Impact on the Speed of Processing

Using those enrichment middlewares may slow the process down, as the number of queries is limited over time.

However, the results are temporarily cached in the mongoDB database, to prevent multiple occurrences of a document from generating further requests. The actual number of requests (i.e. excluding cached ones) is available in the report under general -> <middleware>-queries. Where <middleware> is the name of the middleware involved.

# Configuring Crossref Middleware Call

The Crossref middleware uses the DOI found in access events to request metadata using the node-crossref (opens new window) module.

# Headers

  • crossref-Enrich: set to false to disable crossref enrichment. Enabled by default.
  • crossref-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7)
  • crossref-throttle: minimum time to wait between queries, in milliseconds. Defaults to 200ms
  • crossref-paquet-size: maximum number of identifiers to send for query in a single request. Defaults to 50
  • crossref-buffer-size: maximum number of memorised access events before sending a request. Defaults to 1000
  • crossref-license: set to true to get the license field as JSON. Disabled by default.

# Configuring Sudoc Middleware Call

# Headers

  • sudoc-Enrich: set to true to enable Sudoc enrichment. Disabled by default.
  • sudoc-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
  • sudoc-Throttle : minimum time to wait between queries, in milliseconds. Defaults to 500.

# Configuring HAL Middleware Call

The HAL middleware uses the hal-identifier found in the access events to request metadata using the node-hal (opens new window)

# Headers

  • HAL-Enrich: set to true to enable HAL enrichment. Disabled by default.
  • HAL-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
  • HAL-Throttle: minimum time to wait between queries, in milliseconds. Defaults to 500.

# Configuring ISTEX Middleware Call

The ISTEX middleware uses the istex-identifier found in the access events to request metadata using the node-istex

ISTEX middleware is automatically activated on ISTEX logs

# Headers

  • istex-enrich : set to true to enable ISTEX enrichment. Disabled by default.
  • istex-ttl : lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
  • istex-throttle : minimum time to wait between queries, in milliseconds. Defaults to 500.

# Configuring Unpaywall Middleware Call

The Unpaywall middleware uses the DOI found in access events to request Open Acess metadata using the Unpaywall API. Limited to 100 000 DOIs per day.

# Headers

  • unpaywall-cache: set to false to disable result caching. Enabled by default.
  • unpaywall-TTL: lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7)
  • unpaywall-throttle: minimum time to wait between each packet of queries, in milliseconds. Defaults to 100ms
  • unpaywall-paquet-size: maximum number of DOIs to request in parallel. Defaults to 10
  • unpaywall-buffer-size: maximum number of memorised access events before sending requests. Defaults to 200
  • unpaywall-email: the email to use for API calls. Defaults to YOUR_EMAIL.

← →

- + diff --git a/features/outputfields.html b/features/outputfields.html index 49f06344..66ad8203 100644 --- a/features/outputfields.html +++ b/features/outputfields.html @@ -11,7 +11,7 @@ - + @@ -28,7 +28,7 @@ (opens new window) GitHub (opens new window)

# Output Fields

The Output-Fields header adds or removes fields to those ezPAARSE returns by default when it generates access events.

By default, the fields returned are those present in the EZPAARSE_OUTPUT_FIELDS parameter configuration file (config.json (opens new window)) to which the ones already present in the log format triggered for the processing are added.

This parameter can be used to add custom fields (that some parsers would be able to extract and return). For example, the "btype" field is not added by default and can be used to trace back advanced information on some database consultations.

You can also add internal ezPAARSE fields as:

  • Datetime: for the full date (hour, minute and second included) of the consultation event
  • Timestamp: the date in a computer format for the consultation event

Please note that the personalized fields in the log format will automatically be added to the Output-Fields list: there is no need to declare them with this Output-Fields header.

The Output-Fields header is composed with a list of comma separated fields, each one preceded with a + or - signs, depending on whether it has to be added or removed.

# Example

curl -X POST --proxy "" --no-buffer -H 'Output-Fields: -host,-login,+datetime' --data-binary @test/dataset/sd.2012-11-30.300.log  http://127.0.0.1:59599 -v
-

+

← →

- + diff --git a/features/qualification.html b/features/qualification.html index a3e54680..1885bbbf 100644 --- a/features/qualification.html +++ b/features/qualification.html @@ -11,7 +11,7 @@ - + @@ -27,7 +27,7 @@ Release Notes (opens new window) GitHub - (opens new window)

# Access Events Qualification

The qualification level of an access event is based on the presence of so-called qualifying fields, weighted according to their importance.

An access event is considered qualified when the cumulative weight of its qualifying fields reaches a fixed threshold, ie when they possess enough information to be useful.

Access Events' Qualification

+ (opens new window)

# Access Events Qualification

The qualification level of an access event is based on the presence of so-called qualifying fields, weighted according to their importance.

An access event is considered qualified when the cumulative weight of its qualifying fields reaches a fixed threshold, ie when they possess enough information to be useful.

Access Events' Qualification

← →

- + diff --git a/guide/index.html b/guide/index.html index 833f4f40..63d2822b 100644 --- a/guide/index.html +++ b/guide/index.html @@ -11,7 +11,7 @@ - + @@ -27,7 +27,7 @@ Release Notes (opens new window) GitHub - (opens new window)

# Introduction

VuePress is composed of two parts: a minimalistic static site generator (opens new window) with a Vue-powered theming system (opens new window) and Plugin API (opens new window), and a default theme (opens new window) optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects.

Each page generated by VuePress has its own pre-rendered static HTML, providing great loading performance and is SEO-friendly. Once the page is loaded, however, Vue takes over the static content and turns it into a full Single-Page Application (SPA). Additional pages are fetched on demand as the user navigates around the site.

- + (opens new window)

# Introduction

VuePress is composed of two parts: a minimalistic static site generator (opens new window) with a Vue-powered theming system (opens new window) and Plugin API (opens new window), and a default theme (opens new window) optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects.

Each page generated by VuePress has its own pre-rendered static HTML, providing great loading performance and is SEO-friendly. Once the page is loaded, however, Vue takes over the static content and turns it into a full Single-Page Application (SPA). Additional pages are fetched on demand as the user navigates around the site.

+ diff --git a/guide/using-vue.html b/guide/using-vue.html index 848c9583..cab0f29a 100644 --- a/guide/using-vue.html +++ b/guide/using-vue.html @@ -11,7 +11,7 @@ - + @@ -27,7 +27,7 @@ Release Notes (opens new window) GitHub - (opens new window)

# Using Vue in Markdown

# Browser API Access Restrictions

Because VuePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the universal code requirements (opens new window). In short, make sure to only access Browser / DOM APIs in beforeMount or mounted hooks.

If you are using or demoing components that are not SSR friendly (for example containing custom directives), you can wrap them inside the built-in <ClientOnly> component:

#

- + (opens new window)

# Using Vue in Markdown

# Browser API Access Restrictions

Because VuePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the universal code requirements (opens new window). In short, make sure to only access Browser / DOM APIs in beforeMount or mounted hooks.

If you are using or demoing components that are not SSR friendly (for example containing custom directives), you can wrap them inside the built-in <ClientOnly> component:

#

+ diff --git a/index.html b/index.html index 5f753ebb..0ef07326 100644 --- a/index.html +++ b/index.html @@ -11,7 +11,7 @@ - + @@ -32,6 +32,6 @@

Get Started →

# About ezPAARSE

ezPAARSE (opens new window) is a free and open source software designed to exploit, analyze and enrich access logs to electronic resources, typically available on the web platforms of scientific literature publishers.

# Demo instances

There are two publicly available instances of ezPAARSE:

Those two instance are for test purposes only (and now identified as such: you'll see a banner indicating "This ezPAARSE instance is available as a demonstration tool") and should therefore not be used as production tools. They are very convenient to test small log files and play around with the software and discover its interface. The data you process is only kept for an hour and is then deleted.

Our advice is to use those demo instances to become familiar with the features and then install a local instance on a server hosted by your institution.

# National Demo Instance (Stable)

The instance available on http://demo.ezpaarse.org (opens new window) is based on the latest stable version of the ezPAARSE software. The list of parsers is regularly updated. This instance is a good mirror of what you'll get if you install ezPAARSE locally.

# Preproduction Demo Instance

The instance available on http://dev.ezpaarse.org (opens new window) is based on the bleeding edge version of the ezPAARSE software (can be unstable).

This is were we test the latest features (and you can too!).

- + diff --git a/middlewares/anonymizer/README.html b/middlewares/anonymizer/README.html index 95df5f1a..21b250b1 100644 --- a/middlewares/anonymizer/README.html +++ b/middlewares/anonymizer/README.html @@ -11,7 +11,7 @@ - + @@ -60,6 +60,6 @@ →

- + diff --git a/middlewares/bot-ua-detector/README.html b/middlewares/bot-ua-detector/README.html index d4fef644..9fb8138e 100644 --- a/middlewares/bot-ua-detector/README.html +++ b/middlewares/bot-ua-detector/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/crossref/README.html b/middlewares/crossref/README.html index abb6defb..6caadfd4 100644 --- a/middlewares/crossref/README.html +++ b/middlewares/crossref/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/cut/README.html b/middlewares/cut/README.html index eed235b6..d4c750c8 100644 --- a/middlewares/cut/README.html +++ b/middlewares/cut/README.html @@ -11,7 +11,7 @@ - + @@ -87,6 +87,6 @@ →

- + diff --git a/middlewares/datacite/README.html b/middlewares/datacite/README.html index d6593f2d..3eb3b286 100644 --- a/middlewares/datacite/README.html +++ b/middlewares/datacite/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/deduplicator/README.html b/middlewares/deduplicator/README.html index 96d1f2bb..823f5e37 100644 --- a/middlewares/deduplicator/README.html +++ b/middlewares/deduplicator/README.html @@ -11,7 +11,7 @@ - + @@ -55,6 +55,6 @@ →

- + diff --git a/middlewares/ebscohost/README.html b/middlewares/ebscohost/README.html index 29e93735..b4cb2924 100644 --- a/middlewares/ebscohost/README.html +++ b/middlewares/ebscohost/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/enhancer/README.html b/middlewares/enhancer/README.html index 04515cbb..9d017ce6 100644 --- a/middlewares/enhancer/README.html +++ b/middlewares/enhancer/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/eprints/README.html b/middlewares/eprints/README.html index 561e3a08..934d6493 100644 --- a/middlewares/eprints/README.html +++ b/middlewares/eprints/README.html @@ -11,7 +11,7 @@ - + @@ -59,6 +59,6 @@ →

- + diff --git a/middlewares/ezunpaywall/README.html b/middlewares/ezunpaywall/README.html index f555d869..19ff10c1 100644 --- a/middlewares/ezunpaywall/README.html +++ b/middlewares/ezunpaywall/README.html @@ -11,7 +11,7 @@ - + @@ -64,6 +64,6 @@ →

- + diff --git a/middlewares/field-splitter/README.html b/middlewares/field-splitter/README.html index 321ff8cb..80f1fd89 100644 --- a/middlewares/field-splitter/README.html +++ b/middlewares/field-splitter/README.html @@ -11,7 +11,7 @@ - + @@ -36,6 +36,6 @@ →

- + diff --git a/middlewares/filter/README.html b/middlewares/filter/README.html index 30826d15..14dceeca 100644 --- a/middlewares/filter/README.html +++ b/middlewares/filter/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/geolocalizer/README.html b/middlewares/geolocalizer/README.html index c8d8d733..76d9e80b 100644 --- a/middlewares/geolocalizer/README.html +++ b/middlewares/geolocalizer/README.html @@ -11,7 +11,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/middlewares/hal/README.html b/middlewares/hal/README.html index 54413421..d4defcfd 100644 --- a/middlewares/hal/README.html +++ b/middlewares/hal/README.html @@ -11,7 +11,7 @@ - + @@ -55,6 +55,6 @@ →

- + diff --git a/middlewares/host-chain/README.html b/middlewares/host-chain/README.html index 9e2ad7e6..1d7d4943 100644 --- a/middlewares/host-chain/README.html +++ b/middlewares/host-chain/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/istex/README.html b/middlewares/istex/README.html index 7e0a160d..cc664146 100644 --- a/middlewares/istex/README.html +++ b/middlewares/istex/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/labelize/README.html b/middlewares/labelize/README.html index 3c6a76a7..091e46ae 100644 --- a/middlewares/labelize/README.html +++ b/middlewares/labelize/README.html @@ -11,7 +11,7 @@ - + @@ -79,6 +79,6 @@ →

- + diff --git a/middlewares/ncbi/README.html b/middlewares/ncbi/README.html index 65026378..a9ad3d5c 100644 --- a/middlewares/ncbi/README.html +++ b/middlewares/ncbi/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/omeka/README.html b/middlewares/omeka/README.html index fc2d8cfe..c8cde146 100644 --- a/middlewares/omeka/README.html +++ b/middlewares/omeka/README.html @@ -11,7 +11,7 @@ - + @@ -62,6 +62,6 @@ →

- + diff --git a/middlewares/omekas/README.html b/middlewares/omekas/README.html index 48c05177..3b7edd54 100644 --- a/middlewares/omekas/README.html +++ b/middlewares/omekas/README.html @@ -11,7 +11,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/middlewares/on-campus-counter/README.html b/middlewares/on-campus-counter/README.html index 4ba646ba..d1de7751 100644 --- a/middlewares/on-campus-counter/README.html +++ b/middlewares/on-campus-counter/README.html @@ -11,7 +11,7 @@ - + @@ -63,6 +63,6 @@ →

- + diff --git a/middlewares/panist/README.html b/middlewares/panist/README.html index c8a5989a..7d88f619 100644 --- a/middlewares/panist/README.html +++ b/middlewares/panist/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/parser/README.html b/middlewares/parser/README.html index dc522a4c..6b9e9ebb 100644 --- a/middlewares/parser/README.html +++ b/middlewares/parser/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/populate/README.html b/middlewares/populate/README.html index 1b4ef887..719be031 100644 --- a/middlewares/populate/README.html +++ b/middlewares/populate/README.html @@ -11,7 +11,7 @@ - + @@ -58,6 +58,6 @@ →

- + diff --git a/middlewares/qualifier/README.html b/middlewares/qualifier/README.html index 096107e3..4ff178d7 100644 --- a/middlewares/qualifier/README.html +++ b/middlewares/qualifier/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/robots/README.html b/middlewares/robots/README.html index ce762004..cf00897e 100644 --- a/middlewares/robots/README.html +++ b/middlewares/robots/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/session-id/README.html b/middlewares/session-id/README.html index 4bc20001..38448ae4 100644 --- a/middlewares/session-id/README.html +++ b/middlewares/session-id/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/sudoc/README.html b/middlewares/sudoc/README.html index feed0215..72d6c1e4 100644 --- a/middlewares/sudoc/README.html +++ b/middlewares/sudoc/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/throttler/README.html b/middlewares/throttler/README.html index d12ea79a..5391a161 100644 --- a/middlewares/throttler/README.html +++ b/middlewares/throttler/README.html @@ -11,7 +11,7 @@ - + @@ -62,6 +62,6 @@ →

- + diff --git a/middlewares/trackcode-generator/README.html b/middlewares/trackcode-generator/README.html index 60e0e3ba..8a60e404 100644 --- a/middlewares/trackcode-generator/README.html +++ b/middlewares/trackcode-generator/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/unpaywall/README.html b/middlewares/unpaywall/README.html index 73757bf8..8106e0b2 100644 --- a/middlewares/unpaywall/README.html +++ b/middlewares/unpaywall/README.html @@ -11,7 +11,7 @@ - + @@ -59,6 +59,6 @@ →

- + diff --git a/middlewares/user-agent-parser/README.html b/middlewares/user-agent-parser/README.html index 38b8bda7..8993cf8c 100644 --- a/middlewares/user-agent-parser/README.html +++ b/middlewares/user-agent-parser/README.html @@ -11,7 +11,7 @@ - + @@ -54,6 +54,6 @@ →

- + diff --git a/middlewares/zotero/README.html b/middlewares/zotero/README.html index 0edf966c..0a9957b5 100644 --- a/middlewares/zotero/README.html +++ b/middlewares/zotero/README.html @@ -11,7 +11,7 @@ - + @@ -50,6 +50,6 @@

- + diff --git a/start/install.html b/start/install.html index 89ab297c..b4cd5582 100644 --- a/start/install.html +++ b/start/install.html @@ -11,7 +11,7 @@ - + @@ -53,7 +53,7 @@ docker start ezpaarse-db # Stop mongodb. docker stop ezpaarse-db -

+

← →

- + diff --git a/start/requirements.html b/start/requirements.html index 8a1d3f14..46ceb72e 100644 --- a/start/requirements.html +++ b/start/requirements.html @@ -11,7 +11,7 @@ - + @@ -37,7 +37,7 @@ sudo apt-get update sudo apt-get install -y mongodb-org sudo service mongod start -

# Debian

Please use the official MongoDB doc for Debian (opens new window)

+

# Debian

Please use the official MongoDB doc for Debian (opens new window)

← →

- + diff --git a/start/uninstall.html b/start/uninstall.html index f987a1dd..34a913ca 100644 --- a/start/uninstall.html +++ b/start/uninstall.html @@ -11,7 +11,7 @@ - + @@ -33,7 +33,7 @@

Remove the ezpaarse folder:

rm -rf ezpaarse

# With Docker and Compose

Stop and remove containers:

docker compose down -v

Remove the ezpaarse folder:

rm -rf ezpaarse
-

+

← →

- + diff --git a/start/usage.html b/start/usage.html index 38378590..80176876 100644 --- a/start/usage.html +++ b/start/usage.html @@ -11,7 +11,7 @@ - + @@ -27,7 +27,7 @@ Release Notes (opens new window) GitHub - (opens new window)

# How to use

# Run the server

ezPAARSE launches from the command line. Use the following commands from the installation directory to start and stop the server.

If you want to launch ezPAARSE without the web client, set the EZPAARSE_NO_WEB_CLIENT environment variable with any value. This is not necessary if ezPAARSE has been installed without client dependencies.

# Without Docker

make start   # start the server
+     (opens new window)    
 
# How to use
 
# Run the server
 
ezPAARSE launches from the command line. Use the following commands from the installation directory to start and stop the server.
 
If you want to launch ezPAARSE without the web client, set the EZPAARSE_NO_WEB_CLIENT environment variable with any value. This is not necessary if ezPAARSE has been installed without client dependencies.
 
# Without Docker
 
make start   # start the server
 make stop    # stop the server
 make restart # restart the server
 make status  # check the server status
@@ -35,7 +35,52 @@
 docker compose stop    # stop the server
 docker compose restart # restart the server
 docker compose ps      # check the server status
-
NB: for docker-compose version 1, replace docker compose by docker-compose.
 
# Let's Parse !
 
Visit http://localhost:59599/ (opens new window) and create the first administrator of your local ezPAARSE instance. Administrators can manage the registered users and trigger updates from the web interface.
 
Once logged in, try drag-and-dropping a log file on the online form and processing it. If your logs are standard, you should be able to get a result immediately and see what ezPAARSE can produce for you.
 
Now you're up and ready to use ezPAARSE. Head onto the next section to learn about the basics.
  

+

NB: for docker-compose version 1, replace docker compose by docker-compose.

# Use with web client

Visit http://localhost:59599/ (opens new window) and create the first administrator of your local ezPAARSE instance. Administrators can manage the registered users and trigger updates from the web interface.

Once logged in, try drag-and-dropping a log file on the online form and processing it. If your logs are standard, you should be able to get a result immediately and see what ezPAARSE can produce for you.

Now you're up and ready to use ezPAARSE. Head onto the next section to learn about the basics.

# Use with command line

ezPAARSE ships with an utility called ezp, which allows for processing files through the command line. To make it available in your terminal, you'll need to load the ezPAARSE environment. This is done by sourcing the bin/env file located in the installation directory:

cd ezpaarse
+. bin/env
+

Once the environment is loaded, you get access to the ezp command:

ezp --help
+

You can then use ezp process to process a list of files, or ezp bulk to process an entire directory in a more automated way.

# ezp process

Let you process one or more files with an instance of ezPAARSE. If no files are provided, the command will listen to stdin. The results are printed to stdout, unless you set an output file with --out.

Options:
+  --output, --out, -o       Output file
+  --header, --headers, -H   Add a header to the request (ex: "`Reject-Files: all`")
+  --download, -d            Download a file from the job directory
+  --verbose, -v             Shows detailed operations.
+  --settings, -s            Set a predefined setting.
+

Examples of use :

# Simple case, process ezproxy.log and write results to result.csv
+ezp process ezproxy.log --out result.csv
+
+# Same as above, and download the report file
+ezp process ezproxy.log --out result.csv --download report.json
+
+# Download the report file with a custom path
+ezp process ezproxy.log --out result.csv --download report.json:./reports/job-report.json
+
+# Reading from stdin and redirecting stdout to a file
+cat ezproxy.log | ezp process > result.csv
+

# ezp bulk

Process files in sourceDir and save results in destDir. If destDir is not provided, results will be stored in sourceDir, aside the source files. When processing files recursively with the -r option, destDir will mimic the structure of sourceDir. Files will use the same or Files with existing results are skipped, unless the --force flag is set. By default, the result file and the job report are downloaded, but you can get additionnal files from the job directory by using the --download option.

Options:
+  --header, --headers, -H   Add a header to the request (ex: "`Reject-Files: all`")
+  --settings, -s            Set a predefined setting.
+  --recursive, -r           Look for log files into subdirectories
+  --download, -d            Download a file from the job directory
+  --overwrite, --force, -f  Overwrite existing files
+  --verbose, -v             Shows detailed operations.
+  --list, -l                Only list log files in the directory
+

Examples of use :

# Simple case, processing files recursively from ezproxy-logs and storing results in ezproxy-results
+ezp bulk -r ezproxy-logs/ ezproxy-results/
+
+# Activating reject files and downloading unqualified log lines along results
+ezp bulk -r ezproxy-logs/ ezproxy-results/ -H "Reject-Files: all" --download lines-unqualified-ecs.log
+

A result file (.ec.csv extension) and a report in JSON format (extension.report.json) are generated in the output directory for each log file. If the destination directory is not specified, they are generated in the same directory as the file being processed. +If an error occurs when processing a file, the incomplete result file is named with the .ko extension. +Rejects files are not retained by ezPAARSE.

Inject files to ezPAARSE (for batch purpose)
+  Usage: /home/yan/ezpaarse/bin/ecbulkmaker [-rflvH] SOURCE_DIR [RESULT_DIR]
+
+Options:
+  --recursive, -r  If provided, files in subdirectories will be processed. (preserves the file tree)
+  --list, -l       If provided, only list files.
+  --force, -f      override existing result (default false).
+  --header, -H     header parameter to use.
+  --verbose, -v    Shows detailed operations.
+
+

# Video Demonstration

This screencast (opens new window) demonstrates the usage of ecbulkmaker (ie process a directory containing log files and outputting a mirror directory with the results)

← →

- + diff --git a/troubleshooting/core-dumped.html b/troubleshooting/core-dumped.html index 29af4d7f..83ce9003 100644 --- a/troubleshooting/core-dumped.html +++ b/troubleshooting/core-dumped.html @@ -11,7 +11,7 @@ - + @@ -30,7 +30,7 @@ (opens new window)

# Core dumped

You may get the following error when updating ezPAARSE :

Segmentation error (core dumped) npm install --no-save -q --unsafe-perm

This error comes from a conflict between the versions of nodejs and npm. To solve this problem, you need to purge your nodejs and npm packages with the following commands :

sudo apt --auto-remove purge nodejs
 sudo apt --auto-remove purge npm
-

+

← →

- + diff --git a/troubleshooting/mongodb-connection.html b/troubleshooting/mongodb-connection.html index 040bf885..40dbf2eb 100644 --- a/troubleshooting/mongodb-connection.html +++ b/troubleshooting/mongodb-connection.html @@ -11,7 +11,7 @@ - + @@ -36,7 +36,7 @@ port: 27017 bindIp: 127.0.0.1,::1 ipv6: true -

+

← →

- +