paulscherrerinstitute / scicat-ci

CI related information to deploy SciCat
BSD 2-Clause "Simplified" License
4 stars 2 forks source link

Make CSCS retrieve more descriptive #179

Closed minottic closed 1 year ago

minottic commented 1 year ago

should close: #175

minottic commented 1 year ago

since we can explain in more detail what each option does, we could change the Get download URLs to simply Download.

pozsa commented 1 year ago

something like the below?

        {
            "option": "to PSI",
            "tooltip": "Copy the data to the PSI storage buffer. After that, you need to copy it from there to any destination using the datasetRetriever command or using rsync from pb-retrieve.psi.ch"
        },
        {
            "option": "download URLs",
            "tooltip": "Get an email with temporary links to download the data. Clicking on the links will start the download."
        },
        {
            "option": "to PSI-RA",
            "location": "/gpfs/workfs/p18/p18525/retrieve",
            "tooltip": "Copy the data directly to the PSI RA cluster destination folder at /das/work/${groupname:0:3}/${groupname}/retrieve/${sourceFolder}/"
        }

Which one is the default option? Currently, none is marked, but there is actually one in the background. I know because I could trigger a job without selecting any of the options.

minottic commented 1 year ago

Which one is the default option? Currently, none is marked, but there is actually one in the background. I know because I could trigger a job without selecting any of the options.

the default should be the first one in the list

minottic commented 1 year ago

do we want CSCS as the default one?

stephan271 commented 1 year ago

Good question: if we however apply the "principle of minimum surprise" we should keep the PSI case as the default (at least for now)

minottic commented 1 year ago

the dialog looks like this:

image

so having the "to " prefix might be a little redundant, and also it has implications on the job.jobParams.option value which I think is used in nodered to distinguish the retrieve types (as the value would be "to PSI" as opposed to "PSI"). So, I would suggest to keep them as they are, i.e. simply PSI and PSI-RA. I am happy to change the CSCS one, as that is not known to the user. As before, @pozsa , this will require a change in nodered as well I think

pozsa commented 1 year ago

can we make it selected in the UI? so there is no empty option, but the user sees which one is happening?

pozsa commented 1 year ago

the dialog looks like this: image

so having the "to " prefix might be a little redundant, and also it has implications on the job.jobParams.option value which I think is used in nodered to distinguish the retrieve types (as the value would be "to PSI" as opposed to "PSI"). So, I would suggest to keep them as they are, i.e. simply PSI and PSI-RA. I am happy to change the CSCS one, as that is not known to the user. As before, @pozsa , this will require a change in nodered as well I think

well.. I think it's not optional to select a destination. They are forced to select a destination. You are right about the changes in nodered though.

how about this?

or have an actual value with the option so the user doesn't see the actual value we use to route our logic on, but only sees a display

stephan271 commented 1 year ago

I like this proposal

minottic commented 1 year ago

that's a good idea. My comment was indeed only to avoid the "to " but, I agree on changing the rest!

minottic commented 1 year ago

@pozsa your suggestion has been implemented. You can check it out on discovery-development.psi.ch (you might need to clear the cache first)

pozsa commented 1 year ago

@pozsa your suggestion has been implemented. You can check it out on discovery-development.psi.ch (you might need to clear the cache first)

Hmm, seeing it now.. what do you think if we just call it URLs instead of download URLs? and the help text: Get an email with temporary URLs to download the data. Clicking on the URLs will start the download.?

minottic commented 1 year ago

Get an email with temporary URLs to download the data. Clicking on the URLs will start the download.

fine for me, as well as calling it URLs

minottic commented 1 year ago

@pozsa new wording should be there