1 of 7

Examples

Configuration of the communication with Control-M

We configure the communication with the Control-M Enterprise Manager systems in etc/hwm_universal_interface_config.php this way:

$hwm_universal_interface_config = array(
    'communication' => array(
        ...
        'ctm' => array(
            'connection' => array(
                'url' => 'https://ctm_dev.my_company.com:8443/automation-api',
                'ssl_verifypeer' => true,
                'cainfo' => 'c:/HORIZONT/var/ssl/my_company_CA.crt',
                'timeout' => 120,
                'postfields' => array(),
                'httpheader' => array(),
            ),
            'callback' => array(
                'request' => 'ctm_request',
                'response' => 'ctm_response',
            ),
        ),
        ...
    ),
),

...

require_once('ctm_lib.php');

function ctm_request(&$connection, $inData, &$errMsg)
{
    $system = isset($inData['system']) ? $inData['system'] : '';
    switch (strtoupper($system))
    {
    case 'PROD':
        $connection['url'] =
            'https://ctm_prod.my_company.com:8443/automation-api';
        break;
    case 'DEV':
    case 'TEST':
    default:
        $connection['url'] =
            'https://ctm_dev.my_company.com:8443/automation-api';
        break;
    }
    return ctm_universal_interface_request($connection, $inData, $errMsg);
}

