Property	Value
SubType	Transform Function
Category	KimD
Author	Kim Duke
Arg Count	2
Version	2.0.0
Routine Type	0
Short Description	Last Changed: 07-02-2004
Long Description	Routine: KgdFixLongDescRtn ------------------------------------------------------------------------------------- Non-technical description: tbd ------------------------------------------------------------------------------------- Arguments: 1. RoutineName 2. OverWriteFlag ------------------------------------------------------------------------------------- Modification History: ------------------------------------------------------------------------------------- UserId Date Version Modification Description ------------------------------------------------------------------------------------- kduke 07-02-2004 1 Created job. -------------------------------------------------------------------------------------

Argument	Description
RoutineName
OverWriteFlag

LineNo	Source Code
1	FUNCTION KgdFixLongDescRtn(RoutineName,OverWriteFlag)
2	* -----------------------------------------------------------------
3	* KgdFixLongDescRtn(RoutineName,OverWriteFlag)
4	* Decription: Generate a long description for a routine.
5	* Written by: Kim Duke
6	* Notes:
7	* -----------------------------------------------------------------
8	* $INCLUDE DSINCLUDE JOBCONTROL.H
9	Ans = RoutineName:' not updated.'
10	ThisRoutineName = "KgdFixLongDescRtn"
11	Usage = RoutineName:'(RoutineName,OverWriteFlag)'
12	* ----------------------------------------------------------------------
13	* initialize variables
14	* ----------------------------------------------------------------------
15	True = 1
16	False = 0
17	other = True
18	Forever = True
19	today = oconv(@DATE, "D4-")
20	vm = @VM
21	svm = @SVM
22	fm = @AM
23	ErrMsg = ''
24	nullRec = ''
25	CrLf = char(13):char(10)
26	Dashes = str('-',85)
27	Cnt = 0
28	ShortDescAttr = 4
29	LongDescAttr = 5
30	ArgAttr = 43
31	* ----------------------------------------------------------------------
32	* open files
33	* ----------------------------------------------------------------------
34	FileName = 'DS_ROUTINES'
35	open FileName to FilePtr else
36	ErrMsg = 'Can not open ':FileName:' file.'
37	goto ErrRtn
38	end
39	DsRoutinesPtr = FilePtr
40	* ----------------------------------------------------------------------
41	* main
42	* ----------------------------------------------------------------------
43	if RoutineName = '' then
44	ErrMsg = Usage
45	goto ErrRtn
46	end
47	OldRoutineName = ''
48	* ----------------------------------------------------------------------
49	read RoutineRec from DsRoutinesPtr, RoutineName then
50	RoutineCategory = RoutineRec<3>
51	OldRoutineRec = RoutineRec
52	ShortDesc = 'Last Changed: ':today
53	NewRec = ''
54	NewRec<1,-1> = 'Routine: ':RoutineName
55
56	NewRec<1,-1> = Dashes
57	NewRec<1,-1> = 'Non-technical description:'
58	NewRec<1,-1> = 'tbd'
59
60	NewRec<1,-1> = Dashes
61	NewRec<1,-1> = 'Arguments: '
62	NoOfArgs = dcount(OldRoutineRec<ArgAttr>, @VM)
63	if NoOfArgs > 0 then
64	for i=1 to NoOfArgs
65	NewRec<1,-1> = i:'. ':OldRoutineRec<ArgAttr, i>
66	next i
67	end else
68	NewRec<1,-1> = 'None'
69	end
70
71	NewRec<1,-1> = Dashes
72	NewRec<1,-1> = 'Modification History: '
73	NewRec<1,-1> = Dashes
74	NewRec<1,-1> = 'UserId Date Version Modification Description '
75	NewRec<1,-1> = Dashes
76	NewRec<1,-1> = 'kduke ': today :' 1 Created job. '
77	NewRec<1,-1> = Dashes
78	NewRec<1,-1> = " "
79
80	print " "
81	print "ShortDesc:"
82	print Dashes
83	print ShortDesc
84	print " "
85	print Dashes
86	print "LongDesc:"
87	NoOfLines = dcount(NewRec<1>, @VM)
88	for i=1 to NoOfLines
89	print NewRec<1, i>
90	next i
91	print
92	print
93
94	if RoutineRec<ShortDescAttr> = '' or OverWriteFlag then
95	RoutineRec<ShortDescAttr> = ShortDesc
96	end else
97	print RoutineName:' has short description.'
98	end
99	if RoutineRec<LongDescAttr> = '' or OverWriteFlag then
100	RoutineRec<LongDescAttr> = ereplace(NewRec<1>, @VM, CrLf)
101	end else
102	print RoutineName:' has long description.'
103	end
104	if OldRoutineRec <> RoutineRec then
105	* ----------------------------------------------------------------------
106	write RoutineRec on DsRoutinesPtr, RoutineName
107	Ans = 'Updated ':RoutineName
108	end else
109	Ans = RoutineName:' not updated.'
110	end
111	end else
112	ErrMsg = RoutineName:' not in DS_ROUTINES.'
113	goto ErrRtn
114	end
115	goto TheEnd
116	* ----------------------------------------------------------------------
117	ErrRtn:
118	print
119	print ErrMsg
120	Ans = ErrMsg
121	* ----------------------------------------------------------------------
122	TheEnd:
123
124	RETURN(Ans)