diff --git a/docs.it4i/dice.md b/docs.it4i/dice.md index f7e11b1c82e141f3111b5b57b3f6d160e567c22e..0b29fc5d4e47f84c545630a03ffebd95b50f808d 100644 --- a/docs.it4i/dice.md +++ b/docs.it4i/dice.md @@ -323,6 +323,83 @@ ls -la ~ For more commands, use the `ihelp` command. + +## PID Services + +You, as user, may want to index your datasets and allocate some PIDs - Persistent Identifiers for them. We host pid system by hdl-surfsara ( https://it4i-handle.it4i.cz ), wich is conected to https://hdl.handle.net , and you are able to create your own PID by calling some of irule. + +### How to Create PID + +Pids are created by calling `irule`, you have to create at your $HOME or everewhere you want, but you have to specify path correctly. +rules for pid operations have always .r suffix . It can by done only throught `iCommands` + +example of rule for PID creating only +```console +user in ~ λ pwd +/home/user + +user in ~ λ ils +/IT4I/home/user: + C- /IT4I/home/dvo0012/Collection_A + +user in ~ λ ls -l | grep pid +-rw-r--r-- 1 user user 249 Sep 30 10:55 create_pid.r + +user in ~ λ cat create_pid.r +PID_DO_reg { + EUDATCreatePID(*parent_pid, *source, *ror, *fio, *fixed, *newPID); + writeLine("stdout","PID: *newPID"); +} +INPUT *source="/IT4I/home/user/Collection_A",*parent_pid="None",*ror="None",*fio="None",*fixed="true" +OUTPUT ruleExecOut + +user in ~ λ irule -F create_pid.r +PID: 21.12149/f3b9b1a5-7b4d-4fff-bfb7-826676f6fe14 +``` +After creation, your PID is worldwidely searchable + + + + +**More info at [www.eudat.eu][n]** + +### Metadata + +For adding metadata to you collection/dataset, you can use imeta from iCommands + +this is after PID creation +```console +user in ~ λ imeta ls -C /IT4I/home/user/Collection_A +AVUs defined for collection /IT4I/home/user/Collection_A: +attribute: EUDAT/FIXED_CONTENT +value: True +units: +---- +attribute: PID +value: 21.12149/f3b9b1a5-7b4d-4fff-bfb7-826676f6fe14 +units: +``` + +For adding any other metadata you can use : +```console +user in ~ λ imeta add -C /IT4I/home/user/Collection_A EUDAT_B2SHARE_TITLE Some_Title + +user in ~ λ imeta ls -C /IT4I/home/user/Collection_A +AVUs defined for collection /IT4I/home/user/Collection_A: +attribute: EUDAT/FIXED_CONTENT +value: True +units: +---- +attribute: PID +value: 21.12149/f3b9b1a5-7b4d-4fff-bfb7-826676f6fe14 +units: +---- +attribute: EUDAT_B2SHARE_TITLE +value: Some_Title +units: +``` + + [1]: irods.cyberduckprofile [2]: irods_environment.json [3]: config.yml @@ -337,3 +414,4 @@ For more commands, use the `ihelp` command. [i]: https://cyberduck.io/download/ [l]: https://www.eudat.eu/contact-support-request?Service=B2SAFE [m]: https://aai.it4i.cz/ +[n]: https://www.eudat.eu/catalogue/b2handle diff --git a/docs.it4i/img/hdl_net.jpg b/docs.it4i/img/hdl_net.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d96c82a99df18c7d306bafd7fa40353dd067a308 Binary files /dev/null and b/docs.it4i/img/hdl_net.jpg differ diff --git a/docs.it4i/img/hdl_pid.jpg b/docs.it4i/img/hdl_pid.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cd1cfbdbbc49fa44af6b67ae282a48558d1f3d54 Binary files /dev/null and b/docs.it4i/img/hdl_pid.jpg differ