69 Starting and Stopping Pipeline Manager

This chapter describes how to start and stop Oracle Communications Billing and Revenue Management (BRM) Pipeline Manager framework components and pipelines.

Customizing the pin_ctl Utility Environment Variables for Pipeline Manager

Some BRM components need environment variables set before starting. You can edit the pin_ctl.conf file to change the environment variables if yours are different from the default settings.

  1. Open the pin_ctl.conf file in BRM_home/bin.

  2. To define environment variables for pipeline registry files, find the following lines:

    # registry details for pipeline services
    aaa env_platform:common env_variable:AAA_REGISTRY env_val:$IFW_HOME/conf/diameter_charge.reg
    rtp env_platform:common env_variable:RTP_REGISTRY env_val:$IFW_HOME/conf/wirelessRealtime.reg
    bre env_platform:common env_variable:BRE_REGISTRY env_val:$IFW_HOME/conf/wireless.reg
    
  3. Add the following line for each pipeline component that uses a registry file:

    component env_platform:common env_variable:registry_variable env_val:$IFW_HOME/registry_file
    

    where:

    • component is the pipeline component name.

    • registry_variable is the environment variable to set before starting component. The syntax for pipeline registry environment variables is *_REGISTRY.

    • registry_file is the path and file name for the pipeline registry file.

    For example:

    aaa env_platform:common env_variable:AAA_REGISTRY env_val:$IFW_HOME/conf/diameter_charge.reg
    
  4. Save and close the file.

Starting Pipeline Manager Components by Using pin_ctl

To add a custom Pipeline Manager component to the components list, use the :pipeline parameter. For example:

4 bre_custom:pipeline

To start a BRM component by using the pin_ctl utility:

  1. Edit the BRM_home/bin/pin_ctl.conf configuration file.

  2. Copy the pipeline_home/bin/ifw binary file to pipeline_home/bin/component, where component is the pipeline component name.

  3. Go to the BRM_home/bin directory.

  4. Run the pin_ctl utility with the start action:

    pin_ctl start component
    

    where component is the component you want to start.

Starting and Stopping Pipeline Manager Manually

You can stop and start Pipeline Manager by using the command line instead of by using the pin_ctl utility.

Note:

If you start Pipeline Manager manually, you cannot use the pin_ctl utility to control Pipeline Manager (for example, to stop it or to get the status).

Starting Pipeline Manager

You start an instance of Pipeline Manager by using the following command from the pipeline_home directory:

bin/ifw -r RegistryFile

where RegistryFile is the name of the registry file.

Note:

If Pipeline Manager cannot establish a connection with the Pipeline Manager database (most likely because the database is down), you receive an error message and the Pipeline Manager startup is canceled.

The general syntax for the ifw command and parameters is:

ifw  -r RegistryFile | -h | -v [-r RegistryFile] 

where:

-r RegistryFile

Starts Pipeline Manager with the specified registry file.

-h

Displays the syntax and parameters.

-v  [-r RegistryFile]

Displays the version of Pipeline Manager. If you use the -r parameter, it also displays the version and name of data and function modules. For example:

ifw -v -r conf/wireless.reg
Module ifw.DataPool.Listener.Module Name: DAT_Listener, Version: 10010

Pipeline Manager displays Ready for processing when startup procedures are completed.

Stopping Pipeline Manager

You stop Pipeline Manager by using the following semaphore entry:

ifw.Active = FALSE

Starting and Stopping Individual Pipelines

When you start Pipeline Manager, the Controller starts all pipelines. However, you can stop or restart individual pipelines by using semaphores.

Note:

When a pipeline cannot establish a connection with the Pipeline Manager database (most likely because the database is down), you receive an error message and the pipeline startup is canceled.

To start an individual pipeline, use the following semaphore entry:

ifw.Pipelines.PipelineName.Active = True

where PipelineName is the name of the pipeline.

To stop an individual pipeline, use the following semaphore entry:

ifw.Pipelines.PipelineName.Active = False

where PipelineName is the name of the pipeline.

If files are added to the input directory after a pipeline is stopped and before it is restarted, the files are processed in order based on their last modified timestamp.

Note:

Pipeline Manager includes a set of Perl scripts, and associated semaphore files, that you can use to start and stop various types of pipelines and perform other system administration tasks. See "Using Perl Scripts to Start and Stop Pipeline Manager".

