bocad steel interface

Download BOCAD Steel Interface

If you can't read please download the document

Upload: tien-ha-sy

Post on 09-Oct-2015

773 views

Category:

Documents


103 download

DESCRIPTION

BOcad

TRANSCRIPT

  • AVEVA Bocad Steel Interface

  • Discl1.1 AVE errupted, error-free or free fromviruses

    1.2 AVE will and/or similar losses; loss ofanticipa tion of data or information; anyspecial,sufferedcreatedcontrac

    1.3 AVEperformclaim is

    1.4 Cla

    1.5 In thwhich th

    CopyCopyrig(includiwith it)

    All rightis commthe priothat thismade.

    The maelectronengineepublicapermissprohibit

    The AVand coUnauth

    Copynot be lfrom a u

    AVEVA

    TradeAVEVAthe AVE

    AVEVAsubsidia

    The coplogo be

    AVEVA Solutions Limited aimerVA does not warrant that the use of the AVEVA software will be unint

    .

    VA shall not be liable for: loss of profits; loss of business; depletion of goodted savings; loss of goods; loss of contract; loss of use; loss or corrup

    indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise int, tort (including negligence) or otherwise.

    VA's total liability in contract, tort (including negligence), or otherwise, arising in connection with theance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's brought.

    uses 1.1 to 1.3 shall apply to the fullest extent permissible at law.

    e event of any conflict between the above clauses and the analogous clauses in the software licence undere AVEVA software was purchased, the clauses in the software licence shall take precedence.

    rightht and all other intellectual property rights in this manual and the associated software, and every part of it

    ng source code, object code, any data contained in it, the manual and any other documentation suppliedbelongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

    s are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this documentercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without

    r written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is

    nual and associated documentation may not be adapted, reproduced, or copied, in any material oric form, without the prior written permission of AVEVA Solutions Limited. The user may not reverser, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this

    tion may be incorporated into any third-party software, product, machine, or system without the prior writtenion of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictlyed, and may give rise to civil liabilities and criminal prosecution.

    EVA software described in this guide is to be installed and operated strictly in accordance with the termsnditions of the respective software licences, and in accordance with the relevant User Documentation.orised or unlicensed use of the software is strictly prohibited.

    right 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shalliable for any breach or infringement of a third party's intellectual property rights where such breach resultsser's modification of the AVEVA software or associated documentation.

    Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

    mark and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use ofVA or Tribon trademarks is strictly forbidden.

    product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or itsries, registered in the UK, Europe and other countries (worldwide).

    yright, trademark rights, or other intellectual property rights in any other product or software, its name orlongs to its respective owner.

  • Revisi

    Date

    May 2

    June

    Sept 2

    AVEVA Bocad Steel Interface on Sheet

    Version Comments / Remarks

    013 2.0 Design Parameters modifications2013 2.1 Model Limits Offsets modifications

    013 2.2 Profile mapping Files modifications

  • AVEVA Bocad Steel Interface

  • AVEVA Bocad Steel InterfaceAVEVA Bocad Steel Interface

    Contents Page

    AVEVA Bocad Steel InterfaceIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

    Installation of the ABSI Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Version Specific Installation Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Installation with AVEVA E3D1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

    Export/Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12.2i Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Export to AVEVA Bocad Steel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1Import from AVEVA Bocad Steel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:20Technical Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:40Transfer of Curved Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:46Stairs, Ladders and Handrailing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:48

    Import Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:49Sample Validity Check Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:51Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:52Upgrading a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:55Customise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:67Internal Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:75External Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:78

  • AVEVA Bocad Steel InterfaceSupplementary Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1Modification Dates and Times and the Base Product . . . . . . . . . . . . . . . . . . . .A:1First Time Export to AVEVA Bocad Steel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:2Import from AVEVA Bocad Steel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:2Subsequent Export to AVEVA Bocad Steel . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:2Removal of History Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:3Design Parameter Sized Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:3Managing the Model Limits and Offsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:8Initialisation of the ABSI Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:11Catalogue Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:11Application Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:11User Customisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:182.2ii Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • AVEVA Bocad Steel InterfaceIntroduction1 Introduction

    AVEVA Bocad Steel Interface allows the user to export and import files using the AVEVABocad Steel Interface (ABS) format. This is a proprietary encrypted and compressed fileformat designed to reduce transfer file size and to increase security.

    The interface is compatible with: AVEVA Plant 12 Series AVEVA Outfitting 12 Series AVEVA Everything3D

    henceforth known as the base product.

    1.1 AssumptionsThe AVEVA Bocad Steel Interface Reference Manual has been written for users familiar withstructural design practices, who may or may not have prior knowledge of the base product.

    It is assumed that: Users have a valid base product license and the software has been installed. Users have a basic knowledge of the base product. The user is familiar with the basic graphical user interface (GUI) features.

    1.2 Guide StructureThe AVEVA Bocad Steel Interface Reference Manual is divided into the following sections:

    Introduction introduces this guide and summarises its scope.

    Installation of the ABSI Product

    how to install the product.

    Export/Import gives a general overview of the facilities provided within theapplication.2.2 1:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Supplementary Information

    provides supplementary information.

  • AVEVA Bocad Steel InterfaceIntroduction2.1 1:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceInstallation of the ABSI Product2 Installation of the ABSI Product

    The user will be able to install the ABSI product for the base product, so that the sameproduct files will work with any target version. On installation a file Bocad_vars.bat isautomatically produced that stores the folders where the product is installed. If required tohave several versions of the application on a single machine, this file can be modified toaccess the correct version.rem ---------------------------------------------------------------rem Add AVEVA Bocad Steel Interface variablesrem ---------------------------------------------------------------set BOCMAIN=C:\Program Files (x86)\AVEVA\Plant\ABSI2.2.0\set BOCDATA=C:\Users\Public\Documents\AVEVA\Plant\ABSI2.2.0\

    The installer allows the user to select where the main product (BOCMAIN) and the usermodifiable parts (BOCDATA) are to be located. Once installed, the user will have to modifythe main batch files for starting the base product. For the base product the file to modify isevars.bat or custom_evars.bat in the main executable folder. The same manual change isrequired in each file.

    Add to the bottom of the file the followingrem ---------------------------------------------------------------rem Add AVEVA Bocad Steel Interface variablesrem ---------------------------------------------------------------set BOCAD_INSTALLED_DIR=C:\Program Files (x86)\AVEVA\Plant\ABSI2.2.0if exist "%BOCAD_INSTALLED_DIR%\Bocad.bat" call "%BOCAD_INSTALLED_DIR%\Bocad.bat"

    where the BOCAD_INSTALLED_DIR is the correct installation folder for your situation.

    For AVEVA PDMS12.0 SP6, AVEVA PDMS12.1 series and AVEVA Marine 12.1 the usermust also copy the file called bocad from BOCAD\bocad\addins to the addins folder inthe UI area for the installed PDMS version, for example:C:\AVEVA\Plant\PDMS12.1SP2\PDMSUI\des\addins.

    2.1 Version Specific Installation Issues2.22:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    The PML index files in user accessible areas can be rebuilt easily. The problem is for theapplication core PML file index. If, for any reason, the user needs to regenerate the index,there are two files that might not get indexed by the PML REHASH ALL command in theAVEVA E3D. This is most likely to happen with the base product. Following a PMLREHASH, the application might not work with the base product.

    The following files may get missed, although their containing folder should be held.

  • Bocad Steel InterfaceInstallation of the ABSI ProductIf they are not in the index file, they should be put in by hand so that E3D can use them.

    2.2 Installation with AVEVA E3D1.1AVEVA E3D1.1 was distributed with the option of installing the previous version of ABSI,ABSI1.1. Although there should not be an interference problem, once the old ABSI1.1 hasbeen removed, the user is advised to remove the equivalent lines from the end of theevars.bat and evars.init files to ensure that the correct environment variables are initialised.

    For example: remove the following lines:

    rem ---------------------------------------------------------------rem Add AVEVA Bocad Steel Interface variablesrem ---------------------------------------------------------------set BOCMAIN=%AVEVA_DESIGN_INSTALLED_DIR%if exist "%BOCMAIN%Bocad_env.bat" call "%BOCMAIN%Bocad_env.bat"If problems persist, remove the old Bocad application by hand from the following locations(as PML files may be defined several times):

    Once all traces of ABSI from AVEVA E3D1.1.0 have been removed, the user mustregenerate the pml.index for AVEVA E3D. Unfortunately, as this is embedded in a folderthat the user cannot change by normal methods, it has to be done by an administrator. APML REHASH ALL will not work. The administrator must copy the original pml.index file tothe desk top, then edit it by hand to remove all the references to Bocad folders and files. Thefile must then be copied back into place as an Administrator to override the security settings.

    Enter AVEVA E3D, the ABSI options on the main tabs will not be displayed, proceed withthe installation of this release.

    C:\Program Files (x86)\AVEVA\Plant\E3D1.1.0\PMLLIB (bocad sub folder)

    C:\Program Files (x86)\AVEVA\Plant\E3D1.1.0 (bocad_env.bat, possibly the bocad exefolder)

    C:\Users\Public\Documents\AVEVA\Plant\E3D\Data1.1.0\... (bocad user data)

    The bocad addin2.22:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/Import3 Export/Import

    AVEVA Bocad Steel Interface is an application which allows the user to export and importfiles using the AVEVA Bocad Steel Interface (ABS) format.

    3.1 Export to AVEVA Bocad SteelAVEVA Plant and Outfitting 12 Series

    To export a steel structure to an AVEVA Bocad Steel Interface file, select Utilities > AVEVABocad Steel Interface > Export to AVEVA Bocad-3D to display the Export window.

    A Warning message may be displayed stating mapping files are not found. This is becauselocal versions have not been set up. Use the default set provided with the product.

    AVEVA Everything3D

    To export a steel structure to an ABS file, on the Sections, Plates or Stairs LaddersHandrails tab, in the ABSI group, click Export to display the Export window.2.23:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportMapping Files

    Click Mapping files to display the Export mapping files window which containsinformation about the mapping files that are to be used in the Export process.

    The interface requires at least two external mapping tables to enable it to check that AVEVABocad Steel can accept the data. It also may use the Unicode mapping table if necessary.The main mapping tables are for the Profiles and Materials between base product and theneutral file. The Unicode mapping table is to translate the base product Unicode strings intoASCII strings. The section Customise tells the user how to arrange these files on the filesystem and what format they are to be. The interface also needs to know where the externalmapping files are located on the users computer network. For this, internal mapping tablesare required. Refer to Internal Mapping Files which explains how to configure the interfaceto tell it where all the files are located.

    The user may have a generic set of mapping tables to map between the base product andAVEVA Bocad Steel. Or the user may have a set for a particular steel fabricator.

    The current file settings are indicated on this Export Target Information window. Do not beconcerned that the path name may be truncated by the insertion of the ellipsis (): it ismodified only for display purposes on the window.

    The system also checks that these files are compatible with AVEVA Bocad Steel bychecking only the identification line at the top of each mapping table. Refer to ExternalMapping Files for details about the format of these mapping files.

    The two main options are System and Manual which are activated by selecting theappropriate radio button.

    System causes the interface to select automatically the mapping tables for AVEVA BocadSteel according to the system configuration files.

    Manual activates other buttons, which are initially greyed out for the System option.Selecting this option changes the window to be similar to below.2.23:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe user can select the file type using the Profiles, Materials or Unicode radio buttons andenter the full path name of the file in the data entry area. The user can also include systemenvironment variables in the path name as long as they are in the proper base productformat, for example AVEVA Bocad Steel %ENVVAR% being the base productrepresentation of the ENVVAR environment variable.

    Click carriage return, the interface checks for existence of the file and compatibility withAVEVA Bocad Steel.

    Note: The check is only that the file applies to AVEVA Bocad Steel and not that it is acorrect file type or that its contents are correctly formatted.

    The user can either choose by hand which mapping file to use by entering its name in thetext data entry field, or by using the Browse option to bring up a File Browser. The user mayuse this browser to search for the relevant mapping file.

    Once the user has entered all the correct data on the Export Mapping Files window, clickOK the interface variables are updated. Click Cancel to close the window, leaving theoriginal interface variables unchanged.2.23:3 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportError and Log File Messages

    Export Information

    Click Export Information to display the Export Information window which containsinformation about the export process.

    The user can either type the full folder path name of the output file, or click Browse todisplay a File Browser. The interface tests to see if the file exists and if it does, the user willbe asked whether to overwrite it. If the file does exist and the user wants to overwrite it, thefile mode beside Browse will change from WRITE to OVERWRITE. The output file isrechecked for write/overwrite status during the actual Export process. This is because theuser can perform repeat Exports without changing the output file name.

    Note: If the user does not enter the full path name and just a plain file name, the output fileis created in the folder which started the base product. The user may also includesystem environment variables in the path name as long as they are in the proper the

    Internal error Internal lists are not in step.

    Cannot find suitableinternal mapping list

    Internal mapping files not found.

    Suitable Mapping TableFile not found

    Mapping table found is not for AVEVA Bocad Steel, or itdoes not exist.

    Not a suitable MappingTable File

    Incorrect format of file, or empty file, or wrong target forexample not AVEVA Bocad Steel.

    Bad Map File Mapping file is not correct format. Possibly it is fromanother operating system.

    Error on FileBrowser window

    The user has entered incorrect data on the file browser.2.23:4 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/Importbase product format, for example: %ENVVAR% being the base productrepresentation of the ENVVAR environment variable.

    The ABS file may have several sections: a header, a set of Linear Members, and a set ofPlates and their holes. The header is compulsory: any other section is optional.

    The user can create and use any number of project header elements that are used to insertinformation into the transfer file. The interface assumes that there is a default one /FABGLOBAL. These zones are stored in the Application Data area. On export and importone can associate the project header details with the transfer file. This can include themodel offset and orientation applied to the model.

    Different transfers can use different headers. The user can select the correct one, or createa new one in from the Project Header drop down list. It is up to the user to ensure that thecorrect header is used.

    The user can view the information contained by the chosen header element by clickingInspect which displays the Export File Header Details window.

    At first the entry fields are inactive so the user can just read the contents. To modify thecontents of the fields click Edit on the Export File Header Details window and the fieldsbecome active allowing the user to enter any revised data. Click Apply and the data will betransferred back to the chosen header object, overwriting the original data. Click Cancel toleave all the data unchanged.

    Note: The user cannot modify or delete /FABGLOBAL.2.23:5 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportWith this window, the user can define a model offset and rotation for ease of use in Bocad.

    Using the toggles on the Export Information window, the user can select whether to exportStraight or Curved members, and Plates, with the additional option of including their holes.The user is able to export Plates without their holes.

    Model Offsets and Orientations

    If the user has already selected something to Export, the Export Information window isupdated to include the 3d world limit box of the export items.

    The user can see the limit box of the items to be exported in global terms, or in terms of theselected header element.2.23:6 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportAVEVA Bocad Steel cannot handle such large coordinates as other AVEVA products, andhere there is the opportunity to define in the file header a local origin, offset position andorientation in world coordinates. The model offset and orientation are used to translate themodel in the ABS file. The East/North/Up position is entered in the fields indicated. It mighttake an iteration or two for the AVEVA model to be compatible with the AVEVA Bocad Steelmodel, such that the user of each system is happy with the Model Offset value. Once this isachieved, the Model Offset will be locked and it becomes fixed for future transfers. If theuser later tries to modify these values, it must be an explicit decision. Refer to Managing theModel Limits and Offsets for more information.

    The Model Offset values are stored in a system ZONE in the Application Data world /FABAPPDW. In case of emergency, using normal commands outside the interface, theZONE can be locked or unlocked by hand.2.23:7 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportCreate a new header block

    The user can create a new header block by selecting New header from the Projectheader drop down list.

    The ABSI - Export Header window is displayed, the user can populate the window with allthe relevant details. Remember to fill in the name to appear in the header drop down list.This must be the basis of a valid Dabacon element name.

    The Model Rotation is a rotation angle measured in degrees about the Z axis following theright hand screw rule. It is usually assumed that the header is locked to prevent accidentalchanges

    Transfer User Data

    This version of the interface allows the user to transfer up to 5 numerical values and 5 textvalues to AVEVA Bocad Steel. The data are associated with linear members or plates.There is the equivalent functionality in AVEVA Bocad Steel, but they operate in differentways.

    If required, the user can transfer specific information about the model hierarchy to assist theAVEVA Bocad Steel user in managing the model in AVEVA Bocad Steel. This functionality iscovered by user data, the interface comes with two sample configurations, but the user cancreate more.2.23:8 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportUse the toggles to turn fields on and off. The user can then enter the Source type of elementin the hierarchy above the element at which this data extraction is taking place. The usercan even extract data at the GENSEC, PANE or SCTN level. The attribute is the PDMSattribute name or the name of a user defined function that can perform more complexoperations to return the correct value. As with all equivalent customisation functionality, it isup to the user to manage errors.

    By default the system is suppled with two configurations, ANY and HIERARCHY. Whenviewing the HIERARCHY, ABSI Export User Data Set window is populated as follows:

    If the attribute value is not immediately available, the user can specify an alternative defaultattribute, function or value. And then if required enter descriptive text. The data on thewindow is encoded and included in the transfer file for the AVEVA Bocad Steel user to seewhat has been transferred.2.23:9 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThis information is not stored in the database, but in the configuration file, which can beloaded by other projects. Refer to Customise in Chapter Export/Import for more information.

    The interface checks that the user is attempting to Export something and will output amessage if there is nothing to export.

    Once all the correct data has been entered on the Export Information window, click OKand the interface variables will be updated. Click Cancel to close the window, leaving theoriginal interface variables unchanged.

    Error and Log File Messages

    Run Information

    Click Run Information to display the Export window which allows the user to view the LogFile after the export process is complete by clicking to select the Log File? check box.

    Export file already exists File exists, the user will get the option to overwrite it.

    Wrong place in database The user is most likely at the WORLD element in thedatabase.

    Illegal Transfer letter The user can only use transfer letters between A and Z.

    Nothing to export The user has deselected both the Linear Members andPlates options.

    Cannot decrement Transferletter

    The user can not decrease the Transfer letter, onlyincrement it.2.23:10 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportClick the Brief or Verbose radio buttons, the user can choose which format messages aredisplayed.

    The Test Run? option allows the user to suppress the updating of all the Export flags. Thisis so that the user can see if there will be a successful Export of the model. The user mayfind that the Profile or Material mapping files are not quite up to date which might cause afailure in the Export process. Therefore, the user can select this option to define this as atest run.

    After the Export process has completed, Test Run? is reset to false. This is so that the useris forced to state categorically each time the model is Exported that the run is a trial.

    Once all the correct data has been entered on the Run Information window, click OK andthe interface variables will be updated. Click Cancel to close the window, leaving theoriginal interface variables unchanged.

    Members and Export List

    The Members pane allows the user to navigate around the database hierarchy.

    The user must enter the elements to be exported, Linear Profile or Planar members. Theinterface will locate all SCTNs, GENSECs and PANEs contained in, or implied by, the Exportlist. If the user adds something to the Export list and has the item on display in a 3D VolumeView it will be enhanced by changing its colour. The Export list is managed such thatduplicate elements are removed and that items are exported only once.

    Note: Partial model transfers are supported by the interface, however, the user must beaware of how the Import process handles partial model transfers. Refer toComparison and Merging Processes.

    There are several methods of adding elements to the Export list:

    Add CE Adds the current element to the list. This also implies allitems below the current element in the database hierarchy.The WORL can not be added to the list.

    Add by Pick Allows the user to select an item from the 3D Volume View.It is similar to other pick functions. Selection of this optionbrings up a Status window and puts the user into a modewhere an item from the 3D Volume View can be picked. Theuser can also pick a sequence of items in succession to addto the Export list. Press Esc when complete. If the userdoes not want to continue, press Esc.2.23:11 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe user may find that items are shown in the Export list do not exist, or have beenrenamed. The Export process will determine all the valid entries in the Export list andprepare the data accordingly. Clearing the list, or removing individual items will beperformed as expected.

    Error and Log File Messages

    Click Cancel to close the Export window.

    Export executes the Export process. As it proceeds the user is kept informed of theprogress by means of messages at the bottom of the main window as well as by windowsand prompts.

    Control

    The Control drop-down menu has three options; Re-initialise, Configure and Exit.Changing any mapping files or any other variables:

    Re-initialise reloads files to save the user having to rebuild the whole user interfacefrom scratch.

    Configure enables the user to define run parameters, model parameters, displaycolours and environment parameters. Refer to System Configuration for further

    Add Structure Attempts to climb to the Structure owning the currentelement and add that to the Export list. A warning isdisplayed if there isn't an owning Structure.

    There is also a set of methods by which the user canremove items from the Export list. These options workonly on entries in the Export list, rather than in themodel. As with adding to the Export list, removing from theExport list will cause the item or items removed to bereturned to the default colour as defined by this interface.

    Note: The colour may be different from the colour in whichit may have originally been added to the Drawlist.

    Remove CE Looks for the name of the current element in the list andremoves it if present.

    Remove by Pick Allows the user to select something from the 3D VolumeView and, if it is present in the Export list, the name will beremoved. As with the Add by Pick option, the user mayselect a series of items to attempt to remove from the Exportlist until Esc is pressed.

    Remove Selected Is a means by which the item selected in the Export list issubsequently removed. Select the item first in the list, thenclick Remove Selected.

    Clear Removes everything from the list.

    Can't export the WORLD The user cannot export the WORLD

    No owning Structure Cannot climb to Structure element from current locationin database.2.23:12 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    information.

  • Bocad Steel InterfaceExport/Import Exit removes all forms and menus and global variables associated with the interface.The General drop-down menu has two options, Highlight and Clear ABSI History.Highlight displays the Highlighter window enabling the user to identify new, changed anddeleted items in the model. This has more relevance to the Import process, refer toHighlighting Changes in the Design for further information. Clear ABSI History enables oneto clear the import/export history on the current element and all elements below that havedate and time UDAs that are relevant to the AVEVA Bocad Steel Interface.

    The Export Process

    Exporting from the base product all items are exported using millimetres as the distanceunits.

    All reference data, such as any pre-existing reference model from the current session areremoved before exporting anything. For more details on Importing and for details aboutsaving the reference model, refer to Import from AVEVA Bocad Steel.

    Prior to any Export process, all fields are checked for validity. Is the output file named? Is anything going to be exported? Are the mapping tables compatible with AVEVA Bocad Steel? Is there a valid Steel Standard table?

    In addition, there is an specific UDA, :FABEXCLUDE, attached to certain base productelements by which the user can define whether the item is to be exported or not. Setting thislogical flag to true will exclude the item from the Export process. Refer to UDAs for furtherinformation.

    Before continuing, the Export process polls all the Configuration objects for the high watermark on Transfer and Revision numbers. It then updates the object applicable to the currentMDB and user to contain the latest Transfer value. The list of all items listed in the Export listis then stored on Header element.

    After verifying that all the data is correct and valid, the external program is called. Theinterface waits for a certain time until the program is finished. This waiting time is userconfigurable. If there are errors raised by the external program the user is notified and moredetailed information is placed in the log file. If the waiting period expires without the interfacedetecting that the external program has completed - it may have crashed, or even not exist,the user will be asked if to carry on waiting for another time unit.

    Click Yes and the interface will wait for another period of time. Click No to stop the interfacewhere it is. Finally the system will indicate its completion, whether successful or not. Thiscompletion message should be read in conjunction with the log file, if any errors areindicated.2.23:13 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe above indicates a successful completion, while the below represents some problemencountered in the external program.

    On completion of the external program, the status file is inspected and, if the result isfavourable, the user will then be asked whether or not to view the log file, if that option hasbeen selected on the Run Information window.

    To inspect the log file later, save it with the File > Save as option in the File Viewer windowwhich will bring up a File Browser, or by clicking Save as to the suggested filename. Eitherway, if the file already exists, the user will be asked whether to overwrite it. The log filewindow may then be closed by clicking Cancel.2.23:14 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportIf the Brief mode has been chosen on the Run Information window for displaying the logfile, the window displaying the log file will filter out all Warning messages, leaving only theError messages. Saving the log file, however, all messages will be retained in the file.

    Error and Log File Messages

    Exporting Linear Members

    A series of checks are made before a Linear Member is output. Is the SPRE set? Is it a zero length member? Does it have a valid material? Is the Justification Pline mappable to a Cardinal Point if it is not a Cardinal Point itself? Are the start and end points valid?

    If any of the above criteria is not satisfied, the linear member does not even get exported tothe output file.

    Note: This will have an effect on the subsequent import process as the member will appearto have been deleted by AVEVA Bocad Steel since its export. In fact, the linearmember never made the transfer to there in the first place.

    As has been indicated before, Linear Members can be transferred as either Straight orCurved. In the base product, curved members are modelled using GENSECs. However,GENSECs can be compound shapes with both straight and arc sections.

    Once the Linear Member has been output, the relevant UDAs specific for the interfaceassociated with Export are updated. These are principally the element's internal ID and

    File does not exist Somehow there is no log file. Are there issues regardingaccess rights to the users work folder?2.23:15 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportUUID numbers and transfer and revision numbers. This is only as necessary to minimisecore database changes that affect the modification dates and times.

    The interface may not be able to update the export information on the elements. This wouldusually be because the database is read-only. If this is the case, a session related macro fileis produced for execution immediately afterwards, or when one has write access to thedatabase. This file is called updateVersionnos.mac and is stored in theusers work folder.

    Error and Log File Messages

    Illegal or unset SPRE - notexported

    SPRE must be valid.

    Zero length Linear Member- not exported

    Length less than user definable tolerance.

    No material information -not exported

    Cannot determine material properties for member.

    No material match fornnnn. - Unknown material

    :FABMGRADE cannot be matched with a material in theProperties database.

    No material property match As above

    Inconsistent materialspecification

    The element's MATR and :FABMGRADE attributes arenot consistent.

    Multiply defined entries inMaterial Table

    Either a material to be mapped or a mapped profileappears more than once in the material file.

    No match for material The material is not in the material file

    Syntax Error Other, less specific, errors.

    Unrecognised Parse State This should not occur. If it does then it indicates a systemerror. Although the error is non-fatal it should bereported. A number representing the parse state will alsobe output.

    No match for CardinalPoint nnnn

    Pline or Cardinal Point not recognised. Neutral axis(Cardinal Point 10) assumed.

    No Cardinal Point nnnn JUSL unset.

    Bad Cardinal Point nnnn Cardinal Point/Pline identified is not valid. Does it exist?Neutral axis (Cardinal Point 10) assumed.

    Problem exporting entity Other errors found.

    Profile cannot be mapped The profile is not in the profile mapping file.

    Profile is not in thestandard

    The profile is in the profile mapping file but is not in anyone of the set of standards.

    Profile is not the default The profile is in the profile mapping file and is in one ofthe set of standards, but not the default standard.2.23:16 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportExporting Plates

    Panels in the base product are to be transferred as Plates. This covers stiffeners, floorand toe plates. Bent plates are also transferred if they are expressed as their componentflat plates. If Bent Plates are to be treated as Angle linear members then they should bemodelled as such.

    If the base products penetration functionality is used to generate Catalogue holes, theresultant holes, kicker plates and stiffeners are not exported because they are contained ina Catalogue definition. Some holes and negative primitives can be exported. Refer toTransferring Holes for further information.

    The Description attribute will be used to store the flooring type, such as grating or chequerplate. This is passed as the type field (up to 24 characters).

    The Material Grade transferred represents the material type. This is a text attribute, ratherthan the number field in the base product. Therefore a User Defined Attribute (UDA),:FABMGRADE, has been defined within the base product to store this information.

    Note: Any edge preparation details and modelling, such as grinding, will be lost in thetransfer operation.

    A basic series of tests is performed before the Plate is exported. Is there any geometry? Is the height valid? Is it justified correctly? Does it have a valid material? Are there enough vertices?

    If any of the above criteria is not satisfied, the plate does not get exported in the output file.

    Note: This has an effect on the subsequent import process as the plate will appear to havebeen deleted by AVEVA Bocad Steel since its export. In fact, the plate never madethe transfer in the first place.

    Once the Plate has been output, the relevant UDAs specific for the interface associated withExport are updated. These are principally the element's internal ID and the UUID numbersand transfer and revision numbers.

    Although both plates and holes are supposed to have a clockwise definition (right handscrew rule) for their boundaries in either the base product or in the file, the interface must beable to cope with either clockwise or anti clockwise directions. In exporting plates the vertexorder is converted to satisfy the right-hand screw rule.

    Note: Importing a Plate previously defined in base product, the user may find the order ofvertices to have been reversed.

    Plates with curved and straight segments to their boundaries can be transferred both to andfrom the base product. Because of the difference between the base product and boundarydefinitions, vertices will stand a high chance of being created in different places. Further, inorder to recreate the shape, there may be a different number of vertices in the boundary.This makes it very difficult to compare the boundaries, especially on import.

    Multiply defined entries inProfile Table

    Either a profile to be mapped or a mapped profileappears more than once in the profile mapping file.2.23:17 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportIn order to assist the transfer of these complex shapes, the vertices are given a type codeas a design parameter. The code indicates whether the following boundary segment isstraight, an arc, or whether the vertex is a created one not contained in the AVEVA BocadSteel Interface file.

    Circular Plates

    Circular plates in the base product are identified by the number of vertices, the geometryand possibly the vertex type codes. There is no short-hand definition of a circular plate in thebase product. As a result, a certain amount of geometric testing is involved in identifying andexporting circular plates. The interface recognises only 4 or 5 point circles, where the 5thpoint is a duplicate of the first point.

    Error and Log File Messages

    Transferring Holes

    There is a limitation as to which holes are exported. Only secondary PLOO boundaries andNXTR elements can be handled. PLOOs are full depth penetrations: partial penetrationscan be modelled using NXTR elements. Circular boundaries of holes and indentations canbe imported and exported if recognised as such, by having 4 unique fillet vertices.

    No geometry information -not exported

    No PLOO element. Plate cannot be exported.

    Plate too thin -not exported

    Thickness less than user defined minimum. Plate notexported.

    Not enough vertices - not exported

    Fewer than 3 vertices. Cannot define valid geometry soPlate is not exported.

    No material information -not exported

    Cannot determine material properties for member. Amatching set of :FABMGRADE and Matref cannot bedetermined.

    No material match for nnnn Unknown material. :FABMGRADE cannot be matchedwith a material in the Properties database.

    No material property match As above

    Inconsistent materialspecification

    The element's MATR and :FABMGRADE attributes arenot consistent.

    Multiply defined entries inMaterial Table

    Either a material to be mapped or a mapped profileappears more than once in the material mapping file.

    No match for material The material is not in the material mapping file.

    Syntax Error Other, less specific, errors.

    Unrecognised Parse State This should not occur. If it does then it indicates a systemerror. Although the error is non-fatal it should bereported. A number representing the parse state will alsobe output.

    Problem exporting entity Other errors found.2.23:18 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportOn import vertices in boundaries are given a DESP value according to the list below.

    Using these values specific shapes, such as circles, ellipses, etc., can be detected.

    A message is output when the export process ignores non loop-based negative primitives.This is because it is difficult to determine the geometric intersection with the PANEL,especially if the primitive axis is not perpendicular to the plate plane. In the future it may bepossible to handle some of them, but only within tight geometrical constraints. Negativeboxes and cylinders could be transferred only if a principal axis is parallel to the plate'snormal. This means that the cylinder's Z-axis, and any of the box's X, Y or Z-axis must beparallel to the plate normal. We even have to limit NXTR elements those with an extrusionvector parallel to the panel plane normal. The following negatives are not exported:

    Imported holes will be either NXTR or PLOO elements. A full penetration will be a PLOO,and a partial penetration will be an NXTR.

    Any other negatives will not be compared or merged on import. Other pre-existing negativeswill be just moved and updated to maintain their original position and orientation.

    The use of SAVEWORK on Export and Import

    In order for the AVEVA Bocad Steel Interface, and more specifically the AVEVA Bocad Steelprogram, to be able to detect model changes, the interface needs to manage modificationdates and times. These values are stored in the database as text strings, based on the lastrecorded Dabacon model modification date and time. For us to then save these dates andtimes we need to lock the changes in with a SAVEWORK. This implies some significant timedifference between setting a text string attribute and the SAVEWORK. This time differenceis model size dependent. We compare the database modification times with the time storedon the attribute with a 5 minute time buffer in order to determine, to the best of our ability,whether an element has been changed.

    Importing does not do a SAVEWORK by itself, but because of this, there can become somesignificant time difference between the import, modification and database dates and times.Import, creation and modification dates and times are passed through the ABS file, butthese can be significantly different from the Dabacon date and time.

    Overall, this will make it difficult to compare models purely on dates and times.

    PVTLastPoint 0PVTStraight 1PVTArc 2PVTFillet 3PVTCircle 4

    NBOX NPOLYH NCYL NSLC NSno

    NDIS NCON NPYR NCTO NRTO

    NXTR NREV2.23:19 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/Import3.2 Import from AVEVA Bocad SteelAVEVA Plant and Outfitting 12 Series

    To import a steel structure from an AVEVA Bocad Steel Interface file, select Utilities >AVEVA Bocad Steel Interface > Import from AVEVA Bocad-3D to display the Importwindow.

    AVEVA Everything3D

    To import a steel structure from an AVEVA Bocad Steel Interface file, on the SECTIONS,PLATES or STAIRS LADDERS HANDRAILS tab, in the AVEVA Bocad Steel group, clickImport to display the Import window.

    A Warning window may be displayed stating mapping files are not found. This means localversions have not been set up. Use the default set provided with the product.

    Mapping Files

    Click Mapping files to display the Import mapping files window populated with informationabout the mapping files that will be used in the Import process.2.23:20 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe interface requires at least two external mapping tables to enable the interface to checkthat the base product can accept the data. It also may use the internal Profile Orientationand/or the Unicode mapping table if necessary. The mapping tables are for the Profiles,Materials, Unicode text string and for mapping the Profile orientations between the AVEVABocad Steel Interface file and the AVEVA steel catalogue. The section Customise explainshow the user can arrange these files on the file system and what format they are to be. Theinterface also needs to know where the external mapping files are located on the userscomputer network. For this internal mapping tables are required. Refer to Customise whichexplains how the user can configure the interface to let it know where all the files arelocated.

    The user can have a generic set of mapping tables to map between the base product andAVEVA Bocad Steel. Or the user can have a set for a particular steel fabricator.

    The current file settings are indicated on this window.

    Note: Do not be concerned that the path name may be truncated by the insertion of theellipsis (): it is modified only for display purposes on the window.

    The system also checks that these files are compatible with AVEVA Bocad Steel bychecking the identification line at the top of each mapping table. Refer to Internal MappingFiles for details about the format of these mapping files.

    The two main options are Auto and Manual which are activated by selecting theappropriate radio button on the left hand side of the Import mapping files window.

    The Auto option causes the interface to select automatically the mapping tables for AVEVABocad Steel, according to the system configuration files. When the user comes to executethe Import process, the Auto flag will cause the correct mapping files to be used based onthe Input file header.

    The Manual option activates other buttons, which are initially greyed out for the Systemoption. Selecting this option changes the window to be similar to below.2.23:21 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe user can select the file type using the Profiles, Materials or Unicode radio buttonsabove the text data entry field and enter the full path name of the file in the data entry area.The user can also include system environment variables in the path name as long as theyare in the proper base product format, for example: %ENVVAR% being the representationof the ENVVAR environment variable.

    On clicking carriage return, the interface will check for existence of the file and itscompatibility with AVEVA Bocad Steel.

    Note: The check is only that the file applies to AVEVA Bocad Steel and not that it is acorrect file type or that its contents are correctly formatted.

    The user can either choose by hand which mapping file to use by entering its name in thetext data entry field, or by using the Browse option to bring up a File Browser. Use thisbrowser to search for the relevant mapping file.

    Once all the correct data has been entered on the Import mapping files window, click OKand it updates the interface variables. Click Cancel to close the window, leaving the originalinterface variables unchanged.

    Error and Log File Messages

    Internal error Internal lists are not in step.

    Cannot find suitableinternal mapping list

    Internal mapping files not found.

    Suitable Mapping Table File not found

    Mapping table found is not correct or it does not exist.

    Not a suitable MappingTable File

    Incorrect format of file, or empty file.

    Bad Map File Mapping file is not correct format. Possibly it is from anotheroperating system.

    Error on File Browser window

    The user has entered incorrect data on the file browser.2.23:22 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportImport Information

    From the Import window, click Import Information to display the Import Informationwindow which is populated with information about the import process.

    The user either types the full folder path name of the input file, or clicks Browse to bring upa File Browser. The interface tests to see if the file exists and if it does not the user will bewarned. As well as testing for the existence of the file, it is also tested for being a valid file byinspection of its header details.

    Note: If the user does not enter the full path name, the input file is assumed to be in thefolder from which started the base product. The user can also include systemenvironment variables in the path name as long as they are in the proper baseproduct format, for example. %ENVVAR% being the base product representation ofthe ENVVAR environment variable.

    On entering the name of the file, if Auto mode is set on the Import Information window, theProfile and Material mapping files are selected automatically and indicated in the ImportInformation window.

    On reading the file header information the interface will attempt to select a suitable header.If one does not exist the user will be asked whether to create one for the import. If the userwants to override the recommended header element, it will be checked for compatibility.

    The user can view the header information of the chosen input file, click Inspect, to displaythe Input File Header Details from window with which the user can determine whether thefile is the correct one to Import.

    From the Attributes page, the user can see what user data is being transferred fromAVEVA Bocad Steel.2.23:23 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportUse the check boxes on the Import Information window, to select whether to import LinearMembers and/or Plates or Holes.2.23:24 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportOnce all the correct data has been entered on the Import Information window, click OKand the interface variables updates. Click Cancel to close the window, leaving the originalinterface variables unchanged.

    Error and Log File Messages

    Import User Data

    When a user selects a file to import from AVEVA Bocad Steel, the file can be inspected tosee what additional data is being transferred.

    From this window, the user can see what data is being considered for transfer, the selectedcheck boxes show what data will actually be transferred. There is also a field for adescription of the data.

    Once imported into PDMS, the data will be stored in UDAs, the numerical values will bestored in a real array, :FABRADATA. The text strings will be stored in an individual text UDA,:FABTADATA to :FABTEDATA. The index of these will direct the user to the correct location.

    Note: Importing and exporting are two separate operations. The user data exported mighthave no correlation to the user data being imported. It is information that the receiverof the transfer file might find useful, once imported, the user can use the data.

    Import file does not exist File specified does not exist.

    Not an ABSI File File specified is not an ABSI file. This may also arise ifthe file the user is inspecting has been transferredacross hardware platforms.

    Nothing to import The user deselected everything.2.23:25 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportRun Information

    From the Import window, click Run Information to display the Import Run Informationwindow. The window is allows the user to view the Log File after the import process iscomplete by clicking the Log File? check box.

    Click either the Brief or Verbose radio buttons the user can choose which format messagesare displayed.

    As part of the Import process a reference model is constructed against which comparisonswill be made. Save Reference Model allows the user to keep this. Otherwise it will bedeleted on completion of the Import process.

    Note: This reference model will be deleted next time the user Exports or Imports anything.It is only transient data. Also, it may not be a complete model as some items mayalready have been transferred into the main model on merging.

    After the Import merging process has been performed, the user can sort all new items intoFRMW (Framework) elements according to their Material type. This option is selected byclicking the Sort on Material Type option.

    During the Import process, comparisons are made for Linear Members and Plates betweenthe existing model data and the imported model data. The default system configurationcompares all the relevant data entries transferred in the file between the models. However,the user can select which attributes may be ignored by the comparison process by clickingEdit Attribute Comparison List to display the Comparison Checklist window.2.23:26 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportUse this window to deselect attributes for comparison but be aware that strange results mayoccur especially if the user ignores positional and rotational attributes.

    Finally, there are two validity checks the user can perform on the incoming data which willmake sure a subsequent Import run will have a chance of success. Activating these optionsoverrides completely the Import choices made on the main window. With these validitychecks the user will be able to see a log file before any data is merged whatsoever.

    Profile Mapping? enables the user to see if the incoming Linear Member Profilespecifications will be successfully mapped between systems. This is a relatively fasttransaction as the file is just passed through the external program without any subsequentimport or comparison in the base product. The user will then be able to see the log fileproduced and take appropriate action.

    There is a risk in either package that entity UUIDs may be duplicated. The Duplicate UUIDselector gadget enables the user to check for duplicate UUIDs in the incoming model. Thereare three options: NONE, NEW and GLOBAL. NONE deactivates the gadget and nochecks are made. The import process just goes through unhindered. The NEW optionallows the user to check only the new imported items for duplicate UUIDs, while theGLOBAL option enables the user to search all the available databases for duplicate UUIDs.Obviously these searches may involve a certain amount of time, but for the sake of validity,they would be worth using.

    Once all the correct data has been entered on the Run Information window, click OK andthe interface variables updates. Click Cancel to close the window, leaving the originalinterface variables unchanged

    Members and Operations

    On the Import window the Members list can be used to navigate around the databasehierarchy.

    The user must state where the Imported model is to be located. This must be a SITE, ZONE2.23:27 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    or STRU element. Using the Members list, navigate round the database to the correct

  • Bocad Steel InterfaceExport/Importstorage location and click Store in: CE. The window text indicates where the Importedmodel will reside. If there is not enough space on the window, the SITE's reference numberis output rather than its name.

    The Import process is essentially a three phase operation. First a reference model is builtwhich is then compared with the original model identified during the Store in: CE operation.Then, if required, the changes, additions and deletions encountered in the comparisonphase are transferred to the actual model. Thus, using the Operations toggles, the user cancontrol how the Import process is to proceed.

    Note: These options may be completely overridden if the user wants to perform a validitycheck as on the Run Information window.

    The user should be aware of how the model manages partial model transfers and wheretemporarily imported data goes before it is merged into the pre-existing model. See thesections describing the Import, Comparison and Merging processes.

    This is a very quick option and there are no checks, except what the user wants to do it.

    Error and Log File Messages

    Import and Cancel

    Cancel closes the Import window.

    Import executes the Import process. As it proceeds the user is kept informed of theprogress.

    Import Bar Menu

    The Control drop-down menu has three options; Re-initialise, Configure and Exit.Changing any mapping files or any other variables:

    Re-initialise reloads files to save the user having to rebuild the whole user interfacefrom scratch.

    Compare + Merge Goes through the complete Import process - that is theimport, comparison and merging are all completed withoutany interaction with the user. This is only to be performed ifthe user is absolutely sure that they will get the desiredresult.

    Compare ( + Merge ) Imports the model and compare the reference model withthe location chosen to be the storage area. At this point theuser will be asked whether to merge the models. Click Yesto continue with the merge process and complete theImport.

    Merge from File Takes a merge command file produced during the currentsession only and imports it directly into the model. Thereference model must not have been deleted beforehand.Otherwise, the user may lose any elements added to themodel by AVEVA Bocad Steel.

    Bad element type The user is not trying to store imported data at a SITE,ZONE or STRU element.2.23:28 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/Import Configure enables the user to define run parameters, model parameters, displaycolours and environment parameters. Refer to System Configuration for furtherinformation.

    Exit removes all forms and menus and global variables associated with the interface.The General drop-down menu has two options, Highlight and Clear ABSI History.Highlight displays the Highlighter window enabling the user to identify new, changed anddeleted items in the model. This has more relevance to the Import process, refer toHighlighting Changes in the Design for further information. Clear ABSI History enables oneto clear the import/export history on the current element and all elements below that havedate and time UDAs that are relevant to the AVEVA Bocad Steel Interface.

    Import Process

    After clicking OK the fields in the window are checked for validity: Is the storage location valid? Is there a valid input file? Do we need to convert the file across platforms? Are the Profile and Material mapping files valid?

    After verifying that all the data is correct and valid, the external program is called. Theinterface waits for a certain time until the program is finished. This waiting time is userconfigurable. If there are errors raised by the external program the user is notified and moredetailed information is placed in the log file. If the waiting period expires without the interfacedetecting that the external program has completed - it may have crashed, or not exist, theuser will be asked if they want to carry on waiting for another time unit.

    Click Yes and the interface will wait for another period of time. Click No causes the interfaceto stop where it is. Finally the system will indicate its completion, whether successful or not.This completion message should be read in conjunction with the log file, if any errors areindicated.

    The user will be alerted to unsuccessful runs by the external program displaying an Errorwindow, after which the process exits.2.23:29 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportIf the external program successfully completes, the processed file will be imported into thedesign model. Any reference data which may have been retained by the user before willhave been deleted beforehand.

    The status line will inform the user of the progress on importing the data.

    After the Import of everything, the material properties are reconciled with the :FABMGRADEattribute and, if possible, the MATR is also set to point to the appropriate property in theProperties database.

    At this point, if the user has chosen to be asked whether to Merge after the Compareoperation, Confirm window is displayed.

    Click Yes the interface continues with the Merge process.

    Click No and the Import process skips the Merging, but the user is then given a chance tostore the Merging commands in a file for use later on only in the current base productsession. The user cannot use a file from a previous session as the Import data may beincorrect.

    The user can save the Merge command file and then be prompted whether to see theImport log file. This Merge command file may then be used in the Merge from File option onthe Import window. This latter option needs the reference model from this run to be kept.Therefore, the user does not have the option below.

    If the user has merged the models, they will then be asked if they want to keep the referencemodel, verifying the option selected on the Run Information window.2.23:30 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportFinally, the user is asked whether to view the log file, if they have chosen that option on theRun Information window.

    If the user wants to inspect the log file, they can then save it with the File > Save as optionin the File Viewer window which will bring up a File Browser, or by clicking Save as to thesuggested filename. If the file exists, the user will be asked whether they want to overwriteit. The log file window can then be closed by clicking Cancel.

    If the user has chosen Brief mode on the Run Information window for displaying the logfile, the window displaying the log file will filter out all Warning messages, leaving only theError messages. To save the log file, however, all messages will be retained in the file.2.23:31 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportClicking on a line containing a base product reference number causes all graphical views tozoom in to the chosen item and to identify it. The interface also navigates to the item in thedatabase and leave the user there to perform any queries or operations.

    Error and Log File Messages

    Comparison and Merging Processes

    The Import, Comparison and Merge process involves three stages. First, the model isimported. The user then has the option of comparing the imported model with the originalmodel, after which they may merge the new data into the old model, or the comparison andmerge process can be performed as one with no user interaction. Although the user can tellthe system to Import, Compare and Merge the model straight away this should only beperformed if the user is sure of the end result. It is advised that the user Compares themodels first and then inspect the results before Merging.

    The user can decide to keep the imported reference model as has been described above -but is warned that this is only to be regarded as transitory information. It may also not be acomplete representation of the data imported as some of it will get transferred to the realdesign area.

    If the target area is empty, the Compare/Merge processes are bypassed which can be a lotfaster when importing large amounts of data.

    The Comparison Process

    There are three conditions the interface looks for: items in the imported file that are not in the original model - Added items; items in the original model that are not in the imported file - Deleted items; items that it can match between the imported file and the original model and checks for

    modifications - Changed items.The fact that an item is in the imported file and not in the original model is indicative of oneof two cases: that the item has indeed been added by AVEVA Bocad Steel; or that the itemwas never exported in the first place for some reason. This latter case might also occur if theoriginal model has had items added to it since the export happened. Further, items mayappear to have been deleted and their "clones" imported when the import store location isnot the same as it was for the export process.

    Below is a diagram illustrating the route through which the data is imported, compared andmerged. New items are green, changed items are orange and deleted items are red.

    File does not exist Somehow there is no log file Are there issues regardingaccess rights to the users work folder?

    Input file name notspecified

    Something strange here. The name of the inputcommand file generated has been forgotten.

    Import file does not exist Something strange here. The input command file has notbeen generated or it has been deleted, or is not found inthe expected folder. Are there issues regarding accessrights to the users work folder?

    Data store unset The data store variable is unset or the SITE the user hadintended to store the imported data in is invalid. Has itbeen deleted since the user set the store variable?2.23:32 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportIt is clear from the above diagram that the interface supports partial model transfer as it justidentifies those new or changed items. Anything indicated as deleted is more an indicationthat the item is not present in the Imported file. It is not deleted from the Original Modelduring the Merge process: "Deleted" items are simply moved to another SITE to enable theuser to recover them if necessary. So parts of models can be merged into the original modelwith no loss of data.

    Note: The Reference Model which is created is named according to the user session, sothat several user Reference Models could coexist at the same time. As they arenamed according to session, the user is advised to take care to manage them andnot to leave too many versions around to fill up the users disk space.

    The Comparison process allows any potential changes, additions and deletions to theoriginal model to be detected and shown in a 3D Volume View window, if there is onepresent and if the items are in the current Drawlist.

    As for both Linear Members and Plates the user can select which attributes are significantfor Comparison. This is performed using the Comparison Checklist window which is a childof the Import Run Information window. By default, all the attributes transferred through thefile are compared.

    Comparing Linear Members

    The following data attributes are compared between the original model and the referencemodel:

    Start and end of Pline defined by Cardinal Point Orientation and Beta angle Specification Reference Material grade and reference

    Importing a Linear Member also sets the Import date and time UDAs. On merging members2.23:33 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    the revision number, transfer number and code are updated.

  • Bocad Steel InterfaceExport/ImportThe log file messages recording any differences are of two formats: in Brief mode theresults are presented on one line; in Verbose mode the user is told what the old value wasand the new value is so that they can see how the model has been changed. Refer to BriefFormat for details about the brief log file format.

    The user may get a lot of apparent changes which may be caused by the failure to map theprofile types between systems. The log file will indicate which profiles have not beenmapped. It is advised that the user resolves the Profile Mapping issues first beforebecoming too concerned with other changes recorded in the log file.

    During the Import phase, an attempt is made to map the Cardinal Points (SNFA to SNFN) inthe incoming model with existing Plines that have been mapped onto them.

    Comparing Plates (PANE)

    The following data attributes are compared between the original model and the referencemodel:

    Position, orientation Material grade and reference Hold and Paint Spec UDAs Panel loop height and justification Number of vertices

    Vertex positions compared to within the user definable tolerance as described in the sectionon user customisation of the interface.

    Importing a Plate also sets the Import date and time UDAs. On merging members therevision number, transfer number and code are updated.

    The log file messages recording any differences are of two formats: in Brief mode theresults are presented on one line; in Verbose mode the user is told what the old value wasand the new value is so that they can see how the model has been changed. Refer to BriefFormat for details about the brief log file format.

    Note: In Exporting a Plate, it has to be converted to the standard of being defined in aclockwise direction relative to the plane normal. Thus Importing a Plate previouslydefined in the base product the user may find the order of vertices to have beenreversed. This is because the base product is more tolerant about the ways in whichthe user can define a plate.

    We now compare plates with holes as secondary loops (PLOO) or NXTR primitives. We cannow merge the imported model including new holes created outside of . However, becauseof the complexity of the comparison process, it is difficult to compare holes between theoriginal and imported model. Where possible all other negative primitives representing holesin the original model are maintained. Therefore the comparison does not go down to thelevel of holes.

    The Merging Process

    See the diagram in Comparison and Merging Processes illustrating the route by whichinformation is transferred from the Import, through the Comparison and on to the Mergingprocesses.

    The interface manages the Comparison and Merging of imported models so that otherimportant engineering data is not lost or overwritten. However, other data, includingconnectivity may be lost.2.23:34 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe user can separate the Comparison and Merging processes, so that they are able toview the log file in between operations. If the user chooses the Merge from File option onthe main Import window, the Comparison process is deemed to have been completed andso all that remains to be done is the actual Merging. This is why the reference model for thecurrent session must still be available. The user will be prompted for confirmation.

    If, during the Merge phase, items are to be merged, then the lists of added and deleteditems are reconciled with the original model - by being deleted or transferred from referencemodel. The storage SITE header details are then merged with the information in the header.

    After the main model Merging has been completed, if the user has chosen the Sort onMaterial Type option on the Import window, any new items will be sorted into FRMWgroups according to their material type as specified by the :FABMGRADE attribute.

    The version numbering system is described below, in Technical Information.

    Additional Items

    Items added to the model are recorded as such; they are indicated by changing their colour,a suitable message is output to the log file and they are then transferred to a special area.Merging will transfer all the added items from the reference model to the original model. Ifrequired, they are then sorted according to material type.

    The new items are gathered together into a site whose name is constructed from theTransfer and Revision Numbers so that the user can easily locate all items added at aspecific version or date.

    For example, a new STRU may be created with the name of /FAB-NEW-DEMO-SYSTEM/A.1 under the container element as specified in the Store in: field on the Import window.The components of this name are as follows:

    The user would thus be able to find all the added items to this MDB at this version.

    /FAB- the system prefixNEW- identification of new element container- the current MDB, for example: /DEMO-/ the current user name, for example: SYSTEM. the current Transfer letter, for example: 'A' the current revision number, for example: '1'2.23:35 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportDeleted Items

    Deleted items in the model are recorded as deleted during the Compare phase and remainin the reference model to be deleted later if not required. This separation of operations is sothat the user can see what will be deleted during the Merge process. Before deletion theobjects are changed in colour so that they may be identified.

    Note: An item is not actually deleted from the original model. The apparent deletion may, infact, be because the item was never transferred to AVEVA Bocad Steel in the firstplace due to some reason. Alternatively it may have been created in the baseproduct since the initial Export process had taken place.

    'Deleted' items are disconnected from the old model and transferred from the current part ofthe database into a STRU created under the special 'Deleted' SITE.

    As with the added items, the STRU is named out of components, thereby enabling the userto determine at which version items may have been removed from the model.

    For example, a new STRU may be created with the name of /FAB-OLD-DEMO-SYSTEM/A.1 under the special SITE /FAB-OLD-DEMO-SYSTEM. The components of this name areas follows:

    The user would thus be able to find all the 'deleted' items to this MDB at this version.

    Changed Items

    In merging Plates the interface tries to keep the original vertices as they may have beenused for locating dimensions on drawings: it may be that just the positions have beenchanged. However, the comparison only works in list order: the interface does not lookaround for another vertex in the same physical place, although it may be in a different listposition. Extra unwanted vertices are deleted on merging and all new vertices are added tothe end of the list. A totally new Plate is just imported directly.

    Note: Changed objects are indicated as such by a change in colour.

    /FAB- the system prefixOLD- identification of new element container- the current MDB, for example: /DEMO-/ the current user name, for example: SYSTEM. the current Transfer letter, for example: 'A' the current revision number, for example: '1'2.23:36 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportError and Warning Messages

    Validation Process

    As has been described in Comparison and Merging Processes there are two validationchecks the user can perform prior to the full import and merging of models.

    The first option is for profile mapping. The Profile Mapping? Option on the RunInformation window turns this on. The Import process initialises normally and calls theexternal program to process the incoming file. In so doing it checks for a complete mappingof the profiles in the mapping tables. A log file is produced. No further Import actions areundertaken with this option.

    Second, the user can check that there are not any duplicate UUIDs. This can quite easilycome about if the user copies members in AVEVA Bocad Steel without creating uniqueUUIDs for them. When they are imported into the base product, the Comparison processmay fail as it could be uncertain as to which member it is supposed to be comparing.

    The options for this check are NEW and GLOBAL. NONE turns the facility off. NEW checksamong all this run's imported members contained in the reference model for duplicateUUIDs, while GLOBAL checks the whole structural database, both imported and existingelements. These can be quite slow options as the reference model must be created andcompared anyway.

    As this option also calls the external program which checks the mapping of profile namesbetween systems, the user will see that the log file may also list any problems with themapping tables. So this option is actually a combination of this and the previouslymentioned validity checking option. For a sample log file, refer to Sample Validity Check LogFile for further information.

    Highlighting Changes in the Design

    The user can display a Highlighter window from either the Import or Export windows bythe General > Highlight menu bar option.

    The window allows the user to identify in a graphical window whatever they want, eitheraccording to Import date, or by Transfer/Revision number combinations. The Select bytoggle switches the window into the appropriate mode. Both these options work from thestart element selected and will indicate only those items that are in the drawlist.

    Highlighting by Import Date

    The window below allows the user to choose what to enhance on the screen according tothe Import Date of an item.

    WARNING: Reference SITEnnnn contains transient data

    The reference SITE is likely to be deleted sometime.

    Model comparisoncompleted

    Process was successful.

    Failed to compare models Do they both exist?2.23:37 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportIn the Selected items box, the user can select any combination of Added, Changed, orDeleted Items for identification, according to the date range described below.

    By selecting the inclusive dates defining the limits of the range using the From and To dateselector gadgets the user can locate on the screen those items in the current drawlist whichhave been changed, added or deleted.

    Note: As the 'deleted' elements are relocated in the database after Merging, the areawhere they are finally located should also be in the drawlist if the user wants to seewhat has been 'deleted'.

    Highlighting by Version

    The window below allows the user to choose what to indicate on the screen according to theVersion of an item.2.23:38 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportThe functionality available to select changed, deleted or added items is identical to that forhighlight by import date, refer to Highlighting by Import Date for further information.

    By selecting the versions defining the limits of the range using the From and To versionselector gadgets the user can identify on the screen those items in the current drawlistwhich have been changed, added or deleted.

    Note: As the 'deleted' elements are relocated in the database after Merging, the areawhere they are finally located should also be in the drawlist if the user wants to seewhat has been 'deleted'.

    Error and Warning Messages

    Bad date input The configuration of day, month and year is illegal. Or isthe start date after the end date?

    Bad version input Is the start version after the end version?

    Nothing to highlight Nothing satisfies the selection criteria.2.23:39 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/Import3.3 Technical InformationThis section contains technical information which is not immediately specific to Products butof which the user should be aware in order to get the best out of the interface.

    Recommended File Suffix

    Although it is not critical for this interface, the recommended suffix for the files is to be abs.

    Cardinal Points

    Below is a diagram illustrating the positions of the Cardinal Points.

    The Cardinal Point imported should be retained for later export. This is because it is likely tobe a source of confusion when a member originally laid out on Cardinal Point 14 (Top ofSteel) is returned on the Cardinal Point 10 (Neutral Axis). Additionally, it will cause minorproblems in model versioning and comparisons.

    Default Orientations

    There is a definition of the default orientation of profile shapes. This is closely based on theAISC standard.

    Below is a diagram showing the default orientations of the Catalogue profiles.2.23:40 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportPline Selection Rules

    The user can define which Plines are identifiable or selectable using the supplied structuraldesign appware. Saving the rules generates a file in the default folder. This is laterautomatically picked up on re-entry into the base product. Then, these rules becomeapplicable to various operations in the standard Steelwork Appware.

    AVEVA Plant and Outfitting 12 Series

    Select Settings > Pick Filters > Plines to display the Pline Filter window.

    AVEVA Everything3D

    On the Sections tab within Structures, in the Settings group, click Plines Filter to displaythe Pline Filter window.2.23:41 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportClicking Define Rules displays a window on which the user can create their own. Above isthe window filled in for the supplied Pline filter rule. The operation of the window is fairly selfexplanatory.2.23:42 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Bocad Steel InterfaceExport/ImportUse of Pline Filters

    The default drawing flags for the Plines have been changed to LEVEL 99 99, CLFLAGTRUE and TUFLAG TRUE. In the base product the user can choose which Pline filters touse using the following method.

    AVEVA Plant and Outfitting 12 Series

    Select Settings > Pick Filters > Plines to display the Pline Filter window.

    AVEVA Everything3D

    On the SECTIONS tab in the Settings group, click Plines Filter to display the Pline Filterwindow.

    Select which rule set the user wants to use by indicating it.

    Click OK. This rule set then becomes available for use when using AppWare functionalityonly.

    Note: Direct querying, such as "q idpl @" does not access this rule set.

    UDAs

    This section lists the UDAs defined for this interface, an attempt has been made to keep theunique abbreviation to 6 characters. The UDAs for this interface are:

    General Data

    Name Type Len On Description

    :FABID/ATE TEXT 30 SCTN PANE GENSEC Date of Import

    :FABIT/IME TEXT 30