# DCbegin.cfg: Initializes the Data Collection
# $Id: DCbegin.cfg,v 1.14 2014/11/05 16:58:13 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/RDA/DCbegin.cfg,v 1.14 2014/11/05 16:58:13 RDA Exp $
#
# Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
#
# Change History
# 20141105  MSC  Add B_TARGETS setting.

###############################################################################
# Collect the global setup information
###############################################################################

#------------------------------------------------------------------------------
# Module definition
#------------------------------------------------------------------------------
cfm=0
dft=1
dsc='Initializes the Data Collection'
lim=0
man='The DCbegin module regroups all generic properties. It must be set up \
     before any other module.'
req=RDA:DCconfig,RDA:DCocm,RDA:DCstatus,RDA:DCload,RDA:DCend,RDA:DCfilter
var=check_rda,\
    prf_type,check_type,need_instance,\
    B_TARGETS,\
    B_BIN_CHECK,B_NO_PARALLEL,B_SAVE,B_USE_TEMP,\
    N_TAIL,N_TIMEOUT,\
    vms_command,win_command,D_SQL_HOME,T_SQL_COMMAND,\
    B_ACCESS,B_ERROR,B_LOGIN,B_PRELIM,B_SQL_FORK,\
    N_ATTEMPTS,N_SQL_TIMEOUT,N_DBI_TIMEOUT

#------------------------------------------------------------------------------
# Setting definitions
#------------------------------------------------------------------------------
[check_rda]
typ=B
dft=${RDA.N_ENGINE}
dsc='Check if the engine code is not obsolete'
nam=-
var=false:obsolete_engine

[obsolete_engine]
typ=C
inp="Expecting the RDA build ${RDA.N_BUILD} or later"
val=F
vis=0

[prf_type]
typ=T
dft=keys(${SET.B_PRF})
dsc='Profile type'
nam=T_TYPE

[check_type]
typ=B
dft=match(${T_TYPE},'^CUS:')
dsc='Check the profile type'
nam=-
var=true:component_setup,D_ORACLE_PARENT:\
         get_oracle_home

[component_setup]
typ=S
dft=${PRF.M_SETUP}
dsc='Component specific setup'

[get_oracle_home]
typ=B
dft=${RDA.B_UNIX}
nam=-
var=true:T_ORACLE_HOME,set_unix_home:\
         D_ORACLE_HOME

[D_ORACLE_HOME]
typ=D
dft="<<PATH:D:${ENV.ORACLE_HOME}"
dsc='Oracle home'
err='Warning: The specified directory does not -yet- exist'
fmt='<<Native'
inp='Enter the Oracle home to be used for data analysis'
raw=true
val=W
var=exists:set_home_target,D_ORACLE_PARENT

[T_ORACLE_HOME]
typ=D
dft=${ENV.ORACLE_HOME}
dsc='Oracle home'
err='Warning: The specified directory does not -yet- exist'
inp='Enter the Oracle home to be used for data analysis'
val=W

[set_unix_home]
typ=D
dft=${T_ORACLE_HOME}
dsc='Oracle home'
nam=D_ORACLE_HOME
raw=true
var=exists:set_home_target,D_ORACLE_PARENT

[set_home_target]
typ=I
cls='OH'
dft=nvl(findItem('OH','D_ORACLE_HOME',${D_ORACLE_HOME}),\
        defineTarget('OH',{'D_ORACLE_HOME'=>${D_ORACLE_HOME},\
                           'T_ORACLE_HOME'=>${T_ORACLE_HOME},\
                           'T_TITLE'=>"Default home ${D_ORACLE_HOME}"}))
dsc='Target associated with the default Oracle home'
nam=I_ORACLE_HOME
vis=false
exe=sdcl {
"call initTargets()
}

[D_ORACLE_PARENT]
typ=D
alt=get_product
dft="<<PATH:D:${D_ORACLE_HOME/v}/.."
dsc='Parent directory of the Oracle home directory'
var=exists:check_utils,get_product:\
           get_product

[check_utils]
typ=B
dft=testDir('d',catDir(${D_ORACLE_PARENT},'utils'))
dsc='Possible utils Middleware directory'  # stopwords utils
nam=-B_TMP_HAS_UTILS

[get_product]
typ=T
dft=${T_PRODUCT/P}
dsc='Oracle home installation type'
nam=T_INSTALL

[need_instance]
typ=B
dft=or(${PRF.B_INSTANCE},\
       ${D_INSTANCE_DIRECTORY},\
       match(${T_INSTALL},\
             '^(Classic Application Server 11g|\
                Oracle Business Intelligence Shiphome|\
                Oracle Forms and Reports 11g|\
                Oracle Portal, Forms, Reports and Discoverer 11g|\
                Oracle WebTier)'),\
       defined(testDir('d',catDir(${D_ORACLE_HOME},'webgate'))))
dsc='Is an instance directory required?'
nam=-
var=true:chk_oracle_instance,D_INSTANCE_ROOT:\
         need_optional_root

