Difference between revisions of "HOWTO:New Equipment Definition"
From WireCAD Online Help
| (34 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
|desc=Create a new piece of equipment not currently in the Equipment Library. WireCAD has a local libray and an online community to find equipment. This function will allow you to create equipment it if is not avaliable in either resource.}}<br> | |desc=Create a new piece of equipment not currently in the Equipment Library. WireCAD has a local libray and an online community to find equipment. This function will allow you to create equipment it if is not avaliable in either resource.}}<br> | ||
| − | |||
__TOC__ | __TOC__ | ||
| Line 11: | Line 10: | ||
== Before You Start == | == Before You Start == | ||
| − | Check that the piece of equipment you are looking for is not currently avaliable in the | + | Check that the piece of equipment you are looking for is not currently avaliable in the Local Library or Online Community. |
| − | To check the | + | To check the Local Library and Online Community, ''Click'' '''Advanced Tools>Equipment Library'''. On the left hand side of the screen under the '''Menu Bar''', you will see the option to select '''Local''' or '''Community Server'''. Enter your search query information in the '''Find''' box, select whether you would like to search '''Local''' or '''Community Server''' and press '''[Find]'''. |
If you are unable to find your equipment, proceed below. | If you are unable to find your equipment, proceed below. | ||
| + | {{Note| If you try to search using multiple criteria ''(Manufacturer AND Model)'' you will not return any results. When searching use only 1 query at a time.}} | ||
| Line 22: | Line 22: | ||
! Step !! Description | ! Step !! Description | ||
|- | |- | ||
| − | |''Click'' '''Advanced Tools>Equipment Library''' ''OR'' '''Database>Equipment Library''' ''OR'' Command shortcut '''LE''' || This will bring you to | + | |1. ''Click'' '''Advanced Tools>Equipment Library''' ''OR'' '''Database>Equipment Library''' ''OR'' Command shortcut '''LE'''. || This will bring you to the equipment library where you can search for pieces of equipment. |
|- | |- | ||
| − | |On the right hand side of the screen, you will see multiple buttons including '''[Add Manufacturer To Library]''' and '''[Add Equipment To Library]''' || You will need to make sure that your ''Manufacturer'' is currently listed in the library. If it is not please refer to [[How To Add A New Manufacturer To Library]] and add this information first. ''(This can also be done while adding new equipment if desired)'' | + | |2. On the right hand side of the screen, you will see multiple buttons including '''[Add Manufacturer To Library]''' and '''[Add Equipment To Library]'''. || You will need to make sure that your ''Manufacturer'' is currently listed in the library. If it is not, please refer to [[How To Add A New Manufacturer To Library]] and add this information first. ''(This can also be done while adding new equipment if desired).'' |
| + | |-. | ||
| + | |3. ''Click'' '''[Add Equipment To Library]'''.|| When you click '''[Add Equipment To Library]''', a dialog box will pop up with a series of fields that you are required to fill in as well as some that are optional.[[File:New Equipment Window.png|thumb|New Equipment Window]] | ||
|- | |- | ||
| − | | | + | |4. In the dialog box, start by selecting the Manufacturer field, and input who makes your piece of equipment.|| Clicking anywhere in the field will populate a drop down menu in which you will be able to select from the list of Manufacturers currently avaliable. ''Alternately'', if your Manufacturer isnt listed and you havent created it yet, you can ''Click'' the '''[...]''' which will bring up a new dialog box allowing you to create your Manufacturer from here. For more info on creating a new manufacurer refer to [[How To Add A New Manufacturer To Library]]. [[File:Add Manufacturer Window.png|thumb|Add Manufacturer Window]] |
| − | + | ||
| − | + | ||
|- | |- | ||
| − | |After filling out the first set of fields Click '''[Next]'''|| You are now presented with another set of fields to fill out. The only | + | |5. After filling out the first set of fields Click '''[Next]'''.|| You are now presented with another set of fields to fill out. The only reccomended field is the front panel field. ''Click'' '''[...]''' to open the folder and select the '''2D_Elevations''' folder. This folder contains a set of premade panels. Here you will need to browse in order to find the panel that works best for your type of equipment. You can also refer to [[Creating Equipment Panels]] to learn how to create custom panels. |
[[File:Front Panel Select Window.png|thumb|Panel Select Window]] | [[File:Front Panel Select Window.png|thumb|Panel Select Window]] | ||
|- | |- | ||
| − | |After selecting your panel and filling out any other information you would like, ''Click'' '''[Finish]'''.|| Your new equipment will now be created and you will automatically be taken to it in your Equipment Library. | + | |6. After selecting your panel and filling out any other information you would like, ''Click'' '''[Finish]'''.|| Your new equipment will now be created and you will automatically be taken to it in your Equipment Library. |
| Line 41: | Line 41: | ||
== Adding/Changing I/O Ports And Updating Detail == | == Adding/Changing I/O Ports And Updating Detail == | ||
| − | At this point, your newly created equipment should be the only visible piece of equipment | + | At this point, your newly created equipment should be the only visible piece of equipment. |
{| class="wikitable" style="color:black; background-color:#ffffcc;" cellpadding="10" cellspacing="0"; border="1"; width="100%" | {| class="wikitable" style="color:black; background-color:#ffffcc;" cellpadding="10" cellspacing="0"; border="1"; width="100%" | ||
| Line 47: | Line 47: | ||
! Step !! Description | ! Step !! Description | ||
|- | |- | ||
| − | |''Click'' the '''[Detail]''' tab. || From here enter in any information you have avaliable on your equipment. ''( | + | |1. ''Click'' the '''[Detail]''' tab. || From here enter in any information you have avaliable on your equipment. ''(We ask that you please be as thorough as possible and please upload your equipment to the community when you're done)''. [[File:Equipment Detail.png|thumb|Equipment Detail Page]] |
|- | |- | ||
| − | |When you have finished updating your equipment detail, ''Click'' the '''[I/O]''' tab. || This will pull up the I/O page where you will be able to add, delete or modify all inputs and outputs on this | + | |2. When you have finished updating your equipment detail, ''Click'' the '''[I/O]''' tab. || This will pull up the I/O page where you will be able to add, delete or modify all inputs and outputs on this piece of equipment. [[File:I-O Page.png|thumb|I/O Detail Page]] |
|- | |- | ||
| − | |In the middle of the screen, ''Click'' the '''[Add Ports]''' button || A dialog box will now pop up allowing you to fully customise your I/O list. You have the ability to select add as an | + | |3. In the middle of the screen, ''Click'' the '''[Add Ports]''' button. || A dialog box will now pop up allowing you to fully customise your I/O list. You have the ability to select add as an Input, Output or Both, The Name Of The Port, Cable End Connectors, Signal Type, Input and Output Pin Types, Add Multiple Ports and Appending Characters. To learn more about customising your I/O, please refer to '''[[Customizing Equipment I/O]]'''. [[File: Port Creation Window.png|thumb|Add Port Dialog Box]] |
|- | |- | ||
| − | | | + | |4. ''Click'' '''[Finish]''' || Your equipment is now ready to be placed in your drawing. |
|- | |- | ||
| Line 60: | Line 60: | ||
== Uploading Equipment Back To The Community Library == | == Uploading Equipment Back To The Community Library == | ||
| − | We ask that all of our WireCAD users upload any created equipment back to our Community Server to share with everyone. | + | We ask that all of our WireCAD users upload any created equipment back to our Community Server to share with everyone. This way the database will continue to grow and new equipment will be avaliable. This is also very helpful in the event that your database gets lost or corrupt since you will be able to access the equipment again from the Community Server. |
| − | + | Please refer to [[Uploading Equipment To Community Server]]. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 17:31, 11 October 2011
| Command Line Shortcut: ' User Permissions Level: All |
Contents
Before You Start
Check that the piece of equipment you are looking for is not currently avaliable in the Local Library or Online Community. To check the Local Library and Online Community, Click Advanced Tools>Equipment Library. On the left hand side of the screen under the Menu Bar, you will see the option to select Local or Community Server. Enter your search query information in the Find box, select whether you would like to search Local or Community Server and press [Find]. If you are unable to find your equipment, proceed below.
 Note: If you try to search using multiple criteria (Manufacturer AND Model) you will not return any results. When searching use only 1 query at a time.
|
How To Create A New Piece Of Equipment
| Step | Description |
|---|---|
| 1. Click Advanced Tools>Equipment Library OR Database>Equipment Library OR Command shortcut LE. | This will bring you to the equipment library where you can search for pieces of equipment. |
| 2. On the right hand side of the screen, you will see multiple buttons including [Add Manufacturer To Library] and [Add Equipment To Library]. | You will need to make sure that your Manufacturer is currently listed in the library. If it is not, please refer to How To Add A New Manufacturer To Library and add this information first. (This can also be done while adding new equipment if desired). |
| 3. Click [Add Equipment To Library]. | When you click [Add Equipment To Library], a dialog box will pop up with a series of fields that you are required to fill in as well as some that are optional. |
| 4. In the dialog box, start by selecting the Manufacturer field, and input who makes your piece of equipment. | Clicking anywhere in the field will populate a drop down menu in which you will be able to select from the list of Manufacturers currently avaliable. Alternately, if your Manufacturer isnt listed and you havent created it yet, you can Click the [...] which will bring up a new dialog box allowing you to create your Manufacturer from here. For more info on creating a new manufacurer refer to How To Add A New Manufacturer To Library. |
| 5. After filling out the first set of fields Click [Next]. | You are now presented with another set of fields to fill out. The only reccomended field is the front panel field. Click [...] to open the folder and select the 2D_Elevations folder. This folder contains a set of premade panels. Here you will need to browse in order to find the panel that works best for your type of equipment. You can also refer to Creating Equipment Panels to learn how to create custom panels. |
| 6. After selecting your panel and filling out any other information you would like, Click [Finish]. | Your new equipment will now be created and you will automatically be taken to it in your Equipment Library.
|
Adding/Changing I/O Ports And Updating Detail
At this point, your newly created equipment should be the only visible piece of equipment.
| Step | Description |
|---|---|
| 1. Click the [Detail] tab. | From here enter in any information you have avaliable on your equipment. (We ask that you please be as thorough as possible and please upload your equipment to the community when you're done). |
| 2. When you have finished updating your equipment detail, Click the [I/O] tab. | This will pull up the I/O page where you will be able to add, delete or modify all inputs and outputs on this piece of equipment. |
| 3. In the middle of the screen, Click the [Add Ports] button. | A dialog box will now pop up allowing you to fully customise your I/O list. You have the ability to select add as an Input, Output or Both, The Name Of The Port, Cable End Connectors, Signal Type, Input and Output Pin Types, Add Multiple Ports and Appending Characters. To learn more about customising your I/O, please refer to Customizing Equipment I/O. |
| 4. Click [Finish] | Your equipment is now ready to be placed in your drawing. |
Uploading Equipment Back To The Community Library
We ask that all of our WireCAD users upload any created equipment back to our Community Server to share with everyone. This way the database will continue to grow and new equipment will be avaliable. This is also very helpful in the event that your database gets lost or corrupt since you will be able to access the equipment again from the Community Server.
Please refer to Uploading Equipment To Community Server.
