Visual Paradigm logo
Jump to Menu

How to Store Reference Files in a Project?

During the discussion of requirements with user, you may be given reference files that explain user's problems or needs. These files can be useful in future discussions or even be used as references during the implementation of features. In Visual Paradigm, you can maintain a reference between your software model and these with external files. If your team is using VPository/Teamwork Server as the collaboration solution, you can make use of the "Teamwork Files" feature to keep these files under the project, and to have them shared among the team. In this tutorial you will learn how to do this.

Compatible edition(s): Enterprise, Professional, Standard, Modeler

  • August 24, 2016
  • Views: 12,911
  • PDF
  • Video

Entity referencing invoice

Preparation

In order to complete this tutorial, your team must be using either VPository or Teamwork Server. If you are not a user of VPository and Teamwork Server, please subscribe VPository first.

You also need a project file to walk through this tutorial. To avoid messing up your production data, we have prepared a project file for you. Please download the project file Invoicing System.vpp and ask your server administrator to import it into the server. By the end of this tutorial, you may ask the administrator to delete the project file from server to release storage space.

Finally, since this tutorial involves the sharing of teamwork files with another team member, some steps will be performed by another team member who has read and commit permission to the project Invoicing System. You are suggested to ask your teammate to work with you in completing this tutorial.

Storing reference files in your project

  1. Start Visual Paradigm.
  2. Open the project Invoicing System from server. You can open a project by selecting Project > Open from the application toolbar.
    Opening project
  3. Open the Entity Relationship Diagram (ERD) Invoicing System ERD. You should see the diagram below.
    Sample ERD
    Let's say the user has given us an invoice file for referencing. We want to maintain a reference between the database design and the invoice file so that the database designer can read it when creating and maintaining the database schema.
  4. Now, let's add the invoice file into this project. Select View > Project Browser from the application toolbar to open the Project Browser.
    Open Project Browser
  5. Open the Files tab.
    Open files tab
  6. The Files page is where you can store and manage project-related files. Let's add the invoice file into the project. Download Invoice-Sample.pdf. You can also find this file at the bottom of this tutorial, under the Resources section.
  7. Let's create a folder to hold the invoice sample. On the left hand side there is a list, which will out the files in this project. Click on the New Folder button on top of the list.
    New folder
  8. In the New Folder dialog box, enter References as folder name.
    Entering folder name
  9. Click OK.
  10. Right click on the References folder just created and select Add File/Folder... from the popup menu.
    Add file to folder
  11. In the file chooser, select the invoice sample downloaded, and confirm. You should see its thumbnail appear on the right hand side of the page.
    Invoice file added

Adding file reference to an entity

In this section you will add a file reference from the entity Invoice in the ERD to the sample invoice file.

  1. Open the Diagrams tab in Project Browser.
    Open diagrams tab
  2. Double click on the thumbnail of the ERD Invoicing System ERD to open it.
    Open ERD
  3. Move the mouse pointer to Invoice entity and click on the reference resource icon at the bottom left of the shape.
    Add reference to entity
  4. Select Add File... from the popup menu.
  5. This opens the Select File window. On the left hand side, select Project Files Folder.
    Selecting project files
  6. Select the file References\Invoice-Sample.pdf and click OK to return to the diagram.

Sharing the file with teammate

  1. Commit all the changes to server by selecting Team > Commit from the application toolbar.
  2. Ask your teammate to open the project Invoicing System from server, or to perform an update if he has opened it already.
  3. Both the design changes and the files kept under the project are shared with him/her. He can now open the sample invoice file from the database design. Click on the reference icon from the Invoice entity and select Invoice-Sample.pdf from the popup menu.
    Open referenced file
    He/she should see the file opened as such:
    Invoice file opened

Watch this Tutorial on YouTube

Here is the video version of this tutorial.




Turn every software project into a successful one.