Installation and Licensing: Difference between revisions

From Met Dynamics
Jump to navigation Jump to search
imported>Scott.Munro
imported>Scott.Munro
Line 17: Line 17:
* Microsoft Windows 10 or later
* Microsoft Windows 10 or later
* Microsoft Office 365 or 2021 version (Excel, 32-bit or 64-bit)
* Microsoft Office 365 or 2021 version (Excel, 32-bit or 64-bit)
* (Optional) {{Name (Text, SysCAD, Build)}}
* (Optional) {{Name (Text, SysCAD, Build)}} or later


Administrator rights are not required to install or use Met Dynamics software.
Administrator rights are not required to install or use Met Dynamics software.
Line 23: Line 23:
=== Step One: Obtain the distribution package ===
=== Step One: Obtain the distribution package ===


Met Dynamics software is distributed as a ''zip'' archive file. The zip archive contains versions of the software for all available interfaces (e.g. Excel 32 and 64 bit, SysCAD 9.3).
The {{Name (Text, Excel, Product Name)}} is distributed as a ''zip'' archive file. The zip archive contains versions of the software and associated example files.


To obtain the latest distribution, please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au]
To obtain the latest distribution, please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au]
The {{Name (Text, SysCAD, Product Name)}} is distributed with the SysCAD application.


=== Step Two: Excel installation ===
=== Step Two: Excel installation ===


Met Dynamics software may be installed for Microsoft Excel by undertaking the following steps:
The {{Name (Text, SysCAD, Product Name)}} may be installed by undertaking the following steps:
# Unzip the contents of ''{{Name (Text, Distribution, File Name)}}'' into ''{{Name (Text, Distribution, Install Folder)}}'' (recommended) or your preferred folder
# Unzip the contents of ''{{Name (Text, Distribution, File Name)}}'' into ''{{Name (Text, Distribution, Install Folder)}}'' (recommended) or your preferred folder
# Start Microsoft Excel
# Start Microsoft Excel
Line 41: Line 43:
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK''
# Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK''
# If the software is not licensed, please proceed to the [[Installation and Licensing#Licensing|Licensing]] section below for instructions on obtaining a license.
 
