Skip to content

Latest commit

 

History

History
85 lines (65 loc) · 7.45 KB

sharestudy.md

File metadata and controls

85 lines (65 loc) · 7.45 KB
Raw

Sharing and Publishing Studies

There are two ways in which your work on the online platform can be accessed by others. You may either share an instance of your Study with other member(s), with other organization(s), or publish the Study as a Template for other members to copy.

For a full demonstration of these functionalities, take a look at our webinar on collaboration!

<iframe width="784" height="441" src="https://www.youtube.com/embed/cI5p0bki258" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Organization

An organization is any group of o²S²PARC users that are able to share Studies with each other. To see which organizations you are a part of, go to your user preferences through your Profile button on the top right corner of the user interface. Then choose the organization icon (the last icon) which will display all organizations you belong to and you may see the members of each organization by clicking on it. The member details will be then displayed in the lower half of the window under Members. There are three different types of members in an organization:

  1. Regular Member
    • Has access to shared content of the organization
    • Can share content with the organization
  2. Manager
    • Has Member privileges
    • Can add or remove Members
    • Can promote Members to Managers
  3. Administrator
    • Has Manager privileges
    • Can edit the organization’s description
    • Can delete the organization

To create a new organization, click the New Organization button and add members by entering each new member's o²S²PARC email address and then clicking Add. Note that you may only add members that are already registered o²S²PARC users. If a user is successfully added, you will see a confirmation message and if there was an error, e.g. the email address is not registered, you will see an error message pop up. You may then change each member's privileges by clicking on that member's name. The new member will receive a notification under the bell icon.

You can also access your Organizations from the Study card, by clicking on the icon on the left side of the last change date. This will open the Sharing dialog, where you will find the "Organizations" button (see below).

organization

Sharing a Study

Sharing a Study instance with other users allows collaboration on the same pipeline and code. When one member of the shared users is editing a Study, the Study is locked for the others. When that user finishes and returns to their Dashboard, the changes will be updated when another member accesses the Study.

share-study-options

To share a Study:

  1. Access the Study's options from the Dashboard by clicking on the three dot button on the upper right hand corner of the Study's card or from the Study card, by using the Share button on left side of the last changed date.
  2. In the Sharing tab, click on the Organizations and Members dropdown to see the list of users you may share with. Choose one or more people/organizations to share your Study with, and then click the Add button. If you want, you can also create a new Organization by using the Organizations button.
  3. The Study will then appear in the Studies tab of the user(s) you have shared with.

Note: the members you have shared the Study with will receive a notification under the bell icon.

Publishing a Study as a Template

Publishing a Study as a Template will save the state of the Study at the current moment and it will appear as a Template Study in the Templates tab of the Dashboard. Any changes made to the original Study after publishing as a Template will not change the Template. Clicking on the Template Study in the Templates tab will create a copy of the contents of the Template accessible in your Studies tab. Any changes you make to this new Study will not affect the original Template.

To publish your Study as a Template:

  1. Access the Study's options from the Dashboard by clicking on the three dot button on the upper right hand corner of the Study's card.
  2. Choose the More options option. A modal should appear.
  3. In the popup modal, there is a panel menu to the left. Click on the Save as Template button (bottom-most button) to switch to the Templating tab.
  4. Set the access rights of the Template in the popup menu. You may make the Template accessible to only yourself or members of organizations. If you choose Organizations, you will be able to select from the list of organizations that you are a part of.

templateshare

  1. You may also choose to publish the Template with the data inside (for example, if you have any files saved in a JupyterLab inside the Study). To publish with data, scroll down in the modal and make sure the "Publish with data" field is checked. To export the pipeline structure without any customizations, uncheck the box.
  2. Click the Publish button on the bottom right hand corner.
  3. The Template will now appear as a Template Study in your Templates tab. If you have chosen to share the Template with members of an organization, others in that same organization will also see the Study in their respective Templates tabs.

Note: the members you have shared the Template with will receive a notification under the bell icon.

User Roles

When you add a Member to a Study or Template, you can assign different access rights:

  1. Viewer
    • Can only open the Study
    • Can run computational studies and open the Interactive View for interactive services.
    • Cannot add new Services to a Study
    • Any change will not be saved
    • Cannot modify the Study information (e.g. name, thumbnail, etc...)
  2. Collaborator
    • Has write access on the Study
    • Can run computational studies and open the Interactive View for interactive services
    • Can add new Services to the Study and edit the pipeline (e.g. connect/disconnect services)
    • Can modify the Study information (e.g. name, thumbnail, etc...)
  3. Owner
    • Has the same privileges as a Collaborator
    • Can delete the Study

Notifications

When you share a Study or a Template with a collaborator, or you add a collaborator to an Organization, the collaborator will see a notification under the bell icon.

bell-notify

The number on the bell icon is the count of unread notifications (notifications you have not yet clicked on). When you click on a notification, a window will open, showing details about the Study or the Template that has been shared with you or about the Organization. A list of the most recent notifications is kept for you, in case you wish to come back to check some details.

Note: you collaborator(s) will receive a notification only if you directly share a Study/Template and not if you share the Study/Template with an entire Organization.