Customizing the Control-M Active Environment Screen

Display types for Control‑M Active Environment screens can be customized for local language, local site terminology, ease of use, and so on, using the following methods:

• Modifying the $$ACT Member: This is the preferred method. By modifying member $$ACT in the IOA MSGENG, you can modify the following screens:

  • Screen 3

  • Screen 3.N

  • Screen 3.G

  • History screen

• Modifying Definitions in Members Containing Assembler Macro Instructions: This is the standard method. By modifying definitions in members containing Assembler macro instructions, which must be assembled and link-edited to create a CSECT and module with a name identical to the screen member name. For more information, see IOA Administration.

Modifying the $$ACT Member

This method is similar to customizing IOA display format members. For more information regarding the Display Type facility, see the topic about customizing IOA display format members in see IOA Administration.

Before changing this member, review member $$ACTDOC in the IOA MSGENG library.

The $$ACTDOC member contains four sections, each of which describes how to change parts of each screen display:

• Screen Fields: For improving and customizing display types (header and bottom line fields, and job related fields).

• Status Area Color: For changing the color of jobs according to their status.

• Filter Fields: For creating and modifying filters.

• CLASS of Bottom Lines: For changing the primary and/or bottom lines on each screen (that is, Active, Net, Group, and History).

Note: If Control‑M/Enterprise Manager is installed at your site, care must be taken when changing the constants Filter and Order-ID. The Control‑M/Enterprise Manager KSL (ECSKSL) accesses these constants, and if they are changed (for example, making all letters uppercase), KSL must be changed as well.

Modifying Definitions in Members Containing Assembler Macro Instructions

The following sections list the available definitions that you can modify:

• Screen Fields

• Color Fields

• Filter fields

• CLASS of Bottom Lines

Screen Fields

The following tables list the fields that can be displayed in the Active Environment screen (Screen 3). Header line and bottom line fields do not vary by display type. Job related fields do vary by display type.

Table 332 Header and Bottom Line Fields

Field Name	Field Length	Where Used (As supplied)	Details
ACTAFILT	9	Title line	Active filter.
ACTBTIM	8	Bottom line	Current time.
ACTCPID	4	Unused	CPU-ID where the user is working
ACTDTYP	3	Title line	Current Display Type.
ACTTDIS	7	Title line	Display mode (Active, History, Network, or Group) In History mode, the word History is displayed in red.
ACTTIND	7	Title line	Dump ON indication. In regular mode, it contains only dashes. If the Dump status is ON, the text ‘DUMP ON’ is displayed in red.
ACTTITL	7	Title line	Display details (Environment, memname).
ACTTMST	4	Title line	Control‑M status (UP, DOWN).
ACTTUPD	8	Unused	Last time the Refresh NET was handled.

Table 333 Job Related Fields

Field Name	Field Length	Where Used (As supplied)a	Details
ACTDDIN	4	<A> <N>	DUE IN.
ACTDDUT	4	<A> <N>	DUE OUT.
ACTDGRP	20	<A>	Group. (Also displayed in the STATUS field if command Group was issued.)
ACTDING	1	<A>	IN SMART Table indicator (T, _). ‘T’ indicates a SMART Table Entity or a job ordered in a SMART Table.
ACTDJNM	16	<A> <D>	Job name/Job ID.
ACTDLAT	1	<A> <N>	Late indicator (Input, eXecuting/Out).
ACTDLPS	4	<A> <N>	Job average elapsed time.
ACTDMCC	24	<A>	Max-RC (STEP.PROC).
ACTDNAM	8	<A> <D>	Job MEMNAME.
ACTDNNA	27	<N>	Nesting Level & Name of job. This field is meaningful only under NET display. The Root job is displayed in the left-most position. Successor and predecessor jobs are aligned to the right according to level. Example: 2   Pred2 1      Pred1 =>         Root +1            Succ1 +2               Succ2
ACTDNNM	27	Unused	Nesting Level & Name of job. This field is meaningful only under NET display. The Root job is centered. Predecessor jobs are aligned to the left and successor jobs are aligned to the right according to level, for example: 2   Pred2 1      Pred1 =>         Root +1            Succ1 +2               Succ2
ACTDNOD	8	Unused	NJE Node ID.
ACTDODT	6	<A> <D>	Job ODATE.
ACTDORD	5	<A>	Order-ID. (Also displayed in the STATUS field if command ORDER was issued.)
ACTDOWN	8	<A> <D>	Job owner.
ACTDPRI	2	<A> <N>	Job Priority.
ACTDRBA	6	<A>	Job’s RBA in the AJF.
ACTDRES	1	<A> <N>	Resource use indicator (Y, _). NET display: Quantitative or Control resource. All other displays: In Condition, Out Condition, Quantitative Resource or Control Resource.
ACTDRUN	5	Unused	Run number.
ACTDTMF	4	<A>	Time FROM.
ACTDTMU	4	<A>	Time UNTIL.
ACTJTYP	3	<A> <D>	Task type.
ACTSTAT	288	<A> <D> <N>	Jobs status. Multiple line field composed of 9 sub-fields, each of which is 31 characters with one blank at the end. Under <N>, only the first 16 bytes are displayed.

