Ticket #8742 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

icat publishing description box

Reported by: Jay Rainey Owned by: Jay Rainey
Priority: major Milestone: Release 3.1
Component: Framework Keywords: ICAT, publish
Cc: Blocked By:
Blocking: Tester: Samuel Jackson

Description

When discussing the publishing algorithm with Nick and Tom we agreed that an optional input field were the user could input a short description of the file that they are uploading would be great! To do this, I will need to:

  1. Add new input field in CatalogPublishDialog.
  2. Add new property to CatalogPublish algorithm named: dataFileDescription.
  3. Update the method signature of getUploadURL in ICatalog to take another parameter named dataFileDescription.
  4. Update getUploadURL in subclasses of ICatalog.

Change History

comment:1 Changed 7 years ago by Jay Rainey

  • Status changed from new to inprogress

Added description field to publishing dialog. Refs #8742.

Changeset: 1fe04cbe493d3786b802e34796a3dfc35bd92114

comment:2 Changed 7 years ago by Jay Rainey

Added dataFileDescription to getUploadURL. Refs #8742.

  • Added implementation to icat4catalog's getUploadURL.

Changeset: e9940cad1f5d90dd89966ee7ac937f264c9843a2

comment:3 Changed 7 years ago by Jay Rainey

Added property to publish algorithm. Refs #8742.

  • Made publish dialog use publishing algorithm's property.

Changeset: 8309477800c9f2d46b18d4b3fadd53cc44b9f6f5

comment:4 Changed 7 years ago by Jay Rainey

Added description field to datafile table. Refs #8742.

  • Although some datafiles do not have a description, once users begin to publish datafiles it will be a lot easier to differentiate between datafiles (if there are many) based on the description.

Changeset: 148d782c18d1a84c2e593111a56580f9a7ba70c7

comment:5 Changed 7 years ago by Jay Rainey

Fix doxygen warnings. Refs #8742.

Changeset: d51ce1a795b20e919a113806a997b9b06876c632

comment:6 Changed 7 years ago by Jay Rainey

  • Status changed from inprogress to verify
  • Resolution set to fixed
Last edited 7 years ago by Jay Rainey (previous) (diff)

comment:7 Changed 7 years ago by Jay Rainey

  • Summary changed from [ICAT] Publishing description box to icat publishing description box

comment:8 Changed 7 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester set to Samuel Jackson

comment:9 Changed 7 years ago by Jay Rainey

  • Status changed from verifying to reopened
  • Resolution fixed deleted

comment:10 Changed 7 years ago by Jay Rainey

  • Status changed from reopened to inprogress

Added description field to publishing dialog. Refs #8742.

Changeset: 6cda8d49cf73a3adcec8ed1e201190f10fe1489c

comment:11 Changed 7 years ago by Jay Rainey

Added dataFileDescription to getUploadURL. Refs #8742.

  • Added implementation to icat4catalog's getUploadURL.

Changeset: a5fe015b33c7d75e28148109356d773700e55a6d

comment:12 Changed 7 years ago by Jay Rainey

Added property to publish algorithm. Refs #8742.

  • Made publish dialog use publishing algorithm's property.

Changeset: 4bbe13eb2c8c8a4e27fec0200a8756be3dd8202d

comment:13 Changed 7 years ago by Jay Rainey

Added description field to datafile table. Refs #8742.

  • Although some datafiles do not have a description, once users begin to publish datafiles it will be a lot easier to differentiate between datafiles (if there are many) based on the description.

Changeset: e2878a6802a0d6f833d0d48547b300e2d85ccdda

comment:14 Changed 7 years ago by Jay Rainey

Fix doxygen warnings. Refs #8742.

Changeset: 49e970269c460c6bebe3698799fcbebb67a4da7b

comment:15 Changed 7 years ago by Jay Rainey

  • Status changed from inprogress to verify
  • Resolution set to fixed

In this ticket I added a new property (dataFileDescription) to the catalog publishing algorithm. This involved modifying the catalog interface, related classes, and the catalog publishing custom dialog.

To test

Change Facilities.xml

You will need to change the soapendpoint and externaldownload in Facilities.xml in order to use the development servers (as publishing is not enabled on the release servers at the moment). To do this, change the following in Facilities.xml:

  soapendpoint     -> "https://icatdev.isis.cclrc.ac.uk/ICATService/ICAT"
  externaldownload -> "https://isisoxfordvmsrv.isis.cclrc.ac.uk/ids/"

Publishing a file

  1. Open Mantid and log into the catalog. (From the menu select Catalog then Login)
  2. Select "Publish" and select a file to upload.
  3. Provide a name for the file (E.g. example1234.nxs).
  4. Enter a description that you will easily recognize.
  5. Select an investigation you would like to publish the file to.
  6. Press "Run". The file will now be uploaded to the archives.

Viewing the published file

  1. Click the Search option in the catalog menu. The search GUI will open.
  2. Click Advanced search and you will see an option named datafile name:
  3. Enter the name of the file you provided above (example1234.nxs) into the datafile name field.
  4. Click Search and the Search results window should now show the investigation where you uploaded the datafile to.
  5. Double click on the investigation and the Datafiles information table will be populated. Scroll down until you find your file and observe that the description you wrote into the publishing dialog box is shown in the related cell of the file you uploaded.cd wor

comment:16 Changed 7 years ago by Jay Rainey

  • Tester Samuel Jackson deleted

comment:17 Changed 7 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester set to Samuel Jackson

comment:18 Changed 7 years ago by Samuel Jackson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/8742_icat_publish_input_description'

Full changeset: 4b5a7c22381aa05bdb096c7c9cf6de7e48147313

comment:19 Changed 7 years ago by Samuel Jackson

The change works and the code looks good.

comment:20 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 9586

Note: See TracTickets for help on using tickets.