If the software is not licensed, please proceed to the [[Installation and Licensing#Licensing|Licensing]] section below for instructions on obtaining a license.


=== Step Three: SysCAD installation (optional) ===
=== Step Three: SysCAD installation (optional) ===


To install the {{Name (Text, SysCAD, Product Name)}}, please use Windows Explorer or a command prompt to undertake the following steps:
The {{Name (Text, SysCAD, Product Name)}} is distributed with the SysCAD application and does not require additional installation.
# Copy the ''{{Name (Text, SysCAD, File Name)}}'' file from your Met Dynamics software installation path (e.g. ''{{Name (Text, Distribution, Install Folder)}}'') to the SysCAD ''bin'' folder (e.g. ''C:\SysCAD139\bin'')
 
To confirm if the {{Name (Text, SysCAD, Product Name)}} is licensed and functioning, please follow these steps:
# Start SysCAD and open an existing project that utilises the {{Name (Text, SysCAD, Product Name)}}, or create a new configuration file and project as described in [[Getting Started]]
# Start SysCAD and open an existing project that utilises the {{Name (Text, SysCAD, Product Name)}}, or create a new configuration file and project as described in [[Getting Started]]
# View the ''General Message Log'' in the SysCAD [https://help.syscad.net/Message_Window Message Window] and locate the text section beginning with "{{Name (Text, SysCAD, Product Name)}}..."
# View the ''General Message Log'' in the SysCAD [https://help.syscad.net/Message_Window Message Window] and locate the text beginning with "{{Name (Text, SysCAD, Product Name)}}..."
# Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK'' on the ''About'' tab or ''General Message Log''
# Confirm the ''License status'' text is ''LICENSE_OK'' in the ''General Message Log''.
# If the software is not licensed and the ''License location'' field does not point to a valid license file:
## Open the SysCAD Access window for an existing Met Dynamics unit model, or insert a new model if none are present
## Click on the ''About'' tab
## Click the ''Browse'' button and use the file explorer to select a valid license file
## Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK''
# If the ''General Message Log'' reports "WARNING: SysCAD Runtime license or /rt command line argument required for Met Dynamics 'MD-SysCAD Runtime' license level", then the Met Dynamics software is licensed for runtime use only. Please obtain a [https://help.syscad.net/SysCAD_License_Options#Full_and_Runtime_Licenses runtime license for SysCAD] or start the SysCAD application in [https://help.syscad.net/Command_Line_Options runtime mode]
# If the software is otherwise not licensed, please proceed to the [[Installation and Licensing#Licensing|Licensing]] section below for instructions on obtaining a license.


'''Note''': The {{Name (Text, SysCAD, Product Name)}} is compiled against a specific SysCAD Build version, as noted in the [[Revision History]]. As such, SysCAD projects utilising {{Name (Text, Product Name)}} may cease to load if the SysCAD version is upgraded without the corresponding version of ''{{Name (Text, SysCAD, File Name)}}''.
If the software is not licensed, please proceed to the [[Installation and Licensing#Licensing|Licensing]] section below for instructions on obtaining a license.


== Licensing ==
== Licensing ==
Line 71: Line 68:


=== Obtaining a license ===
=== Obtaining a license ===
The steps below outline the procedure for obtaining a license for Met Dynamics software:
 
# Install Met Dynamics software for Microsoft Excel, as described [[Installation and Licensing#Step One: Excel installation|above]]
==== {{Name (Text, Excel, Product Name)}} ====
 
The steps below outline the procedure for obtaining a license for {{Name (Text, Excel, Product Name)}}:
# Install {{Name (Text, Excel, Product Name)}}, as described [[Installation and Licensing#Step One: Excel installation|above]]
# Start Microsoft Excel
# Start Microsoft Excel
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# Enter the formula ''=mdLicense()'' in any cell and press Enter
Line 85: Line 85:
# Enter the ''=mdLicense()'' function in any cell and confirm the ''License status'' field now reports ''LICENSE_OK''
# Enter the ''=mdLicense()'' function in any cell and confirm the ''License status'' field now reports ''LICENSE_OK''


Alternatively, the ''Site code'' character string may be obtained from the SysCAD application ''General Message Log'' or unit model Access window ''About'' tab, as described in the [[Installation and Licensing#Step Two (Optional): SysCAD installation|SysCAD installation]] section above.
==== {{Name (Text, SysCAD, Product Name)}} ====
 
Licenses for the {{Name (Text, SysCAD, Product Name)}} can be obtained from the SysCAD vendor:
* Please note that additional SysCAD Add-Ons (e.g. Size Distribution, Integrated Libraries) may be required to use the {{Name (Text, SysCAD, Product Name)}}.
* For more information or to obtain licenses, please contact the SysCAD vendor at [http://mailto:info@syscad.net info@syscad.net].
 
If the ''General Message Log'' in the SysCAD [https://help.syscad.net/Message_Window Message Window] reports "WARNING: SysCAD Runtime license or /rt command line argument required for Met Dynamics 'MD-SysCAD Runtime' license level", then the Met Dynamics software is licensed for runtime use only. Please obtain a [https://help.syscad.net/SysCAD_License_Options#Full_and_Runtime_Licenses runtime license for SysCAD] or start the SysCAD application in [https://help.syscad.net/Command_Line_Options runtime mode].
<!--
The steps below outline the procedure for obtaining a license for {{Name (Text, SysCAD, Product Name)}} from Met Dynamics:
# Start SysCAD and open an existing project that utilises the {{Name (Text, SysCAD, Product Name)}}, or create a new configuration file and project as described in [[Getting Started]]
# View the ''General Message Log'' in the SysCAD [https://help.syscad.net/Message_Window Message Window] and locate the text beginning with "{{Name (Text, SysCAD, Product Name)}}..."
# ''Copy'' the string of characters displayed next to the ''Site Code'' text to the Windows clipboard
# ''Paste'' the Site Code character string into the body of a new email message
# Include your contact details and a message requesting a license issue in the email
# Send the email to the Met Dynamics Accounts team at [mailto:accounts@metdynamics.com.au accounts@metdynamics.com.au]
# After the license request has been received, Met Dynamics will generate a license file and return it to the sender's email address
# Place a copy of the returned license file (e.g. ''{{Name (Text, Company Name)|nospace=1}}.lic'') in a suitable path, e.g. ''{{Name (Text, Distribution, Install Folder)}}'' if {{Name (Text, Excel, Product Name)}} is also installed.
# Open the SysCAD Access window for an existing Met Dynamics unit model, or insert a new model if none are present
# Click on the ''About'' tab
# Click the ''Browse'' button and use the file browser dialog to select the valid license file which was added to the path above
# Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK''
-->


=== Trial license ===
=== Trial license ===


A Trial License for Met Dynamics software is available upon request:
A Trial License for Met Dynamics software is available upon request:
* A 30 day trial period is typically offered
* A time-limited trial period is typically offered
* Trial licenses are not locked to client PC hardware identifiers, and software functionality is not in any way restricted during the trial period
* Trial licenses are not locked to client PC hardware identifiers, and software functionality is not in any way restricted during the trial period
* The software will cease to function after the expiration of the trial period
* The software will cease to function after the expiration of the trial period
Line 116: Line 137:
# Click on ''{{Name (Text, Excel, File Name)}}'' or ''{{Name (Text, Excel, File Name, 32)}}'' and select ''OK'' when prompted to "Delete from list"
# Click on ''{{Name (Text, Excel, File Name)}}'' or ''{{Name (Text, Excel, File Name, 32)}}'' and select ''OK'' when prompted to "Delete from list"
# Close Microsoft Excel
# Close Microsoft Excel
=== SysCAD uninstallation ===
While the SysCAD application is closed:
# Delete the ''{{Name (Text, SysCAD, File Name)}}'' file from the SysCAD ''bin'' folder (e.g. ''C:\SysCAD139\bin'')
'''Note''': SysCAD projects that include models from the {{Name (Text, SysCAD, Product Name)}} will no longer load if the ''{{Name (Text, SysCAD, File Name)}}'' file is removed.


== Further support ==
== Further support ==


If any step of the installation or licensing procedures fails, please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au] for assistance.
If any step of the installation or licensing procedures fails, please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au] for assistance.

Revision as of 08:53, 29 May 2024

Introduction

This article describes the procedures for installing and licensing Met Dynamics software on client PCs.

Installation

Figure 1. Steps to enable the Met Dynamics Models Microsoft Excel Add-In.

Met Dynamics software may be installed by following the procedures provided in this section:

  • Manual installation steps are provided in lieu of an installer program, which may be restricted in some security environments.
  • Some basic knowledge of file manipulation in Microsoft Windows is required to complete the installation.

System requirements

The following hardware, operating system and software installations (and licenses) are required in order to use Met Dynamics software:

  • An Intel or AMD CPU with SSE2 support
  • Microsoft Windows 10 or later
  • Microsoft Office 365 or 2021 version (Excel, 32-bit or 64-bit)
  • (Optional) SysCAD 9.3 Build 139.35544 or later

Administrator rights are not required to install or use Met Dynamics software.

Step One: Obtain the distribution package

The Met Dynamics Models Microsoft Excel Add-In is distributed as a zip archive file. The zip archive contains versions of the software and associated example files.

To obtain the latest distribution, please contact support@metdynamics.com.au

The Met Dynamics Models SysCAD Add-On is distributed with the SysCAD application.

Step Two: Excel installation

The Met Dynamics Models SysCAD Add-On may be installed by undertaking the following steps:

  1. Unzip the contents of Met Dynamics.zip into C:\Met Dynamics (recommended) or your preferred folder
  2. Start Microsoft Excel
  3. Identify your Excel installation architecture (32 or 64 bit), File…Account…About Excel
  4. Select File...Options...Add-Ins (see Figure 1)
  5. Ensure Manage is set to Excel Add-Ins and click Go
  6. Select Browse and navigate to your installation path (e.g. C:\Met Dynamics)
  7. For 64 bit versions of Excel (default Office install), select the file MetDynamics.xll and choose Ok
  8. For 32 bit versions of Excel, select the file MetDynamics32.xll and choose Ok
  9. Return to the Excel worksheet window
  10. Enter the formula =mdLicense() in any cell and press Enter
  11. Confirm the software license information is displayed and the License status field is LICENSE_OK

If the software is not licensed, please proceed to the Licensing section below for instructions on obtaining a license.

Step Three: SysCAD installation (optional)

The Met Dynamics Models SysCAD Add-On is distributed with the SysCAD application and does not require additional installation.

To confirm if the Met Dynamics Models SysCAD Add-On is licensed and functioning, please follow these steps:

  1. Start SysCAD and open an existing project that utilises the Met Dynamics Models SysCAD Add-On, or create a new configuration file and project as described in Getting Started
  2. View the General Message Log in the SysCAD Message Window and locate the text beginning with "Met Dynamics Models SysCAD Add-On..."
  3. Confirm the License status text is LICENSE_OK in the General Message Log.

If the software is not licensed, please proceed to the Licensing section below for instructions on obtaining a license.

Licensing

Figure 2. Example Met Dynamics Models license information shown in Microsoft Excel.
Figure 3. Example Met Dynamics Models license information shown in SysCAD.

Licenses to use Met Dynamics software are provided on a 'per seat' basis.

A granted license is locked to the unique hardware identifier of an individual client PC.

Obtaining a license

Met Dynamics Models Microsoft Excel Add-In

The steps below outline the procedure for obtaining a license for Met Dynamics Models Microsoft Excel Add-In:

  1. Install Met Dynamics Models Microsoft Excel Add-In, as described above
  2. Start Microsoft Excel
  3. Enter the formula =mdLicense() in any cell and press Enter
  4. Copy the string of characters displayed next to the Site Code field to the Windows clipboard
  5. Close Microsoft Excel
  6. Paste the Site Code character string into the body of a new email message
  7. Include your contact details and a message requesting a license issue in the email
  8. Send the email to the Met Dynamics Accounts team at accounts@metdynamics.com.au
  9. After the license request has been received, Met Dynamics will generate a license file and return it to the sender's email address
  10. Place a copy of the returned license file (e.g. MetDynamics.lic) in the Met Dynamics Models installation path (e.g. C:\Met Dynamics)
  11. Start Microsoft Excel
  12. Enter the =mdLicense() function in any cell and confirm the License status field now reports LICENSE_OK

Met Dynamics Models SysCAD Add-On

Licenses for the Met Dynamics Models SysCAD Add-On can be obtained from the SysCAD vendor:

  • Please note that additional SysCAD Add-Ons (e.g. Size Distribution, Integrated Libraries) may be required to use the Met Dynamics Models SysCAD Add-On.
  • For more information or to obtain licenses, please contact the SysCAD vendor at info@syscad.net.

If the General Message Log in the SysCAD Message Window reports "WARNING: SysCAD Runtime license or /rt command line argument required for Met Dynamics 'MD-SysCAD Runtime' license level", then the Met Dynamics software is licensed for runtime use only. Please obtain a runtime license for SysCAD or start the SysCAD application in runtime mode.

Trial license

A Trial License for Met Dynamics software is available upon request:

  • A time-limited trial period is typically offered
  • Trial licenses are not locked to client PC hardware identifiers, and software functionality is not in any way restricted during the trial period
  • The software will cease to function after the expiration of the trial period

Please contact support@metdynamics.com.au to request a trial license.

Expired licenses

Expired client or trial licenses limit software functionality in the following ways:

  • Excel functions cease to operate and return the #License error message in place of results
  • SysCAD projects will continue to load and unit models may be inspected. However, the project will not Solve/Run if the On field of any Met Dynamics unit model in the project is checked.

Uninstallation

Met Dynamics software may be removed from your system by following the instructions below.

Excel uninstallation

  1. Start Microsoft Excel
  2. Select File...Options...Add-Ins
  3. Ensure Manage is set to Excel Add-Ins and click Go
  4. Unselect the MetDynamics.xll or MetDynamics32.xll checkbox and choose OK
  5. Close Microsoft Excel
  6. Delete the installation folder, e.g. C:\Met Dynamics, and all contents
  7. Return to Excel Add-Ins via steps 1 - 3
  8. Click on MetDynamics.xll or MetDynamics32.xll and select OK when prompted to "Delete from list"
  9. Close Microsoft Excel

Further support

If any step of the installation or licensing procedures fails, please contact support@metdynamics.com.au for assistance.

Retrieved from "https://wiki.metdynamics.com.au/index.php?title=Installation_and_Licensing&oldid=2046"