wcmc-its / ReCiter

ReCiter: an enterprise open source author disambiguation system for academic institutions
Apache License 2.0
45 stars 23 forks source link

No documentation on how to use Reciter and the Reciter Pubmed retrieval tool #500

Closed jcabrerazuniga closed 1 year ago

jcabrerazuniga commented 1 year ago

I have running Reciter and the Reciter Pubmed Retrieval tool. Yet, I do not see how to test their integration. Could your documentation be enhanced to provide some example where Reciter is forced to use the Reciter pubmed retrieval tool?

Thanks

paulalbert1 commented 1 year ago

Hey @jcabrerazuniga - The PubMed Retrieval Tool is required, which is implied here. Are you saying that's ambiguous from the readme? If I said somewhere that the Retrieval Tool is required, would that address your concern?

For your second question, how do you test the integration between the two appsl? You run a Feature Generator for a person who has an identity record.

Is this helpful?

jcabrerazuniga commented 1 year ago

I know the retrieval tool is required and that's the reason I installed it. Can you please tell me how can I retrieve all persons with their identity record? I also could not find the default login values for the Reciter's database that I will like to query. This is or a local installation of the Dynamo db. I think my title for my issue was not well written... sorry for that.

Thank you very much!

paulalbert1 commented 1 year ago

There are several options for retrieving data from DynamoDB.

  1. You can retrieve all users from DynamoDB using the Find All Identity API.
  2. You can download some of the data from the DynamoDB / AWS interface but I think that's only the personIdentifier.
  3. There are a couple of third party tools for querying DynamoDB including this and this.
  4. Another option is to use the MySQL database and a set of Python scripts available here. But we're in the process of refactoring these, so that's not as well documented. Generally speaking, the MySQL database gives you (or will give you) the most options.

I'm not sure which Reciter database you're referring to: the DynamoDB one or the MySQL one.

If you want to sync up over Zoom, send me a couple times next week. -- Paul, paa2013@med.cornell.edu

jcabrerazuniga commented 1 year ago

I noticed while compiling Reciter using:

aws.dynamoDb.local=true aws.dynamoDb.local.port=8000 aws.dynamoDb.local.region=us-central-1 aws.dynamoDb.local.accesskey=dummy aws.dynamoDb.local.secretkey=dummy aws.dynamoDb.local.dbpath=/opt/ReCiter/dynamodb/

that it is installs a local copy of DynamoDB which is possible according to https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html.

I think I just found while I was looking for... the default username and password are "dummy". But another question arises: Do I need to re-compile Reciter if I decide to change those passwords?

Thanks

paulalbert1 commented 1 year ago

I think so, yes.

paulalbert1 commented 1 year ago

FYI - I updated the documentation here.