Repository in a Box (RIB) QuickStart Guide

ABSTRACT: This document provides instructions for using the RIB software (version 1.2). It is intended to provide the RIB administrator with brief instructions on setting up and populating an interoperable software repository using the RIB software. It is beyond the scope of this document to provide detailed explanations on how to install, configure, or use the RIB software. See the RIB Installation Guide or the RIB User's Guide. Both of these documents provide detailed directions for installing and using the software. Because the administrative interface to RIB is Web-based, this guide was written for administrators using versions 3.0 or later of either Microsoft's Internet Explorer or Netscape's Navigator Web browser.

1. Click on the "Create a new repository" link

2. On the screen that appears, give your repository a name and provide an e-mail address in the appropriate input boxes.

3. Check the spelling and syntax of the repository name and e-mail address that you entered. Note: Neither the name nor e-mail address can be changed once the Repository has been created.

4. Click on the "Create Repository" button.

5. If the information was entered correctly, a page will appear titled "Repository Creation Results" and files will be created as you watch. Once the page has completed, scroll to the bottom of the page.

6. Under the bold word "Success" on the left, click on the link which says "using this new repository".

7. Congratulations! You should now be looking at the Administrator screen for your new repository.

8. Take a moment to look over this interface and familiarize yourself with each section and the options available within each section.

The first step is to create an Asset description. This can be done three different ways. An Asset can be created from scratch, can be copied ("Import") from another repository, or you can link to an Asset in another Repository ("Add a link"). See Section 4.1.1 Create Options and/or Section 6.0 Repository Interoperation of the RIB User's Guide for details on using the "Import" and/or "Add a link" features, respectively. The following instructions are for creating an Asset from scratch.

The instructions that follow are for populating a repository that uses the default BIDM configuration and the default NHSE domain configuration. If you have changed either of those parts of your repository then your repository may not behave in a manner that is consistent with the remainder of this guide.

Note : as of version 1.2 of RIB, it is possible to upload software files into your repositories. The remainder of this guide does not discuss the upload feature but instead focuses only on creating Asset descriptions for the Software Catalog. See the Managing Software Files section of the RIB user's guide for information on how to upload files.

1. On the Administration screen for your repository, there is a section called "Create Asset Descriptions". In this section on the left side of the table are the Classes in your configuration. The simple BIDM configuration uses two Classes; Asset and Organization. Located to the right of each Class name are the following Actions: "Browse", "Create", "Edit", "Delete", "Import".

2. Click on the "Create" link beside Asset.

3. The next page that appears is the "Asset creation for your repository name" screen. If you scroll down this page, you will see input boxes for each attribute of your Asset which is determined by the configuration that you specified when the repository was installed (Remember--by default the simple BIDM configuration is used if no configuration was specified at the time of installation). The simple BIDM configuration for each Asset contains the following fields or attributes: Abstract, ContactIsOrganization, DateOfInformation, Domain, File, Name, Restrictions, TargetEnvironment, Version, VersionDate, and Webpage. There is also a filename input box. It is explained on the screen. Above the input box for each attribute is the attribute title or name which is a hyperlink. Clicking on the name produces a new browser window which describes the attribute. Also beside each attribute name (located in parenthesis) is a note specifying whether that attribute is optional or required.

4. In the "Abstract" input box, type a descriptive explanation of your software application (Asset) that you are now cataloging. This might include the application's purpose and/or benefit to users.

5. Scroll down to the next input box, which is for ContactIsOrganization. Since you are creating the first Asset, you must also create an organization for that Asset which serves as a contact. ContactIsOrganization is a relationship. Refer to section 3 Configuring the Repository of the RIB User's Guide for more information about relationships. Refer to the Glossary of the RIB User's Guide for the definition of organization. Right Click on the "Create" link located above and to the right of the ContactIsOrganization input box. Select the "Open new window" option.

6. The resulting screen will say "Organization creation for your repository name". There are two options on this screen. Click on the "Create a new Organization" link.

7. Fill in, at minimum, the required fields (including filename) on this page and follow the instructions located at the bottom of the page. Note: Remember, write down, or copy the name that you typed inside the filename input box because you will need this for step 10.

8. The screen that follows will indicate whether the Organization was successfully created. If the Organization creation was not successful, the errors will be identified. Simply return to the "Organization creation for your repository name" screen and correct the errors. Refer to the RIB User's Guide or Installation Guide for trouble-shooting non-recoverable errors. If the Organization creation was successful, then continue

9. Close this browser window and return to the "Asset creation for your repository name" browser window.

10. Insert or paste the filename of the Organization that you just created into the ContactIsOrganization input box and go to step 12 below. If you do not remember the file name that you created for the new Organization, right click on the "browse" link located to the left and above the ContactIsOrganization input box. Select the "Open new window" option and proceed to step 11 below.

11. On this screen (the one in the new window you just opened), you will see the organization name(s) in bold letters on the left side of the page. Remember, write down, or copy your Organization name, close this browser window, return to the "Asset creation for your repository name" window. Go back to step 10.

12. The DateOfInformation box will contain the correct date and time that you began creating this Asset.

13. The Domain box will contain the domain hierarchy for your repository which you configured during RIB installation. The default domain hierarchy/configuration for RIB is the NHSE configuration. Refer to section 3.3 Configuring the domain hierarchy of the RIB User's Guide for more information on domain configuration. Select the domain where you wish to place the Asset that you are now cataloging. Note: Exclamation points are used as delimiters between domains and sub-domains.

14. The File field is optional. This is where you type the url which points to the actual software packaage. This url should not point to a web page or other informational type of document, but instead should point at the actual software package itself.

15. In the Name input box, type the name of the application (Asset) that you are cataloging.

16. The Restrictions field is optional. Type inside this input box any legal information governing the use of this asset, including potential copyright, data rights, disclaimers, export restrictions, and licenses.

17. In the TargetEnvironment input box, type any information concerning the computer system, operating system, and/or compiler for which this application (Asset) was developed.

18. The Version field is optional. Type inside this input box the current version of this application (Asset).

19. The VersionDate field is optional. Type inside this input box the publication date or date this version of the application (Asset) was made available for public use.

20. In the Webpage input box, type the full url which represents the homepage on the Internet where information about this application (Asset) can be found.

21. The RIB application is a file-based system, which means that data is stored in the way of separate files. In the filename input box, type the name of the file that you wish to give this Asset in the repository. Note: The filename is not the name that will appear in your repository catalog, but rather the file name that RIB uses to access data about this Asset. The name that will appear in the catalog comes from the Name that you created in step 15. The filename may be the same as the name entered in the Name field input box, but the correct syntax must be followed. Read the instructions preceding the filename input box for the proper syntax.

22. Check the small box beside the long gray bar located below the filename input box.

23. Click on the long gray bar.

24. If the Asset creation was successful, the resulting screen will indicate such. Skip to step 25. If the creation was not successful, the "Asset creation for your repository name" page will appear with any errors listed at the top. Correct the errors listed and go back to step 22.

25. On the page that now appears, go to the line which states "Click here to update the software catalog for this repository." and click on "here".

26. On the resulting screen, you will see the catalog generation as it progresses. When the catalog generation is complete, scroll to the bottom of the page and follow the instructions to view the catalog for your repository.

27. Congratulations! You have successfully created and populated a RIB repository.

Please send any questions or comments to rib@nhse.org