# Modifying the board keyword file

NMS OAM uses board keyword files to load and initialize all AG and CG boards in your system. If you are running NaturalFax on a QX 2000-based system, no modifications are necessary. If you have a combination of QX and AG boards in your system, you need to modify only the AG board keyword file.

To use NaturalFax in your AG- or CG-based system, modify the board keyword files to:

- Explicitly allocate the DSPs on the board to perform fax functions.

- Specify the NaturalFax runtime software to be downloaded at board initialization.

Use the sample board keyword files provided with NaturalFax as models. Choose a board keyword file that corresponds to the AG and/or CG hardware installed in your system.

For more information about... | Refer to...
--- | ---
Fax performance | Strategies for optimizing performance.
NMS OAM | The NMS OAM System User's Manual.
The keywords specified for each board | The board-specific installation and developer's manual.

The NMS OAM configuration files invoke the board keyword files. The NMS OAM configuration files are located in the following directories:

Operating system | Directory
Windows | \nms\ag\cfg \nms\oam\cfg
UNIX | /opt/nms/ag/cfg /opt/nms/oam/cfg

The following table lists some of the sample board keyword files for boards that support NaturalFax.

Note: These board keyword files are valid for both CompactPCI and non-CompactPCI boards. When using the NMS OAM configuration file on a CompactPCI board, change the product name in the file to the board name (for example, AG_2000C, AG_4040C).

Board | Board keyword file | Description | NMS OAM configuration file
--- | --- | --- | ---
AG 2000/200 AG 2000/400 | agpi2fax.cfg | mu-law fax transmit and receive configuration file | ag2fax_oamsys.cfg
agpi2faxa.cfg | A-law fax transmit and receive configuration file | ag2fax_oamsys.cfg
AG 2000-BRI | agpi2bri_fax.cfg | mu-law fax transmit and receive configuration file | ag2brifax_oamsys.cfg
agpi2bri_faxa.cfg | A-law fax transmit and receive configuration file | ag2brifax_oamsys.cfg
AG 4000/800, AG 4040/800 | agpi4_8fax.cfg | mu-law fax transmit and receive configuration file | ag4fax_oamsys.cfg
agpi4_8faxa.cfg | A-law fax transmit and receive configuration file | ag4fax_oamsys.cfg
AG 4000/1600, AG 4040/1600 | agpi4fax.cfg | mu-law fax transmit and receive configuration file | ag4fax_oamsys.cfg
agpi4faxa.cfg | A-law fax transmit and receive configuration file | ag4fax_oamsys.cfg
AG 4000/3200, AG 4040/3200 | agpi4dfax.cfg | mu-law fax transmit and receive configuration file | ag4dfax_oamsys.cfg
agpi4dfaxa.cfg | A-law fax transmit and receive configuration file | ag4dfax_oamsys.cfg
CG 6000 | cgfax.cfg | mu-law fax and IVR configuration file | cgfax_oamsys.cfg
cgfaxa.cfg | A-law fax and IVR configuration file | cgfax_oamsys.cfg
cgfax_t37.cfg | mu-law fax and VoIP configuration file | cgfax_oamsys.cfg
cgfaxa_t37.cfg | A-law fax and VoIP configuration file | cgfax_oamsys.cfg
cgfax_t37t38.cfg | mu-law fax, T.38 (FoIP) and one complex vocoder configuration file | cgfax_oamsys.cfg
cgfaxa_t37t38.cfg | A-law fax, T.38 (FoIP) and one complex vocoder configuration file | cgfax_oamsys.cfg
CG 6100C/1000 | c61f1016.cfg | A-law/mu-law fax transmit and receive configuration file | cg61fax_oamsys.cfg
CG 6100C/2000 | c61if208.cfg c61mf208.cfg | A-law/mu-law fax transmit and receive configuration file | cg61fax_oamsys.cfg
CG 6100C/3600 | c61if3016.cfg c61mf3016.cfg | A-law/mu-law fax transmit and receive configuration file | cg61fax_oamsys.cfg
CG 6500C | cg65fax.cfg | mu-law fax and IVR configuration file | cg65fax_oamsys.cfg
cg65faxa.cfg | A-law fax and IVR configuration file | cg65fax_oamsys.cfg
QX 2000 | None. | Not required | None.

## Configuring AG boards

Complete the following steps to modify the board keyword file to run NaturalFax on AG boards:

Step | Action
1 | Verify that the DLMFiles keyword includes ag2fax.leo: DLMFiles[x] = ag2fax.leo
2 | Verify that the DSP.C5x[x].Image keyword includes the following files: For mu-law: DSP.C5x[x].Image = ag2fax.c54 For A-law: DSP.C5x[x].Image = ag2faxa.c54
3 | Save the changes to the board keyword file and exit the text editor.
4 | Run NMS OAM to configure and initialize the AG board(s) as specified in the oamsys.cfg file.
5 | Refer to the sample board keyword files for AG 2000 and AG 4000 boards. Note: For AG 4040 boards, refer to the AG 4040 Installation and Developer's Manual.

## Configuring CG boards

Complete the following steps to modify the board keyword file to run NaturalFax on CG boards:

Step | Action
1 | Verify that the DLMFiles[x] keyword includes the cg6fax or ppcfax file. For CG 6000/C and CG 6100C boards: DLMFiles[x] = cg6fax For CG 6500C boards: DLMFiles[x] = ppcfax
2 | Verify that the DSP.C5x[x].Files keyword identifies nmsfax as one of the data processing modules (DPMs) loaded on specific DSPs. The following example is for a CG 6000 board: DSP.C5x[1..31].Files = nmsfax voice tone dtmf echo callp ptf mf
3 | Verify that the Resource[0].Definitions keyword identifies nmsfax as one of the data processing functions (DPFs) loaded on the DSPs. The following example is for a CG 6000 board: Resource[0].Definitions = (nmsfax | (dtmf.det_all & ptf.det_2f & voice.rec_24 & (voice.play_24_100 | tone.gen)))
4 | Save the changes to the board keyword file and exit the text editor.
5 | Run NMS OAM to configure and initialize the CG board or boards as specified in the oamsys.cfg file.

For more information, refer to the Sample board keyword files.