1 of 1

Configuration file

First, we need configuration file/files for the new process. In this example we will use one configuration file in all actions. After creating the configuration file etc/hos_docu_call_config_EI.php (EI means Emergency Instructions) as a copy of the sample file etc/hos_docu_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',
        'param_prefix' => 'EI.PROC.',
        'param_prefix_trigger' => '',
        'form_name' => 'frmEI',
        'ok_question' => '',
        'discard_question' => 'hwm_mMemoConfirmDiscard',
        'memo_visible' => 'Y',
        'memo_mandatory' => 'Y',
        'memo_rows' => '5',
        'memo_columns' => '100',
        'memo_max_len' => '0',
        'display_gpd_expanded' => 'Y',
        'display_apd_expanded' => 'Y',
        'display_mh_expanded' => 'Y',

        'docu_stage_archive' => 'EI',
        'docu_final_archive' => 'EI',
        'docu_archive_objects' => 'Y',
        'docu_interim_archive' => 'EI_INTERIM',
        'docu_id_descr' => '',
        'docu_id_descr_trnsl' => 'N',
        'docu_id_srch_class' => '',
        'docu_param_prefix_key' => 'EI.KEY.',
        'docu_param_prefix_data' => 'EI.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' => 'Y',
        'docu_enable_change' => 'Y',
        'docu_enable_substitute' => 'Y',
        'docu_enable_copy' => 'Y',
        'docu_enable_delete' => 'Y',
        'docu_enable_restore' => 'Y',
        'docu_enable_view' => 'Y',
        'docu_enable_edit' => 'Y',
        'docu_enable_clone' => 'Y',
        'docu_enable_remove' => 'Y',
        'docu_on_obj_in_use_new' => 'E',
        'docu_on_obj_in_use_change' => 'E',
        'docu_on_obj_in_use_delete' => 'E',
        'docu_enable_edit_save' => 'Y',
        'docu_confirm_edit_cancel' => 'Y',
        'docu_system_gen_expr' => 'trim(${EI.KEY.SYSTEM})',
        'docu_key_gen_expr' => 'trim(${EI.KEY.DIR}).\'/\'.trim(${EI.KEY.FILE})',
        'docu_object_enabled_expr' => '${EI.DATA.ENABLED} = \'Y\'',
        'docu_edit_rejected_version' => 'N',
        'docu_enable_system_column' => 'Y',
        'docu_enable_check_column' => 'Y',

        'docu_report_archives' => array(
            'EI' => array(
                'description' => 'Accepted emergency instructions',
                'translate_description' => false,
            ),
        ),

        'docu_browser_process_type' => 'EMERGENCY_INSTRUCTIONS',
    );
?>

While editing the configuration file we have decided that the process ID will be 'EMERGENCY_INSTRUCTIONS', that the name of the repository archive will be 'EI', that the process parameter prefix will be 'EI.PROC.', that the prefixes of object key/data parameters will be 'EI.KEY.'/'EI.DATA.' , that there will be an object key parameters 'EI.KEY.SYSTEM'/'EI.KEY.DIR'/'EI.KEY.FILE' containing the information about the system/directory/file name of a program which is the object of an emergency instruction and that there will be an object data parameter 'EI.DATA.ENABLED' containing the information whether an emergency instruction is enabled or not. Further we have specified expressions for how the system, key and enabled information of an emergency instruction will be evaluated from the object parameters.

Configuration file

<?php
    $hos_docu_call_config = array(
        'readonly' => 'N',
        'rejectable' => 'N',
        'param_prefix' => 'EI.PROC.',
        'param_prefix_trigger' => '',
        'form_name' => 'frmEI',
        'ok_question' => '',
        'discard_question' => 'hwm_mMemoConfirmDiscard',
        'memo_visible' => 'Y',
        'memo_mandatory' => 'Y',
        'memo_rows' => '5',
        'memo_columns' => '100',
        'memo_max_len' => '0',
        'display_gpd_expanded' => 'Y',
        'display_apd_expanded' => 'Y',
        'display_mh_expanded' => 'Y',

        'docu_stage_archive' => 'EI',
        'docu_final_archive' => 'EI',
        'docu_archive_objects' => 'Y',
        'docu_interim_archive' => 'EI_INTERIM',
        'docu_id_descr' => '',
        'docu_id_descr_trnsl' => 'N',
        'docu_id_srch_class' => '',
        'docu_param_prefix_key' => 'EI.KEY.',
        'docu_param_prefix_data' => 'EI.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' => 'Y',
        'docu_enable_change' => 'Y',
        'docu_enable_substitute' => 'Y',
        'docu_enable_copy' => 'Y',
        'docu_enable_delete' => 'Y',
        'docu_enable_restore' => 'Y',
        'docu_enable_view' => 'Y',
        'docu_enable_edit' => 'Y',
        'docu_enable_clone' => 'Y',
        'docu_enable_remove' => 'Y',
        'docu_on_obj_in_use_new' => 'E',
        'docu_on_obj_in_use_change' => 'E',
        'docu_on_obj_in_use_delete' => 'E',
        'docu_enable_edit_save' => 'Y',
        'docu_confirm_edit_cancel' => 'Y',
        'docu_system_gen_expr' => 'trim(${EI.KEY.SYSTEM})',
        'docu_key_gen_expr' => 'trim(${EI.KEY.DIR}).\'/\'.trim(${EI.KEY.FILE})',
        'docu_object_enabled_expr' => '${EI.DATA.ENABLED} = \'Y\'',
        'docu_edit_rejected_version' => 'N',
        'docu_enable_system_column' => 'Y',
        'docu_enable_check_column' => 'Y',

        'docu_report_archives' => array(
            'EI' => array(
                'description' => 'Accepted emergency instructions',
                'translate_description' => false,
            ),
        ),

        'docu_browser_process_type' => 'EMERGENCY_INSTRUCTIONS',
    );
?>