text: AVEVA Solutions Ltd
  Disclaimer
  Information of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law. Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or entity for any actions, claims, loss or damage arising from the use or possession of any information, particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
  Copyright and all other intellectual property rights in this manual and the associated software, and every part of it (including source code, object code, any data contained in it, the manual and any other documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries. All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where such permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made. The manual and associated documentation may not be adapted, reproduced, or copied, in any material or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in this publication may be incorporated into any third-party software, product, machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution. The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms and conditions of the respective license agreements, and in accordance with the relevant User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited. First published September 2007 © AVEVA Solutions Ltd, and its subsidiaries AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
  Trademarks
  AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use of the AVEVA or Tribon trademarks is strictly forbidden. AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries, registered in the UK, Europe and other countries (worldwide). The copyright, trade mark rights, or other intellectual property rights in any other product, its name or logo belongs to its respective owner.
  OpenSteel Configuration Guide
  Contents
  OpenSteel Configuration Guide
  Contents
  Page
  Configuration Guide
  Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1 Installation on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
  Hardware and Operating System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . 3:1
  Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
  Read from the DVD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1 Flexman License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2 How to Run OpenSteel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
  OpenSteel Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
  System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1 Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
  Setting SDNFINTMAPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3 Overloading Mapping Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3 Set SDNFMAPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4
  Upgrade a Project for OpenSteel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
  Cardinal Point Plines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
  Update the Supplied Catalogues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1 Update Catalogues not supplied by AVEVA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:5 Catalogue Upgrade Step-by-Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9
  Installation of User Defined Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:12
  i
  2.1
  . . . . . . . . . . . . . 6:3 Tolerance Settings . . . . . . . . . . . 6:7 Exporting Internal Reference Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .and Post-processing Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1 External Packages . . . . . . . . 6:5 Profile Mapping Files . . . . . . . 6:2 Colour Code . . . . . . . . . . . . . . . . . . . . . . . .1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6 Replacement of SCTNs with GENSECs on Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1 CSV Format for Profile Mapping Files . . . . . . . . . . . . . . . . . . . . . . . 6:3 Waiting Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 Ignore Material Flag . . . 8:2 ii 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6 External Mapping Files . . . . . . . . . . . 8:1 Space-Separated Format for Profile Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 Connected Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5 User-definable Material Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:2 Profile Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 External Mapping File Separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7 Local User Configuration . . . . . . . . . . . . . 6:5 Maximum File Size . . . 5:13 Customise OpenSteel . . . . . . . 7:4 User-Definable Mapping Macros . . . . . . . . . . . . . . . . . . 5:12 Integration into other PML Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:13 Uninstall OpenSteel . . . . 6:6 SDNF File Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1 External Package Equivalences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .OpenSteel Configuration Guide Contents Special OpenSteel SITES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3 Holds and Paint Spec Files . . . . . . . . . . 6:3 Export Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5 Steel Standards Mapping Files . . . . . . . . . . . . . . . . . . . . . . . 7:2 Text Conversion Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 Pre. 7:1 File Mapping Files . . . . . . . . 7:3 Connection Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7 Internal Mapping Files . .
  . . . . . . . . . . . 8:10 Start OpenSteel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3 Profile Type Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:7 Sample Material Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:2 Steel Standard Field. . . . . . . . . . . . . . . . . . 9:1 Examples of Typical Environment Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1 iii 2. . . . 8:5 Sample Profile Mapping File . . . . . . . . . . . . . . . . . . . . . 8:5 Material Mapping Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3 Extend the Profile Mapping File . . .OpenSteel Configuration Guide Contents Record Structure for Profile Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:9 Profile Orientation Mapping Files . . . . . . . . . . .A:1 Windows Setup Script OpenSteel_env. . .bat . . . . . . . . . . . 8:6 User-Definable Material Macro. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
  OpenSteel Configuration Guide Contents iv 2.1 .
  The OpenSteel interface uses a large proportion of the information transferable in SDNF format. its format and contents. describes how to set up the internal mapping files which control the location of data to be transferred between different systems. describes how to upgrade a PDMS project to configure user-defined attributes (UDAs) and catalogues before the user can use OpenSteel. lists the scripts supplied with the products which the user will need to edit to customise the OpenSteel interface and use them with their own projects. Refer to the OpenSteel User Guide describing SDNF. Details are also given on how to remove as much of OpenSteel from the project as possible. describes the checks that are made when the user starts up the OpenSteel interface. This version of OpenSteel is compatible with PDMS (Series 12) on the Windows operating system. describes how to customise the OpenSteel interface. Customise OpenSteel Internal Mapping Files External Mapping Files Start OpenSteel Examples of Typical Environment Scripts 1:1 2.OpenSteel Configuration Guide Introduction 1 Introduction AVEVA OpenSteel is the interface for PDMS which allows the user to import and export files to and from the DESIGN module using the SDNF (the Structural steel Detailing Neutral File) format. describes the OpenSteel environment. The format is in the public domain and is therefore available to be considered as a suitable means of transferring data between 3D steel detailing packages and PDMS. The SDNF format was originally defined by the Intergraph FrameWorks user community for the transfer of steel data. Glossary Installation on Windows OpenSteel Environment Upgrade a Project for OpenSteel is a Glossary tells the user how to install the product on the workstation. and how to correct some problems which may be encountered.1 . describes how to set up the external mapping files which control how and what data is transferred between different systems.
  OpenSteel Configuration Guide Introduction 1:2 2.1 .
  External Package Linear Member Plate PML/F&M SDNF (Structural steel Detailing Neutral File Format) Source Package Target Package UDA (User Defined Attribute) 2:1 2. The Design programmable macro language. This interface requires a certain set of UDAs for storing SDNF-specific data. Cardinal Point An SDNF concept representing points of significance on the 2D profile and mapped in Design onto the Pline (PLIN) elements in the Catalogue. Defined by the Intergraph FrameWorks user community for the transfer of steel data. the member cross section profile is constant along its length. An attribute in DESIGN which the user can define and attach to specific elements. It may be a 3D steel detailing package. The external package from which an imported SDNF file is coming.1 . Linear Members can be either Straight or Curved: Straight members are transferred through Packet 10. are transferred through Packet 60.OpenSteel Configuration Guide Glossary 2 Glossary This section explains certain terms used in this document. Formerly this was mapped to a SCTN element. An SDNF Entity mapped to the Design Section (GENSEC) element. An SDNF Entity mapped to the Design Panel (PANE) element. an intermediate format or system or even some format related to a particular steel fabricator or producer. In both cases. The external package for which an exported SDNF file is destined. It is in the public domain and is therefore available to be considered as a suitable means of transferring data between 3D steel detailing packages and DESIGN. Curved ones. circular arcs. The system with which this interface is communicating. allowing user’s to create their own user interface.
  OpenSteel Configuration Guide Glossary 2:2 2.1 .
  OpenSteel Configuration Guide Installation on Windows 3 Installation on Windows This section tells the user how to install OpenSteel on a Windows workstation and what the user then needs to do in order to be able to run the program.1 Hardware and Operating System Requirements The hardware requirements for running the OpenSteel interface are the same as for running PDMS (12 Series). Previous versions of OpenSteel do not need to be uninstalled before installing this version. or a separate DVD. and its documentation. The software is supplied on DVD. scripts and test data. Note: The definition of the hardware and operating system requirements for the third party software with which this interface is to work is outside the scope of this document. See the PDMS & Associated Products Installation Guide for more details or for completely up-to-date information.2 Read from the DVD OpenSteel is supplied on a DVD.1. To install OpenSteel. Some previous releases of OpenSteel have been as an optional feature of a PDMS installation. follow the on-screen instructions as they appear. first insert the DVD in the Workstation's DVD drive.htm file. If the DVD does not start. click for Contents.1 . 3:1 2. Note: During the installation sequence. Once you are satisfied that the product is installed correctly. and then follow the Installer on screen. the user must have at least 60 Mb of free disk space for the OpenSteel executables. macros. and it is recommended that the user carefully reads all of the Installation instructions before installing the software.com and refer to the Customer Services Hardware pages. click Start > Run. Read the label on the supplied medium. select the product (OpenSteel). and then browse for the Start. Also on the DVD is a folder containing the Installation instructions and user documentation.1 Disk Space For a full installation of OpenSteel on a hard disk. 3. During the installation the Installer checks that there is enough space available before it starts. 3. and warns the user if there is not.aveva. which may be either an AVEVA Plant DVD alongside PDMS. you may free up 40Mb by removing the supplied PDMS test projects. 3. for any updated installation instructions. It is assumed that the user is familiar with the concepts of directory and file hierarchies for storing data on disks and with the most commonly used Windows operating system terminology and commands. please see the AVEVA Solutions Ltd website at.
  it will display a set of options for modifying/repairing/removing these existing files in place of the standard installation options.1 installation.6 Series). it is helpful to maintain a test area. A sub-directory which contains test files and project and results from the test Export and Import.bat script called on startup of PDMS (12 Series). 3. in some circumstances. Refer to the Flexman Installation and Configuration Guide. This may be deleted when you are satisfied that the product has been installed correctly. 3:2 2. Note: The default installation disk is. This will usually be done only on the server. A file containing environment variable definitions for incorporation into each user’s evars. A sub-directory containing further sub-directories which contain the DESIGN Forms and Menus user interface.1 . The manuals for OpenSteel and Flexman may be read with the Adobe Acrobat file reader. A sub-directory which contains templates for the production of Anchor Bolt location and quantity reports and sample files based on the supplied test project. Other versions of OpenSteel need not be removed before installing this version. The OpenSteel[ver] directory will contain the following sub-directories:: exe maps Manuals pml samples reports A sub-directory containing the license controlled executables for the import and export of SDNF files. and this is not always appropriate. A file containing environment variable definitions for incorporation into each user’s evars. News and update information is also available for Flexman on the AVEVA support web-site.OpenSteel Configuration Guide Installation on Windows It is recommended that the user uses the default settings for folder paths etc. OpenSteel_ env. Note: If the installer detects an existing OpenSteel 2. The C:\AVEVA\Plant directory will now contain a new sub-directory called OpenSteel[ver] where [ver] is the installed version of OpenSteel. A sub-directory containing sample profile mapping files between PDMS and external 3D steel detailing packages. A directory containing sample SDNF files as exported by other 3D steel detailing packages. the largest disk.bat OpenSteel_ env. A sub-directory containing this manual and the User Guide. This can be checked and if necessary changed by clicking the Advanced button on the installer.3 Flexman License Manager The user must install and set up the Flexman license system before launching the installed software.bat script called on startup of PDMS (11. However.bat test All the necessary OpenSteel directories have been created and the software installed.
  Please apply to your local AVEVA sales/support office.bat file.bat file to call the OpenSteel_env.1 call "%SDNFMAIN%\opensteel_env_116.bat" "%SDNFMAIN%" Please note that spaces are not permitted in the installation path name for PDMS 11. The user must set the environment variables for the interface. In order to run OpenSteel the user will need two licenses specific for the product .one for exporting and the other for importing.OpenSteel Configuration Guide Installation on Windows 3. refer to the Flexman Installation and Configuration Guide. Edit each user's evars.bat or OpenSteel_env_116. Refer to Examples of Typical Environment Scripts for an example batch file At the end of the evars.bat file provided.bat" "%SDNFMAIN%" or (for PDMS 11.1 call "%SDNFMAIN%\opensteel_env.6.6 series) set SDNFMAIN=C:\AVEVA\Plant\OpenSteel2. 3:3 2. insert a call similar to: set SDNFMAIN=C:\AVEVA\Plant\OpenSteel2.1 .4 How to Run OpenSteel The user must make sure that the Flexman license manager daemon is running before using OpenSteel.
  OpenSteel Configuration Guide Installation on Windows 3:4 2.1 .
  with a brief description of each one. which sets default values for the environment variables so that they point to the directory structure as installed.1 . The product is supplied with a file OpenSteel_env. The following is a list of the variables the user may need to reset. The user may need to modify this file to reflect the directory structure of their own installation.bat in the executables directory.OpenSteel Configuration Guide OpenSteel Environment 4 4. OpenSteel uses environment variables to refer to all directory paths. Like PDMS. It also sets the PATH variable to include the PDMSEXE directory. The external programs are license controlled and need separate licenses before the user is permitted to use them.1 OpenSteel Environment System Architecture The diagram below illustrates the whole OpenSteel interface system architecture. This allows the user to locate these directories anywhere on the file system. 4:1 2.
  The format of the external mapping files is described in External Mapping Files. the supplied project is TST. 4:2 2. add the pathname to the directory containing the OpenSteel application-ware macros. They tell the interface where on the computer network the external mapping files may be found. External mapping files are files which determine how the interface handles the data for going to the target package.1 . 4. the Profile. The supplied script will set this as follows: %OPENSTEELUI% %PDMSDFLTS% and the user will not normally have to change it The location of the project default mapping files. where xxx is the project code. just set it to the directory containing the OpenSteel application-ware macros. For example: %OPENSTEELUI% %PMLLIB%.2 Mapping Files There are two types of mapping files: internal and external mapping files. For example: %PDMSDFLTS% %TSTDFLTS% %PDMSUSER% The sequence of the components in the variable will determine any overloading of mapping files. Refer to OpenSteel Environment for a more detailed description of overloading of mapping files. The format of the internal mapping files is described in Internal Mapping Files. For example: %OPENSTEELUI% PDMSDFLTS The directory containing PDMS default (DFLTS) files. xxxDFLTS SDNFINTMAPS The location of the mapping files.OpenSteel Configuration Guide OpenSteel Environment SDNFMAIN OPENSTEELUI PMLLIB The top directory containing the whole set of OpenSteel files. The search path for PML macros. By default this is set to %SDNFMAIN%\pml. The mapping files must be stored in a directory called OSDE under the directory to which xxxDFLTS is set. for example. Otherwise. Profile Orientation and Material mapping files. It is set to a single directory. If this is already set. For example: C:\AVEVA\Plant\OpenSteel[ver]\ The location of the OpenSteel interface macros. For example. Internal mapping files are prepared by the OpenSteel system administrator. or coming from the source package. SDNFMAPS This is used in the internal mapping files for the location of the mapping files. It is not essential for OpenSteel.
  However.1 . The user does not have to use all three defaults variables. this does not alter the search rules for the external mapping files as based on the content of the identification line in the internal mapping file. The internal mapping files become the basis for locating the external mapping files. OpenSteel will search all the directories pointed to by this variable and locate all files with the suffix .map files will be imported during system initialisation as internal mapping files.2.map in each sub-directory called OSDE. This means that a file that is found in the first directory will be overwritten by a file with the same identifying characteristics. 4:3 2. a project mapping file could overload any company mapping files.2.OpenSteel Configuration Guide OpenSteel Environment 4. as overloading of mapping files is permitted and may occur. The diagram below illustrates how these environment variables may be used to select and overload sets of internal mapping files. found later in any of the succeeding directories. The . and they can use any others which have defined as well.2 Overloading Mapping Files The order in which directories are given in the setting of SDNFINTMAPS is important. 4. though not necessarily with the same filename (Internal Mapping Files). For example.1 Setting SDNFINTMAPS The environment variable SDNFINTMAPS is set to the locations of the internal mapping files.
  the variable SDNFMAPS is assumed to have been set up in the user's OpenSteel_env.OpenSteel Configuration Guide OpenSteel Environment 4.bat file to point to the directory containing the external mapping files. In this case the variable must point to only one directory. The user should take care in using environment variables in internal mapping files.2. so that the internal mapping files may be kept unchanged. but the user will be able to pick up mapping files from a project-specific location.3 Set SDNFMAPS For the purposes of this section. This variable may be made to be project specific. as a recursive scan is not performed at this level. The environment variable SDNFMAPS should point to a single directory only. By default this is actually SDNFMAIN.1 . 4:4 2. Note: SDNFMAPS is not a variable specifically required by this interface.
  The user may upgrade the catalogues by performing the following actions: 1. Exit from PARAGON. saving the changes by returning to MONITOR. some upgrade macros must be run on the project which: • • Update catalogues to include the Pline representation of the SDNF Cardinal Points. sdnfloadcpdata. In a command window in PARAGON. 5.pmlfnc in the pml/functions directory. call !!SDNFCataUpgrade( ) 4.1 5. rather than the higher points. There are 15 Cardinal Points defined in the SDNF standard. The macro suite will check to see if this upgrade has already been executed and create or modify the original set of Cardinal Points with an updated set. Of the remaining Cardinal Points. 2.1.1 . Enter PDMS and enter PARAGON with write access to all relevant catalogue databases. Install the UDAs which OpenSteel requires. If the user has not used Plines representing Cardinal Points to place Linear Members in PDMS. during the Export or Import processes an attempt is made to map existing Plines onto Cardinal Points.OpenSteel Configuration Guide Upgrade a Project for OpenSteel 5 Upgrade a Project for OpenSteel After the user has installed OpenSteel and set the appropriate environment variables. Note: This upgrade process works only for the AVEVA Solutions Ltd supplied catalogues. because other systems prefer to use these. This basic Pline mapping is as follows: 5:1 2. Refer to the OpenSteel User Guide which describes the Cardinal Points in more detail. Note: the user will have to perform these actions on the supplied project. run the upgrade macro by the following command: 3. OpenSteel tries to use those between 1 and 10.1 Cardinal Point Plines Update the Supplied Catalogues The standard AVEVA Solutions Ltd supplied steelwork catalogue must be upgraded to include the Pline representation of the SDNF Cardinal Points. The OpenSteel interface uses only 14 of them: the Shear Centre (Cardinal Point 15) is not a practical reference point to use in these circumstances. 5. This is in order to familiarise themselves with the process of upgrading a project for OpenSteel. This mapping is performed using information stored in a configuration file.
  1 .OpenSteel Configuration Guide Upgrade a Project for OpenSteel Symmetric Sections about Y Axis Pline RBOS BOS SS LBOS RIGH NARO AA MM NALO LEFT RTOS GG TOS LTOS NA Angles Pline mapped to Pline which is Cardinal Point mapped to Pline SNFA SNFB SNFB SNFC SNFD SNFD SNFD SNFF SNFF SNFF SNFG SNFH SNFH SNFI SNFJ which is Cardinal Point 1 2 2 3 4 4 4 6 6 6 7 8 8 9 10 TOAX TOAY RTTA LBOA NA NAT NAL SNFA SNFA SNFC SNFG SNFJ SNFK SNFL 1 1 3 7 10 11 12 5:2 2.
  1 . In particular we draw the user’s attention to the different handedness of the coordinate systems as illustrated below. 5:3 2. Note: The different Y directions to match the default angle orientations in each system. The main differences arise from the mapping of the profile orientations in the PDMS Catalogue onto the agreed SDNF format. see the section describing the assumed default profile orientations in the SDNF file and Cardinal Point locations in the OpenSteel User Guide. The diagram below illustrates the mappings of the Plines to Cardinal Points. and the Structural Design User Guide.OpenSteel Configuration Guide Upgrade a Project for OpenSteel Channels Pline LTOC RTOC FOC ROC LBOC RBOC NA TOC BOC mapped to Pline SNFA SNFC SNFD SNFF SNFG SNFI SNFJ SNFK SNFN which is Cardinal Point 1 3 4 6 7 9 10 11 14 For further explanation of the reasons why the mapping may seem inconsistent. The difference is most apparent in channel and angle profiles.
  Cardinal point Pkeys !!SDNFCPPkeys. the user may have to manage the orientation of the profile with regard to the SDNF intermediate form by using the Profile Orientation mapping file (External Mapping Files).pmlfnc is given here. there must be a mapping to SDNF Cardinal Points as shown above.Variable does not exist endhandle !!SDNFCPPkeys = ARRAY( ) !!SDNFCPPkeys[ 1 ] = |SNFA| 5:4 2.751 ) -. -.OpenSteel Configuration Guide Upgrade a Project for OpenSteel Y (PDMS) CP 1 Plines SNFA TOAX TOAY CP 11 Plines SNFK NAT CP 2 Pline SNFB CP 3 Plines SNFC RTTA CP 12 Plines SNFL NAL CP 10 Plines SNFJ NA CP 13 Pline SNFM CP 4 Pline SNFD X (PDMS) X Z (PDMS) CP 5 Pline SNFE CP 6 (SDNF) Pline SNFF Z (SDNF) CP 7 Plines SNFG LBOA + CP 9 Pline SNFI CP 14 Pline SNFN CP 8 Pline SNFH Y (SDNF) Diagram illustrating mapping of Cardinal Points to Plines for Angle profile If the user wishes to create profiles. If they are named differently. This is performed in the file sdnfloadcpdata. A sample extract of the Pline mapping in the file sdnfloadcpdata. Further.pmlfnc in the pml/functions directory. the user must provide a Pline set similar to the ones provided here to map onto the Cardinal Point Pline set.1 .delete( ) handle( 2.
  but the interface will know that it is equivalent to the SNFC Pline (i. Pline mapping on Import is subject to the constraint that the map will take the first equivalent it finds. sdnfusercataupgr.2 Update Catalogues not supplied by AVEVA Important: The naming conventions and database structure for the Pline sets should be similar to those used in the AVEVA supplied Catalogues. which is to be equivalent to Cardinal Point 3. To update individual catalogues. RTTA is equivalent to SNFC (Cardinal Point 3). Thus. importing new items positioned using Cardinal Point 3 will appear in the PDMS model to have been positioned using the RTOP Pline. The user must not alter in any way the array which maps Pline names to Cardinal Point Pkey values. This section gives details on how the user can update the steel catalogues to include the Plines necessary for the OpenSteel interface. The user may have to modify it in a different way for each catalogue.1. the format is… = |SNFC| !!SDNFCPBM<Pline PKEY> = |SNF[A-N]| the user will then be able to use the RTOP Pline for their own positioning functions.e. i.OpenSteel Configuration Guide Upgrade a Project for OpenSteel !!SDNFCPPkeys[ 2 ] !!SDNFCPPkeys[ 3 ] -. is mapped to the Pline whose Pkey is SNFA and which is equivalent to the Cardinal Point number 1. 5.) The user can write a macro which will call all the modified files in turn and so upgrade all their catalogues at once. The macro takes one argument which is the DBREF (the database reference number) of the catalogue to be updated. In some circumstances the Pline TOAY (Cardinal Point 1) may be Imported as Pline TOAX (also Cardinal Point 1) because the TOAX mapping is the first suitable one the system finds. Thus. whose Pkey is RTOP. run the upgrade macro as follows: 5:5 2. There is no way that the interface can determine which Pline the system originally used. the user must insert a line similar to the following in the mapping list: !!SDNFCPBMRTOP i.pmlfnc in the pml/upgrade directory provides the basis on which the user may build their own mechanism for updating the catalogues automatically. the Pline. whose Pkey is TOAX.e. The macro file. (Details about how the file should be modified are given in following sections. Cardinal Point 3).e.1 . if the user has a new Pline. We have indicated where the user may have to modify this file with lines prefixed by: >>>> User… The macro must be run for each catalogue (CATA element) the user wishes to update. the array !!SDNFCPPkeys.Angles !!SDNFCPBMTOAX !!SDNFCPBMTOAY !!SDNFCPBMRTTA !!SDNFCPBMLBOA = |SNFB| = |SNFC| = = = = |SNFA| |SNFA| |SNFC| |SNFG| In the above example.
  Repeat for as many catalogues as required. or have parameterised them in a different way from the supplied PDMS catalogues. That manual explains the parameterisation method for these shapes. the user will have to write their own macro for their own shape based on the most suitable one provided.OpenSteel Configuration Guide Upgrade a Project for OpenSteel 1. or to create their own. Please take note of the catalogue profile orientation with regard to the SDNF format. Angle shape RHS shape Japanese Bulb shape DIN Bulb shape Macro sdnfupgradet. Save your work and exit from PARAGON by returning to MONITOR.pml sdnfupgradei.Significant Catalogue Parameters: --------[#] [Description] 1 2 3 4 5 6 Vertical leg length (Y) Horizontal leg length (X) Thickness Cy (X offset) Cx (Y offset) Unit weight Horizontal leg (JIS-PTSS-JANG) Vertical leg (JIS-PTSS-JANG) [Specials] 5:6 2. and how the profile shape is positioned relative to the Neutral Axis and the X/Y origin in the catalogue. including parts of the header. Channel shape L. Generic Catalogue Shapes The AVEVA Solutions supplied catalogue contains profiles of 8 standard generic shapes which are detailed in the manual Structural Design User Guide. These are: Profile Shape Tee shape I shape O.pml sdnfupgradec.pml sdnfupgradejbulb. As a result. there are 8 generic macros in the pml/upgrade directory. Below is an extract of the supplied sdnfupgradel. Make the catalogue (CATA) the user wants to update the current element and give the command: call !!SDNFUserCataUpgr( !!CE ) 3. Refer to the OpenSteel User Guide for more details.pmlfnc macro. CHS shape C.pml sdnfupgradedbulb.pml sdnfupgradel.1 .pml sdnfupgraderhs. -------------------------------------------------------------------------. Start up PDMS and enter PARAGON with write access to all the relevant catalogue databases. 2. one for updating the Pline set of each standard shape.pml If the user has other additional shapes.pml sdnfupgradeo. 4. Customise the SDNF Pline Generating Macros In order to customise the generic SDNF Pline generating macros listed above. the user will need to understand fully how the profile in question is parameterised in their catalogue database. Tube.
  Build map of existing PLINes !plineMap = ARRAY() var !coll collect all PLIN with (substring((PKEY ).dbref( ) enddo endif -.3) eq |SNF|)for CE if( not !coll.Create all new SDNF PLINes necessary !pkeysHashed = ARRAY( ) do !i to !!SDNFCPPkeys.752 ) -.0 * ATTRIB CPARA[ 5 ] )| -.0 ) .109 )( 2.1.size( ) !pkey = !!SDNFCPPkeys[ $!i ] var !pkeyString hash( |$!pkey| ) !index = !pkeyString.create it NEW PLIN $!!SDNFCPData PKEY $!pkey !ref = ( ref ) !plineMap[ !index ] = !ref endhandle enddo -.empty( ) )then -.Define function define function !!SDNFUpgradeL( ) is REAL -.Set Pline dimensions !YOff = |( ATTRIB CPARA[ 4 ] )| !nYOff = |( ATTRIB CPARA[ 4 ] .0 ) )| !XOff = |( ATTRIB CPARA[ 2 ] .Try going to PLINe called SNF[A-N] $!plineMap[ $!index ] handle( 2.real( ) !pkeysHashed[ $!i ] = !index -.Pkey = SNFB $!plineMap[ $!pkeysHashed[ 2 ] ] PX $!XCOff PY $!YOff PLAX -Y -.Build a map indexed on PKEY .don't delete them do !i values !coll $!i !pkey = PKEY var !pkeyString hash( |$!pkey| ) !index = !pkeyString.real( ) !plineMap[ !index ] = !i.1 .Cardinal point 1 .( ATTRIB CPARA[ 1 ] / 2.All requisite PLINes exist now -.ATTRIB CPARA[ 5 ] )| !nXOff = |( -1.Pkey = SNFA $!plineMap[ $!pkeysHashed[ 1 ] ] PX $!nXOff PY $!YOff PLAX -Y -.ATTRIB CPARA[ 1 ] )| !YCOff = |( ATTRIB CPARA[ 4 ] .Cardinal point 3 .OpenSteel Configuration Guide Upgrade a Project for OpenSteel ------------------------------------------------------------------------.Cardinal point 2 .Pkey = SNFC $!plineMap[ $!pkeysHashed[ 3 ] ] 5:7 2.Initialisation !error = !!SDNFCPErrOK !origin = ( ref ) -.ATTRIB CPARA[ 5 ] )| !XCOff = |( ( ATTRIB CPARA[ 2 ] / 2.Failed .
  pmlfnc macro file. These are Xoff. nYOff and nXOff. The structure of all the supplied macros is similar. We also need to work out the location of the geometric centre relative to the method of profile definition. e. The user will see above that the definition is in terms of a text string which describes a formula.Map Shapes to generic update macros !TShape = |!!SDNFUpgradeT( )| !IShape = |!!SDNFUpgradeI( )| !OShape = |!!SDNFUpgradeO( )| !CShape = |!!SDNFUpgradeC( )| !LShape = |!!SDNFUpgradeL( )| !RHSShape = |!!SDNFUpgradeRHS( )| !JBULBShape = |!!SDNFUpgradeJBULB( )| !DBULBShape = |!!SDNFUpgradeDBULB( )| -. Later on in the macro.g. and the user may have to extend the list for their own additional specific shapes. These location parameters are XCOff and YCOff. This is done by filling in a mapping file of PML objects in the sdnfusercataupgr.Name = |/USER-PTSS-I| !UserMap[ 1 ]. Any SDNF Plines that are not available and are needed by the OpenSteel interface as listed in the !!SDNFCPData array. The structure of the upgrade process allows the user to run the macro during the project as well as at project initiation. the user should. The first set in the UserMap array may have to be modified. pay close attention to the default profile orientations within SDNF. Map Pline Set Names to Profile Shapes Once the user has defined their generic shapes the user needs to be able to map the Pline set names to that shape. Refer to the OpenSteel User Guide regarding these Cardinal Points. For example.>>>> User Map definition between PTSS and Shape code !UserMap = ARRAY( ) !UserMap[ 1 ] = object SDNFMAPOBJ( ) !UserMap[ 1 ]. If the user is extending or modifying OpenSteel. Using these SDNF Pline location parameters. rather than the immediately evaluated formula.Macro = !IShape 5:8 2. Note: We record our interpretation of the catalogue parameters in the header. This ensures we use the latest configuration. YOff. this text string is inserted into the command line.1 . however. all the user should need to do is to modify the part of the macro which calculates the location parameters. We then need to define the SDNF Cardinal Point Pline location parameters related to the method of catalogue parameterisation. dimensions. a complete mapping for a Pline set consists of the following: -. are then created. Any database relationships that refer to the old Plines will be maintained. The macro first builds a list of any SDNF Plines that already exist.OpenSteel Configuration Guide Upgrade a Project for OpenSteel PX $!XOff PY $!YOff PLAX -Y … and so on. This use of PML allows the user to insert formulae into the Pline definition.>>>> User to add any specific shapes here -!USERAShape = |!!SDNFUpgradeUSERA( )| -. all the Cardinal Point Plines required for the OpenSteel interface can be located.
  On the 2D profile in each package locate where the Cardinal Points and their Pline equivalents will be.3 Catalogue Upgrade Step-by-Step Below are instructions to create and upgrade the Catalogue based on the requirement to create a new profile shape in both DESIGN and the external steel detailing package. Mirroring represents a transformation about the Y axis: rotation is about the Z axis. In the PARAGON module. In the steel detailing package create the profile such that its default orientation will be the same as that in DESIGN when laid out from start to end. the middle diagram shows the Cardinal point positions in Frameworks for the angle. the default orientation may be different. In PDMS (Series 12). Determine the generic shape and parameterisation best suited to the required profile.1 . Above are the three diagrams that show the Plines and Cardinal points that are to be considered in DESIGN and Frameworks for the case of an unequal angle. the user may need to use mirroring and/or rotation transformations to get to the correct "starting position". Record the correspondence between Cardinal Points and Pline names. Keep a record of these necessary transformations as they will go into the orientation mapping file. 5. this is done in PARAGON. such as unequal angles. Build the new catalogue. the user can see that the !IShape variable is associated with the macro !!SDNFUpgradeI( ). At this point do not include SDNF Plines in the Pline set just place other Plines the user will find useful and name them accordingly.OpenSteel Configuration Guide Upgrade a Project for OpenSteel This means that the Pline set (PTSS) named /USER-PTSS-I is to be modified using the PML macro represented by the variable !Ishape. With predefined profiles. should be preceded by backing up the files first. New Profile Shape Definition With each package the user will need to create the new 2D profile shape. The left hand diagram shows the normal Plines associated with the angle profile in its default orientation. place any other Plines that the user may find useful. also in 5:9 2. following the "Right Hand Screw Rule".1. In this case. Any operations that require changes to system mapping files. Do not include any Plines with PKEY values SNFA to SNFN as these will be added in the upgrade process. recording which parameters apply to which dimension. Further up. Remember also that any mirroring and rotation will affect the Cardinal Point locations.
  Note: The coordinate system in PDMS is right handed.pmlfnc macro. whereas in Frameworks it is left handed. This is how the Pline mapping is managed. the right hand diagram shows the Pline equivalents to the Cardinal Points. In PARAGON determine the parameterised geometry and Pline positioning for the Cardinal Points. Upgrade the Catalogue for SDNF Upgrading the Catalogue involves adding SDNF Plines to be equivalent to the Cardinal Points. This three letter abbreviation is stored in the internal steel standards file. Inspect the current file for directions on how to extend this file.pmlfnc macro. the user may need to assign a new profile integer type code to it for use in the profile mapping file. The Cardinal Point : Pline equivalencing by superposition is illustrated below. Also. Modify it then run it. the user may need to assign a new country code to this. Use an existing example as a guide. use a customised copy of the sdnfupgrade<*>. must be mapped to Cardinal Points in the sdnfloadcpdata.OpenSteel Configuration Guide Upgrade a Project for OpenSteel its default orientation. If the new profile is not one of the existing types. Using this kind of diagram the user will be able to determine the mappings between Plines and Cardinal Points. Modify the profile upgrade macro to account for the new parameterisation to create and locate the SDNF Plines for the Cardinal Points. Any new Pline names. if the new profiles are for a new country standard. as set in the PKEY attribute. PML is a language that enables the user to construct variable names from string components and then use them. This TLA is also used in the profile mapping file. 5:10 2.1 . If the user is extending an existing generic shape use the existing upgrade file provided. Or if the profile can be based on an existing generic shape.
  In the example below.pmlfnc macro for upgrading standard catalogues.pmlfnc to extend any lists to include the new profile shape. they are to be recorded in the orientation mapping file for the target detailing package. For example: PDMS XSTEEL HE280A HEA280 EUR 20 HE280B HEB280 EUR 21 5:11 2. the British type 9 profiles are orientated by mirroring (1) and then rotating by 180 degrees. !Ishape = !UserMap[ !UserMap[ !UserMap[ |sdnfupgradei()| 1 ] = object SDNFMAPOBJ( ) 1 ].delete( ) handle( 2.751 ) -. if any transformations are to be applied to convert from DESIGN to the SDNF default system. British type 8 profiles are not mirrored (0) and just rotated by 180 degrees.Cardinal point Pkeys !!SDNFCPPkeys.Angles !!SDNFCPBMTOAX = |SNFA| !!SDNFCPBMTOAY = |SNFA| !!SDNFCPBMRTTA = |SNFC| !!SDNFCPBMLBOA = |SNFG| Run sdnfcataupgr. Once modified. run this macro.Variable does not exist endhandle !!SDNFCPPkeys = ARRAY( ) !!SDNFCPPkeys[ 1 ] = |SNFA| !!SDNFCPPkeys[ 2 ] = |SNFB| !!SDNFCPPkeys[ 3 ] = |SNFC| º -.Macro = !Ishape Modify the Orientation Mapping File For the chosen profile in the chosen standard.Name = |/USER-PTSS-I| 1 ]. Inspect the macro sdnfusercataupgr. associating it with any new profile upgrade macro. PDMS STRUCAD BRI 8 0 180 BRI 9 1 180 DIN 8 0 180 DIN 9 1 180 Modify the Profile Mapping File Any new profiles requiring mapping between DESIGN and the external steel detailing system should be entered in the mapping file appropriate to the detailing package.1 . If the profile requires no transformations.OpenSteel Configuration Guide Upgrade a Project for OpenSteel -. it should not be listed in this file.
  so you will need to upgrade your current projects if you are to use this later version of OpenSteel. More UDAs are required in this version. Start up PDMS and go into LEXICON with write access to all the relevant Dictionary databases. However this last option is very brutal as all form settings will be lost because the forms and menus are regenerated.g.OpenSteel Configuration Guide Upgrade a Project for OpenSteel Re-initialise the System and Save the UI Binaries On the OpenSteel Export or Import main forms use Control > Re-initialise for resetting the configuration data only. SYSTEM 5:12 2. The user will have to regenerate UI binaries after this. Execute the upgrade macro by the following command: call !!SDNFUDAUpgrade( ) 3. The user can always recover elements from this area if they need to later on. e. for example. saving your changes. 5. e. 2. Note: This upgrade may be run even if the UDAs exist already. The macro has been configured to keep existing UDA definitions so that you will not lose data. default Header information. This latter site will be created only when needed. Or execute call !!sdnfimpexp() in a command window to re-initialise the system.1 . Exit from LEXICON. to include more UDAs needed for a later version of the interface. some SITE elements will be created.3 Special OpenSteel SITES When the OpenSteel application installs itself in the Design database.g. In this way the user may upgrade the system whenever necessary. 5. Typically these will be called something like /SDNF-CONFIG-DEMOSYSTEM and /SDNF-OLD-DEMO-SYSTEM. The name of the configuration and deleted element SITEs are built up of the following components:: /SDNFCONFIGOLD<mdb name> <user name> the system prefix identification of a Configuration SITE identification of a SITE for ‘deleted’ elements the current MDB. The first is a SITE to store information about the Import and Export processes. the interface requires a set of User Defined Attributes (UDAs) specifically for storing OpenSteel related information. by typing Monitor. The second is a SITE to store items which have been 'deleted' from the model during the Export/Import design cycle. /DEMO the current user name. and Transfer and Revision numbers. These are installed by performing the following actions: 1.2 Installation of User Defined Attributes Before the user starts designing steelwork.
  all the user needs to do is to find the suffix applicable to the toolbar with which the user wants to integrate OpenSteel and copy either of the DES-UTILS-xxx files to have the new suffix. the supplied product will be available automatically in the DESIGN General and Steelwork application-ware systems. However. OpenSteel then becomes available under the Utilities > Piping menu option. so that the user can quickly isolate which items were deleted at which time. The SITE for deleted elements. to integrate OpenSteel into the Piping Application. in order to run OpenSteel there are various additional things that have been done to the databases that you may also wish to remove. There may be several of these. to remove the extra OpenSteel Plines. OpenSteel will then become available in that application-ware package. The principal things the user has to do to uninstall OpenSteel from PDMS are: • • • • to remove the UDA definitions. all these elements are inspected to extract the latest transfer information. If the user wants to integrate OpenSteel into other application-ware toolbars.4 Integration into other PML Applications In the pml directory are several files beginning with ‘DES’. The user will note that the SITE names contain the current MDB and the current user name.OpenSteel Configuration Guide Upgrade a Project for OpenSteel OpenSteel will check that the user has read/write access to their specific SITEs. They are: DES-INIT-MAC DES-UTILS-GEN DES-UTILS-STLWRK called on startup of DESIGN called on startup of the General Application toolbar called on startup of the Steelwork Application toolbar Therefore. Refer to the OpenSteel User Guide for more information. named in a similar manner to the Configuration object and described in more detail in the User Guide. They are found in the path of the %PDMSDFLTS% environment variable and called on startup of the DESIGN module or the individual PML Applications.5 Uninstall OpenSteel The main OpenSteel product can be removed from your system using the normal Add/ Remove Programs option from the Windows Control Panel. and multiple accesses to the database. 5. depending on which MDB and/or user has access to the particular database. 5:13 2. 5. This is to facilitate multi-user working. will store the 'deleted' elements in STRUs according to the Import revision. to remove the link to the PML appware. since the user and the interface may need to edit certain attributes. the user needs to copy DES-UTILS-GEN to a file called DES-UTILS-PIPE. During the Import and Export processes.1 . For example. to remove the Configuration SITE elements.
  the user need to ‘disconnect’ OpenSteel from the DESIGN application ware. 5:14 2. remove all the /SDNF-CONFIG-xxx elements from every Design database. It is then up to the user whether the user delete the SITEs containing the ‘deleted’ elements. if they want.OpenSteel Configuration Guide Upgrade a Project for OpenSteel There are two PML functions in the pml/functions directory which the user can run from LEXICON and PARAGON to perform the first two actions.1 . They are run in a command window by using the following syntax: call !!SDNFRemUDAs( ) call !!SDNFRemPlines() in LEXICON in PARAGON The user can then. This involves deleting or renaming the ‘DES’ files in the pml directory. Finally. as these will no longer be necessary.
  g.pmlfnc file: call !!SDNFImpExp( ) However.1 . as they match the names of the external packages with their three-letter abbreviations used internally in the interface. If the user changes variables in the user data area. They are set in the file called sdnfuserdata. Alternatively. A typical message indicating this condition might be: Object does not have a member . or even the mapping for a particular steel manufacturer.append( |StruCAD| ) !!SDNFExtProgList. reload the DESIGN UI from macros. the user may reload the OpenSteel system variables and rebuild the forms using the following command.append( |XSteel| ) !!SDNFExtProgList. the user can extend the list of external packages which the interface will know about by modifying the following two list attributes: !!SDNFExtProgList !!SDNFExtProgAbbr These lists must be kept in step with each other.append( |PDMS| ) and 6:1 2. SDNF.pmlfnc found in the pml/functions directory of the interface.targetlist The user must also load the DESIGN UI from macros if the user make any changes to the internal mapping files 6. Refer to the OpenSteel User Guide for more details. the user must reload the DESIGN user interface from macros in order to rebuild it. or the name on an intermediate mapping state. e. after the user have saved the sdnfuserdata. It is this three-letter abbreviation which is used in the identification of the correct mapping files (see below). They may represent steel detailing packages. the user can use the Re-initialise option on the main Import or Export forms.1 External Packages If the user uses other external packages that can export and import SDNF files. Note that ANY should be the last entry in the abbreviation list.append( |SteelCAD| ) !!SDNFExtProgList.OpenSteel Configuration Guide Customise OpenSteel 6 Customise OpenSteel This chapter describes the PML variables which the user can set to customise OpenSteel. If the user customises the OpenSteel forms. if the user finds that the user interface forms are damaged. The supplied lists are constructed as follows: !!SDNFExtProgList.
  copy the bottom commented lines and replace the bold text accordingly.!equivalent.for further equivalents use versions of the next 4 lines -!equivalent. 6. and not in the form definition files. the exporting program includes an identifying string in the SDNF file header. To create a new pairing.OpenSteel Configuration Guide Customise OpenSteel !!SDNFExtProgAbbr.clear( ) -. Like PDMS. external packages can change their names over the years.1 . yet the program can still behave in a similar way to before.751 ) -. if the user wants to extend or modify the list of Target Packages the user needs only to change it here. The user will also have to generate the other internal and external mapping files required by the new system.append( |XST| ) !!SDNFExtProgAbbr.delete( ) handle( 2.append( !equivalent ) -. This has been started in the file sdnfuserdata.The first entry is the one we DO have the mapping files for !equivalent = ARRAY( ) !equivalent.pmlfnc.1 External Package Equivalences When exporting to SDNF.append( |Tekla| ) !equivalent.append( |TeklaStructures| ) !!sdnfExtProgEquList.Make TeklaStructures equivalent to Tekla -. Therefore we need to be able to associate alternative identifying strings to the same basic source program.Program equivalent list !!sdnfExtProgEquList. Thus. Below is the code to make an equivalence relationship between Tekla and TeklaStructures.append( |STE| ) !!SDNFExtProgAbbr. -. OpenSteel searches for this string in order to identify the source and then select the correct mapping files automatically.ANY to be the last in the list !!SDNFExtProgAbbr.append( |PDM| ) -.append( |ANY| ) This list is picked up automatically by the Import and Export forms.append( |Existing program for which we have the mapping files| ) 6:2 2.1. The identifying string can also change.Variable does not exist endhandle !!sdnfExtProgEquList = ARRAY( ) -.append( |STR| ) !!SDNFExtProgAbbr.
  2 Colour Code The user can change the colours of the objects on the screen using the variables listed below. which is used to determine how many iterations of the waiting loop the interface goes through before prompting the user for further information.4 Waiting Time The system wait time represents a unit of time which the interface will wait while the external program is executing. the minimum Plate thickness. This variable is nominally measured in seconds. -.OpenSteel Configuration Guide Customise OpenSteel -. If there is no response within this time. in millimetres. The default settings are: !!SDNFColChanged !!SDNFColAdded !!SDNFColDuplicate !!SDNFColDeleted !!SDNFColExported !!SDNFColDefault = ( 12 ) = ( 5 ) = ( 6 ) = ( 2 ) = ( 3 ) = ( 1 ) $* Mauve $* Green $* Cyan $* Red $* Orange $* Grey The duplicate colour is used when the import system searches for items with duplicated mark numbers. If the user wants to change them. 6:3 2.append( !equivalent ) Once the above relationship has been set up.it may just be working hard! The user will be asked whether they want to wait for another unit period. -. OpenSteel will treat SDNF files containing the string "TeklaStructures" as though they have come from Tekla and use the correct mapping files for Tekla. the interface may assume that the external program has stopped for some reason. !!SDNFNoOfTries. 6.!equivalent.Set wait time !!SDNFWaitTime !!SDNFNoOfTries = ( 10 ) = ( 5 ) There is also a variable. 6. The minimum tolerance is used as a fine tolerance value in vector comparisons.Set distance tolerance !!SDNFDistTol !!SDNFMinTol = ( 1 ) = ( 0. the list of colour numbers is given in the DESIGN Reference Manual. such as for angles. but it is also dependent on how busy the computer is on other tasks as well. This may not be the case . and the minimum length of Linear Members.1 .01 ) 6.append( |New program to use the mapping files for the program above| ) -!!sdnfExtProgEquList. below which two points are considered coincident).3 Tolerance Settings The user can modify the distance tolerance (the separation.
  Ignore unconnected Linear members !!SDNFNoUnconnMem = false 6. 6:4 2.6 Connected Members The user may set the default to ignore unconnected members.7 Ignore Material Flag The user can choose to ignore any errors caused by different material mappings by using this flag. The default is set up by the system. The header element will contain information about the imported or exported model. Zones or Structures and their selection as required. the user will receive a warning in the log file if any are found.5 Export Header The default Export file header information is to be contained in the Configuration SITE element. OpenSteel now manages these Configuration SITEs separately from the header elements. but the user may want to override that setting using the code below. -.Source of Export Header data !!SDNFExpHeader = !!SDNFConfigObj This should be set to a string representing the name of the SITE from which the configuration details are to be taken e.1 . The role of header elements has changed since previous versions of OpenSteel as the Transfer and Revision data have been separated into the Configuration SITEs. the client information. the user can indicate their choice.Ignore Material changes !!SDNFIgnoreMatl = false 6. this variable just sets up a default location. If the user wants to ignore unconnected Linear Members. -. !!SDNFExpHeader = |/OtherHeaderSITE| The user will still have the opportunity to choose the another header element during the Export process.OpenSteel Configuration Guide Customise OpenSteel 6. otherwise an error is raised. -. The user can therefore create elements to store information specific to a particular Export event and use this information in the Export process. This information can be customised per run by the creation of Sites.g. Alternatively. Header information can also be stored in ZONE and STRU elements. any difference in material is not raised as an error. What this means is that on comparing the original model with the imported model. the user may set the value to ‘true’ so that they do not Export unconnected members. 6. This variable indicates where that will be.8 External Mapping File Separator The separator character for the external mapping files may be either a space or a comma. Using the variables below. target information about the steel contractor and other details.
  there is a current size limit of 500000 lines. Note: It is for the user to handle all internal errors within the macro. while others are comma separated. such as the mapping files.10 User-definable Material Macro If the material information is not contained in the MATR or :SDNFMGRADE attributes. Orientation or Profile) must use the same separator consistently: the user cannot have some Material files space separated.1 .Material macro !!SDNFMaterialMac = |sdnfgetusermatl| This would enable the user to configure the system to extract material information in a manner different from the default system. This is performed using the variables below: -. This macro is identified using the following global variable: -. -. respectively. See User-Definable Material Macro.pmlfnc and postexport. Note: It is for the user to handle all internal errors within the macros.11 Maximum File Size For reading many files. -. 6.pmlfnc. This may be modified by changing the lines below. it may be extracted using a user-definable macro.and Post-processing Macros The user can write their own macros to be run before and after the Export process has taken place. 6. This lets the user build a model in DESIGN which then needs some sort of pre.Mapping File separators !!SDNFProfSep !!SDNFMatSep !!SDNFOriSep = !!SDNFSpaceSep = !!SDNFCommaSep = !!SDNFSpaceSep 6. This macro takes no arguments and returns a string.9 Pre.OpenSteel Configuration Guide Customise OpenSteel Note: Note that all the files of the same type (either Material. log files or even some internal files. They are named preexport. These macros will be called before and after the Export process has been executed.Pre/Post Export User Defined Macros !!SDNFPreExpMac = |preexport| !!SDNFPostExpMac = |postexport| The above syntax defines the names of two macros which are to be found in the directory structure below the %PMLLIB% environment variable. The above defines a reference to a macro which is to be found in the directory structure below the %PMLLIB% environment variable.Maximum file size in lines !!sdnfMaxFileSize = ( 500000 ) 6:5 2. These macros should have no arguments and return no value.or post-processing.
  as all of the files must be built using one reference or the other.13 Replacement of SCTNs with GENSECs on Import The more modern PDMS structural user interface creates GENSEC elements for all structural members.7X5 EUR 13 This means that the XSteel profile PD193. However.Profile Map Table Ref -!!SDNFProfMapRef = |CATR| !!SDNFProfMapRef = |SPRE| Now OpenSteel will use the name of the Specification Component as their mapping name. The original XSteel Profile Mapping File. and all curved ones (packet 60) are imported as GENSECs.7x5 XSTEEL PD193. By default the lines are as follows. Below is an example of each case. this should appear as something like the following. whether they are straight or curved.pmlfnc function there is a variable. This is a significant decision the user will have to make before starting to build their mapping files. thus: -. Therefore. it would be difficult to build a structurally connected model with GENSECs. The user has the option of replacing these straight SCTNs with GENSECs by modifying the following line in the sdnfuserdata.Flag to replace imported SCTNs with GENSECs 6:6 2. with the second line commented out: -. !!SDNFProfMapRef.7X5 will be related to the Catalogue Component whose name is /OD193.pmlfnc file. This means that the Profile mapping files must be built differently.12 Profile Mapping Files The user can create their own Profile mapping files using either the PDMS Specification Component or the Catalogue Component.7x5 XSTEEL PD193. very much abbreviated (to just one line after the first one). In the first phase of import. is as follows: PDMS OD193. In the sdnfuserdata. all straight structural members (Packet 10) are imported as SCTN elements.1 .OpenSteel Configuration Guide Customise OpenSteel 6. comment out the first line and uncomment the second.Profile Map Table Ref !!SDNFProfMapRef = |CATR| -!!SDNFProfMapRef = |SPRE| Should the user want to build their Profile mapping files using the Specification Component.7X5 EUR 13 6. The default is not to replace the SCTNs. -. where the PDMS name is actually the name of the PDMS Specification Component. The user cannot mix the PDMS names. which the user can set to determine whether OpenSteel uses the Specification or Catalogue Component. the connectivity features for the new elements are not as advanced as for the old SCTN elements. Note: The supplied files are based on the Catalogue Component names. To use the second option.7x5. PDMS DIN-SPEC/OD193.
  If. Important: This latter function must not be modified. -. -.Brief/Verbose SDNF file header !!sdnfBriefHdr = true 6. However. but all new elements will be replaced or not as required.pmlfnc can be modified by hand to provide a degree of customisation of OpenSteel. the user is working with a local set of configuration data. By default the SDNF files have brief headers. the file sdnfuserdata.14 SDNF File Headers The user can select whether the SDNF file will contain listings of all the mapping files or just the Packet count table.pmlfnc variable. The configuration form is accessible from either the main Import or Export form using the Control > Configure. This overwrites the system variables in sdnfsystemdata.. menu item below. This is performed by changing the flag !!sdnfFEMarkMode. the system detects that there are duplicate external mark numbers.pmlfnc function. you may wish to force the system to export the PDMS reference numbers irrespective of the state of the external mark numbers. This is done by the !!sdnfBriefHdr variable in the sdnfuserdata. !!sdnfEMarkMode = |EXTERNAL| 6. This form has access to versions of all the variables in the sdnfuserdata.Change only if you are sure of what you are doing. So. 6:7 2.15 Exporting Internal Reference Numbers Some systems do not use unique mark numbers on elements and so it can be difficult to relate components when they are repeatedly imported.16 Local User Configuration As has been described above.1 . at this point. but it does not modify that function at all. but if the user wishes to include details of all the files used for the translation. 6.OpenSteel Configuration Guide Customise OpenSteel !!sdnfSCTNtoGENSEC = false If the user is importing to update and existing model.Flag to export [INTERNAL|EXTERNAL] IDs. -. PDMS keeps a record of both the PDMS reference number (:SDNFMARK) and the external mark number (:SDNFEMARK). the database type of elements is not changed.. There is a third level of customisation available that is accessible by a form.pmlfnc. it will switch automatically to exporting the PDMS internal reference numbers instead. prior to export. the variable can be switched to 'false'.
  model parameters. The detail of the attributes can be read above. display colours. where appropriate.OpenSteel Configuration Guide Customise OpenSteel The System Configuration Form has 5 tab pages for run parameters. The forms do have some data validation. 6:8 2.1 . environment parameters and macros.
  OpenSteel Configuration Guide Customise OpenSteel 6:9 2.1 .
  OpenSteel Configuration Guide Customise OpenSteel 6:10 2.1 .
  To load any settings file other than the default one use Control > Load.xml file.pmlfnc and subsequently overwritten by sdnfuserdata.pmlfnc.1 .xml file..OpenSteel Configuration Guide Customise OpenSteel By default. On re-showing the form any unsaved attributes will be lost.xml files.. If this file is not available. is initialised. If present. The Re-initialise option goes right back to the source variables in the system and user data and the default OpenSteel. then the default values that are used are set in sdnfsystemdata. To save the settings to another file.. The OK button transfers the form settings to the main Import/Export system for use in that session. The user can save the form settings to this default file using the Control > Save option. 6:11 2. option. just delete the OpenSteel. A file browser form is shown for you to choose where to locate the new file. and indeed the whole OpenSteel system. option. this file is accessed when the form. To restore the main default settings at form initialisation.xml in the PDMSUSER area. the system looks for a file OpenSteel.. use the Control > Save as. The Reset button resets the values using the normal form initialisation process with the current variables and any saved OpenSteel.
  OpenSteel Configuration Guide Customise OpenSteel 6:12 2.1 .
  the precise rules for which are defined below. The internal files recognise an external package. there are several potential errors: it is not of the correct format. If the user does not continue. or they define the mapping of strings or attributes between DESIGN and the intermediate SDNF file.map’ and be stored in a directory under the %SDNFINTMAPS% environment variable. Alternatively the user can use the Re-initialise menu option on the main OpenSteel Import and Export forms. although it is frequently inadvisable. The supplied interface stores example files in a directory pml/OSDE.1 . the user will be prompted to confirm that the user wants to carry on with using the interface. it may not exist. Error and Log File Messages Bad Map File On attempting to load the internal mapping file. for example: %ENVVAR%\… These environment variables cannot be search paths: they must translate to a reference to a single directory. a fatal error is raised and the interface exited. As an aid to generalising the user’s interface. the first line is not correct. The first line of the file is taken to be a file identifier. it may contain empty lines. These define where external mapping files are located on the user’s system network. but there are no mapping table files associated with it. the user must reload the DESIGN user interface from macros. all these internal files are listed at the top of the file as comments for the user’s information. Comment lines in SDNF start with the # symbol. When an SDNF export file is created.OpenSteel Configuration Guide Internal Mapping Files 7 Internal Mapping Files The interface relies on several internal mapping files. Internal mapping files are of the form of an asterisk (*) separated sequence of strings. Internal files must have a suffix ‘. No Mapping Table defined for selection 7:1 2. The user should then resave the binary UI. the user may include environment variables in the path names as long as they are defined in PDMS format. Internal mapping files are loaded on start-up of the OpenSteel interface. If there are any problems on loading. It is the user’s responsibility to modify them correctly so that they indicate the correct file location Note: If the user changes any of the internal mapping files.
  1 File Mapping Files The file mapping tables indicate the location of external Profile. indicating the location of the mapping file for the associated external package.g.map XSTEEL*%SDNFMAPS%\XSteel\XSteelMat. SDNFMAPS. The files consist of a first line. using a previously defined environment variable. or ANY.map XSTEEL*C:\AVEVA\Plant\OpenSteel[ver]\maps\XSteel\XSteel. • The first part of this identifier text is either the three-letter name of the project.map 7:2 2. The external package may be a 3D steel detailing package e. StruCAD.map STEELCAD*C:\AVEVA\Plant\OpenSteel[ver]\maps\SteelCad\SteelCad. The project-specific Profile mapping files for the TST project may be similar to: TSTPRF*TSTPRF STRUCAD*C:\AVEVA\Plant\OpenSteel[ver]\maps\StruCad\StruCad. e.m ap PDMS*C:\AVEVA\Plant\OpenSteel[ver]\maps\PDMS\PDMS. TST for the TST000 project. Orientation and Material mapping tables in the directory structure. signifying a companywide table for any PDMS project.OpenSteel Configuration Guide Internal Mapping Files 7.1 .map The Material mapping tables are defined in a similar way. The package name must correspond exactly to that in the list set up during the user customisation process described above. The first line in each file is a pair of values.map STEELCAD*%SDNFMAPS%\SteelCad\SteelCadMat.map STEELCAD*C:\AVEVA\Plant\OpenSteel[ver]\maps\SteelCad\SteelCad. an intermediate file e. The second part must be one of: PRF ORI MAT for a Profile mapping table for a Profile Orientation mapping table for a Material mapping table.map and a companywide Profile mapping table may look like: ANYPRF*ANYPRF STRUCAD*C:\AVEVA\Plant\OpenSteel[ver]\maps\StruCad\StruCad. might look like: TSTMAT*TSTMAT STRUCAD*%SDNFMAPS%\StruCad\StruCadMat. For example a project-specific Material mapping file. then a series of pairs of * separated values (with no spaces). or even a steel fabricator's catalogue. The internal mapping tables may be specific to either the project or the company. SDNF. The tables are searched first for a project-specific set before a company-specific set. the second of which is used to identify the list.g.map XSTEEL*C:\AVEVA\Plant\OpenSteel[ver]\maps\XSteel\XSteel.g.m ap PDMS*C:\AVEVA\Plant\OpenSteel[ver]\maps\PDMS\PDMS.
  map XSTEEL*%SDNFMAIN%\maps\XSteel\XSteelOri.1 . Examples are: STATUS*HOLD 0*Undefined 1*Fixed 2*Provision 3*Other or CLASS*PSPEC 0*Undefined 1*Lead Paint 7:3 2.2.The interface cannot determine the meaning of %nnnn% in the mapping file.OpenSteel Configuration Guide Internal Mapping Files PDMS*%SDNFMAPS%\PDMS\PDMSMat. No action is taken by the interface to manage these values inside DESIGN: the value in the :SDNFHOLD and :SDNFPSPEC attributes are used to store and export the values. These tables are output in the top of the SDNF file. Paint Spec Coding and Connection Type text.map PDMS*%SDNFMAIN%\maps\PDMS\PDMSOri. The SDNF file takes an integer value in the Status and Class field for a Linear Member or Plate which this interface is using as the Holds and Paint Spec values. Error and Log File Messages Environment variable ‘$nnnn' not understood.2 Text Conversion Mapping Files The text conversion mapping tables perform conversion operations between text strings derived from the Design database and the SDNF file. The tables described here just provide an aid to the user. consult the relevant section in this guide. 7. 7.1 Holds and Paint Spec Files The simplest tables are the Holds and Paint Spec tables which are just for reference for the user. .map For details of the format of the external mapping files. so that the value of the field in the SDNF file may be interpreted.map STEELCAD*%SDNFMAIN%\maps\SteelCad\SteelCadOri. These cover the Holds.map A companywide Profile Orientation mapping table would look similar to the following: ANYORI*ANYORI STRUCAD*%SDNFMAIN%\maps\StruCad\StruCadOri.
  but for only the TST project may be: ANYTSTCON*ANYTSTCON BP*macro BasePlate TP*TP FPWB*FPWB FPWC*FPWC and for any Source or Target Package and any project the file might look like: ANYANYCON*ANYANYCON BP*macro BasePlate TP*TP EP*End Plate FPWB*FPWB FPWC*FPWC The interface search order is for mapping files for: 1. 2. an occurrence of ‘EP’ in the Design database will be output in the SDNF file as ‘End Plate’ in the relevant field in the Packet 40 section of the SDNF file. TST. the interface searches for a string identifier in the Design database. For example.2 Connection Mapping File The Connection mapping table allows the user to define a conversion table between a DESIGN value and a string value which appears in the Packet 40 entries (Connection Details) in the SDNF file.2. 7:4 2. As this interface currently only exports connections to SDNF.OpenSteel Configuration Guide Internal Mapping Files 7. or ANY. A specific Source or Target Package and a specific project. this conversion is made only during the Export process. This is then mapped to the output string based on the mapping table. as in the above examples.1 .g. but here the code is in three parts depending on a) the Source or Target Package and b) the project. e. the second is the project name. 3. There is no means yet by which Packet 40 can be imported and interpreted by the interface to create a Joint of the correct type. as pairs between data found in DESIGN and that to be output in the SDNF file generated by the Export process. Any Source or Target Package and a specific project. On Export. The data lines are arranged. A file for the external package identified by XST and for the TST project might look like: XSTTSTCON*XSTTSTCON BP*macro BasePlate TP*TP FPWB*FPWB FPWC*FPWC A file for any Source or Target Package. The table identification method is similar to the methods described above for the external mapping files. The first part is the three-letter abbreviation for the Source or Target Package as set up in the user customisation process described above. and the third component of the name must be CON. Any Source or Target Package and any project.
  OpenSteel Configuration Guide
  Internal Mapping Files
  To find the end coding in DESIGN, the interface looks at the CTYA attribute on the catalogue description of the Joint associated with an end of a Linear Member (SCTN or GENSEC). The coding is taken from there, but, while the interface exports the data, it is also transferred to the CTYS or CTYE attribute of the SCTN as appropriate. A warning is raised if an end coding mapping cannot be found. To cater for the fact that the CTYA may not be set and the user wants there to be a default end connection type, all the user needs to do is to include in the file a line similar to the following. Note: There is no DESIGN value before the asterisk. This means that for unset CTYA values Default Connection is mapped into the output file.
  ANYANYCON*ANYANYCON *Default Connection BP*macro BasePlate TP*TP etcº
  7.2.3
  User-Definable Mapping Macros
  The user will notice that the mapping file extract shown above has the entry:
  BP*macro BasePlate
  This is the means by which the user can customise the text string in the SDNF output file, rather than just having a single text for all cases; for example, if the user wants to transfer a set of parameters along with the text. Note: The SDNF limit for the length of the replacement text is 50 characters. Thus, when the interface meets a replacement text which has ‘macro’ as its first word, a macro of the following name is searched for under the %PMLLIB% search path. The macro name must be completely in lowercase and end in .pmlfnc, according to PML conventions. The macro takes no arguments, as there are no means of transferring them in this situation, and it returns the character string to be inserted into the SDNF file. In the above case, the interface will search for a macro file baseplate.pmlfnc. The example base plate macro supplied with the interface is:
  define function !!BasePlate( ) is STRING -- Initialisation !string = STRING( ) !start = ( ref ) -- Some PML to extract the required information goto catr !thick = para numb 1 !nrOfBolts = para numb 2 same !width = desp numb 1 !length = desp numb 2 -- Concatenate information into the string
  7:5
  2.1
  OpenSteel Configuration Guide
  Internal Mapping Files
  !string = |Base Plate $!width[ 1 ] $!length[ 1 ] | + $ |$!thick[ 1 ] $!nrOfBolts[ 1 ]| -- Return string and exit $!start return !string endfunction
  This example may return a single text string such as:
  ‘Base Plate 250 300 25 4’
  which should be sufficient information for the external system to generate an end detail of the correct type and dimensions. It is assumed that the system is at the Design Joint in the database at the point of calling this user macro. Note: In writing the user’s own macro, the user must handle all errors encountered, so that the macro will safely return a valid PML string, whatever it may be. Error and Log File Messages No Connection mapping table for nnnn for project mmmm User macro nnnn not found Error in user macro nnnn No mapping for Connection type nnnn System cannot find a suitable table for the nnnn target and mmmm project. Cannot find user macro. PML programming error in user macro. Cannot translate Connection text.
  7.3
  Steel Standards Mapping Files
  There are two situations for choosing whether a particular steel profile is permitted or not. The situations are Default or Multiple. The default steel standard is that listed as the first entry in the Steel Standard mapping file. This is the preferred standard. If the profiles come from the other listed standards, they are deemed to be acceptable. In this case, a warning message will be output to the log file. Profiles taken from standards which are not in the list are flagged as errors. The Steel Standards mapping files may be project or company specific. The identification convention used in the first line of the file, by which we identify the file, is similar to that mentioned above for other internal mapping files. It is the second entry on the first line which is critical. In this case, it is composed of two parts. The first part is either the three-letter name of the project, e.g. TST, or it is the word ANY signifying that the file is company specific; i.e. for ANY project. The second part, STD, is compulsory. The lines are * separated pairs (with no spaces), only the first value of which is used internally. The second value can be for information, as these files will be listed as comments
  7:6
  2.1
  OpenSteel Configuration Guide
  Internal Mapping Files
  in the exported SDNF file. The first value of each entry must be the three-letter coding for the profile standards, as recorded in the external Profile mapping files and as suggested in the section discussing the format of the Profile mapping files. The sequence of search is for a project-specific mapping file, and then a company-specific file. A project-specific mapping file for the TST project might look like:
  TSTSTD*TSTSTD EUR*Euronorm BRI*British AME*American
  A company-specific file for ANY project might look like:
  ANYSTD*ANYSTD EUR*Euronorm BRI*British AME*American GER*German CAN*Canadian JAP*Japanese
  7:7
  2.1
  OpenSteel Configuration Guide Internal Mapping Files 7:8 2.1 .
  8. as they interfere with the field separation. A description of the individual fields in the Profile Mapping Files is given after this section. Blank lines are also permitted. but not in PDMS names. The four fields are read in the following order. The first field is the PDMS name (with no leading. The check line must be of the form: PDMS TargetPackage For example: PDMS XSteel The target package name must be as it appears in the data list. trailing or embedded spaces). This list is picked up automatically by the Export and Import forms. !!SDNFExtProgList (see External Packages). The third field is the Steel Standard (with no leading. 8:1 2.Is it empty? File specified in the mapping table is not found. space-separated mapping files receive special treatment to allow spaces in external Profile names. 3. Error and Log File Messages Suitable Mapping Table File not found Not a suitable Mapping Table File . once the leading and trailing spaces have been removed. trailing or embedded spaces). the external mapping files are tested to see if they are valid. 1. 2. 4.1 . trailing or embedded spaces).1 Space-Separated Format for Profile Mapping Files Because PDMS names cannot contain spaces. Comments may be included in the mapping files. The header may not be of the correct format. Note: Tab characters are not permitted in the mapping files. The fourth field is the Profile type (with no leading.OpenSteel Configuration Guide External Mapping Files 8 External Mapping Files While setting up the Export or Import variables. The header does not match the target package. At the top of each file is a check line indicating the external package to which the file is related. They are indicated by a hash (#) character as the first non-blank character on the line. The second field is the external profile name.
  8. Any system exporting data will export its own local names without performing any translation process whatsoever. data are to be transferred. The mapping files supplied are modifiable and extensible by the user. 8. This interface. There are two similar mapping files required: one for PDMS and the other for the 3D steel detailing package. therefore. however. 8.4 Record Structure for Profile Mapping File The database file consists of records of PDMS catalogue profile name matched with the external profile name and two other fields giving the origin and profile type as recognised by the external package. the user should be aware how a CSV file handles commas in fields.0 BRI 12 The fields are described below: Field 1 2 Description PDMS catalogue profile name (without leading / ) External catalogue profile name 8:2 2. This can also be a cause for misunderstanding if the SDNF output file is inspected. In CSV format.1 . to which. the fields are separated by commas rather than by spaces.00SHS TUB30030025.OpenSteel Configuration Guide External Mapping Files See External Mapping File Separator for information on how the user can specify which separator which the interface will use to discriminate between fields. or from which. and the user still sees PDMS profile names. A typical record is as follows: 300X300X214. CSV format allows the user to manage the mapping files in a spreadsheet program. checks that there is a valid mapping for a Profile before it is exported. This means. that the names of profiles must not contain commas. and not the names translated for the target package. Important: It is assumed that the package importing the data will perform the mapping to local names. This will allow greater modularity and independence of each software component in the interface. It is the user’s responsibility to ensure that any geometrical modelling required in either system is suitably reproduced in the other.3 Profile Mapping Files This section describes the formats for the mapping files between PDMS catalogues and those of external 3D steel detailing packages. If the user is constructing a CSV file by hand.2 CSV Format for Profile Mapping Files The user can also use Comma Separated Variable (CSV) format for the Profile mapping. The mapping files will indicate a correlation between the catalogue item in PDMS and its equivalent in the other system. but the external profile name can still contain spaces. even though the local PDMS profile name is still exported.
  Profile type.OpenSteel Configuration Guide External Mapping Files Field 3 4 Description Steel standard. 8. For example: PDMS L4X3. which is currently codified as follows: Country America Britain Canada Euronorm Germany Japan Code AME BRI CAN EUR GER JAP If the user wants to include profiles or joints from another standard or country. Therefore. The external package may stop if it finds a profile from a different steel standard. The catalogue names for the external package must be ascertained by the user and matched correctly with the equivalent PDMS name.25 2L4X3. we need to record the origin of the profile. For example.4.5X. 8.25. the user must add a new and unique three-character identifier. only those T shapes which are derived from cutting up I shapes may be stored.L 2L4X3. the Steel Standard field. This is because there may be many occurrences of the same profile name in the 3D steel detailing package.25.4.1 .1 Steel Standard Field Some 3D steel detailing packages cannot mix profiles from more than one steel standard at the same time.S External L40354 L40354 L40354 Origin AME AME AME Type 9 10 11 Description L shape 2L long leg 2L short leg 8:3 2. This could be recorded in the file as follows: PDMS W21X44 WT10.5X.5X.5X22 External W21X44 W21X44 Origin AME AME Type 1 6 Description I shape Tee ex W21X44 Similarly. See below. but used in different manners. This is done in the third field. angles (L shapes) are further classified if they are to be placed back to back by either the long or short leg to form a double-angle profile. See below.2 Profile Type Field The Profile Type field defines exactly what type the profile is.
  square) (RHS.UNP) Angles (L) Double angles with gap (2L) Double angles without gap (2L) Tube (rectangular.OpenSteel Configuration Guide External Mapping Files We have assumed that double angles may have a gap (i. WT) I with cover plate Channels (C. beams) HEM (Columns. 0 or more) corresponding to type 10 below. SHS) Pipe (circular) (CHS) Prismatic Bulb shapes Z shapes HEA (Columns. The profile type codes are as follows: Type Code 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 20 21 22 23 25 26 27 28 29 30 31 32 Profile/Joint Beams (UB. W) Columns (UC. HP) Composite Tee (T.1 . beams) HEB (Columns. There are no genuine type 11 profiles in the supplied data set. but to differentiate between short-leg and long-leg double angles we have used type 10 to identify the long and type 11 the short leg back-to-back double angles.e. beams) IPE INP Flat Steel Round Steel Dummy Sections (ASL) Grating Chequered Plate Treads Anchor Bolts Note 1 Note 1 8:4 2. M) Joists (RSJ) Piles (UBP. MC.
  4x3.6*8 PD406. Note: Also that it is not complete in any way. they must be classified as angles (type 9).5 OD42. along with the catalogue origin and profile type. 8.2 PD42.6*12. they must therefore be modelled as two single sections. PDMS HE280A HE280B HE300A HE300B HE320A HE360B L35x5 L40x20x3 L40x5 L45x30x3 L45x30x4 L45x30x5 L45x4 OD355.2 OD355. Types 10 and 11 are often not available in external 3D steel detailing packages as a single Catalogue entry.4*3.2 OD42. Once the user have found a match between the PDMS catalogue profile name and the equivalent profile in the external detailing package.2 PD355.6x8 OD406.6 Sample Profile Mapping File Below is a short extract of a Profile mapping file between PDMS and XSteel. 8. If Bent Plates are to be treated as angles with regard to mirroring etc. Note: The identification line at the top of the file which indicates the Target Package. the ASCII file may be extended.4x4 OD457x10 XSTEEL HEA280 HEB280 HEA300 HEB300 HEA320 HEB360 L35*5 L40*20*3 L40*5 L45*30*3 L45*30*4 L45*30*5 L45*4 PD355.5 Extend the Profile Mapping File To extend the facilities provided by the system.1 .6x12. In those cases.4*4 PD457*10 EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR 20 21 20 21 20 21 9 9 9 9 9 9 9 13 13 13 13 13 13 8:5 2.OpenSteel Configuration Guide External Mapping Files Type Code 33 34 Note: Profile/Joint Earthing Boss Bent Plates Note 2 1.4*12. 2.5 PD42.4x12.. the name pair may be added to the file.
  5 T45 T50 T60 T70 T80 T90 UNP100 UNP120 UNP140 UNP160 UNP180 UNP200 PD457*14. checks that there is a valid mapping for a Material before it is exported. The profile is in the Profile Mapping File but is not in any one of the set of standards. The existing PDMS material description may not be recognised in the external 3D steel detailing package.7 Material Mapping Files Elements cannot be transferred through the SDNF if they do not have a valid material associated with them. This will allow greater modularity and independence of each component in the interface. The profile is in the Profile Mapping File and is in one of the set of standards.2 OD457x17. This is performed by means of a Material mapping file which relates the PDMS text description of a material to that output to. or found in. Important: It is assumed that the package importing the data will perform the mapping to local names. even though the local PDMS material text is still exported.5 T45 T50 T60 T70 T80 T90 UNP100 UNP120 UNP140 UNP160 UNP180 UNP200 EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR EUR 13 13 6 6 6 6 6 6 8 8 8 8 8 8 Error and Log File Messages Profile cannot be mapped Profile is not in the standard Profile is not the default Multiply defined entries in Profile Table The profile is not in the Profile Mapping File. but not the default standard. There are two similar mapping files required: one for PDMS and the other for the 3D steel detailing package. an SDNF file. 8. however. Either a profile to be mapped or a mapped profile appears more than once in the Profile Mapping File. This can also be a cause for 8:6 2. consequently. This interface.OpenSteel Configuration Guide External Mapping Files OD457x14.1 . there must be a means by which we can translate the material description between systems. The user can modify and extend the mapping file.2 PD457*17. Any system exporting data will export its own local names without performing any translation process whatsoever.
  the SDNF file material description is looked up in the material mapping file and translated into the PDMS equivalent text string.Initialisation !material = STRING( ) !material = |unset| 8:7 2.1 User-Definable Material Macro The user may modify the sample macro. less specific. 8. If the above system is still not specific enough. Error and Log File Messages Multiply defined entries in Material Table No match for material Syntax Error Unrecognised Parse State Either a material to be mapped or a mapped profile appears more than once in the Material Mapping File.OpenSteel Configuration Guide External Mapping Files misunderstanding if the SDNF output file is inspected.1 . A number representing the parse state will also be output. If a SOLI element with this material text is found. See the next section for details. its material is determined by inspecting the :SDNFMGRADE attribute first. An internal list is then built for rapid reference. This is then initially copied into the :SDNFMGRADE attribute of the element before any attempt is made to rationalise the MATR. The text is then transferred locally to the :SDNFMGRADE attribute on the SCTN or PANE element. Materials are usually associated with PDMS elements using the Material Reference attribute. The example macro is as follows: define function !!SDNFGetUserMatl( ) is STRING -. When an element is exported. and the user still sees PDMS material texts. the Properties database is searched for SOLI elements which may define materials used to fabricate elements in the Design. sdnfgetusermatl. the interface will set the MATR to point to the correct SOLI element. which points to a SOLI element in the Properties database. When the OpenSteel interface is started. Other. the user configurable mechanism is invoked. Although the error is non-fatal it should be reported. If it does then it indicates a system error. If that fails.7. The text is then looked up in the Material mapping file to check that there is a translation into the SDNF file replacement text. and not the text translated for the target package. errors. as named by the !!SDNFMaterialMac global variable and given in the pml/userFunctions directory. As with the profile mapping file. However. there is a mechanism by which the user can define from where the material information is to be derived. the first line is an identifier which indicates the external package or system with which the file is associated. then the Description attribute of the SOLI element to which the MATR refers. MATR. The material is not in the Material Mapping File.pmlfnc. Either of these should be set for the interface to be able to export elements successfully. the user may want to use the local :SDNFMGRADE attribute to specify the material. if the user has specific requirements as to where the material information resides. When an element is to be imported. The local material text is still exported. This should not occur.
  a material cannot be identified.Material stored on Catalogue component goto catr handle any -.1 . If. 8:8 2.unset( ) or $ !material.OpenSteel Configuration Guide External Mapping Files !start = ( ref ) -.Some User specific PML to get the required info !type = ( type ) if( !type eq |SCTN| )then -.length( ) eq 0 )then -.Try to return :SDNFMGRADE or default material !material = ( :SDNFMGRADE ) if( !material eq |unset| or $ !material.length( ) eq 0 )then -.Return string and exit label /Finished $!start return !material endfunction The above example assumes that the material information for Sections resides on the catalogue component in the UDA :MATERIAL.Bad or null reference !material = !defaultMaterial golabel /Finished endhandle !material = ( :Material ) handle any !material = !defaultMaterial golabel /Finished endhandle if( !material eq |unset| or $ !material. for any reason. a default value of 'St 37-2' is assigned.Use default material !material = !defaultMaterial endif elseif( !type eq |PANE| )then -.Use default material !material = !defaultMaterial endif endif -.Set default material !defaultMaterial = |St 37-2| -.unset( ) or $ !material.
  Error and Log File Messages User macro nnnn not found Error in user macro nnnn Cannot find user macro. Duralumin". and that the starting point for database navigation is the current DESIGN element under consideration. PDMS.XSTEEL "unset"."Red Brass " "Brass. See User-definable Material Macro regarding the naming of this macro."Chrome Steel" "Steel."LDPHP-GRADE" "Aluminium. by default. a Section or Panel."Aluminum" "GR 420 I"."Wrought Aluminium" "Aluminium."Carbon Steel" "Steel."GR 420 I" "Pyrocrete".2 Sample Material Mapping File Below is a sample comma separated mapping (CSV) file to map between the PDMS materials found in the Properties database and the SDNF file targeted at XSteel."Ni Steel" 8:9 2. i."Yellow Brass " "Brass."TREAD-Aluminum" "ALUMINIUM". See the previous sections for details of how the user can configure the system to use a material macro with a name of the user’s choice. cast"."Fire concrete" "Tread Grade".OpenSteel Configuration Guide External Mapping Files The interface assumes. PML programming error in user macro. Also. Note: In writing the user’s own macro. chrome". the user must handle all errors encountered so that the macro will always safely return a valid PML string."Aluminium. Ni-chrome". cast" "Aluminium."Tread Grade" "LDPHP-GRADE".1 . 8. wrought".e. that materials for Panels must also be determined using this macro."Duralumin" "Brass. cast". carbon"."unset" "TREAD-ALU". red 80% Cu". yellow 65% Cu". whatever it may be. that this file exists under the above name in a directory below the %PMLLIB% search path."Cast Brass" "Steel.7.
  For example. this mapping file should be used. Thus. In all cases an Orientation mapping file should be available.OpenSteel Configuration Guide External Mapping Files 8. or modify the supplied ones. If the user defines their own catalogue profiles. which should be set to 1 if the profile is to be reflected about the Yaxis. the user can see that the channels (type 8) and angles (type 9) from the Euronorm.8 Profile Orientation Mapping Files Using the Profile Orientation Mapping File the user can define how OpenSteel translates a profile from PDMS format into the SDNF Neutral File format on Export. no action is taken. The last field defines how much additional angular rotation the user wants to apply to the shape. If. DIN and British Standard catalogues have been identified for special treatment. The third is the mirroring flag. Refer to the OpenSteel User Guide for details of how the Neutral File understands default orientations of certain profiles. We re-emphasise the difference in the handedness of the coordinate systems. The following figure illustrates the effect of each operation on different catalogue representations of an angle profile. and no error message is output as it is assumed that the user does not want it to receive special treatment. during the Import or Export process. The structure of the rest of the mapping file is of a comma or space separated file with four fields per line. 8:10 2.1 . and need to transform them into or from the SDNF format. In this way the user will avoid confusion in the external package. Below is an example file: PDMS STRUCAD BRI 8 0 180 BRI 9 1 180 DIN 8 0 180 DIN 9 1 180 EUR 8 0 180 EUR 9 1 180 The first line is the file identification line. in the example above. or from it on Import. The first two fields provide the identification of the profile for treatment. This will commonly be the case for angle profiles. Note: Mirroring will change the start and end positions of the linear member. even if it is empty apart from the first line. It is therefore advisable that if the user can achieve the same result purely by rotation. whereas SDNF expects it to be vertical. an entry for a specific profile is not found. No mirroring is indicated by a value of 0 in this field. The second is the actual profile type code according to the codes given in Section Error in Cross Reference. The first of the identification fields states the steel standard from which the profile is to be taken. described as for the Material or Profile mapping files. The rotation angle must be between 180 and +180 degrees. then the latter is the preferred option. some catalogues may define the long leg of an unequal angle to be on the horizontal. The third and fourth fields describe what the user wants to do with the profile shape.
  1 .OpenSteel Configuration Guide External Mapping Files PDMS CATALOGUE DEFINITION Y CATALOGUE DEFINITION Y start X start X end Z end Z IS EQUIVALENT TO Z end IS EQUIVALENT TO start MIRROR Y Z end Z end start start ROTATE 180 ROTATE 180 Y Z end EUR 9 0 180 EUR 9 1 180 start X DEFAULT ORIENTATION SDNF Diagram illustrating the effect of the Mirror and Rotation flags 8:11 2.
  OpenSteel Configuration Guide External Mapping Files 8:12 2.1 .
  The system checks that: • • • • The catalogues include the Pline representation of the SDNF Cardinal Points. and how some of the problems which might be encountered are handled.OpenSteel Configuration Guide Start OpenSteel 9 Start OpenSteel This chapter describes the checks that OpenSteel makes when the user starts up the interface. 9:1 2. • When the user tries to invoke the Import or Export forms without the necessary data loaded the user will be presented with appropriate message forms. There are SOLI elements in the Properties database which may be used for material text. The version of PDMS is supported. There is a default object to store the Configuration information and it is available for modification according to the Import and Export status. The Description attribute is assumed to contain the material text for use in the external Material mapping file and relating MATR and :SDNFMGRADE attributes. if the user answers YES. and a Fatal Error is raised. The UDAs which OpenSteel requires are available. When the user starts the interface. For example: In the above case. certain checks are made to ensure that the SDNF interface will be able to proceed.1 . the interface will automatically install the SITE to store the configuration details without switching modules. The interface will not be able to proceed if the user does not install the configuration details.
  Read the sections on upgrading a project for OpenSteel.1 . the user will be instructed to change modules and to follow the further instructions given. If a command window is open instructions on what to do are listed.OpenSteel Configuration Guide Start OpenSteel In the case of the OpenSteel Plines or UDAs. or 9:2 2.
  A default configuration object is not present.map. at the end of the initialisation process. he OpenSteel interface must have the UDAs installed. Not installing the configuration object is the cause of a fatal error as the system cannot proceed. This is a fatal error. This is a fatal error. Unsupported version of AVEVA PDMS DB containing Config element is not in Modify mode 9:3 2. No SOLI elements in the Properties database. The recursive search of the directory(ies) pointed to by the %PMLLIB% environment variable has failed to discover any internal mapping files named *.OpenSteel Configuration Guide Start OpenSteel Important: If. Must be installed first OpenSteel Configuration details not present No materials found No Map Files of any kind found Steel catalogues are assumed to be identified by the Purpose attribute on the CATA element being set to ‘STL’. This is a fatal error. The system cannot determine which version of PDMS the user is running.1 . This is a fatal error and the interface cannot proceed. OpenSteel Plines not present in Catalogue. This is a fatal error and the interface cannot really proceed. Error and Log File Messages No Steel Catalogues available. the interface still has no mapping files to work with. or the UDAs required are not available. he database containing the specified Configuration element is not modifiable. the user will be informed with a fatal error message. The OpenSteel interface won’t work without them. Must be installed first UDAs for OpenSteel Interface not present.
  1 .OpenSteel Configuration Guide Start OpenSteel 9:4 2.
  Two versions of this file are installed with the product: • • OpenSteel_env_116.1 .1 Windows Setup Script OpenSteel_env. rem Add OpenSteel macros to PML search path set PMLLIB=%OPENSTEELUI%. and sets the TST project variables to the 12 version of the project.bat rem rem This script shows which environment variables are expected by rem the AVEVA OpenSteel Import\Export system. permits install folder names with embedded spaces.bat This section lists the OpenSteel_env. The lines preceded by "rem: >>>>>>" may need to be changed to suit rem your environment.bat is compatible with PDMS 12 series. OpenSteel_env.bat is compatible with PDMS 11. rem echo off echo *** INITIALISING AVEVA OpenSteel ENVIRONMENT *** rem >>>>>> Define OpenSteel main directory set SDNFMAIN=%~df1 rem Locate OpenSteel UI macros set OPENSTEELUI=%SDNFMAIN%\pml.6 series.bat file.bat must be called in the user’s evars.bat file which the user must invoke to set up the environment variables upon which the interface depends.6 version of the project.OpenSteel Configuration Guide Examples of Typical Environment Scripts A Examples of Typical Environment Scripts This appendix lists typical scripts which the user can use as a basis for editing their own versions. The file OpenSteel_env. so that the user can invoke the OpenSteel interface. rem Set other OpenSteel environment variables A:1 2. and sets the TST project variables to the 11. rem rem NOTES: rem rem 1. A.%PMLLIB%. rem OpenSteel_env.
  rem Point to correct set(s) of internal maps set SDNFINTMAPS=%PDMSDFLTS%.1 . TSTMAC=%SDNFMAIN%\test\tstmac. echo *** AVEVA OpenSteel ENVIRONMENT INITIALISED *** If the user wants to change the location of the interface material. A:2 2. rem >>>>>> Project specific default directory set TSTDFLTS=%SDNFMAIN%\test\tstdflts. the only variable to change is %SDNFMAIN%. TSTEXP=%SDNFMAIN%\test\results\export.%PDMSUSER%. However. rem set set set set >>>>>> Set up the PDMS project variables TST000=%SDNFMAIN%\test\tst000.%PDMSDFLTS%. see the section describing the system architecture to understand the significance of the environment variables related to the internal mapping files.OpenSteel Configuration Guide Examples of Typical Environment Scripts set PDMSDFLTS=%OPENSTEELUI%.%TSTDFLTS%. TSTIMP=%SDNFMAIN%\test\results\import.
  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3 special sites . . . . . 6:4 customise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1 Colour Code . . . . . . . . . . . . . . . . . . . . . . . . 6:4 W Waiting Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1 Variable . . . . . . . . . 5:12 P PML Applications integration into . . . . . . . . . . . . . . . . . . . . . . . . . . 5:13 Upgrade a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1 User Defined Attributes installation of . . . . . . . . 6:3 O OpenSteel Index page i 2. . . . . . . . . 6:3 Connected Members . . . . . . . . 5:13 E Environment OpenSteel . . . . 5:12 I Installation on Windows . . . . . . 3:2 T Tolerance Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3 G Glossary . . 4:2 Material Flag Ignore . . . . . . 6:1 how to run . . 2:1 U Uninstall OpenSteel . . . . . . .1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1 F Flexman License Manager . . . . . . . . . . . . 6:4 S System Architecture . . . . . . . . . 7:3 Export Header . . . .OpenSteel Configuration Guide Index C Cardinal Point Plines . . . . . 3:1 M Mapping Files . . . . . . . . .