[need_optional_root]
typ=B
dft=match(${T_INSTALL},\
          '^(Application Server 11g ECM|\
             EPM System|\
             Oracle Application Developer 11g|\
             Oracle Identity Management 11g|\
             Oracle IDM Suite|\
             Oracle SOA Suite 11g|\
             Oracle WebCenter Portal Suite 11g|\
             Oracle WebCenter Suite 11g|\
             SOA Application Server 11g|\
             Standalone WebLogic Server|\
             Webcenter Application Server 11g)')
dsc='Is an instance directory required?'
nam=-
var=true:set_optional_root:\
         need_default_root

[need_default_root]
typ=B
dft=${B_TMP_HAS_UTILS}
dsc='Is an instance directory required?'
nam=-
var=true:set_default_root

[chk_oracle_instance]
typ=B
dft=defined(${ENV.ORACLE_INSTANCE})
dsc='Check the ORACLE_INSTANCE environment variable existence'
nam=-
var=true:dft_instance_root

[dft_instance_root]
typ=D
dft="<<PATH:D:${ENV.ORACLE_INSTANCE}/.."
dsc='Default instance root directory'
nam=-D_TMP_INSTANCE_ROOT

[set_default_root]
typ=D
dft=${D_ORACLE_PARENT}
dsc='Instance root directory'
nam=D_INSTANCE_ROOT

[set_optional_root]
typ=D
clr='-'
dft=${D_ORACLE_PARENT}
dsc='Instance root directory'
err='Warning: The specified directory does not -yet- exist'
inp='In case of instances homes could be involved in the data collection, \
     enter the location of the directory containing instance homes. \
     Otherwise, provide the Middleware home directory.'
nam=D_INSTANCE_ROOT
val=W

[D_INSTANCE_ROOT]
typ=D
clr='-'
dft=${D_TMP_INSTANCE_ROOT}
dsc='Instance root directory'
err='Warning: The specified directory does not -yet- exist'
inp='Enter the location of the directory containing the instance homes to \
     analyze (For example the parent directory of the path specified by an \
     ORACLE_INSTANCE environment variable)'
val=W
var=exists:dir_loop,has_instances

[dir_loop]
typ=L
dft=findDir(${D_INSTANCE_ROOT},'^\.+$','v')
dsc='Examine all directories'
nam=-T_item
var=loop:check_item

[check_item]
typ=F
dft=(catFile(${D_INSTANCE_ROOT},${T_item},'bin','opmnctl'),\
     catFile(${D_INSTANCE_ROOT},${T_item},'bin','opmnctl.bat'),\
     catFile(${D_INSTANCE_ROOT},${T_item},'bin','opmnctl.exe'))
dsc='Check the presence of an instance opmnctl'  # stopwords opmnctl
nam=-
var=exists:store_instance

[store_instance]
typ=T
dft="${T_TMP_INSTANCE_LIST}|${T_item}"
dsc='Store a valid candidate directory'
nam=-T_TMP_INSTANCE_LIST

[has_instances]
typ=B
dft=defined(${T_TMP_INSTANCE_LIST})
dsc='Check instance presence'
nam=-
var=false:edit_instance_root:\
          set_instance_target

