HyperWorks Desktop

Home
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
Automate Tool
Automate is an advanced flow-based utility for authoring processes.
Use the Application Programming Interface
The Automate API's let you call the most frequently used functionality in the software.
::hw::automate::StartExecution
Executes the current process.

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2020.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Learn how to create, open, import and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes with the Parameters Browser.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
- Process Manager
  Use the Process Manager to rapidly develop and deploy process automation applications for standard product engineering practices within the HyperWorks environment using the Process Manager.
- Automate Tool
  Automate is an advanced flow-based utility for authoring processes.
  - Supported File Formats and Operating Systems
    File formats and extensions associated with a process, and supported operating systems.
  - Prerequisites
    User and software prerequisites.
  - Terms and Definitions
    Terms and definitions associated with Automate.
  - User Interface
    Overview of the Automate tool user interface.
  - Basic Tasks and Processes
    Learn how to run a math task, create a process with math tasks and load a task.
  - Create Tasks and Processes
    Learn how the Task Builder helps you to create new tasks, data types, and processes, and save them inside of catalogs that are easily accessible from the Task and Process browsers.
  - Examine and Debug a Process
    The Example Process tool lets you set breakpoints in your process and step through the execution of individual tasks.
  - Save and Retrieve a Session
    During an Automate session, you can save your work in progress, and at any given time reload the session and resume working from the exact point where you left off.
  - Create a Batch Mode Package for a Process
    Use the Batch Mode function to create a process and share it as a package.
  - Use the Application Programming Interface
    The Automate API's let you call the most frequently used functionality in the software.
    - ::hw::automate::InvokeAutomate
      Invokes Automate.
    - ::hw::automate::NewProcess
      Creates a new empty process. Does not take any arguments. Equivalent to the New Process option in Automate.
    - ::hw::automate::LoadTaskFile
      Creates a new instance of the task specified by .tsk file filename at the location x position, xpos, and y position, ypos, on the current Process Modeling window. Equivalent to the New Task from File option.
    - ::hw::automate::LoadSuperblock
      Creates a new instance of the super block specified by .prs file filename at the location x position, xpos, and y position, ypos, in the current Process Modeling window. Equivalent to the Import Process as Superblock option.
    - ::hw::automate::LoadProcess
      Creates a Process Modeling window and opens the process specified by filename. Equivalent to the Open Process option.
    - ::hw::automate::CloseProcess
      Closes the process.
    - ::hw::automate::GroupTasks
      Groups tasks with the IDs specified in the arguments into a super task.
    - ::hw::automate::ConnectBlocks
      Makes a connection between Taskid1 portlabel1 with Taskid2 portlabel2 if they are compatible.
    - ::hw::automate::StartExecution
      Executes the current process.
    - ::hw::automate::RegisterTask
      Registers the task file with Automate. The task name can later be used with ::hw::automate::LoadTask.
    - ::hw::automate::LoadTask
      Creates a new instance of the task specified by the specname at the location x position, xpos, and y position, ypos, on the current Process Modeling window. Equivalent to dragging and dropping a task from the Palette.
    - ::hw::automate::RegisterCatalog
      Registers the custom catalog file specified by catalogfile with Automate.
    - ::hw::automate::SaveProcess
      Saves the current process into the file processfile. Similar to the Save Process Locally button in the Automate GUI.
    - ::hw::automate::SaveProcessInstance
      Save the current process instance into the file.
    - ::hw::automate::LoadProcessInstance
      Loads the process instance in the current session.
    - ::hw::automate::GetHelp
      Opens the help string of the task or process.
HyperWorks 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.
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.

View All Altair HyperWorks Help

HyperWorks Desktop

Home
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
Automate Tool
Automate is an advanced flow-based utility for authoring processes.
Use the Application Programming Interface
The Automate API's let you call the most frequently used functionality in the software.
::hw::automate::StartExecution
Executes the current process.

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

::hw::automate::StartExecution

Executes the current process.

Syntax

::hw::automate::StartExecution

Arguments

N/A

Returns

Error if unsuccessful.

Example

::hw::automate::StartExecution

(c) 2020. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support