function ctm_response(&$response, &$errMsg)
{
    return ctm_universal_interface_response($response, $errMsg);

Call configuration file

In this example we will use one configuration file in all actions. After creating the configuration file etc/hos_ctm_dev_test_prod_call_config.php as a copy of the sample file etc/hos_ctm_call_config.php.sample and editing it, the configuration file looks like this (normally it would contain also descriptions in comments, but for the purpose of this document we removed them):

<?php
    $hos_docu_call_config = array(
        'readonly' => 'N',
        'rejectable' => 'N',
        'possible_rejects' => array(
            'DEV' => array('DEV', '1', 'N'),
            'TEST' => array('TEST', '2', 'N'),
        ),
        'rejects' => 'DEV',
        'param_prefix' => 'CTM.GNRL.',
        'param_prefix_trigger' => '',
        'form_name' => 'frmCTM',
        'ok_question' => '',
        'discard_question' => 'hwm_mMemoConfirmDiscard',
        'memo_visible' => 'Y',
        'memo_mandatory' => 'Y',
        'memo_rows' => '20',
        'memo_columns' => '100',
        'memo_max_len' => '0',
        'display_gpd_expanded' => 'N',
        'display_apd_expanded' => 'N',
        'display_mh_expanded' => 'N',
        'display_af_expanded' => 'N',
        'exec_ext_cmd_communication' => '',
        'exec_ext_cmd_command' => 'dummy',

        'docu_stage_archive' => 'CTM',
        'docu_final_archive' => 'CTM',
        'docu_finalize_process' => 'N',
        'docu_archive_objects' => 'Y',
        'docu_interim_archive' => 'CTM',
        'docu_id_descr' => '',
        'docu_id_descr_trnsl' => 'N',
        'docu_id_srch_class' => 'CTM_KEY',
        'docu_param_prefix_key' => 'CTM.KEY.',
        'docu_param_prefix_data' => 'CTM.DATA.',
        'docu_param_prefix_trigger' => '',
        'docu_show_key_in_filter' => 'Y',
        'docu_object_count_param' => 'OBJECT_COUNT',
        'docu_objects_mandatory' => 'Y',
        'docu_enable_new' => 'Y',
        'docu_enable_import' => 'N',
        'docu_enable_change' => 'N',
        'docu_enable_substitute' => 'N',
        'docu_enable_copy' => 'Y',
        'docu_enable_delete' => 'N',
        'docu_enable_restore' => 'N',
        'docu_enable_view' => 'Y',
        'docu_enable_edit' => 'Y',
        'docu_enable_clone' => 'Y',
        'docu_enable_remove' => 'Y',
        'docu_on_obj_in_use_new' => 'W',
        'docu_on_obj_in_use_change' => 'W',
        'docu_on_obj_in_use_delete' => 'W',
        'docu_enable_edit_save' => 'Y',
        'docu_confirm_edit_cancel' => 'Y',
        'docu_system_gen_expr' => 'trim(${CTM.KEY.SYSTEM})',
        'docu_key_gen_expr' => 'trim(${CTM.KEY.SERVER})'
                               .'.\'/\'.trim(${CTM.KEY.FOLDER})',
        'docu_key_params_in_key' => array(
            'CTM.KEY.SERVER',
            'CTM.KEY.FOLDER',
        ),
        'docu_edit_rejected_version' => 'N',
        'docu_enable_system_column' => 'Y',
        'docu_enable_check_column' => 'Y',
        'docu_file_version_action_map' => array(
            'CTM_DEV_TEST_PROD_OPEN' => 'DEV',
            'CTM_DEV_TEST_PROD_TEST' => 'TEST',
            'CTM_DEV_TEST_PROD_CLOSE' => 'PROD',
        ),

        'ctm_param_system' => 'CTM.KEY.SYSTEM',
        'ctm_param_server' => 'CTM.KEY.SERVER',
        'ctm_param_folder' => 'CTM.KEY.FOLDER',
        'ctm_param_definition' => 'CTM.DATA.DEF',
        'ctm_stage' => 'DEV',
        'ctm_rules_file' => 'hos_ctm_dev_test_prod_rules_config.php',
        'ctm_enable_import' => 'Y',
        'ctm_enable_xml_import' => 'Y',
        'ctm_enable_em_import' => 'Y',
        'ctm_enable_file_import' => 'Y',
        'ctm_enable_file_export' => 'Y',
        'ctm_communication' => 'ctm',
        'ctm_em_id' => 'PROD',
        'ctm_user' => 'emuser',
        'ctm_password' => '=T6jQA8bb+K0dVMuobQarcQ==',
        'ctm_list_folders_report' => 'PMFolders',
        'ctm_alternative_em' => array(
            array(
                'ctm_em_id' => 'TEST',
                'ctm_user' => 'emuser',
                'ctm_password' => '=T6jQA8bb+K0dVMuobQarcQ==',
            ),
            array(
                'ctm_em_id' => 'DEV',
                'ctm_user' => 'emuser',
                'ctm_password' => '=T6jQA8bb+K0dVMuobQarcQ==',
            ),
        ),
        'ctm_source_em' => 'DEV',
        'ctm_target_em' => 'DEV',
        'ctm_stage_em' => array(
            'DEV' => 'DEV',
            'TEST' => 'TEST',
            'PROD' => 'PROD',
        ),
        'ctm_report_max_wait_time' => '10',
        'ctm_deploy' => 'Y',
        'ctm_deploy_block_size' => '20',
        'ctm_deploy_ignore_sync_errors' => 'DEV,TEST',
        'ctm_key_delimiter' => '/',
        'ctm_known_folders_check' => 'Y',
        'ctm_display_kf_expanded' => 'N',
        'ctm_kf_stages' => array('TEST', 'PROD'),

        'docu_report_archives' => array(
            'CTM' => array(
                'description' => 'Control-M',
                'translate_description' => false,
            ),
        ),

        'docu_browser_process_type' => 'CTM_DEV_TEST_PROD',
        'docu_browser_selection_params' => array(
            'CTM.KEY.SERVER',
            'CTM.KEY.FOLDER',
        ),
        'docu_browser_enable_compare' => 'Y',
    );
?>

While editing the configuration file we have decided that: the process ID will be 'CTM_DEV_TEST_PROD', that the action names will be 'CTM_DEV_TEST_PROD_OPEN', 'CTM_DEV_TEST_PROD_TEST' and 'CTM_DEV_TEST_PROD_CLOSE', that the name of the repository archive will be 'CTM', that the process parameter prefix will be 'CTM.GNRL.', that the prefixes of object key and data parameters will be 'CTM.KEY.' and 'CTM.DATA.' , that there will be object key parameters 'CTM.KEY.SYSTEM', 'CTM.KEY.SERVER' and 'CTM.KEY.FOLDER' containing the information about the system, server and folder name of a folder definition in the process and that there will be an object data parameter 'CTM.DATA.DEF' containing the folder XML definition. Further we have specified expressions for how the system and key information of a folder definition will be evaluated from the object parameters.

Rules configuration file

In the rules file we will specify for the purpose of this example only simple rules for checking and changing the folder definitions.

We will check, that the folder and job names start with 'D' for DEV, with 'T' for TEST and with 'P' for PROD. If a description for a folder or job is missing a warning shall be displayed.

On change we will change the folder and job names and datacenters accordingly to the environment in which the folder definition is being moved.

After creating the configuration file etc/hos_ctm_dev_test_prod_rules_config.php as a copy of the sample file etc/hos_ctm_rules_config.php.sample and editing it, the configuration file looks like this:

Actions

Action for the developer requests:

Action for the tester approval and the deployment into the test environment:

Action for the planner approval and the deployment into the production environment:

Action for the process report:

Action for the cleanup on process deletes:

Action for the Object Browser:

Process

In the process definition we define the parameters we need, using proper parameter name prefixes:

In the process definition the previously defined actions have to be assigned to the activities and the process cleanup:

Object Browser

Rules configuration file

In the rules file we will specify for the purpose of this example only simple rules for checking and changing the folder definitions.

We will check, that the folder and job names start with 'D' for DEV, with 'T' for TEST and with 'P' for PROD. If a description for a folder or job is missing a warning shall be displayed.

On change we will change the folder and job names and datacenters accordingly to the environment in which the folder definition is being moved.

<?php
$hos_ctm_rules_config = array(
    'check' => array(
        array(
            'element' => array('FOLDER', 'SCHED_TABLE', 'TABLE',
                               'SMART_FOLDER', 'SMART_TABLE',
                               'SCHED_GROUP'),
            'variables' => array(
                'stage_short' => 'substr(${stage}, 0, 1)',
            ),
        ),
        array(
            'warning' => true,
            'element' => array('SMART_FOLDER', 'SMART_TABLE',
                               'SCHED_GROUP', 'SUB_FOLDER', 'SUB_TABLE',
                               'JOB'),
            'mandatory-attribute' => 'DESCRIPTION',
        ),
        array(
            'attribute' => 'FOLDER_NAME',
            'condition' => 'substr($, 0, 1) = ${stage_short}',
            'message' => 'The folder name must start with the first character '
                         .'of the current stage (D~DEV, T~TEST, P~PROD)',
        ),
        array(
            'attribute' => 'JOBNAME',
            'condition' => 'substr($, 0, 1) = ${stage_short}',
            'message' => 'The job name must start with the first character '
                         .'of the current stage (D~DEV, T~TEST, P~PROD)',
        ),
    ),



    'change' => array(
        array(
            'element' => array('FOLDER', 'SCHED_TABLE', 'TABLE',
                               'SMART_FOLDER', 'SMART_TABLE',
                               'SCHED_GROUP', 'DOFORCEJOB'),
            'variables' => array(
                'stage_short' => 'substr(${stage}, 0, 1)',
            ),
        ),
        array(
            'attribute' => 'DATACENTER',
            'evaluate' => '\'CTM_\'.${stage_short}.substr($, 5)',
        ),
        array(
            'attribute' => array('FOLDER_NAME', 'TABLE_NAME', 'JOBNAME'),
            'condition' => 'trim($) <> \'\'',
            'evaluate' => '${stage_short}.substr($, 1)',
        ),
        array(
            'attribute' => array('PARENT_FOLDER', 'PARENT_TABLE'),
            'condition' => 'trim($) <> \'\'',
            'delimiter' => '/',
            'evaluate' => '${stage_short}.substr($, 1)',
        ),
    ),
);
?>

Call configuration file

<?php
    $hos_docu_call_config = array(
        'readonly' => 'N',
        'rejectable' => 'N',
        'possible_rejects' => array(
            'DEV' => array('DEV', '1', 'N'),
            'TEST' => array('TEST', '2', 'N'),
        ),
        'rejects' => 'DEV',
        'param_prefix' => 'CTM.GNRL.',
        'param_prefix_trigger' => '',
        'form_name' => 'frmCTM',
        'ok_question' => '',
        'discard_question' => 'hwm_mMemoConfirmDiscard',
        'memo_visible' => 'Y',
        'memo_mandatory' => 'Y',
        'memo_rows' => '20',
        'memo_columns' => '100',
        'memo_max_len' => '0',
        'display_gpd_expanded' => 'N',
        'display_apd_expanded' => 'N',
        'display_mh_expanded' => 'N',
        'display_af_expanded' => 'N',
        'exec_ext_cmd_communication' => '',
        'exec_ext_cmd_command' => 'dummy',

        'docu_stage_archive' => 'CTM',
        'docu_final_archive' => 'CTM',
        'docu_finalize_process' => 'N',
        'docu_archive_objects' => 'Y',
        'docu_interim_archive' => 'CTM',
        'docu_id_descr' => '',
        'docu_id_descr_trnsl' => 'N',
        'docu_id_srch_class' => 'CTM_KEY',
        'docu_param_prefix_key' => 'CTM.KEY.',
        'docu_param_prefix_data' => 'CTM.DATA.',
        'docu_param_prefix_trigger' => '',
        'docu_show_key_in_filter' => 'Y',
        'docu_object_count_param' => 'OBJECT_COUNT',
        'docu_objects_mandatory' => 'Y',
        'docu_enable_new' => 'Y',
        'docu_enable_import' => 'N',
        'docu_enable_change' => 'N',
        'docu_enable_substitute' => 'N',
        'docu_enable_copy' => 'Y',
        'docu_enable_delete' => 'N',
        'docu_enable_restore' => 'N',
        'docu_enable_view' => 'Y',
        'docu_enable_edit' => 'Y',
        'docu_enable_clone' => 'Y',
        'docu_enable_remove' => 'Y',
        'docu_on_obj_in_use_new' => 'W',
        'docu_on_obj_in_use_change' => 'W',
        'docu_on_obj_in_use_delete' => 'W',
        'docu_enable_edit_save' => 'Y',
        'docu_confirm_edit_cancel' => 'Y',
        'docu_system_gen_expr' => 'trim(${CTM.KEY.SYSTEM})',
        'docu_key_gen_expr' => 'trim(${CTM.KEY.SERVER})'
                               .'.\'/\'.trim(${CTM.KEY.FOLDER})',
        'docu_key_params_in_key' => array(
            'CTM.KEY.SERVER',
            'CTM.KEY.FOLDER',
        ),
        'docu_edit_rejected_version' => 'N',
        'docu_enable_system_column' => 'Y',
        'docu_enable_check_column' => 'Y',
        'docu_file_version_action_map' => array(
            'CTM_DEV_TEST_PROD_OPEN' => 'DEV',
            'CTM_DEV_TEST_PROD_TEST' => 'TEST',
            'CTM_DEV_TEST_PROD_CLOSE' => 'PROD',
        ),

        'ctm_param_system' => 'CTM.KEY.SYSTEM',
        'ctm_param_server' => 'CTM.KEY.SERVER',
        'ctm_param_folder' => 'CTM.KEY.FOLDER',
        'ctm_param_definition' => 'CTM.DATA.DEF',
        'ctm_stage' => 'DEV',
        'ctm_rules_file' => 'hos_ctm_dev_test_prod_rules_config.php',
        'ctm_enable_import' => 'Y',
        'ctm_enable_xml_import' => 'Y',
        'ctm_enable_em_import' => 'Y',
        'ctm_enable_file_import' => 'Y',
        'ctm_enable_file_export' => 'Y',
        'ctm_communication' => 'ctm',
        'ctm_em_id' => 'PROD',
        'ctm_user' => 'emuser',
        'ctm_password' => '=T6jQA8bb+K0dVMuobQarcQ==',
        'ctm_list_folders_report' => 'PMFolders',
        'ctm_alternative_em' => array(
            array(
                'ctm_em_id' => 'TEST',
                'ctm_user' => 'emuser',
                'ctm_password' => '=T6jQA8bb+K0dVMuobQarcQ==',
            ),
            array(
                'ctm_em_id' => 'DEV',
                'ctm_user' => 'emuser',
                'ctm_password' => '=T6jQA8bb+K0dVMuobQarcQ==',
            ),
        ),
        'ctm_source_em' => 'DEV',
        'ctm_target_em' => 'DEV',
        'ctm_stage_em' => array(
            'DEV' => 'DEV',
            'TEST' => 'TEST',
            'PROD' => 'PROD',
        ),
        'ctm_report_max_wait_time' => '10',
        'ctm_deploy' => 'Y',
        'ctm_deploy_block_size' => '20',
        'ctm_deploy_ignore_sync_errors' => 'DEV,TEST',
        'ctm_key_delimiter' => '/',
        'ctm_known_folders_check' => 'Y',
        'ctm_display_kf_expanded' => 'N',
        'ctm_kf_stages' => array('TEST', 'PROD'),

        'docu_report_archives' => array(
            'CTM' => array(
                'description' => 'Control-M',
                'translate_description' => false,
            ),
        ),

        'docu_browser_process_type' => 'CTM_DEV_TEST_PROD',
        'docu_browser_selection_params' => array(
            'CTM.KEY.SERVER',
            'CTM.KEY.FOLDER',
        ),
        'docu_browser_enable_compare' => 'Y',
    );
?>