8
Table & Field Name Overwrites XML File

Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

Embed Size (px)

Citation preview

Page 1: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

Table & Field Name Overwrites XML File

Page 2: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

ISO GEN041709M3 Rev. 2 Proudly developed in the United States of America February 2017

Table and Field Name Overwrites XML File

For SAP2000®, ETABS®, SAFE® and CSiBridge®

Page 3: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

Copyright

Copyright Computers and Structures, Inc., 1978-2017

All rights reserved.

The CSI Logo®, SAP2000®, ETABS®, SAFE®, and CSiBridge® are registered

trademarks of Computers and Structures, Inc. Watch & LearnTM is a trademark of

Computers and Structures, Inc.

The computer programs SAP2000®, ETABS®, SAFE®, and CSiBridge® and all

associated documentation are proprietary and copyrighted products. Worldwide

rights of ownership rest with Computers and Structures, Inc. Unlicensed use of

these programs or reproduction of documentation in any form, without prior

written authorization from Computers and Structures, Inc., is explicitly

prohibited.

No part of this publication may be reproduced or distributed in any form or by

any means, or stored in a database or retrieval system, without the prior explicit

written permission of the publisher.

Further information and copies of this documentation may be obtained from:

Computers and Structures, Inc. www.csiamerica.com

[email protected] (for general information)

[email protected] (for technical support)

Page 4: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

DISCLAIMER

CONSIDERABLE TIME, EFFORT AND EXPENSE HAVE GONE INTO THE

DEVELOPMENT AND TESTING OF THIS SOFTWARE. HOWEVER, THE USER

ACCEPTS AND UNDERSTANDS THAT NO WARRANTY IS EXPRESSED OR

IMPLIED BY THE DEVELOPERS OR THE DISTRIBUTORS ON THE ACCURACY OR

THE RELIABILITY OF THIS PRODUCT.

THIS PRODUCT IS A PRACTICAL AND POWERFUL TOOL FOR STRUCTURAL

DESIGN. HOWEVER, THE USER MUST EXPLICITLY UNDERSTAND THE BASIC

ASSUMPTIONS OF THE SOFTWARE MODELING, ANALYSIS, AND DESIGN

ALGORITHMS AND COMPENSATE FOR THE ASPECTS THAT ARE NOT

ADDRESSED.

THE INFORMATION PRODUCED BY THE SOFTWARE MUST BE CHECKED BY A

QUALIFIED AND EXPERIENCED ENGINEER. THE ENGINEER MUST

INDEPENDENTLY VERIFY THE RESULTS AND TAKE PROFESSIONAL

RESPONSIBILITY FOR THE INFORMATION THAT IS USED.

Page 5: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use
Page 6: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

1

Table and Field Name Overwrites XML File

1 General

The program maintains both a key and a name for each table and for each field in

each table. The table and field keys are predefined by the program and cannot be

changed; the program uses the keys internally when working with the tables. The

program uses the table and field names for all table export and display actions.

By default, each table and field name is the same as its corresponding key.

However, the user can change the table and field names using the table and field

name overwrites XML file, as described in this documentation.

By default, table and field names are revised based on the content of a file

named xxxDefaultTableNameFile.xml. When the program launches, it reads the

xxxDefaultTableNameFile.xml file. If the xxxDefaultTableNameFile.xml file does

not exist (see Note), or if it is empty, the table and field names remain the same

as the keys. The Options menu > Database > Set Current Table Name

Source command in SAP2000, ETABS, and SAFE or the Orb > Settings >

Database Table Utilities and Settings > Set Current Table Name Source

command in CSiBridge can be used at any time to specify that table and field

names be based on an .xml file other than the xxxDefaultTableNameFile.xml. The

command also allows the user to restore the program defaults.

Any table name can be specified for a table; however, each table name must be

unique compared to all other table names. Similarly, any field name can be

specified; however, each field name in a table must be unique. If the program

reads non-unique table or field names, it will provide a warning message and set

the name back to its default; that is, the program will set the table or field name

to be the same as the associated key. The comparison of names for uniqueness is

not case sensitive.

Note: The default xxxDefaultTableNameFile.xml must be located in the same

directory as the program executable file. The "xxx" is Sap, Etabs, Safe, or

CSiBridge, depending on the program in use. The following table identifies the

.xml file and the executable file for each CSi Program.

Program-Specific XML File Name and Program Executable File Name

Program XML File Program Executable File

SAP2000 CSiDefaultTableNameFile.xml Sap2000.exe

ETABS EtabsDefaultTableNameFile.xml Etabs.exe

SAFE SafeDefaultTableNameFile.xml Safe.exe

CSiBridge CSiDefautTableNameFile.xml CSiBridge.exe

The use of the Table and Filed Name Overwrites file is currently available for

SAP2000 Version 12 and later, SAFE Version 12 and later, and CSiBridge Version

15 and later. It will become available for ETABS with the next major release of

the software.

Page 7: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

Table and Field Name Overwrites XML File

2

2 Schema

The schema is in the file named xxxDefaultTableNameFile.xsd, which is located in

the same directory as the program executable file (see preceding table). Again

xxx is Sap, Etabs, Safe, or CSiBridge, depending on the program in use.

3 Description of Simple Elements

Element Description

Assumed

Value*

tkey The table key as predefined by the program. N.A.

tname The new table name. Same as tkey

fkey The field key as predefined by the program. N.A.

fname The new field name. N.A.

* value assumed by program if the simple element is not included in the

complex element

Page 8: Table and Field Name Overwrites XML Filedocs.csiamerica.com/manuals/csibridge/Table and Field Name... · The "xxx" is Sap, Etabs, Safe, or CSiBridge, depending on the program in use

Table and Field Name Overwrites XML File

3

4 Example Following is an example Table and Field Name Overwrites XML file: This file

modifies the Sap2000 Joint Coordinates table name to JCs and modifies the XorR

and the Z field names in that table to X and Zee, respectively. It also modifies

the name of the JointI field in the Connectivity - Frame table to JtI.

<?xml version="1.0"?>

<tablelist xmlns="http://www.csiberkeley.com"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.csiberkeley.com

CSiDefaultTableNameFile.xsd">

<table>

<tkey>Joint Coordinates</tkey>

<tname>JCs</tname>

<field>

<fkey>XorR</fkey>

<fname>X</fname>

</field>

<field>

<fkey>Z</fkey>

<fname>Zee</fname>

</field>

</table>

<table>

<tkey>Connectivity - Frame</tkey>

<field>

<fkey>JointI</fkey>

<fname>JtI</fname>

</field>

</table>

</tablelist>