Home
Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
Reference Guide
API
new_DocumentMetadata
Create a new metadata value.

Welcome
What's New
View new features for Altair HyperWorks 2024.
Get Started
Learn the basics and discover the workspace.
Tutorials
Learn more about the Altair HyperWorks suite of products with interactive tutorials.
Startup Procedures and Customizations
Start and configure the applications.
Tool Finder
View a list of deprecated panels and their newer, equivalent workflows.
Manage Files and Data
Create, open, import, and save models.
Sessions and Report Templates
Set up sessions and create report templates.
Interface with External Products
Solver interfaces supported in HyperMesh.
Entities and Solver Interfaces
A solver interface is made up of a template and a FE-input reader.
Browsers
Browsers provide a structured view of model data, which you can use to review, modify, create, and manage the contents of a model. In addition to visualization, browsers offer features like search, filtering, and sorting, which enhance your ability to navigate and interact with the model data.
Sketching
Create and edit 2D parametric sketch geometry.
Topology
Create, edit, and cleanup geometry.
FE Geometry
FE geometry is topology on top of mesh, meaning CAD and mesh exist as a single entity. The purpose of FE geometry is to add vertices, edges, surfaces, and solids on FE models which have no CAD geometry.
Meshing and Elements
Explore the different types of mesh you can create in HyperMesh and create and edit 0D, 1D, 2D, and 3D elements.
Model Build and Assembly
Create, organize and manage parts and subsystems.
Composites
HyperMesh composites modeling.
Connectors
Create connections between parts of your model.
Morph
Rapidly change the shape of the FE mesh without severely sacrificing the mesh quality.
Skeleton Modeling
Create a reduced ordered model to facilitate optimization at the concept phase.
Design Space
Workflow to support topology optimization model build and setup.
Optimization
Setup an Optimization in HyperMesh.
Design Explorer
Multi-disciplinary design exploration and optimization tools.
Validate
Validate the model built before running solver analysis.
Analyze
Models require loads and boundary conditions in order to represent the various physics and/or physical equivalents to bench and in-use testing.
Axisymmetry
Reduce a full 3D model with axisymmetric surfaces while accounting for imperfections.
Concept Modeling
Tools and workflows that are dedicated to rapidly creating new parts for specific use cases, or amending existing parts. The current capabilities are focused on stiffening parts.
Crash and Safety
Tools used for crash and safety analysis.
Airbag
Use airbag folder utilities and export a resulting airbag in a Radioss deck.
Aerospace
Essential utility tools developed using HyperMesh-Tcl.
Aeroelasticity
Import an aeroelastic finite element model with Nastran Bulk Data format.
Certification
Framework to plug certification methods to assess margin of safety from the model and result information.
PhysicsAI
Use PhysicsAI to build fast predictive models from CAE data. PhysicsAI can be trained on data with any physics or remeshing and without design variables.
Results Data
Results data can be post-processed using both HyperMesh and HyperView.
Developer
The Developer ribbon contains tools for automation and customization.
Plot Data
HyperGraph is a data analysis and plotting tool with interfaces to many file formats.
Multibody Modeling
MotionView is a general pre-processor for Multibody Dynamics.
Media Files
MediaView plays video files, displays static images, tracks objects, and measures distances.
Tabulate Results
Use TableView to create an Excel-like spreadsheet.
Text Files
TextView math scripts reference vector data from HyperGraph windows to automate data processing and data summary.
Publishing and Reporting
Create, define, and export reports.
Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
- Terminology
  Common terminology used with the collaboration features is described in this section.
- Contents and Content Definition
  Content refers to any information stored in a library. Content Definitions encapsulate information about the types of information managed by the HyperMesh libraries.
- Open the Organize Browser
  Use the Organize browser to organize your data.
- Open the Explore Dialog
  The Explore dialog provides enhanced capabilities for searching for and retrieving data, beyond what is provided from typical file browse dialogs.
- Add Subscribed Parts
  Use the Subscribe dialog to register or subscribe to parts or items of interest that reside within a corporate PDM system. Once the parts have been subscribed to, the dialog helps to ensure that you are working with the latest information by allowing you to quickly check whether any subscribed to parts have been updated, and to seamlessly retrieve updated information and files for those that have.
- Add MotionView Models into the Library
  MotionView supports a limited version of interface with Collaboration Tools.
- Material Library
  Collaboration Tools comes with an out-of-the-box profile, which is tailored specifically for organizing and managing material information and data.
