Workspaces

A Workspace is an area in the Planning domain where you can create a workflowClosedA flow of jobs that execute at specific times, in a specific sequence, and with available resources that contains all your folders, sub-folders, and jobs. You can create a blank Workspace and add new folders, and jobs, as described in Creating a Workspace, or use existing jobs from the Control-M/EMdatabase to create a new Workspace, as described in Creating a Workspace from Existing Jobs.

The following procedures describe how to manage your Workspace:

Creating a Workspace

This procedure describes how to create a Workspace, which enables you to create and define folders, sub-folders, and jobs.

Begin

  1. From the Home tab, click and select Add workspace.

    The Create New Workspace pane appears.

  2. Define the Workspace parameters, as described in Workspace Parameters.

  3. Click Create.

  4. Create a folder, sub-folder or job, as follows:

  5. Click Save.

    A Workspace is created.

Workspace Parameters

The following table describes the Workspace parameters that you must complete when Creating a Workspace:

Parameter

Description

Name

Defines the name of the Workspace.

Description

Provides a free text description of the Workspace.

Change ID

Defines the Change ID that is associated to the Workspace.

This field might appear as non-editable. If you use integration with a change management system, the Change ID might be automatically created upon submission of the request, as described in WCM Integration with a Change Management System.

E-mail Notification Address

Defines the email address where notifications are sent.

If you have set your email address in User preferences, it appears by default.

Site Standard

Determines which Site StandardClosedA set of rules that are relevant to your organization and applied on the folder level, and that determines how users must define folders and jobs you apply to your folder when you create a Workspace, as described in Site Standards.

If Site Standard enforcement is enabled (see Defining System Settings), you must assign a default Site Standard.

If the Site Standard that you select includes Business Parameters, fields for each Business Parameter appear. For more information, see Adding a Business Parameter to a Site Standard.

Server

Determines which Control-M/Server runs the jobs.

Folder Type

Determines whether the folder type is one of the following:

  • Regular folder: Enables you to collect and group jobs together. Jobs in a Regular folder are processed independently of each other and according to the processing parameters defined. Definitions scheduled on the folder are not inherited by the sub-folder or jobs within the folder.

  • SMART folder: (Default) Enables you to schedule criteria at folder level, which is then inherited by the jobs and sub-folders within the SMART folder. You can also define prerequisites and actions on a SMART folder. Scheduling criteria on the folder enables a single folder to represent all the jobs within the folder.

If you pre-define a folder type in a Site Standard, no other folder type options are available in the Workspace parameters.

Workspace Statuses

The following table describes the possible Workspace statuses that appear in the Status column of the Home tab:

Status

Description

User Works

Indicates that the user is editing the Workspace.

Submitted

Indicates that the request is submitted to the Control-M Scheduler to handle.

The request is in read-only mode and cannot be modified until the Control-M Scheduler responds.

Scheduler Works

Indicates that the Control-M Scheduler is editing the job definitions in the Workspace.

If the Control-M Scheduler is working on the Workspace, the Workspace is in read-only mode. The user cannot modify the Workspace.

Returned

Indicates that the Workspace is returned to the user by the Control-M Scheduler. This can happen if the Control-M Scheduler is requesting more information or modifications to the Workspace.

Approved

Indicates that the Control-M Scheduler does not require any further modifications in the Workspace and has approved the Workspace. The Workspace is now part of Control-M definitions.

The Workspace is in read-only mode and cannot be modified.

Checked In

Indicates that the Workspace is checked in successfully.

If Control-M is integrated with a change management system, some actions might require approval depending on the rules you have defined. If an action is not approved by the change management system you cannot continue with these actions, as described in WCM Integration with a Change Management System.

 

Creating a Workspace from Existing Jobs

This procedure describes how to load and modify existing folders, sub-folders, and jobs in a new Workspace.

Begin

  1. From the Home tab, click Folders and Jobs.

  2. Do one or more of the following:

  3. Select the jobs you want to load and click Open.

    The Workspace opens in read-only mode.

  4. Select one of the following options:

    • Modify: Enables you to modify folder and job definitions in this Workspace.

    • Duplicate: Enables you to duplicate this Workspace.

  5. Click Save.

  6. From the Workspace toolbar, click Check In.

    A confirmation message appears. The Workspace is now deleted.

  7. Click Yes.

    The jobs are uploaded to the Control-M/EMdatabase and the Workspace appears in the Home tab with a status of Checked in.

Exporting a Workspace

This procedure describes how to export a saved Workspace to an XML or a JSON file, which enables you to export job and folder definitions and later import them to the same or another environment, as described in Importing a Workspace.

You cannot export duplicate job names.

Begin

  1. From the Workspace toolbar, click Export.

    A drop-down list appears.

  2. From the drop-down list, select JSON or XML <Control-M/EM version>.

    The XML or JSON file is downloaded.

Importing a Workspace

This procedure describes how to import a Workspace from an XML or a JSON file, which enables you to import job and folder definitions into your current environment.

Only XML files exported in the same version as your target Control-M/EM environment are supported.

Begin

  1. From the Home tab, click and select Import from File....

  2. Select the file you want to load and click Open.

    The job definitions are loaded into a new Workspace in read-only mode.

  3. Select one of the following options:

    • Modify: Enables you to modify the folder and job definitions, and to save as a new Workspace. Changes made to the new Workspace overwrite the existing folder names and events.

    • Duplicate: Enables you to duplicate the folder and job definitions, and to save as a new Workspace. The duplication of a Workspace adds a suffix to the folder name and events.

  4. For each parameter, type the required values, as described in Workspace Parameters.

  5. Click Save.

    The Workspace is saved.

  6. From the Workspace toolbar, click Check In.

    A confirmation message appears.

  7. Click Check In.

    The jobs are uploaded to the Control-M/EM database, and the Workspace appears in the Home tab with a status of Checked in.

Taking Ownership of the Workspace of Another User

This procedure describes how to take ownership of the Workspace of another user, which enables you to review and edit a Workspace.

Begin

  1. From the Home tab, click Others Work.

  2. Select the Workspace that you want to review.

    The Workspace opens in a read-only mode.

  3. Click Take Ownership.

    The Workspace is now owned by you and appears in the My Work area in the Home tab.

Submitting a Workspace as a Request

This procedure describes how to submit a Workspace as a request to the Control-M Scheduler, which enables you to submit and integrate your job definitions within Control-M.

Before you Begin

Define all your job definitions.

Begin

  1. From the Home tab, open the Workspace that you want to submit.

  2. Click Workspace Notes to add a note and correspond with the Control-M Scheduler, (Optional).

    You can also add a note and correspond with the Control-M Scheduler on a specific folder/job in the properties pane.

  3. Click Submit.

    If errors are found after you have submitted your Workspace, a message appears in the Validations section of your Workspace. You can modify any errors in the folder/job properties pane and re-submit your Workspace. After the Workspace is submitted, it is in Scheduler Work status and you cannot modify the Workspace.

  • You can view your changes, or changes made by a Control-M Scheduler to your Workspace in the Changes section of your Workspace.

  • If Control-M is integrated with a change management system and the workspace is not approved, you cannot submit the Workspace to the Control-M Scheduler. To submit the Workspace you must resolve the issue that prevents the approval, as described in WCM Integration with a Change Management System.