Archiving and Merging OPSLOG Data › Set the Archive Parameters

Set the Archive Parameters

You can set or change the parameters that trigger the archival process after you set up the OPSLOG archive system from the Parameters screen (4.1.1). Restart the ARCH subtask for these changes to take effect.

Consider the following information when you set parameters:

• If you set the ARCHIVETRIG parameter too low (for example, 10 messages), the archival process will create a large number of archives.
• If you set the ARCHIVETRIG and the ARCHIVELIMIT parameters too low, your archives will quickly be overwritten. Only use an archival process that is set up in this way for short-term archiving.
• If you set the ARCHIVETRIG parameter too high, the number of messages could exceed the maximum capacity of the OPSLOG, as specified by the BROWSEMAXINUSE parameter. For example, when BROWSEMAXINUSE = 100,000 and ARCHIVETRIG = 1,000,000, the content of the OPSLOG changes 10 times before the archive is created.

  Important! When the number of messages specified by the ARCHIVETRIG parameter is set too close to the maximum capacity of the OPSLOG, there is a risk that not all your messages will be correctly archived.

• Avoid reusing archives when you set the ARCHIVEHLQ parameter. We recommend that you rename any existing archives or that you change the ARCHIVEHLQ parameter before you start CA OPS/MVS.

Trigger OPSLOG Archival Based on Number of Messages

1. Use the following format to schedule archival based on number of messages (from the CA OPS/MVS Parameters screen (4.1.1)):

   T = OPSPRM_Set("ARCHIVETRIG","n")
   

2. Restart the subtask with the following command

   /F OPSS,RESTART(ARCH)
   

Definitions

n

Specifies the number of messages that accumulate before the archive process starts.

Limits: The number of messages must be in the range 1-4925000.

Example: Trigger Archival After 10,000 Messages

The following example triggers the archive step after 10,000 messages:

T = OPSPRM_Set("ARCHIVETRIG","10000")

Trigger OPSLOG Archival at a Specific Time of Day

1. Use the following format to schedule automated archival based on time of day (from the CA OPS/MVS Parameters screen (4.1.1)):

   T = OPSPRM_Set("ARCHIVETRIG","hh:mm")
   

2. Restart the subtask with the following command

   /F OPSS,RESTART(ARCH)
   

Definitions

hh:mm

Specifies the time of day at which archival begins.

Limits: 00:00-23:59

Example: Trigger Archival at 7:30pm

The following example triggers the archive step at 7:30pm every day:

T = OPSPRM_Set("ARCHIVETRIG","19:30")

Trigger OPSLOG Archival Based on Interval of Time

1. Use the following format to schedule automated archival each time a specific interval of time passes (from the CA OPS/MVS Parameters screen (4.1.1)):

   T = OPSPRM_Set("ARCHIVETRIG","+hh:mm")
   

2. Restart the subtask with the following command

   /F OPSS,RESTART(ARCH)
   

+hh:mm

Specifies the interval of time in hours and minutes.

Limits: The minimum interval is +00:10; the maximum interval is +99:59.

Example: Trigger Archival After 2 Hours, 45 Minutes

The following example triggers the archive process at intervals of 2 hours, 45 minutes:

T = OPSPRM_Set("ARCHIVETRIG","+02:45")

How to Set up the OPSLOG Archive System

To use the OPSLOG archive system, set up the ARCH subtask in your CA OPS/MVS procedures.

Note: It is possible to modify the archive parameters at a later date.

Follow these steps:

1. In the OPS CNTL data set, set the following parameters in OPSSPA00:

   T = OPSPRM_Set("INITARCH","YES")      
   T = OPSPRM_Set ("ARCHIVETRIG", "parameter")
   T = OPSPRM_Set ("ARCHIVEHLQ", "parameter")
   

