Skip to main content

Notebook Runtime Parameters

Important rules:

  • RunMode: BUILD, PARSE, or FULL
  • SourceType: XML or DB
  • PipelineTriggerTime: Timestamp value

ingestion_master.ipynb​

Mandatory values:

  • RunMode: BUILD, PARSE, or FULL
  • PipelineId: Mandatory
  • PipelineTriggerTime: Mandatory

Mandatory when RunMode includes build:

  • SourceType: XML or DB
  • BuildConfigPath: Mandatory
  • RootFolder: Mandatory when SourceType = XML

Mandatory when RunMode includes parse:

  • ParseStage: Must be Filter
  • ParseConfigPath: Mandatory

Pass when required for downstream parsing:

  • ExtensionConfigPath

xml_build.ipynb​

Mandatory values:

  • PipelineId: Mandatory
  • PipelineTriggerTime: Mandatory
  • SourceType: XML or DB
  • BuildConfigPath: Mandatory

Conditional values:

  • RootFolder: Mandatory when SourceType = XML
  • SubFolder: Optional

Implementation note:

  • When SourceType = DB, the notebook constant SOURCE_QUERY must be maintained for the source system.

xml_parse.ipynb​

Mandatory values:

  • ParseStage: Filter or Process
  • ParseConfigPath: Mandatory
  • PipelineId: Mandatory
  • PipelineTriggerTime: Mandatory

Conditional values:

  • LineOfBusiness: Mandatory when ParseStage = Process
  • ScenarioId: Pass when process-stage parsing must resolve scenario-specific response rows
  • ExtensionConfigPath: Pass when extension-table parsing is required

scenario_api_build_and_process.ipynb​

Mandatory values:

  • ScenarioId: Mandatory
  • ContextPayloadConfigPath: Mandatory
  • APIThroughputConfigPath: Mandatory
  • PipelineId: Mandatory
  • PipelineTriggerTime: Mandatory

Branch control:

  • CurrentPremiumCheck = Active for the current-premium flow
  • CurrentPremiumCheck = "" for the proposed-premium flow

Conditional values:

  • PreEndPoint: Mandatory for the current-premium flow
  • PostEndPoint: Mandatory for the proposed-premium flow
  • PreEnvironmentId: Pass when current-premium endpoint authentication requires environment lookup
  • PostEnvironmentId: Pass when proposed-premium endpoint authentication requires environment lookup

scenario_data_process.ipynb​

Mandatory values:

  • ScenarioId: Mandatory
  • LineOfBusiness: Mandatory
  • ParseStage: Must be Process
  • PostParseConfigPath: Mandatory
  • APIThroughputConfigPath: Mandatory
  • ContextPayloadConfigPath: Mandatory
  • PostEndPoint: Mandatory
  • PipelineId: Mandatory
  • PipelineTriggerTime: Mandatory

Conditional values:

  • CurrentPremiumCheck = Active when current-premium pre-parse is required
  • CurrentPremiumCheck = "" when only the proposed branch is required
  • PreParseConfigPath: Mandatory when CurrentPremiumCheck = Active
  • PreEndPoint: Mandatory when CurrentPremiumCheck = Active
  • PreEnvironmentId: Pass when current-premium API authentication must be resolved through environment lookup
  • PostEnvironmentId: Pass when proposed-premium API authentication must be resolved through environment lookup