- Reference Guide
  - Back Up and Restore a Personal Database
  - Team Database
    This setup is recommended when a team of less than ten members wants to access and create information or data in a shared library. Larger groups of users are not supported in the team environment and should consider a full enterprise deployment.
  - Create a Team Library
  - Add a Team Library
    You can connect to a team library that was already created by your system administrator or team administrator.
  - Profiles
    Profiles are a way to register non core content types and any customization needed for the library.
  - Parsers
    The parsers folder should contain a pkgIndex.tcl with the package name and the list of .tcl files used to extract the metadata from the content.
  - Customize the Organize Browser
    Customize the toolbar and context menu in the Organize browser.
  - API
    - Condition_CreateCondition
      Create a condition to be queried using ExecQuery API.
    - ContentInterface_GetType
      Get content definition type.
    - ContentInterfaceList
      Create an empty content interface list.
    - ContentInterfaceList_at
      Get handle on content interface at index value.
    - ContentInterfaceList_size
      Get size of the returned query.
    - ContentInterface_AddReference
      Add a reference to a selected content.
    - ContentInterface_DisplayName
      Get the display name of content.
    - ContentInterface_GetCategories
      Get handle on the list of categories the selected content belongs to.
    - ContentInterface_GetDefinition
      Get content definition handle for the content.
    - ContentInterface_GetDocuments
      Get all of the associated documents.
    - ContentInterface_GetMetadata
      Get metadata value of content.
    - ContentInterface_GetMetadataDefinition
      Get handle on metadata definition for a specified content.
    - ContentInterface_GetRevision
      Get the latest revision of the selected content.
    - ContentInterface_IsCheckedOut
      Check if the content is checked out.
    - ContentInterface_IsRetrieved
      Check if the content is retrieved to a workspace.
    - ContentInterface_SetDisplayName
      Set the display name of a content.
    - ContentInterface_SetMetadata
      Set a metadata value of content.
    - CreateDefaultSettings
      Point to default setting for parsers, indexer and other necessary settings.
    - DMDirector_AddFolderAndFiles
      Add folders and files to a specified library and folder paths in the library.
    - DMDirector_GetLibraries
      Get a handle on the repositories for the requested DM Director for a specific username.
    - DMDirector_GetWorkSpaces
      Get a handle on the workspaces for a specific username.
    - DMDirector_OpenWorkspace
      Open a workspace for the library specified in the library handle.
    - DocumentMetadata_getName
      Get the name of the metadata for a document being parsed.
    - DocumentMetadata_getValue
      Get the value of the metadata for a document being parsed.
    - ExecQuery
      Query the library manager for content based full text search.
    - Get
      Gets the file associated with the content.
    - GetQuery
      Gets handle on the Query object.
    - hwLMStatus_GetMessage
      Get an error or success message.
    - hwLMStatus_GetStatus
      Get status code.
    - hwStringList
      String list pointer.
    - iQuery_AddCondition
      Add a condition to be queried using ExecQuery API.
    - LibraryList
      Handle on library list.
    - LibraryList_at
      Get a handle on the library at specified index.
    - LibraryList_size
      Returns library list size.
    - LibraryManager_CheckIn
      Check in the file associated with the content.
    - LibraryManager_CheckOut
      Gets the file associated with the content.
    - LibraryManager_UndoCheckOut
      Marks the content as not checked out.
    - LibraryManager_UndoGet
      The content will be updated to a not retrieved state.
    - Library_GetLDBFile
      Get the LDB file path and name.
    - Library_GetName
      Get the library name.
    - Library_GetType
      Get the type of library.
    - Library_isDefault
      Check if the repository is the default library.
    - new_DMDirector
      Gets handle on Data Manager Director.
    - new_DocumentMetadata
      Create a new metadata value.
    - new_WorkSpace
      Creates a new workspace handle at the specified path under the specified username.
    - ParsedDocument_addMetadata
      Placeholder for a metadata that is parsed from a document.
    - ParsedDocument_getAllMetadata
      Get all of the metadata of the document being parsed.
    - ParsedDocument_getType
      Get the type of document.
    - ParsedDocument_setType
      Set the type of document for a parsed document.
    - WorkSpaceList
      Get handle on the workspace list.
    - WorkSpaceList_at
      Get a handle on the library at a specified index.
    - WorkSpaceList_size
      Returns workspace list size.
    - WorkSpace_GetName
      Get the name of the workspace.
    - WorkSpace_GetUserName
      Get the username for the workspace.
    - WorkSpace_GetWorkingDir
      Get the path for the workspace.

new_DocumentMetadata

Create a new metadata value.

Syntax

new_DocumentMetadata <metadata name> <is query able flag> <value in hwstring>

Type/Class

ParsedDocument

Description

Create a new metadata value. Returns new metadata handle, which can be used to add metadata to content.

metadata name

Metadata name in the content definition .xml file.

is query able flag

Flag to set if this metadata can be queried

0: Cannot be queried
1: Can be queried

value in hwstring

metadata value in hwstring form

Examples

set metaval "fileType"
set val "H3D"
set v1 [hwVariant]
$v1 SetString $val
set dm [new_DocumentMetadata $metaval 1 $v1]