Documentation: Quickstart Guides
The RIB project is no longer under development, and this website is no longer being updated.
Quickstart Guides

Guide to 3.X
Guide to 2.X

Quickstart Guide for 3.0



After installing RIB, the "Repository in a Box Management Page" should be opened up in your browser. The purpose of this guide is to get first-time RIB users started using the application with little effort and no reliance on the Help documentation. Some familiarization with data models (especially the BIDM) and domain hierarchies will improve this document's effectiveness and usefulness.

 

1. Use the main RIB password, logon to the RIB administrator's management page in your web browser. Click on the "Create a Repository" button.

2. Enter the required information in the input boxes provided.

3. Select the "Yes" radial button of the Use Simplified BIDM option at the bottom.

4. Click the "Submit" button.

5. A new page should now appear in your browser. Click the "Go to administration page for " button.

6. Once loading is complete, your browser window should contain the opening RIB administration page interface for the repository you just created (the name of your repository should appear in the upper left corner of the browser and a gray "RIB management page" button should appear in the upper right corner).

7. To begin creating an Object (and any relationships between classes of that Object), click on the tab labeled "Manage Objects". It is within this section that you will add, modify, and/or delete all metadata that describe each individual Object (software) that will appear in your repository's catalog.

8. Use the arrow button next to the "Class" input window to display the list of Object classes in your repository (the displayed list is based on the data model that you are using -- in this case the Simplified BIDM).

9. Select the Organization class. An Organization is a person, company, research group, etc. that creates and/or manages an Asset or Library.

10. Click the "Create" button.

