Record format database connection
|
Command |
Path |
|
Record Format Connection |
Tools > Database |
Each field of the record format needs to be mapped to the appropriate database table column. Required record formats that do not yet exist in the file can be created when connecting the records to the database. IFC/COBie entities can also be created and connected by linking their properties to the database table. The record connections can be saved in an xml file and imported into another file.
Record formats can be automatically created and linked to the database table; see Automatically creating record formats from a database table.
To connect the desired record format to the database table:
Select the command. Alternatively, select a record format in the Data tab of the Object Info palette for a selected object with the desired record attached, and then click Record Format Database Connection.
The Record Format Database Connection dialog box opens, showing available record formats in the file. These records consist of Document (user defined), Parametric (related to parametric objects), or IFC (IFC and COBie records). Each record format can be linked to a data source that has already been connected to the file.
Click to show/hide the parameters.Click to show/hide the parameters.
|
Parameter |
Description |
|
Record Formats in the Document |
Lists the record formats available in the Vectorworks file, as well as the databases and database tables to which they are connected |
|
New |
Opens the Specify Format Type dialog box, to indicate which type of record to create. Select Document to create a new, user-defined record format as described in Creating record formats, and then connect it as described in the following steps. Select IFC/COBie to select an IFC entity and connect its properties. See "Creating or editing and connecting IFC/COBie properties" below. |
|
Edit |
The dialog box that opens depends on the type of format selected. Selecting a document or parametric record format opens the Edit Record Format dialog box, to link the record format to the specified database and table as described in the following steps. Selecting an IFC/COBie record format opens the Edit IFC/COBie Record Format dialog box. See "Creating or editing and connecting IFC/COBie properties" below. |
|
Delete |
Deletes the selected record format from the file |
|
Export as Database Table |
Automatically creates database table rows from the selected record format; see Automatically creating a database table from a record format |
|
Manage Databases |
Opens the Manage Databases dialog box, to connect to available databases; see Database connection |
|
Import Connections |
Imports the connection settings from an external .xml file, overriding any existing database connections. This allows the connections specified from another file to be used in this file. |
|
Export Connections |
Exports the current connection settings to an .xml file |
If a parametric or document record is to be connected, select the record format and click Edit. If an IFC entity is to be connected. See "Creating or editing and connecting IFC/COBie properties" below.
The Edit Record Format dialog box opens, with additional database controls available due to the presence of the database connection.
Select Database Connection to link the record format fields to the selected database and table. This area only displays for record formats when a database is connected in the file.
If needed, verify or change the connected database by clicking Manage Databases, or check the table selected in Table Name to view the table contents.
Click Connection Options to specify database connection update options.
The Connection Options dialog box opens. Select the actions to occur in the database table when the connected record format, or object with the record attached, is edited. (These changes occur at the time of database update set in Specifying update settings; alerts inform you of any changes to the database.)
Click to show/hide the parameters.Click to show/hide the parameters.
|
Parameter |
Description |
|
Add new rows in Database Table when creating Records of this Format |
When a new record format is created, automatically adds a database table row to the connected database |
|
Delete the row in the Database Table when removing Records of this Format |
When a record format is disconnected from an object, or an object with a connected record format is deleted, automatically deletes the row that was connected to the object in the database table |
Click OK to return to the Edit Record Format dialog box.
For each record field, assign a column from the selected table. Select a record field and click Edit.
The Edit Field dialog box opens.
Select the associated table column from the database in DB Table Column, and select the method of database communication in DB Link Type.
Read/Write: Allows data to move in both directions between the database and the Vectorworks file.
Read Only: Allows database information to be read into the Vectorworks file, but does not allow record data to modify the database.
Write Only: Allows the Vectorworks file data to modify the database, but does not allow the database information to modify the Vectorworks record field.
Click OK to return to the Edit Record Format dialog box. The dialog box updates to display the associated table data and link type.
Click in a DB Read/Write column to easily change the link type for the selected row.
Once the data has been linked for each record field, click OK. The fields in the record format have now been linked to the table data in the specified database, and the link type has been defined. On the Data tab of the Object Info palette, connected record formats display with the name of the connected database and its table.
Creating or editing and connecting IFC/COBie properties
As mentioned in the previous section, IFC entities that do not yet exist in the file can be created when connecting properties to a database. In addition, the properties of existing entities can be edited. The process is different when creating or editing IFC/COBie record formats. For IFC/COBie, instead of linking record fields to a database, properties are connected.
An alternative, advanced way to link IFC/COBie records to external databases is to link the database to your custom record format(s), and then use the Data Manager command to map IFC fields (from an IFC entity or psets) to the custom record fields. There is no need to populate all objects with IFC Data (no need to use the Eyedropper tool, or open the IFC Data dialog box). If you use symbols, you can choose different IFC mapping options for each symbol definition according to the attached record format.
To create or edit an IFC/COBie record format:
From the Record Format Database Connection dialog box, click New to create a new record format, or select an IFC/COBie record format and click Edit to edit the format.
The New IFC/COBie Record Format dialog box or the Edit IFC/COBie Record Format dialog box opens. When creating a new IFC/COBie format, select the entity from the list to display its properties and connect them. When editing an IFC/COBie format, the entity is already selected so only its properties display for editing connections.
Click to show/hide the parameters.Click to show/hide the parameters.
|
Parameter |
Description |
|
IFC Version (new IFC/COBie format only) |
When creating a new IFC/COBie record format, select the IFC Version. The associated list of IFC entities displays |
|
Filter List (new IFC/COBie format only) |
When creating a new IFC/COBie record format, enter keywords to filter the entity list |
|
Full Entity List (new IFC/COBie format only) |
When creating a new IFC/COBie record format, displays the list of IFC entities. Select an entity to view and connect its properties |
|
Entity (edit IFC/COBie format only) |
When editing an IFC/COBie record format, displays the name of the selected IFC entity |
|
Properties for the selected Data Set |
Lists the properties of the selected or displayed IFC entity. Each property can be selected, and its parameters display for connection to the database. The property parameters are displayed in columns for convenience. |
Select each property to connect, and specify any default value.
Select the connected database to use, and assign a database table from the selected database. Select the associated table row from the database.
Select the method of database communication in DB Link Type:
Read/Write: Allows data to move in both directions between the database and the Vectorworks file
Read Only: Allows database information to be read into the Vectorworks file, but does not allow the property to modify the database
Write Only: Allows the Vectorworks file data to modify the database, but does not allow the database information to modify the Vectorworks property
Click in a DB Read/Write column to easily change the link type for the selected row.
Click OK to return to the Record Format Database Connection dialog box. The dialog box updates to display the associated database.
