Journaling

A journal is a record of all operations that have modified data during your session. Based on your Preferences setting, a journal of your full session will automatically be saved to the location you specify (see Setting Journaling Preferences). You can also choose to record part of a session to a journal file, capturing a specific set of actions. Playing back the journal will recreate the recorded actions exactly. Journaling and scripting tools (including recording and playback) are available through the File > Scripting menu and can be performed by anyone using ANSYS Workbench.

Setting Journaling Preferences

You can set journaling preferences such as the default directory where journals will be written and how long to keep a journal file.

  1. In ANSYS Workbench, select Tools > Options > Journals and Logs.

  2. Select Record Journal Files to have ANSYS Workbench automatically write journal files.

  3. Specify the default location where journal files will be written. This is the location that the browser will open in automatically when you choose to begin recording a journal. You will still be able to browse to a different location before saving a particular journal.

  4. Specify the number of days to keep a journal file.

  5. Specify how long (in seconds) to pause between each command when running a journal file.

  6. Click OK to save your settings.

Recording and Playing a Journal

Follow the steps described below to record a journal and then to playback a journal interactively. To use the command window, see Using the Command Window.

Recording a Journal

  1. Launch ANSYS Workbench.

  2. Select File > Scripting > Record Journal.

  3. Specify the name and location of the journal file and click Save.

  4. Use the GUI to work through your analysis as you normally would.

  5. Select File > Scripting > Stop Recording Journal.

  6. A message appears informing you that you will stop recording. Click OK.


Note:  Not all actions are journaled—only actions that change project data. Some examples of actions that are not journaled include:

  • Interface-only actions, such as:

    Interrupting a Solve operation
    Running in Compact mode
    Launching help (including quick help and the Sidebar Help view)
    Running the View Solver Output option from VistaTF's Solution cell.
  • Actions taken in some data-integrated applications; see Scripting and Data-Integrated Applications.


Playing Back a Recorded Journal

  1. Select File > Scripting > Run Script File.

  2. Select the journal file to be played back and click Open.

  3. The previously recorded actions will occur.

Using the Command Window

The command window allows you to invoke commands, access data entity properties, and invoke data entity and data container methods interactively, one at a time.

  1. Select File > Scripting > Open Command Window.

  2. Enter the commands you want to run, one at a time.

  3. As you enter each command, the appropriate action will occur in ANSYS Workbench.

The Console Window The console window is the same as the command window but is present when running in batch mode to provide a way of working directly with commands outside of the user interface.


Release 18.2 - © ANSYS, Inc. All rights reserved.