[set_instance_target]
typ=I
cls='OI'
dsc='Oracle instance target list'
nam=I_ORACLE_INSTANCES
vis=false
exe=sdcl {
"var ($top,@itm,%ins) = (${D_INSTANCE_ROOT})
"loop $nam (split('\|',${T_TMP_INSTANCE_LIST}))
"{if ?testFile('f',catFile($top,$nam,'bin',${AS.BATCH:'opmnctl'}))
"  var $ins{$dir = catDir($top,$nam)} = true
"}
"loop $dir (keys(%ins))
" call push(@itm,nvl(findItem('OI','D_ORACLE_INSTANCE',$dir),\
"                    defineTarget('OI',{D_ORACLE_INSTANCE=>$dir,\
"                                       T_TITLE=>"Instance home ${VAR.dir}"})))
"var ${AUX.dft} = [@itm]
}

[edit_instance_root]
typ=B
dft=false
dsc='Do you want to modify the instance root location?'
inp='The specified Oracle instance root directory is either invalid or does \
     not contain some Oracle Fusion Middleware instance related-files. \
     Collection will not contain complete instance data.\n\n\
     Do you want to modify the instance root path (Y/N)?'
nam=-
var=true:D_INSTANCE_ROOT

[get_handlers]
typ=T
dft=grep(getModules('DC'),'req$')
dsc='List of modules to execute requests from other modules'
end=''
nam=M_HANDLER

[B_TARGETS]
typ=B
dft=false
dsc="Should RDA check target connectivity?"
lvl=9

#------------------------------------------------------------------------------
# Data Collection settings
#------------------------------------------------------------------------------
[B_BIN_CHECK]
typ=B
def='COL/DEFAULT'
dft=true
dsc='Do you want RDA to check is a file could be a binary file?'

[B_LOGIN]
typ=B
def='COL/DEFAULT'
dft=false
dsc='Abort data collection when no password is provided when requested'
inp='Do you want RDA to abort data collection when no password is provided \
     when requested (Y/N)'
lvl=9

[B_NO_PARALLEL]
typ=B
def='COL/DEFAULT'
dft=${RDA.B_WINDOWS}
dsc='No parallel execution'
inp='Are parallel executions disabled (Y/N)'
lvl=6

[B_SAVE]
typ=B
def='COL/DEFAULT'
dft=true
dsc='Is the setup information saved at the end of each module?'
inp='Is the setup information saved at the end of each module (Y/N)?'
lvl=9

[B_USE_TEMP]
typ=B
def='COL/DEFAULT'
dft=or(${RDA.B_WINDOWS},${RDA.B_VMS})
dsc='Force the usage of temporary files when executing OS commands'
inp='Do you want RDA to use temporary files when executing OS commands (Y/N)?'
lvl=9

[N_TAIL]
typ=N
def='COL/DEFAULT'
dft=1000
dsc='Default number of lines used for tail operations'
err='The number of lines must be an integer greater than zero'
inp='Enter the default number of lines used for tail operations'
lvl=9
ref='I]0,['
val=F

[N_TIMEOUT]
typ=N
def='COL/DEFAULT'
dft=${PRF/N_TIMEOUT:30}
dsc='Command execution timeout (in seconds)'
err='The timeout value must be a positive integer'
inp='Enter the maximum time for command execution (in seconds)'
lvl=9
ref='I[0,['
val=F

#------------------------------------------------------------------------------
# Database Access properties
#------------------------------------------------------------------------------
[vms_command]
typ=T
dft='PIPE SQLPLUS'
dsc='How to execute SQL*Plus for VMS'
fam=Vms
nam=-T_TMP_SQL_COMMAND

[win_command]
typ=F
dft=grepDir(catDir(${D_ORACLE_HOME/v},'bin'),'^PLUS80\.EXE$','ip')
dsc='Check the existence of alternative SQL*Plus'
fam=Cygwin,Windows
nam=-T_TMP_SQL_COMMAND
opt=true
var=exists:win_sql_home

[win_sql_home]
typ=D
dft=${D_ORACLE_HOME}
dsc='Oracle home of alternative SQL*Plus for Windows'
fam=Cygwin,Windows
nam=-D_TMP_SQL_HOME

[T_SQL_COMMAND]
typ=T
def='COL/DEFAULT'
dft=${T_TMP_SQL_COMMAND:'sqlplus'}
dsc='Name of the SQL*Plus command'
inp='Enter the exact name of the local SQL*Plus command'
lvl=9

[D_SQL_HOME]
typ=D
def='COL/DEFAULT'
dft=${D_TMP_SQL_HOME}
inp='Oracle home to be used for the SQL*Plus command'
inp='Enter the Oracle home to be used for the SQL*Plus command'
lvl=9
opt=true

[B_ACCESS]
typ=B
def='COL/DEFAULT'
dft=0
dsc='Abort data collection if database connection problems are encountered'
inp='Abort further data collection if database connection problems are \
     encountered \
     (Y/N)?'
lvl=9

[B_ERROR]
typ=B
def='COL/DEFAULT'
dft=0
dsc='Abort further data collection if SQL errors encountered'
inp='Do you want RDA to abort further data collection if it encounters SQL \
     errors (Y/N)?'
lvl=9

[B_PRELIM]
typ=B
def='COL/DEFAULT'
dft=0
dsc='Should RDA start SQL*Plus with a -prelim option?'
inp="Do you want RDA to start SQL*Plus with a '-prelim' option (Y/N)?"
lvl=9

[B_SQL_FORK]
typ=B
def='COL/DEFAULT'
dft=${RDA.B_FORK}
dsc='Are forks allowed for executing database requests?'
inp='Can RDA use forks to execute database requests (Y/N)?'
lvl=9

[N_ATTEMPTS]
typ=N
def='COL/DEFAULT'
dft=3
dsc='Maximum number of SQL execution attempts'
err='The number of attempts must be a positive integer'
inp='Enter the number of attempts before disabling SQL execution'
lvl=9
ref='I[0,['
val=F

[N_SQL_TIMEOUT]
typ=N
def='COL/DEFAULT'
dft=${PRF/N_SQL_TIMEOUT:30}
dsc='SQL timeout (in seconds)'
err='The number of seconds must be a positive integer'
inp='Enter the maximum time allowed for each SQL*Plus execution (in seconds)'
lvl=6
ref='I[0,['
val=F

[N_DBI_TIMEOUT]
typ=N
def='COL/DEFAULT'
dft=cond(${RDA.B_CYGWIN},0,${RDA.B_WINDOWS},0,30)
dsc='DBI timeout (in seconds)'
err='The number of seconds must be a positive integer'
inp='Enter the maximum time allowed for each DBI request (in seconds)'
nam=N_DBI_TIMEOUT
lvl=6
ref='I[0,['
val=F