To configure the config.sh file for installing FCC Studio, follow these steps:
1. Login to the server as a non-root user.
2. Navigate to the <Studio_Installation_Path>/bin/ directory.
3. Configure the config.sh file as follows:
NOTE |
· Do not alter the parameter values that are already set in the config.sh file · You must manually set the parameter value in the config.sh file. If a value is not applicable, enter NA and ensure that the value is not entered as NULL. · Depending on the installation architecture, ensure to provide the correct hostname for URL of PGX service in the config.sh file. · During upgrading FCC Studio with OFSAA, ensure to provide the same BD database, Studio schema, Hive schema, wallet related information that you used during the installation of the existing instance FCC Studio. · During upgrading FCC Studio with non-OFSAA, ensure to provide the same Studio schema and wallet related information that you used during the installation of the existing instance of FCC Studio. |
Parameter |
Significance |
Installing with OFSAA (Mandatory) |
Upgrading with OFSAA (Mandatory) |
Installing with non-OFSAA (Mandatory) |
Upgrading with non-OFSAA (Mandatory) |
|---|---|---|---|---|---|
FCC_STUDIO_INSTALLATION_PATH |
Indicates the path where the FCC Studio installer file is extracted. |
Yes |
Yes |
Yes |
Yes |
NON_OFSAA |
· To install FCC Studio with OFSAA, enter "false" · To install FCC Studio with non-OFSAA, enter "true" |
Enter false |
Enter false |
Enter true |
Enter true |
REALM |
Realm indicates functional grouping of database schemas and roles that must be secured for an application. Realms protect data from access through system privileges; realms do not give additional privileges to its owner or participants. FCC Studio uses realm based authorization and authentication for its users. For more information, see the Realm Based Authorization for FCC Studio section in the OFS Crime and Compliance Studio Administration Guide. The FCC Studio application can be accessed using the following realms: · FCCMRealm Value=com.oracle.ofss.fccm.studio.datastudio.auth.FCCMRealm · IdcsRealm Value=oracle.datastudio.realm.idcs.IdcsRealm · DemoRealm Value=com.oracle.ofss.fccm.studio.datastudio.auth.DemoRealm NOTE: The DemoRealm is used only for demo purpose and is not recommended for usage. |
Yes |
Yes |
Yes |
Yes |
FCDM_SOURCE |
Indicates the source database for FCC Studio. The available options are ECM and BD. NOTE: · FCC Studio can use either the BD or ECM schema as the source of FCDM data for the graph. · Ensure to enter the value as ECM whenever ECM integration is required with Investigation Hub. Here, ECM schema is used as the source of the FCDM data to load the case information into the graph. |
Enter BD or ECM |
Enter BD or ECM |
Enter NA |
Enter NA |
IDCS NOTE: The IDCS related parameters are applicable only if IdcsRealm is used in the Realm parameter. |
|
|
|
|
|
IDCS_HOST |
Indicates the server of the Oracle Identity Cloud Service (IDCS) instance. |
Yes |
Yes |
Yes |
Yes |
IDCS_PORT |
Indicates the port number of the IDCS instance. |
Yes |
Yes |
Yes |
Yes |
IDCS_SSL_ENABLED |
Indicates if SSL is enabled for the IDCS application. Default value: true |
Yes |
Yes |
Yes |
Yes |
LOGOUT_URL |
Indicates the URL to redirect after logout from FCC Studio. |
Yes |
Yes |
Yes |
Yes |
IDCS_TENANT |
Indicates the IDCS tenant provided by the IDCS Administrator while creating the IDCS application for FCC Studio. |
Yes |
Yes |
Yes |
Yes |
IDCS_CLIENT_ID |
Indicates the IDCS client identifier provided by the IDCS Administrator while creating the IDCS application for FCC Studio. |
Yes |
Yes |
Yes |
Yes |
IDCS_CLIENT_SECRET |
Indicates the IDCS client secret provided by the IDCS Administrator while creating the IDCS application for FCC Studio. |
Yes |
Yes |
Yes |
Yes |
External Services |
|
|
|
|
|
OFSAA_SERVICE_URL |
Indicates the URL of the OFSAA instance. Do not enter ’/’ at the end of the URL. NOTE: For OFSAAI, the value must be set in the following format: https://<HostName>:<PortNo>/<ContextName>/rest-api |
Yes |
Yes |
No |
No |
PGX_SERVER_URL |
Indicates the URL of the PGX server. Example: http://<HostName>:<PortNo>/ Here, default <PortNo> is 7007.
|
Yes |
Yes |
Yes |
Yes |
LIVY_HOST_URL |
Indicates the URL of the Livy application. Example: http://<HostName>:<PortNo> NOTE: This parameter is applicable only if the fcc-spark-sql, fcc-spark-scala and/or fcc-pyspark interpreters are to be used. |
No |
No |
No |
No |
Internal Services |
|
|
|
|
|
AUTH_SERVICE_URL |
Indicates the AUTH service URL that gets activated after the fcc-studio.sh file runs. Example: http://<HostName>:7041/authservice |
Yes |
Yes |
No |
No |
BATCH_SERVICE_URL |
Indicates the batch service URL that gets activated after the fcc-studio.sh file runs. Example: http://<HostName>:7043/batchservice |
Yes |
Yes |
Yes |
Yes |
META_SERVICE_URL |
Indicates the metaservice URL that gets activated after the fcc-studio.sh file runs. Example: http://<HostName>:7045/metaservice |
Yes |
Yes |
Yes |
Yes |
SESSION_SERVICE_URL |
Indicates the session service URL that gets activated after the fcc-studio.sh file runs. Example: http://<HostName>:7047/sessionservice |
Yes |
Yes |
Yes |
Yes |
FCC_STUDIO_URL |
Indicates the FCC Studio URL. Example: http://<HostName>:7008 |
Yes |
Yes |
Yes |
Yes |
ORE Interpreter Settings NOTE: This section is applicable only if ORE interpreter is to be used. |
|
|
|
|
|
RSERVE_USERNAME |
Indicates the RServe username. |
No |
No |
No |
No |
RSERVE_PASSWORD |
Indicates the RServe password. |
No |
No |
No |
No |
HTTP_PROXY |
Indicates the proxy for the host where FCC Studio is installed. |
No |
No |
No |
No |
HTTPS_PROXY |
Indicates the proxy for the host where FCC Studio is installed. |
No |
No |
No |
No |
REPO_CRAN_URL |
Indicates the URL from where the R packages are obtained. The format for the REPO_CRAN_URL is as follows: |
No |
No |
No |
No |
USERS_LIB_PATH |
Indicates the path where the R packages are installed. |
No |
No |
No |
No |
RSERVE_CONF_PATH |
Indicates the path where the Rserve.conf file is present. |
No |
No |
No |
No |
DB Details for Studio Schema |
|
|
|
|
|
STUDIO_DB_HOSTNAME |
Indicates the hostname of the database where Studio schema is created. |
Yes |
Yes |
Yes |
Yes |
STUDIO_DB_PORT |
Indicates the port number where Studio schema is created. |
Yes |
Yes |
Yes |
Yes |
STUDIO_DB_SERVICE_NAME |
Indicates the service name of the database where Studio schema is created. |
Yes |
Yes |
Yes |
Yes |
STUDIO_DB_SID |
Indicates the SID of the database where Studio schema is created. |
Yes |
Yes |
Yes |
Yes |
STUDIO_DB_USERNAME |
Indicates the username of the Studio Schema (newly created Oracle Schema). |
Yes |
Yes |
Yes |
Yes |
STUDIO_DB_PASSWORD |
Indicates the password of the Studio schema. |
Yes |
Yes |
Yes |
Yes |
Studio DB Wallet Details For more information on creating wallet, see Appendix - Setting Up Password Stores with Oracle Wallet . |
|
|
|
|
|
STUDIO_ALIAS_NAME |
Indicates the Studio alias name. NOTE: Enter the alias name that was created during wallet creation. |
Yes |
Yes |
Yes |
Yes |
STUDIO_WALLET_LOCATION |
Indicates the Studio wallet location. |
Yes |
Yes |
Yes |
Yes |
STUDIO_TNS_ADMIN_PATH |
Indicates the path of the tnsnames.ora file where an entry for the STUDIO_ALIAS_NAME is present. |
Yes |
Yes |
Yes |
Yes |
DB Details for BD Config Schema |
|
|
|
|
|
BD_CONFIG_HOSTNAME |
Indicates the hostname of the database where BD or ECM config schema is installed. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_PORT |
Indicates the port of the database where BD or ECM config schema is installed. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_SERVICE_NAME |
Indicates the service name of the database where BD or ECM config schema is installed. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_SID |
Indicates the SID of the database where BD or ECM config schema is installed. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_USERNAME |
Indicates the username for the BD or ECM config schema. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_PASSWORD |
Indicates the password for the BD or ECM config schema. |
Yes |
Yes |
Enter NA |
Enter NA |
BD Config Wallet Details For more information on creating wallet, see Appendix - Setting Up Password Stores with Oracle Wallet . |
|
|
|
|
|
BD_CONFIG_ALIAS_NAME |
Indicates the BD or ECM config alias name. NOTE: Enter the alias name that was created during wallet creation. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_WALLET_LOCATION |
Indicates the BD or ECM config wallet location. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_CONFIG_TNS_ADMIN_PATH |
Indicates the path of the tnsnames.ora file where an entry for the BD_CONFIG_ALIAS_NAME is present. |
Yes |
Yes |
Enter NA |
Enter NA |
DB Details for BD Atomic Schema |
|
|
|
|
|
BD_ATOMIC_HOSTNAME |
Indicates the BD or ECM atomic schema hostname. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_PORT |
Indicates the BD or ECM atomic schema port number. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_SERVICE_NAME |
Indicates the BD or ECM atomic schema service name. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_SID |
Indicates the BD or ECM atomic schema SID. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_USERNAME |
Indicates the username of the BD or ECM atomic schema. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_PASSWORD |
Indicates the password of the BD or ECM atomic schema. |
Yes |
Yes |
Enter NA |
Enter NA |
BD Atomic Wallet Details For more information on creating wallet, see Appendix - Setting Up Password Stores with Oracle Wallet . |
|
|
|
|
|
BD_ATOMIC_ALIAS_NAME |
Indicates the BD or ECM atomic alias name. NOTE: Enter the alias name that was created during wallet creation. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_WALLET_LOCATION |
Indicates the BD or ECM atomic wallet location. |
Yes |
Yes |
Enter NA |
Enter NA |
BD_ATOMIC_TNS_ADMIN_PATH |
Indicates the path of the tnsnames.ora file where an entry for the BD_ATOMIC_ALIAS_NAME is present. |
Yes |
Yes |
Enter NA |
Enter NA |
SQL Scripts |
|
|
|
|
|
FSINFODOM |
Indicates the name of the BD or ECM Infodom. |
Yes |
Yes |
Enter NA |
Enter NA |
FSSEGMENT |
Indicates the name of the BD or ECM segment. |
Yes |
Yes |
Enter NA |
Enter NA |
DATAMOVEMENT_LINK_NAME |
· If the Studio schema is in a different database host, you must create a DB link and provide the same link in this parameter. If no DB link is present, provide the BD or ECM Atomic schema name in this parameter. · If the Studio schema is in the same database host, the value for this parameter is the user name of the BD or ECM atomic schema. |
Yes |
Yes |
Yes |
Yes |
DATAMOVEMENT_LINK_TYPE |
If the DB link is used, enter DBLINK in this field. If the DB link is not used, enter SCHEMA in this field. |
Yes |
Yes |
Yes |
Yes |
PGX Setup Details |
|
|
|
|
|
PGX_INSTALATION_PATH |
Indicates the installation path of the PGX server. Example: <STUDIO_INSTALLATION_PATH>/pgx/server/ |
Yes |
Yes |
Yes |
Yes |
PGX_PGB_PATH |
Indicates the path where you want to obtain the output graph PGB file. Example for Hive Installation: hdfs:/user/ofsaa Example for Oracle DB Installation: /scratch/ofsaa |
Yes |
Yes |
Yes |
Yes |
Cloudera Setup Details Contact System Administrator to obtain the required details for these parameters. |
|
|
|
|
|
HADOOP_CREDENTIAL_PROVIDER_PATH |
Indicates the path where Hadoop credential is stored. |
Yes |
Yes |
Enter NA |
Enter NA |
HADOOP_PASSWORD_ALIAS |
Indicates the Hadoop alias given when creating the Hadoop credentials. Note: Indicates the Hadoop alias given when creating the Hadoop credentials. For information on creating credential keystore, see Creating the Credential Keystore. |
Yes |
Yes |
Enter NA |
Enter NA |
Hive_Host_Name |
Indicates the Hive hostname. |
Yes |
Yes |
Enter NA |
Enter NA |
Hive_Port_number |
Indicates the Hive port number. Contact System Administrator to obtain the port number. |
Yes |
Yes |
Enter NA |
Enter NA |
HIVE_PRINCIPAL |
Indicates the Hive Principal. Contact System Administrator to obtain HIVE_PRINCIPAL. |
Yes |
Yes |
Enter NA |
Enter NA |
HIVE_SCHEMA |
Indicates to create a schema in HIVE. |
Yes |
Yes |
Enter NA |
Enter NA |
JAAS_CONF_FILE_PATH |
Created for future use. |
No |
No |
No |
No |
Krb_Host_FQDN_Name |
Indicates the Krb host FQDN name. |
Yes |
Yes |
Enter NA |
Enter NA |
Krb_Realm_Name |
Indicates the Krb realm name. |
Yes |
Yes |
Enter NA |
Enter NA |
Krb_Service_Name |
Indicates the Krb service name. Example: Hive |
Yes |
Yes |
Enter NA |
Enter NA |
KRB5_CONF_FILE_PATH |
Created for future use. |
No |
No |
No |
No |
security_krb5_kdc_server |
Created for future use. |
No |
No |
No |
No |
security_krb5_realm |
Created for future use. |
No |
No |
No |
No |
server_kerberos_keytab_file |
Indicates the Kerberos keytab file. |
Yes |
Yes |
Enter NA |
Enter NA |
server_kerberos_principal |
Indicates the Kerberos Principal. |
Yes |
Yes |
Enter NA |
Enter NA |
SQOOP_HOSTMACHINE_USER_NAME |
Indicates the user name of the Host machine where sqoop will run. |
Yes |
Yes |
Enter NA |
Enter NA |
SQOOP_PARAMFILE_PATH |
1. Create a file with the name sqoop.properties in the Big Data server and add the following entry: oracle.jdbc.mapDateToTimestamp=false 2. Enter the location of the sqoop.properties file as the value for this parameter. Example: /scratch/ofsaa/ NOTE: Ensure that the location name ends with a ’/’. |
Yes |
Yes |
Enter NA |
Enter NA |
SQOOP_PARTITION_COL |
Indicates the column in which the HIVE table is partitioned. The value must be SNAPSHOT_DT. |
Yes |
Yes |
Enter NA |
Enter NA |
SQOOP_TRG_HOSTNAME |
Indicates the hostname of the Big Data server where SQOOP will run. Example: <HostName> |
Yes |
Yes |
Enter NA |
Enter NA |
SQOOP_WORKDIR_HDFS |
Indicates the SQOOP working directory in HDFS. Example: /user/ofsaa |
Yes |
Yes |
Enter NA |
Enter NA |
Elastic Search Cluster details |
|
|
|
|
|
ELASTIC_SEARCH_PORT |
Indicates the port number where the elastic search service is installed. |
Yes |
Yes |
Yes |
Yes |
ELASTIC_SEARCH_HOSTNAME |
Indicates the hostname of the database where the elastic search service is installed. |
Yes |
Yes |
Yes |
Yes |
Matching Service |
|
|
|
|
|
MATCHING_SERVICE_HOSTNAME |
Indicates the hostname where the matching service is installed. |
Yes |
Yes |
Yes |
Yes |
MATCHING_SERVICE_PORT |
Indicates the port number where the matching service is installed. |
Yes |
Yes |
Yes |
Yes |
EXECUTOR_THREADS |
Indicates the number of threads to run in parallel during one scroll. For example: 10 |
Yes |
Yes |
Yes |
Yes |
ELASTICRESPONSE_BUFFERLIMIT_BYTE |
Indicates the buffer size of the response obtained from the elastic search service. For example: 200 |
Yes |
Yes |
Yes |
Yes |
SCROLL_TIME |
Indicates the duration for which the scroll_size output is active. For example: 5 |
Yes |
Yes |
Yes |
Yes |
SCROLL_SIZE |
Indicates the amount of data that must be obtained in one attempt when a query is fired on an index in the elastic search service. For example: 1000 |
Yes |
Yes |
Yes |
Yes |
Entity Resolution |
|
|
|
|
|
ER_SERVICE_PORT |
Indicates the port number where the entity resolution service is installed. Default Value: 7051 NOTE: This value is already set. Do not change the value. |
Yes |
Yes |
Yes |
Yes |
ER_SERVICE_URL |
Indicates the URL of the entity resolution service. For example: http://<HostName>:7051 |
Yes |
Yes |
Yes |
Yes |
Graphs |
|
|
|
|
|
HDFS_GRAPH_FILES_PATH |
Indicates the filepath in the HDFS where the graph.json is formed. |
Yes |
Yes |
Yes |
Yes |
GRAPH_FILES_PATH |
Indicates the directory in the Big Data server for graph files. |
Yes |
Yes |
Yes |
Yes |
GRAPH_NAME |
Indicates the name you want to assign to the global graph at the end of ETL. |
Yes |
Yes |
Yes |
Yes |