11. Your browser window should now be displaying the list of attributes and relationships (note that there are not any relationships for the Organization Object) on the left-hand side of the interface. Required fields are in red, optional fields are in black (what is optional and what is required may be changed, but should be done before creating or editing the Object's metadata -- see the Guide to Editing Your Data Model).

12. Click on an attribute on the left and enter the appropriate information into the input box that appears. You will notice that once data has been entered into the input box, the attribute name will turn blue.

13. Once you have completed entering attribute data for the Organization, click the button labeled "Save Object". If any required fields have been left blank, the "Save Object" button will not be clickable (it will be "grayed" out).

14. The browser window should now display the name of the Organization that you just created along with a last modified date and status (use the "Help" tab of the interface to learn more). At this time, you can now create another Organization or create an Asset. To create another Organization, go back to step 10. To create an Asset, continue.

15. Use the arrow button to display the list of Object classes (as in step 8 above). Select the Asset class. The Asset class contains the attributes that serve as detailed descriptive information (metadata) for each individual software application that you are cataloging.

16. Click the "Create" button.

17. Enter information for the desired attributes (just like you did in step 12). Upon clicking the domain attribute, a window of classification options appears based on the taxonomy or classification scheme employed by the data model that you are currently using. Select a category to place your asset into (a purple folder indicates the availability of a sub-classification - just double click the folder to view the sub-classification options). The domain classification used in the Simplified BIDM is the same one used by the National HPCC Software Exchange (NHSE) Parallel Tools Library Repository (PTLib). For the purposes of this Quick Start Guide, select any classification within the PTLIb domain classification to continue. See the Guide to Editing Your Data Model for instructions on editing the domain hierarchy used by your repository.

18. When the attributes are completed, select one of the two non-required relationship options ("ContactIs.Organization" or "WasCreatedBy.Organization") for the Asset you are currently creating. Since you already created at least one Organization (steps 8-13), you will notice upon clicking a relationship name that there is a "Browse" button above the input box displayed. You now have the option of using an Organization that you have already created or you can create a new Organization.

19. To select an organization that you have already created, click the "Browse" button and continue to step 20. To create a new Organization, click the "Create" button and go back to step 11 above.

20. The names of the Organizations that have already been created will appear in a menu box. Select the name of the Organization that you wish to use for the current relationship by clicking on the arrow button located to the far right of the input box (if you only created one Organization in the above steps, the name of that Organization will be the only one available). Once you have entered all of the information for the attributes and relationships of the Asset you are now creating, click the "Save Object" button. Again, if a required field has been left blank, the "Save Object" button will not be active.

21. Congratulations! You have just created an Asset, an Organization, and a relationship between the two. To see the catalog entry of your Asset, click on the "Manage Catalog" tab.

22. You should now be looking at the Manage Catalog interface. Click on the "View" button. Select "Catalog".

23. A new browser window should now open that has the name of your repository at the top, a navigation bar showing all the classes in your data model on the left, and a hierarchical domain list under the "Table of Contents" on the right. This is the top-level catalog page for your repository. Follow the appropriate links under "Table of Contents" to view the entry that you have just created (the number in parenthesis is the number of Assets currently cataloged under that classification).

24. Click on the name of the Asset to view its html metadata.

25. The navigation bar will always remain on the left for your convenience to switch between classes. You can click on a different class name to view objects from another class (without classification). And if a class contains vocabulary controlled attributes, you can also click on an attribute name under the class name to view objects from that class as they are hierarchically classified according to the selected attribute.

26. If you wish to modify the data model that you chose when you created this repository, see the Guide to Editing Your Data Model.

 



Quickstart Guide for 2.X


 

After installing RIB, the "Repository in a Box Management Page" should be opened up in your browser. The purpose of this guide is to get first-time RIB users started using the application with little effort and no reliance on the Help documentation. Some familiarization with data models (especially the BIDM) and domain hierarchies will improve this document's effectiveness and usefulness.

1. From the Repository in a Box Management Page in your web browser, click on the "Create a Repository" button.

2. Enter the required information in the input boxes provided.

3. Select the "Yes" radial button of the "Use Simplified BIDM" option at the bottom.

4. Click the "Submit" button.

5. A new page should now appear in your browser. Click the "Go to administration page for " button.

6. Once loading is complete, your browser window should contain the opening RIB administration page interface for your repository (the name of your repository should appear in the upper left corner of the browser and a gray "RIB management page" button should appear in the upper right corner.

7. To begin creating an Object (and any relationships between classes of that Object), click on the tab labeled "Manage Objects". It is within this section that you will add, modify, and/or delete all metadata that describe each individual Object (software) that will appear in your repository's catalog.

8. Use the arrow button next to the "Class" input window to display the list of Object classes in your repository (the displayed list is based on the data model that you are using -- in this case the Simplified BIDM).

9. Select the Organization class. An Organization is a person, company, research group, etc. that creates and/or manages an Asset or Library.

10. Click the "Create" button.

11. Your browser window should now be displaying the list of attributes and relationships (note that there are not any relationships for the Organization Object) on the left-hand side of the interface. Required fields are in red, optional fields are in black (what is optional and what is required may be changed, but should be done before creating or editing the Object's metadata -- see the Guide to Editing Your Data Model).

12. Click on an attribute on the left and enter the appropriate information into the input box that appears. You will notice that once data has been entered into the input box, the attribute name will turn blue.

13. Once you have completed entering attribute data for the Organization, click the button labeled "Save Object". If any required fields have been left blank, the "Save Object" button will not be active (it will be "grayed" out).

14. The browser window should now display the name of the Organization that you just created along with a last modified date and status (use the Help tab of the interface to learn more). At this time, you can now create another Organization or create an Asset. To create another Organization, go back to step 10. To create an Asset, continue.

15. Use the arrow button to display the list of Object classes (as in step 8 above). Select the Asset class. The Asset class contains the attributes that serve as detailed descriptive information (metadata) for each individual software application that you are cataloging.

16. Click the "Create" button.

17. Enter information for the desired attributes (just like you did in step 12). Upon clicking the domain attribute, a window of classification options appears based on the taxonomy or classification scheme employed by the data model that you are currently using. Select a category to place your asset into (a purple folder indicates the availability of a sub-classification - just double click the folder to view the sub-classification options). The domain classification used in the Simplified BIDM is the same one used by the National HPCC Software Exchange (NHSE) Parallel Tools Library Repository (PTLib). For the purposes of this Quick Start Guide, select any classification within the PTLIb domain classification to continue. See the Guide to Editing Your Data Model for instructions on editing the domain hierarchy used by your repository.

18. When the attributes are completed, select one of the two non-required relationship options ("ContactIs.Organization" or "WasCreatedBy.Organization") for the Asset you are currently creating. Since you already created at least one Organization (steps 8-13), you will notice upon clicking a relationship name that there is a "Browse" button above the input box displayed. You now have the option of using an Organization that you have already created or you can create a new Organization.

19. To select an organization that you have already created, click the "Browse" button and continue to step 20. To create a new Organization, click the "Create" button and go back to step 11 above.

20. The names of the Organizations that have already been created will appear in a menu box. Select the name of the Organization that you wish to use for the current relationship by clicking on the arrow button located to the far right of the input box (if you only created one Organization in the above steps, the name of that Organization will be the only one available). Once you have entered all of the information for the attributes and relationships of the Asset you are now creating, click the "Save Object" button. Again, if a required field has been left blank, the "Save Object" button will not be active.

21. Congratulations! You have just created an Asset, an Organization, and a "relationship" between the two. To see the catalog entry of your Asset, click on the "Manage Catalog" tab.

22. You should now be looking at the "Manage Catalog" interface. Click on the "View" button. Select "Catalog".

23. A new browser window should now open that has the name of your repository at the top and the hierarchical domain list under the "Table of Contents". This is the top-level catalog page for your repository. Follow the appropriate links under "Table of Contents" to view the entry that you have just created (the number in parenthesis is the number of Assets currently cataloged under that classification).

24. Click on the name of the Asset to view its html metadata.

25. If you wish to modify the data model that you chose when you created this repository, see the Guide to Editing the Data Model.

Aug 30 2014 Admin Login