a <A>, <D> and <N> represent DI A, DI D and DI N, respectively.

Color Fields

The following table lists the fields that affect the color of the status area (field ACTSTAT). To change a color for a specific status, modify the appropriate field in the "General Constants" part of the $$ACT member. Only the following fields impact the color of the status area; all other fields in the "General Constants" part do not affect the color of the status area.

Table 334 Color Fields

Field Name	Field Length	Current Color	Value of the Field
$677	10	GREEN	Ended OK
$810	9	GREEN	Forced OK
$WRE	12	YELLOW	Wait Release
$REL	8	YELLOW	Released
$671	15	YELLOW	Wait Submission
$672	14	YELLOW	Wait Execution
$673	9	YELLOW	Executing
$687	9	YELLOW	Submitted
$695	14	YELLOW	Going to Start
$697	7	YELLOW	Started
$807	15	YELLOW	In Output Queue
$808	7	YELLOW	NJE Job
$809	20	YELLOW	NJE Job (ID changed)
$811	6	YELLOW	Active
$801	17	PINK	Wait Confirmation
$NF1	13	PINK	Not found
$692	15	RED	Ended Not OK
$682	23	RED	Failed - Reason Unk
$674	23	RED	Problems Reading Sysout
$679	13	RED	Not Submitted
$680	11	RED	Disappeared
$LTE	16	RED	(Late Executing)
$LAT	6	RED	(Late)
$LTS	17	RED	(Late Submission)
$696	11	RED	Not Started
$804	14	RED	Term - Stop job
$812	10	RED	In Error

Filter fields

Predefined and user-defined filters are composed of various fields. The following table lists all the fields that can be specified as part of such filters:

Table 335 Filter Fields

Field Name	Field Length	Used For
SACTSM1	8	1st Memname
SACTSM2	8	2nd Memname
SACTSM3	8	3rd Memname
SACTSM4	8	4th Memname
SACTSM5	8	5th Memname
SACTGR1	20	1st Group
SACTGR2	20	2nd Group
SACT700	1	‘In Process’ Y/N
SACT701	1	‘Ended’ Y/N
SACT702	1	‘State’ Y/N
SACT703	1	‘Wait Sched’ Y/N
SACT704	1	‘Ended "OK"’ Y/N
SACT705	1	‘Free’ Y/N
SACT723	1	‘Wait Confirm’ Y/N
SACT707	1	‘Not OK’ Y/N
SACT708	1	‘Held’ Y/N
SACT706	1	‘Wait SUB’ Y/N
SACT710	1	‘Rerun’ Y/N
SACT711	1	‘On Request’ Y/N
SACT709	1	‘Submitted’ Y/N
SACT713	1	‘Disappeared’ Y/N
SACT714	1	‘Deleted’ Y/N
SACT712	1	‘Wait Exec’ Y/N
SACT716	1	‘Abended’ Y/N
SACT715	1	‘Executing’ Y/N
SACT719	1	‘Unexpected CC’ Y/N
SACT718	1	‘On Output Queue’ Y/N
SACT722	1	‘JCL Error’ Y/N
SACTTPJ	1	‘Job’ Task Type Y/N
SACTTPC	1	‘Cyc’ Task Type Y/N
SACTTPE	1	‘Emr’ Task Type Y/N
SACTTPS	1	‘Stc’ Task Type Y/N
SACTTPD	1	‘Cst’ Task Type Y/N
SACTTPY	1	‘Est’ Task Type Y/N
SACTTPX	1	‘Ecj’ Task Type Y/N
SACTTPZ	1	‘Ecs’ Task Type Y/N
SACTTPW	1	‘Wrn’ Task Type Y/N
SACTTPG	1	‘Grp’ Task Type Y/N
SACTRE1	20	1st Resource
SACTRE2	20	2nd Resource
SACTRIN	1	‘In’ Res Type Y/N
SACTROU	1	‘Out’ Res Type Y/N
SACTRCO	1	‘Conds’ Res Type Y/N
SACTRRS	1	‘Resource’ Res Type Y/N
SACTRCN	1	‘Control’ Res Type Y/N
SACTUI1	8	1st Owner
SACTUI2	8	2nd Owner
SACTUI3	8	3rd Owner
SACTUI4	8	4th Owner
SACTUI5	8	5th Owner
SACTPRI	2	Priority

CLASS of Bottom Lines

Each display has its own Primary and Alternate bottom lines. The Primary bottom line is always the first bottom line displayed when entering the screen. Command OPT toggles between the Primary and the Alternate bottom lines. As supplied, the Primary bottom line lists, beneath the display, the most important, valid options and commands. The Alternate bottom lines list all the valid options and commands beneath the display.

The CLASS of the @STYLE section that defines the bottom lines determines the appropriate Primary and Alternate bottom lines in each display (History, Net, and so on).

The following table lists the CLASS of Primary & Alternate bottom lines for each display, with and without Control‑M/Restart installed:

Table 336 CLASS of Primary and Alternate Bottom Lines

Display	CLASS with Control‑M/Restart		CLASS without Control‑M/Restart
	Alternate	Primary	Alternate	Primary
Active	A	1	A	2
Net	B	1	B	2
Group	B	1	B	2
History	A	3	N/A