emdef Utility for Folders and Calendars (deprecated)

The emdef utility makes various modifications to folder and calendar definitions in the Control-M/EM database.

  • For information about using the emdef utility for jobs, see emdef Utility for Jobs (deprecated).

  • The emdef utility is meant for use during a migration from Control-M (on-prem) to Control-M SaaS, to ensure that you can continue to use your existing emdef scripts after the migration. The description of this utility mentions Control-M (on-prem) product components.

  • The emdef utility suite has been deprecated. It is no longer enhanced and support will be discontinued in version 9.0.22. For more information, see emdef Utility Suite Deprecation (on-prem).

  • To begin using the emdef utility, ensure that you have performed the following setup tasks:

    • Install the Control-M Automation API CLI, version 9.0.21.100 or later, as a Node.js package, as described in Installing the Control-M Automation API CLI.

    • Set up a Control-M environment for the CLI, as described in Setting up a Control-M environment for the CLI

    • If you want to use a non-default Control-M environment, ensure that you have a mapping file named user_environment_map.json in the .ctm directory to associate users with the defined environments. The contents of this file are in the following format:

      CopyCopied to clipboard
      {
      <user1_name> : <env1_name>,
      <user2_name> : <env2_name>,
      <user3_name> : <env3_name>
      }

The emdef utility includes the following utilities:

Utility

Description

copydefcal

Creates a new calendar definition in the Control-M/EM database identical to an existing calendar definition.

defcal

Imports a calendar definition into the Control-M/EM database.

deffolder

Imports Folders and SMART folders into the Control-M/EM database

exportdefcal

Exports calendar definitions in the Control-M/EM database to an output file for use as input to other utilities.

exportdeffolder

Exports folders from the Control-M/EM database to a text file.

updatedef

Modifies jobs, folders, and group attributes.

The emdef utility manages Rule-Base Calendars similar to other calendar types. The Rule-Base Calendar parameters are specified in the arguments file.