Literal Externalization

Objectives

Hard-coded literals, regardless of the implementation language, represent data that, in many cases, should be stored in tables or files. Exposing this hard-coded data and moving this data into a format that is more maintainable and modifiable is the goal of this task. Objectives specifically include:

· Identifying and grouping all hard-coded literals

· Assessing and externalizing hard-coded literals in order to simplify maintenance and improve user responsiveness

· Uncoupling data from embedded, implementation based representations

Entrance Criteria

The entrance criteria for the literal externalization task are listed below.

· A requirement to identify and externalize hard-coded literals

· Completion of the environmental analysis task

· Completion of the data definition analysis of the technical assessment component of the Inventory/Analysis stage

· Completion of the application staging process for system components as listed under input requirements

Roles/Skills

The personnel and skill requirements necessary to meet the literal externalization task objectives are identified below.

· Data Definition Analyst

- Expertise in analyzing and extracting embedded literals

· Current Systems Expert

- Knowledge of existing system data as designed, used and implemented

· Data Administrator/DBA

- Knowledge of data usage procedures and standards for the application area and the organization

· Systems Programmer

- Security access to physical system objects

· Metrics analyst

- Analyst conversant with metric tools and interpretation for source language type(s)

Input Requirements

The system components and related inputs required to initiate and complete the literal externalization task are listed below.

· Program and Copy source code for the systems of interest

· Data definition standardization control log Form 023

· Inventory lists and cross reference reports created in the environmental analysis

· Positioning work plan Form 020

· Record grouping reports created in the data definition analysis task

· Data definition analysis results recorded on Form 003C

· Pertinent data administration standards

Tool/Technology Support

Technologies supporting the literal externalization task include data definition analyzer, spreadsheet, word processing, program editor, compiler/preprocessor and comparator tools. These tools are used to represent information as required by this task.

Data Definition Analyzer

The primary requirement of this tool in this task is to analyze, group and report on Procedure Division literals across an application.

Spreadsheet

Spreadsheet tools offer a convenient format for recording much of the information gathered throughout this stage. Referenced Comsys-TIM Forms have been pre-loaded into certain spreadsheet tools to facilitate data entry and analysis. While highly desirable, spreadsheets are not essential to this task.

Word processor

In the absence of a spreadsheet tool, this is required to update Forms.

Program editor

An on-line facility capable of serving as a source code editor to make modifications required by this task . Use a program editor appropriate to the environment.

Compiler/preprocessors

A source language compiler/preprocessor is required to parse source code and convert it into machine executable instructions. This compilation process identifies many types of errors, and requires their correction before it will complete successfully.

Comparator

This tool is used to identify changes made to source code by comparing the input programs line by line and producing listings of any differences it finds.

Task Steps

The literal externalization task is comprised of the following task steps:

Perform Literal Group Analysis
Create Tables from Literals
Externalize Embedded Literals