11.6. Recording Journal Scripts

EKM provides you with a way to dynamically record a sequence of actions that you invoke from the user interface in a journal script (also referred to as “journal” or “journal file”) using a scripting action. To do this, you need to start the recording process, perform a set of actions in the user interface and then stop recording. A journal Python script with extension .jou.py will be written to your My Data folder (or other EKM location you designate) along with an associated _files folder which is used as temporary storage for the script. An example of a journal script is presented in Example of Journal Recording and Execution.

Once the journal is created, you can execute it by clicking on the file, or right-clicking on it and selecting Execute from the action menu. You can also choose to embed the script in a process template, lifecycle, or custom type definition, use it to define a custom application or custom user interface, or execute it on demand using the Run Journal File action from the Scripting menu.


Important:  Not all actions can be recorded in a journal script in Release 18.2. Support for journaling is currently available for the following actions:

  • Change Files Type

  • Copy Report Action in a Simulation Details Report view for a CAE file (Copy Report Object)

  • Configure > Accept Workspace Configuration

  • Configure > Apply Workspace Configuration

  • Configure > Begin Workspace Configuration

  • Configure > Revert Workspace Configuration

  • Delete Object

  • Delete Multiple Objects (multiple objects selected)

  • Edit > Alerts

  • Edit > Copy/Paste (Copy Object)

  • Edit > Created By Property (Change Creator)

  • Edit > Custom Application (for Application objects)

  • Edit > Cut/Paste (Move Object)

  • Edit > EKM Server (for EKM Server objects)

  • Edit > Get Exclusive Control (Lock)

  • Edit > Group Membership (for Group objects)

  • Edit > Permissions (Change Permissions)

  • Edit > Profile (for User objects)

  • Edit > Properties

  • Edit > Release Exclusive Control (Unlock)

  • Edit > Remote Item (for File or Remote Folder objects)

  • Edit > Rename (Rename Object)

  • Edit > Shortcut (Edit Link)

  • Edit > Type (Change Container Type for a Container object)

  • Edit > Type (Change Type)

  • Edit > Type (multiple objects of same type selected: Change Multiple Types)

  • Edit > Versioning > Add To Version Control

  • Edit > Versioning > Checkin

  • Edit > Versioning > Checkout

  • Edit > Versioning > Create Branch

  • Edit > Versioning > Get Copy Of Version

  • Edit > Versioning > Remove From Version Control

  • Edit > Versioning > Undo Checkout

  • Execute Batch

  • More > Create Shortcut

  • More > Export Workspace

  • New Connection to File/Folder on Remote Server

  • New > (Child Type) (Add Catalog Content for a Catalog object)

  • New > Custom Application

  • New > EKM Server

  • New > Folder (Add Container for a Container object)

  • New > Group

  • New > Object (Add Object for a Container object)

  • New > Shortcut

  • New > User

  • Profile

  • Remote Folder > synchronize

  • Saved query > execute

  • Settings > Alerts

  • Settings > Preferences

  • Synchronize (for Remote Folder objects)



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