Run the Model Upload Utility

  1. Navigate to $FIC_HOME/ficapp/common/FICServer/bin location.
  2. Execute Upload.sh as a Command Line argument as shown in the following:

    ./upload.sh <infodom> <entire file path> <username> <uploadmode N/R/AM/AP> <modelUploadType E/C> <startsFilter> <constainsFilter> <endsFilter> <runscriptsFlag> <constraintNoValidateFlag> <EntityJsonFlag> <DDLMigrationFlag> <DDL Logs Flag> <considerCustomization> <Object Registration Mode> <Refresh Params>

    Note:

    Ensure that you are provided with the execute permission.

    The following are the descriptions for the arguments in the upload.sh file:

    • <infodom> - Refers to the DSN name. The information domain to where the model upload to be done.
    • <entire file path> - Refers to the entire file path of the erwin XML or Database XML. For example, $FTP_SHARE/$INFODOM/erwin/erwinXML/PFT_model.xml. Set this as Null for DB Catalog and Data Model Descriptor options.
    • <username> - Refers to the username of the OFSAA Application.

      Note:

      The User ID or Service accounts are “SMS Auth Only” in case of SSO and LDAP configured setups.
    • <uploadmode N/R/AM/AP> - Refers to the Upload Choice Code.
      • N - Refers to the New Model Upload.
      • R - Refers to the Complete Model Rebuild Upload.
      • AM - Refers to the Incremental Model Upload.
      • AP - Refers to the Sliced Model Upload.
    • <modelUploadType E/C> - Refers to the Model Upload type.
      • E - erwin upload
      • C - Catalog Generation
      • Set this as Null for Data Model Descriptor option.
    • <startsFilter> - This argument should be given only for Catalog generation.

      For example,

      For Catalog - dim_test

      For erwin and Data Model Descriptor options- Null

    • <constainsFilter> - This argument should be given only for Catalog generation.

      For example,

      For Catalog - dim_test

      For erwin and Data Model Descriptor options– null

    • <endsFilter> - This argument should be given only for Catalog generation.

      For example,

      For Catalog - dim_test

      For erwin and Data Model Descriptor options - Null

      Note:

      Do not alter the filter conditions startsFilter, constainsFilter and endsFilter.
    • <runscriptsFlag> - Set this as TRUE or FALSE.
      • TRUE - Updates the database/schema with the Model changes.
      • FALSE - Does not update the database/schema with Model changes. If this is set to FALSE, you should execute the SQL scripts generated as part of OFSAAI model upload process in a correct sequence, in order to make the Infodom Schema to be consistent with the DATABASE.xml. For more information, see Sequence of Execution of Scripts section.
    • <constraintNOVALIDATEFlag> - Refers to give an option to enable or disable constraints in to alter constraint in NOVALIDATE state. During Incremental and Sliced Model upload, the constraint validation is based on the value provided to this flag.
      • TRUE - Enables constraints in NOVALIDATE state and does not check the existing data for the integrity constraint violation.
      • FALSE - Does not enable constraints in NOVALIDATE state and checks the existing data for the integrity constraint violation.
    • considerCustomization - If customization is allowed on columns, set it as TRUE, else set it as FALSE.
    • EntityJSONflag- Set this as TRUE if the model upload option is selected as Data Model Descriptor, else set this as FALSE.
    • ScriptsMigratedFlag- Set this as TRUE or FALSE.
      • FALSE - To resume the model upload process from script generation. That is, if you have copied only database xml file to your target environment, set this as FALSE.
      • TRUE - To resume the model upload process from script execution. That is, if you have copied only database xml file and DB scripts to your target environment, set this as TRUE.
    • DDL Logs Flag- Set this as TRUE to print execution audit logs for Scripts. The logs can be found at ftpshare/<infodom>/executelogs/<infodom>_DDLLOG_<last data model version>_<MM.DD.YYYY>-<HH.MM.SS>.log.
    • Refresh Params – Set this as TRUE to use Database session parameters during model upload process, else set this as FALSE.
    • Object Registration Mode – Set it as F for full Object Registration or I for incremental object registration.

      Note:

      Incremental object registration should be opted only if the object registration on the base environment was incremental. Full Object Registration can be performed irrespective of mode opted in the base environment

    The various parameters to be passed for different modes are shown in the following matrix

    Table 16-16 Parameters for different Modes

    Start point Object Registration status DatabaseXMLFlag ScriptsMigratedFlag ObjectRegistrationflag
    Script generation Full Object Registration True False F
    Incremental Object registration True False I
    Script Execution Full Object Registration True True F
    Incremental Object registration True True I
  3. Logs are updated in regular Model Upload log at ftpshare/<infodom>/logs/<infodom>_LOG_<last data model version>_<MM.DD.YYYY>-<HH.MM.SS>.log

    Note:

    During incremental model upload, when the uploadmode is set as AM, some of mappings done in Data Integrator may get invalidated. You are required to save these mappings again.