Restarting Pipeline Manager after an Abnormal Shutdown

Some modules track data in data files. If an abnormal shutdown occurs, you must delete the data files that were in progress when the shut-down occurred.

Using Perl Scripts to Start and Stop Pipeline Manager

Pipeline Manager includes a set of Perl scripts, and associated semaphore files, that you can use to start and stop various types of pipelines and perform other system administration tasks.

Table 69-1 describes the files and scripts used for starting and stopping pipelines:

Table 69-1 Scripts for Starting and Stopping Pipelines

Semaphore and Perl script file names Description

start_all_pipeline.reg

start_all_pipeline.pl

Starts all pipelines configured in the start_all_pipeline.reg semaphore file. By default, this list includes these pipelines:

  • ALL_RATE

  • PRE_RECYCLE

  • PRE_PROCESS

  • ALL_BCKOUT

  • ALL_RERATE

If you add custom pipelines, add their names to the semaphore file according to the default examples.

Important:

  • Do not run rating pipelines (ALL_RATE, PRE_RECYCLE, and PRE_PROCESS) at the same time that you run the rerating pipeline (ALL_RERATE). Edit the script to specify which pipeline to run.

  • Before running ALL_RERATE, ensure that the backout pipeline (ALL_BCKOUT) has processed all EDRs that were extracted by the Event Extraction tool.

start_all_rate.reg

start_all_rate.pl

Starts the ALL_RATE pipeline.

start_DiscountPipeline.reg

start_DiscountPipeline.pl

Starts the discount pipeline (DiscountPipeline).

start_main_stop_rerating.reg

start_main_stop_rerating.pl

Starts these pipelines:

  • PRE_PROCESS

  • PRE_RECYCLE

  • ALL_RATE

Stops these pipelines:

  • ALL_BCKOUT

  • ALL_RERATE

start_pre_process.reg

start_pre_process.pl

Starts the preprocessing pipeline (PRE_PROCESS).

start_pre_recycle.reg

start_pre_recycle.pl

Starts the pre-recycle pipeline (PRE_RECYCLE).

start_RealtimePipelineGPRS.reg

start_RealtimePipelineGPRS.pl

Starts the real-time GPRS pipeline (RealtimePipelineGPRS).

start_RealtimePipelineGSM.reg

start_RealtimePipelineGSM.pl

Starts the real-time GSM pipeline (RealtimePipelineGSM).

start_RealtimePipelineZone.reg

start_RealtimePipelineZone.pl

Starts the real-time zoning pipeline (RealtimePipelineZone).

start_recycle.reg

start_recycle.pl

Starts recycling rejected CDRs.

start_rerating_stop_main.reg

start_rerating_stop_main.pl

Stops these pipelines:

  • ALL_RATE

  • PRE_RECYCLE

  • PRE_PROCESS

Starts these pipelines:

  • ALL_BCKOUT

  • ALL_RERATE

stop_all_pipeline.reg

stop_all_pipeline.pl

Stops all the pipelines configured in the stop_all_pipeline.reg semaphore file. By default, this list includes these pipelines:

  • ALL_RATE

  • PRE_RECYCLE

  • PRE_PROCESS

  • ALL_BCKOUT

  • ALL_RERATE

If you add custom pipelines, add their names to the semaphore file according to the default examples.

stop_all_rate.reg

stop_all_rate.pl

Stops the ALL_RATE pipeline.

stop_DiscountPipeline.reg

stop_DiscountPipeline.pl

Stops the discount pipeline (DiscountPipeline).

stop_pre_process.reg

stop_pre_process.pl

Stops the preprocessing pipeline (PRE_PROCESS).

stop_pre_recycle.reg

stop_pre_recycle.pl

Stops the pre-recycle pipeline (PRE_RECYCLE).

stop_RealtimePipelineGPRS.reg

stop_RealtimePipelineGPRS.pl

Stops the real-time pipeline for GPRS (RealtimePipelineGPRS).

stop_RealtimePipelineGSM.reg

stop_RealtimePipelineGSM.pl

Stops the real-time pipeline for GSM (RealtimePipelineGSM).

stop_RealtimePipelineZone.reg

stop_RealtimePipelineZone.pl

Stops the real-time pipeline for zoning (RealtimePipelineZone).