2. (Optional) You can also set the following parameters:

   T = OPSPRM_Set("ARCHIVEUNIT","parameter")
   T = OPSPRM_Set("ARCHIVESTORCLAS","parameter")
   T = OPSPRM_Set ("ARCHIVEVOLSER","parameter")
   T = OPSPRM_Set ("ARCHIVELIMIT","parameter")
   

3. Restart OPSS for your changes to take effect.

   Note: Look for the following subtask start message in the OPSLOG or syslog to verify that the ARCH subtask is running correctly:

   OPx5002I OPSLOG subtask is active
   

After the ARCH subtask is set up it performs the following actions:

1. Reads the given parameters.
2. Creates a Generation Data Group (GDG).
3. Creates an archive.
4. Updates tracking.

Example

The following examples show the archives that CA OPS/MVS creates if ARCHIVEHLQ is specified as USER.OPSS.NEWARCH:

USER.OPSS.NEWARCH
USER.OPSS.NEWARCH.G0001V00
USER.OPSS.NEWARCH.G0002V00
USER.OPSS.NEWARCH.G0003V00
USER.OPSS.NEWARCH.MODEL

Note: For more information about the modification of archive parameters, see Set the Archive Parameters.

Subtask Messages

The ARCH subtask issues the following OPSLOG messages:

OPx5002I OPSLOG subtask is active
OPx8330I OPSLOG archive creation request processing completed
OPx8320O OPSLOG archive creation completed, MAXRC=O

Note: If a MAXRC <> 0 error message appears in the OPSLOG, see OPSLOG API Return Codes.

If you enter an invalid trigger parameter, the ARCH subtask issues the following message:

OPx8336E ARCHIVETRIG parameter is invalid: "value"

OPSLOG API Return Codes

The OPSLOG API issues the following return codes:

0

No error occurred in processing

1

The OPS/MVS subsys was not found

2

Abend occurred during API processing

3

No parameters were passed to the API

4

A required parameter is missing

5

The control block is invalid

6

The control block is missing

7

Requested function unknown

8

Requested function unknown

9

Requested func/SFNC not yet supported

10

MVS authorization required

11

Authorization check failed

12

OPSLOG to process has invalid format

13

Global filter FREEMAIN failed

14

Conflicting parameters specified

15

Window search routine failed

16

At end of OPSLOG window

17

The request is out of sequence

18

Unable to allocate a DSN OPSLOG

19

Unable to initialize a DSN OPSLOG

20

Unable to unallocate a DSN OPSLOG

21

Unable to terminate a DSN OPSLOG

22

Out of room to add more filter code

23

Out of room to add more filter data

24

Invalid field name in filter/search

25

Numeric value length error

26

TOD of binary value length error

27

Char or hex value length error

28

Invalid operator - filter/search

29

Operator not supported, filter/search

30

Unknown operator - filter/search

31

Invalid connector - filter

32

Global filter GETMAIN failed

33

Archive dataset not allocated

34

Unable to open archive

35

Access parameter invalid

36

LRECL invalid

37

Unable to read archive

38

Unable to write to archive

39

Unable to close archive

40

Buffer length invalid on add request

41

Add to OPSLOG failed

42

Item being added is not an OPMO

43

Add is not allowed to this OPSLOG

44

ARCH IDENT first record not header

45

RQSD func not allowed for this OPSLOG

46

Supplied buffer too small for function

47

Supplied message number too high

48

Supplied message number too low

49

ARMO version is invalid

50

Archive record is not an ARMO

51

Retrieve from OPSLOG failed

52

ARCHIVE DD(OPSARCH) not preallocated

53

Window range has high lower than low

54

Window range is past end of log

55

Window range is before start of log

56

Window hi value past end - hiest set

57

Window low value bfor strt, lowest st

58

Window high near match - closest set

59

Window low near match - closest set

60

Window high & low near - closest set

61

Window is larger than log - set

62

OPSLOG is not a SUBSYS OPSLOG

63

No current position in the OPSLOG

64

Archive DSN not spec'd and no parm

65

Invalid subsystem name

66

Log name specified is not defined

67

Log name specified is not active