Difference between revisions of "BioStore"

From BioUML platform
Jump to: navigation, search
(Stub template removed)
(Link to BDK fixed - Downloads)
 
(9 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
BioStore is the central authentication and authorization server for all [[BioUML]]-related products. It's located on https://bio-store.org/.
 
BioStore is the central authentication and authorization server for all [[BioUML]]-related products. It's located on https://bio-store.org/.
 
To get access to BioUML servers users have to register on the website first.  
 
To get access to BioUML servers users have to register on the website first.  
 +
 +
Registered users can
 +
* subscribe to a [[BioUML server]] (to gain access to a BioUML-related web products),
 +
* create a project on a server while subscribing to it,
 +
* view information about subscriptions registered under their BioStore account,
 +
* view information about the user groups working on their projects,
 +
* invite colleagues to join their BioUML projects (via email notifications),
 +
* exclude users from working groups when their participation in the projects is not required (any longer),
 +
* download the latest version of the [[BioUML workbench]],
 +
* change their password or restore it if forgotten.
 +
  
 
==Registration==
 
==Registration==
  
 
To register with BioStore you need to click on the '''Register''' link on the start page of BioStore and complete the registration form with personal details such as your email address, your name and country.
 
To register with BioStore you need to click on the '''Register''' link on the start page of BioStore and complete the registration form with personal details such as your email address, your name and country.
[[File:Biostore registration.png|thumb|left|Registrartion on the BioStore website]]  
+
[[File:Biostore registration.png|thumb|Registration on the BioStore website]]  
 
Along with the registration you can subscribe to a specific server handled by BioStore. The list of servers with free or trial subscription currently includes:
 
Along with the registration you can subscribe to a specific server handled by BioStore. The list of servers with free or trial subscription currently includes:
 
* BioUML on Amazon (free),
 
* BioUML on Amazon (free),
Line 16: Line 27:
 
If you want your personal project to be created on the selected server, fill in the '''Project name''' field. However, you can always subscribe to the server or create a project later, after the registration, so you can skip this step if you’re not sure. After you complete all the required fields and press '''Execute''', you will see the successful registration notification and a password to your BioStore account will be generated and sent to your email.
 
If you want your personal project to be created on the selected server, fill in the '''Project name''' field. However, you can always subscribe to the server or create a project later, after the registration, so you can skip this step if you’re not sure. After you complete all the required fields and press '''Execute''', you will see the successful registration notification and a password to your BioStore account will be generated and sent to your email.
  
 +
==Starting work with your account==
 +
[[File:Biostore login.png|thumb|Logging in to BioStore]]
  
  
 +
To start working with your account at BioStore go to the '''login dialog''' either by clicking on the appropriate link ('''Log in to BioStore...''') in the successful registration notification right away or by choosing the '''Login''' option on the BioStore start page.
  
 +
In the '''Login dialog form''' enter your '''Username''' (the email address used during the registration) and the '''password''' that was sent to you by email. If you wish to stay signed in the system (so that you don't have to enter your username and password every time you visit BioStore), check Remember me box, then press '''Execute'''.
  
==Starting work with your account==
+
[[File:BioStore subscriptions and groups.png|thumb|The main page (a) and viewing the user's subscription (b) and group (c) lists]]
  
To start working with your account at BioStore go to the '''login dialog''' either by clicking on the appropriate link ('''Log in to BioStore...''') in the successful registration notification right away or by choosing the '''Login''' option on the BioStore start page. In the '''Login dialog form''' enter your '''Username''' (the email address used during the registration) and the '''password''' that was sent to you by email. If you wish to stay signed in the system (so that you don't have to enter your username and password every time you visit BioStore), check Remember me box, then press '''Execute'''.
 
[[File:Biostore login.png|thumb|left|Logging in to BioStore]]
 
  
 
Once logged in to your account, you can see the main page consisting of the user menu pane (on the left) and the main pane.
 
Once logged in to your account, you can see the main page consisting of the user menu pane (on the left) and the main pane.
  
[[File:BioStore subscriptions and groups.png|thumb|The main page (a) and viewing the user's subscription (b) and group (c) lists]]
+
 
 
Here you can view detailed information about your subscriptions to BioUML servers (''Main pane > Manage subscriptions or Menu > Subscriptions > My subscriptions'') or about your groups (''Menu > Subscriptions > User groups > My groups''), if any.
 
Here you can view detailed information about your subscriptions to BioUML servers (''Main pane > Manage subscriptions or Menu > Subscriptions > My subscriptions'') or about your groups (''Menu > Subscriptions > User groups > My groups''), if any.
  
Line 33: Line 46:
  
 
At this point resetting the password is recommended for your convenience. For that click on the '''Change the password''' option of the menu on the left, fill in the form that appears in the main pane and press '''Execute'''.
 
At this point resetting the password is recommended for your convenience. For that click on the '''Change the password''' option of the menu on the left, fill in the form that appears in the main pane and press '''Execute'''.
 
 
 
 
  
 
==Creating BioUML projects via BioStore==
 
==Creating BioUML projects via BioStore==
Line 52: Line 61:
 
==Inviting other users to your project==
 
==Inviting other users to your project==
  
Using BioStore, users can also invite other users to take part in their project(s) (if assigned the role of the administrator (GroupAdmin).
+
<div id="InvitingOthers"></div>
 
[[File:Inviting users to projects.png|thumb|Inviting a user to join a BioUML project]]
 
[[File:Inviting users to projects.png|thumb|Inviting a user to join a BioUML project]]
For that you have to:
+
On BioStore website users can also invite other users to take part in their project(s) (if assigned the role of the administrator (GroupAdmin).
 +
 
 +
For that you need to:
 
* enter your BioStore account,
 
* enter your BioStore account,
* select the '''Invite colleagues''' option on the main page - the invitation form will appear,
+
* select the '''Invite colleagues''' option on the main page or the '''Ivite''' item on the user menu - the invitation form will appear,
 +
'''Note''' that new members can also be added to projects from the '''Group members''' view (''Menu > User groups > My groups > name of the appropriate group > '''Invite''' button'').
 
* type in your colleague’s e-mail address,  
 
* type in your colleague’s e-mail address,  
 
* select the proper group from the drop-down list. For each project you create a corresponding user group is displayed on the list of the '''Invite''' form ('''Group to invite user to''' field). You can invite your colleague to this or that group and they will gain access to your project associated with it.
 
* select the proper group from the drop-down list. For each project you create a corresponding user group is displayed on the list of the '''Invite''' form ('''Group to invite user to''' field). You can invite your colleague to this or that group and they will gain access to your project associated with it.
* press '''Execute''' - Your colleague will receive the following e-mail:
 
  
''Dear sir or madam!''
+
'''Note''' that the option is available if you have at least one active project under a valid server subscription. Otherwise the drop-down list is empty and there's no '''Invite''' item on  the user menu. However, if you have got projects running on a [[BioUML server]] and yet cannot send invitations via BioStore, report the issue to the tech support.
  
''Mr(s). <YOUR NAME> has invited you to register in the Biostore to participate in collaborative work within the group <PROJECT NAME>@<SERVER NAME>. To register, please visit https://bio-store.org/.''
+
* press '''Execute''' - Your colleague will receive the following e-mail:
  
 +
<pre style="font-style:italic">Dear sir or madam!
 +
 +
Mr(s). <YOUR NAME> has invited you to register in the Biostore to participate in collaborative work within the group <PROJECT NAME>@<SERVER NAME>.
 +
To register, please visit https://bio-store.org/.
 +
</pre>
  
 
When your colleague registers, they will be automatically included into your group and the successful registration notification will be displayed to them.  
 
When your colleague registers, they will be automatically included into your group and the successful registration notification will be displayed to them.  
 
If the user was already registered at the moment you invited them, they will be included into your group immediately.
 
If the user was already registered at the moment you invited them, they will be included into your group immediately.
 +
 +
==Downloads==
 +
[[File:BioStore downloads.png|thumb|Viewing details of the latest BioUML workbench installation pack in the BioStore Download area]]
 +
Currently registered users can find the latest version of the [[BioUML workbench]] installation pack and [[BioUML Development Kit]] freely available in the '''Downloads''' area.
 +
 +
To view the release notes click on the '''Product name'''.
 +
 +
To start download click on the link in the '''Download''' field.

Latest revision as of 12:33, 7 May 2013

BioStore logo

BioStore is the central authentication and authorization server for all BioUML-related products. It's located on https://bio-store.org/. To get access to BioUML servers users have to register on the website first.

Registered users can

  • subscribe to a BioUML server (to gain access to a BioUML-related web products),
  • create a project on a server while subscribing to it,
  • view information about subscriptions registered under their BioStore account,
  • view information about the user groups working on their projects,
  • invite colleagues to join their BioUML projects (via email notifications),
  • exclude users from working groups when their participation in the projects is not required (any longer),
  • download the latest version of the BioUML workbench,
  • change their password or restore it if forgotten.


Contents

[edit] Registration

To register with BioStore you need to click on the Register link on the start page of BioStore and complete the registration form with personal details such as your email address, your name and country.

Registration on the BioStore website

Along with the registration you can subscribe to a specific server handled by BioStore. The list of servers with free or trial subscription currently includes:

  • BioUML on Amazon (free),
  • Genex Server (free),
  • Public geneXplain server (trial).


If you want your personal project to be created on the selected server, fill in the Project name field. However, you can always subscribe to the server or create a project later, after the registration, so you can skip this step if you’re not sure. After you complete all the required fields and press Execute, you will see the successful registration notification and a password to your BioStore account will be generated and sent to your email.

[edit] Starting work with your account

Logging in to BioStore


To start working with your account at BioStore go to the login dialog either by clicking on the appropriate link (Log in to BioStore...) in the successful registration notification right away or by choosing the Login option on the BioStore start page.

In the Login dialog form enter your Username (the email address used during the registration) and the password that was sent to you by email. If you wish to stay signed in the system (so that you don't have to enter your username and password every time you visit BioStore), check Remember me box, then press Execute.

The main page (a) and viewing the user's subscription (b) and group (c) lists


Once logged in to your account, you can see the main page consisting of the user menu pane (on the left) and the main pane.


Here you can view detailed information about your subscriptions to BioUML servers (Main pane > Manage subscriptions or Menu > Subscriptions > My subscriptions) or about your groups (Menu > Subscriptions > User groups > My groups), if any.


At this point resetting the password is recommended for your convenience. For that click on the Change the password option of the menu on the left, fill in the form that appears in the main pane and press Execute.

[edit] Creating BioUML projects via BioStore

Users can create projects within the BioUML workbench or via BioStore.

Subscribing to a BioUML server and (optionally) creating a new project

To subscribe to a server and create a project, go to Subscriptions page (Main pane > Manage subscriptions or Menu > Shop > Subscriptions) and press the Subscribe / Create project button. The Subscribe / create project form will appear in the main pane, where you are to:

  • select from the dropdown list the name of the server subscription you’d like to start,
  • enter your project name if necessary, and
  • press Execute.

If the subscription procedure has been completed successfully, you will see the successful registration notification.


[edit] Inviting other users to your project

Inviting a user to join a BioUML project

On BioStore website users can also invite other users to take part in their project(s) (if assigned the role of the administrator (GroupAdmin).

For that you need to:

  • enter your BioStore account,
  • select the Invite colleagues option on the main page or the Ivite item on the user menu - the invitation form will appear,

Note that new members can also be added to projects from the Group members view (Menu > User groups > My groups > name of the appropriate group > Invite button).

  • type in your colleague’s e-mail address,
  • select the proper group from the drop-down list. For each project you create a corresponding user group is displayed on the list of the Invite form (Group to invite user to field). You can invite your colleague to this or that group and they will gain access to your project associated with it.

Note that the option is available if you have at least one active project under a valid server subscription. Otherwise the drop-down list is empty and there's no Invite item on the user menu. However, if you have got projects running on a BioUML server and yet cannot send invitations via BioStore, report the issue to the tech support.

  • press Execute - Your colleague will receive the following e-mail:
Dear sir or madam!

Mr(s). <YOUR NAME> has invited you to register in the Biostore to participate in collaborative work within the group <PROJECT NAME>@<SERVER NAME>. 
To register, please visit https://bio-store.org/.

When your colleague registers, they will be automatically included into your group and the successful registration notification will be displayed to them. If the user was already registered at the moment you invited them, they will be included into your group immediately.

[edit] Downloads

Viewing details of the latest BioUML workbench installation pack in the BioStore Download area

Currently registered users can find the latest version of the BioUML workbench installation pack and BioUML Development Kit freely available in the Downloads area.

To view the release notes click on the Product name.

To start download click on the link in the Download field.

Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox