diff --git a/data/os-plugins/README.md b/data/os-plugins/README.md index 002cc4e..c019dac 100644 --- a/data/os-plugins/README.md +++ b/data/os-plugins/README.md @@ -2,35 +2,30 @@ Files for creating an external job in Openspecimen and Extracting an BBMRI directory conform EMX file. -The files need to be placed such that openspecimen can access them. The Forms corresponding to the extractor can be found here: +### The files need to be placed such that openspecimen can access them. The Forms corresponding to the extractor can be found here: -https://github.com/bibbox/os-extensions/tree/master/BBMRI_Directory_Forms +- For the collection protocoll extension use *[Collection protocol extension form](https://github.com/bibbox/os-extensions/blob/master/BBMRI_Directory_Forms/src/main/resources/entity-forms/collectionProtocol_extension.xml)*. +- For the site extension use this file *[Site Extension Form](https://github.com/bibbox/os-extensions/blob/master/BBMRI_Directory_Forms/src/main/resources/entity-forms/site_extension.xml)*. For the Job to create see the example job and see https://openspecimen.atlassian.net/wiki/spaces/CAT/pages/56492042/Jobs for general information on external jobs. ![Example Job](Job.png) -In the example the files are placed in "/var/lib/openspecimen/plugins/" - -The job exectutes a bash script which in turn starts a python script so please make sure a python interpreter is available to be called at python3. - -It passes the parameters towards the python script and expects an smpt email server to be present and set in the python file. +- In the example image the files found in ./data/os-plugins/ are placed in "/var/lib/openspecimen/plugins/" +- The job exectutes a bash script which in turn starts a python script so please make sure a python interpreter is available to be called at python3. +- It passes the parameters towards the python script and expects an smpt email server to be present and set in the python file. You can do this within the exports.py file see: +``` context = ssl.create_default_context() - with smtplib.SMTP_SSL(, 465, context=context) as server: - -default value is "smtp.gmail.com" - -Default message test can also be set within the python script see: - subject = "Directory Update" - body = "Diese wichtige Nachricht spamt dich mit EMX files für das directory !" - -within export.py +``` + +- Default value for is "smtp.gmail.com" +- Default message test can also be set within the python script see within export.py Should you not need any Email sending just delete all the content below line 64 in exports.py. In this case you can just fetch the file next to where you placed your python script @@ -38,8 +33,5 @@ The parameters are as follows: --er "${EMAILRECEIVER}" --es "${EMAILSENDER}" --p "${PASSWORD}" --id "${ID}" -the file will be right in the directory next to your python script named "test.xlxs" and doesnt require the E-mail to be sent. - -This file contains the information which can then be sent towards the BBMRI team and can be imported into the directory to update a set BIOBANK collection there. - -Still this way of doing needs to be tested toroughly in production +- The file will be right in the directory next to your python script named "test.xlxs" and does not require the E-mail to be sent. +- This file contains the information which can then be sent towards the BBMRI team and can be imported into the directory to update a set BIOBANK collection there.