IBM Support

PI09318: FILEWATCH SUPPORT FOR TWS AGENT FOR Z/OS

A fix is available

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as unreproducible in next release.

Error description

  • FILEWATCH Support for TWS agent for z/OS
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All TWS user using the TWS for z/OS Agent    *
    *                 FUNCTION=DDRIVEN                             *
    ****************************************************************
    * PROBLEM DESCRIPTION: This PTF imports on the TWS Agent       *
    *                      for zOS the HFS and ZFS File Watch      *
    *                      feature present on TWS for zOS.         *
    ****************************************************************
    * RECOMMENDATION: APPLY THE PTF FIXING THIS APAR               *
    ****************************************************************
    The PTF import on the TWS Agent for z/OS the HFS and ZFS
    File Watch feature already present on TWS for z/OS.
    

Problem conclusion

  • The following documentation must be updated
    +--------------------------------------------------------------+
    |                                                              |
    |TITLE:  IBM TIVOLI WORKLOAD SCHEDULER FOR Z/OS,               |
    |INSTALLATION GUIDE.                                           |
    |                                                SC27-2771-00  |
    |                                                SC27-2771-01  |
    |                                                SC27-2771-02  |
    |                                                              |
    |Chapter 3. Using                                              |
    |                                                              |
    |Add the following paragraph:                                  |
    |                                                              |
    |HFS or ZFS file triggering                                    |
    |                                                              |
    |The APAR PI09318 has introduced the filewatch utility on the  |
    |TWS agent for z/OS you find this utility as load-module       |
    |EELFLWAT in the SEELLMD0 library. You can use it to check for |
    |file system changes of HFS or ZFS files and directories, for  |
    |example when you want to make sure that a file exists before  |
    |running a job that processes that file. By defining a job that|
    |runs this utility, you can implement file dependency, that is |
    |a relationship between a file and an operation in which       |
    |specific activity on the file determines the starting of the  |
    |operation. For example, you can define the job that runs      |
    |EELFLWAT as predecessor of the operation depending on the     |
    |file.                                                         |
    |The user running EELFLWAT must have execute (x) access to the |
    |directory path that contains files to be monitored.           |
    |The SEELSAMP library contains EELFLWAS member as sample JCL   |
    |to call the file watching utility.                            |
    |                                                              |
    |Syntax                                                        |
    |As shown in the EELFLWAS member of the SEELSAMP library, the  |
    |following format is supported for the parameter of the EXEC   |
    |statement that specifies                                      |
    |PGM=EELFLWAT:                                                 |
    |//FLWATCH EXEC PGM=EELFLWAT,PARM= ENVAR()/-c condval -dea     |
    |  deadline                                                    |
    |// -fi file_path -i interval -r rc -t trace_level             |
    |Consider that:                                                |
    |- No continuation character is used. To continue the PARM     |
    |  field, interrupt it at column 72 and continue in column     |
    |  16 of the next card.                                        |
    |- Separate arguments and values by using a blank character.   |
    |- Use ENVAR() to pass environment variables to EELFLWAT.      |
    |- EELFLWAT returns messages and trace information (if         |
    |  required) in the log of the job used to run the utility.    |
    |  If you use the job log retrieval function, set to Y the     |
    |  User Sysout field in the cleanup options at operation       |
    |  level, both in the database and in the current plan.        |
    |- The arguments are not positional.                           |
    |- You can use an abbreviated format for all the arguments.    |
    |  Generally you can truncate the arguments to any position    |
    |  following the first character, except for deadline that     |
    |  requires at least three characters.                         |
    |                                                              |
    |Arguments                                                     |
    |                                                              |
    |-condition | -c                                               |
    |  The condition to be checked. Valid values are:              |
    |  wcr | waitCreated                                           |
    |  Waits until the file exists. If the file already exists,    |
    |  filewatch exits immediately. If -filename argument specifies|
    |  a directory, the process waits until the directory exists   |
    |  and contains a new file.                                    |
    |                                                              |
    |  wmr | waitModificationRunning                               |
    |  Waits until the file size or modification time changes. If  |
    |  -filename argument specifies a directory, the process waits |
    |  until the size or earlier file modification time changes,   |
    |  when a file is created, modified, or deleted.               |
    |                                                              |
    |  wmc | waitModificationCompleted                             |
    |  Checks that the file size or modification time stopped      |
    |  changing, meaning that filewatch waits for three search     |
    |  intervals without any change. If -filename argument         |
    |  specifies a directory, the process checks the size or the   |
    |  earlier file modification time change, for example if the   |
    |  number of directory files and the earlier file              |
    |  modification time does not change within three search       |
    |  intervals.                                                  |
    |                                                              |
    |  wmrc | waitModificationRunningCompleted                     |
    |  Waits until the file size or modification time changes and  |
    |  stops changing, meaning that, after the first change,       |
    |  filewatch waits for three search intervals without any      |
    |  further change. If -filename argument specifies a           |
    |  directory, the process checks the size or the earlier file  |
    |  modification time change, for example if the number of      |
    |  directory files and the earlier file modification time does |
    |  not change within three search intervals.                   |
    |                                                              |
    |  wdl | waitDelete                                            |
    |  Stops running when the file is deleted. If -filename        |
    |  argument specifies a directory, the process waits until a   |
    |  file is deleted from the directory.                         |
    |                                                              |
    |-deadline | -dea                                              |
    | The deadline period, expressed in seconds. The allowed       |
    | formats are:                                                 |
    | - An integer in the range 0 to 31536000 (the upper value     |
    |   corresponds to one year). To have filewatch performing an  |
    |   indefinite loop, specify 0.                                |
    | - hh:mm:ss, in the range 00:00:01 to 24:00:00, to select a   |
    |   time within the same day when filewatch started.           |
    |   It corresponds to the GMT value. To specify a value        |
    |   different from the GMT, use the ENVAR parameter as shown   |
    |   in  Example  on page 458. For details about setting the TZ |
    |   environment variable, refer to the UNIX System Services    |
    |   Command Reference.                                         |
    |                                                              |
    |-filename | -fi                                               |
    | The file path to be processed. You can embed blank or special|
    | characters, by using double quotes. Wildcard characters are  |
    | not supported. To include more files in the monitoring       |
    | process, you can store those files in a specific directory   |
    | and use a file path specifying that directory.               |
    |                                                              |
    |-interval | -i                                                |
    | The file search interval, expressed in seconds. Specify an   |
    | integer in the range:                                        |
    |  - 5 3600 when specifying wcr or wdl as condition value.     |
    |  - 30 3600 otherwise.                                        |
    |The default is 60.                                            |
    |                                                              |
    |-returncode | -rc                                             |
    | The exit return code, if the file is not found by the        |
    | deadline. Specify an integer in the range 0 to 255. The      |
    | returncode value is ignored if you specify 0 as deadline     |
    | value. The default is 4.                                     |
    |                                                              |
    |-trace | -t                                                   |
    | Trace level for internal logging and traces. Possible values |
    | are:                                                         |
    | 0 To receive error messages only.                            |
    | 1 Indicates the fine level, to receive the most important    |
    |   messages with the lowest volume.                           |
    | 2 Indicates the finer level, to activate entry and exit      |
    |   traces.                                                    |
    | 3 Indicates the finest level, to receive the most detailed   |
    |   tracing output. The default value is 0.                    |
    |You find the trace output in the log of the job that run      |
    | filewatch.                                                   |
    |                                                              |
    |Example                                                       |
    |//FLWATCH EXEC PGM=EELFLWAT,PARM= ENVAR(TZ=GMT-1CET)/-co wcr  |
    |  -dead 30                                                    |
    |// -fi /u/falsi/prova -int 30 -t 2                            |
    |In the previous example ENVAR(GMT-1CET) is used to change the |
    |time zone to Central Europe Time. GMT-1 is the time zone value|
    |and CET is the selected daylight saving time.                 |
    +--------------------------------------------------------------+
    860Y
    EELFLWAS
    EELFLWAT
    EELINST
    HEEL860J
    

Temporary fix

Comments

  • The File Watch utility on the TWS agent for z/OS adds a new
    load-module EELFLWAT in the SEELLMD0 library. The new File
    Watch sample skeleton to run this feature is in EELFLWAS member
    and can be updated through the EELINST installation aid.
                             - - -
    The following documentation must be updated:
    +--------------------------------------------------------------+
    |TITLE:  IBM TIVOLI WORKLOAD SCHEDULER,                        |
    |        Scheduling with the agent for zOS       SC27-2771-01  |
    |                                                SC27-2771-02  |
    |Chapter 3. Using                                              |
    |                                                              |
    |Add the following new paragraph:                              |
    |                                                              |
    |"HFS or ZFS file triggering"                                  |
    |                                                              |
    |The filewatch utility on the TWS agent for z/OS adds a new    |
    |load-module EELFLWAT in the SEELLMD0 library.                 |
    |You can use this feature, like the one on TWSz, to check for  |
    |file system changes of HFS or ZFS files and directories, for  |
    |example when you want to make sure that a file exists before  |
    |running a job that processes that file. By defining a job that|
    |runs this utility, you can implement file dependency, that is |
    |a relationship between a file and an operation in which       |
    |specific activity on the file determines the starting of the  |
    |operation. For example, you can define the job that runs      |
    |EELFLWAT as predecessor of the operation depending on the     |
    |file.                                                         |
    |The user running EELFLWAT must have execute (x) access to the |
    |directory path that contains files to be monitored.           |
    |The SEELSAMP library contains EELFLWAS member as sample JCL   |
    |to call the file watching utility.                            |
    |                                                              |
    |Syntax                                                        |
    |As shown in the EELFLWAS member of the SEELSAMP library, the  |
    |following format is supported for the parameter of the EXEC   |
    |statement that specifies                                      |
    |PGM=EELFLWAT:                                                 |
    |//FLWATCH EXEC PGM=EELFLWAT,PARM= ENVAR()/-c condval -dea     |
    |  deadline                                                    |
    |// -fi file_path -i interval -r rc -t trace_level             |
    |Consider that:                                                |
    |- No continuation character is used. To continue the PARM     |
    |  field, interrupt it at column 72 and continue in column     |
    |  16 of the next card.                                        |
    |- Separate arguments and values by using a blank character.   |
    |- Use ENVAR() to pass environment variables to EELFLWAT.      |
    |- EELFLWAT returns messages and trace information (if         |
    |  required) in the log of the job used to run the utility.    |
    |  If you use the job log retrieval function, set to Y the     |
    |  User Sysout field in the cleanup options at operation       |
    |  level, both in the database and in the current plan.        |
    |- The arguments are not positional.                           |
    |- You can use an abbreviated format for all the arguments.    |
    |  Generally you can truncate the arguments to any position    |
    |  following the first character, except for deadline that     |
    |  requires at least three characters.                         |
    |                                                              |
    |Arguments                                                     |
    |-condition | -c                                               |
    |  The condition to be checked. Valid values are:              |
    |  wcr | waitCreated                                           |
    |  Waits until the file exists. If the file already exists,    |
    |  filewatch exits immediately. If -filename argument specifies|
    |  a directory, the process waits until the directory exists   |
    |  and contains a new file.                                    |
    |                                                              |
    |  wmr | waitModificationRunning                               |
    |  Waits until the file size or modification time changes. If  |
    |  -filename argument specifies a directory, the process waits |
    |  until the size or earlier file modification time changes,   |
    |  when a file is created, modified, or deleted.               |
    |                                                              |
    |  wmc | waitModificationCompleted                             |
    |  Checks that the file size or modification time stopped      |
    |  changing, meaning that filewatch waits for three search     |
    |  intervals without any change. If -filename argument         |
    |  specifies a directory, the process checks the size or the   |
    |  earlier file modification time change, for example if the   |
    |  number of directory files and the earlier file              |
    |  modification time does not change within three search       |
    |  intervals.                                                  |
    |                                                              |
    |  wmrc | waitModificationRunningCompleted                     |
    |  Waits until the file size or modification time changes and  |
    |  stops changing, meaning that, after the first change,       |
    |  filewatch waits for three search intervals without any      |
    |  further change. If -filename argument specifies a           |
    |  directory, the process checks the size or the earlier file  |
    |  modification time change, for example if the number of      |
    |  directory files and the earlier file modification time does |
    |  not change within three search intervals.                   |
    |                                                              |
    |  wdl | waitDelete                                            |
    |  Stops running when the file is deleted. If -filename        |
    |  argument specifies a directory, the process waits until a   |
    |  file is deleted from the directory.                         |
    |                                                              |
    |-deadline | -dea                                              |
    | The deadline period, expressed in seconds. The allowed       |
    | formats are:                                                 |
    | - An integer in the range 0 to 31536000 (the upper value     |
    |   corresponds to one year). To have filewatch performing an  |
    |   indefinite loop, specify 0.                                |
    | - hh:mm:ss, in the range 00:00:01 to 24:00:00, to select a   |
    |   time within the same day when filewatch started.           |
    |   It corresponds to the GMT value. To specify a value        |
    |   different from the GMT, use the ENVAR parameter as shown   |
    |   in  Example  on page 458. For details about setting the TZ |
    |   environment variable, refer to the UNIX System Services    |
    |   Command Reference.                                         |
    |                                                              |
    |-filename | -fi                                               |
    | The file path to be processed. You can embed blank or special|
    | characters, by using double quotes. Wildcard characters are  |
    | not supported. To include more files in the monitoring       |
    | process, you can store those files in a specific directory   |
    | and use a file path specifying that directory.               |
    |                                                              |
    |-interval | -i                                                |
    | The file search interval, expressed in seconds. Specify an   |
    | integer in the range:                                        |
    |  - 5 3600 when specifying wcr or wdl as condition value.     |
    |  - 30 3600 otherwise.                                        |
    |The default is 60.                                            |
    |                                                              |
    |-returncode | -rc                                             |
    | The exit return code, if the file is not found by the        |
    | deadline. Specify an integer in the range 0 to 255. The      |
    | returncode value is ignored if you specify 0 as deadline     |
    | value. The default is 4.                                     |
    |                                                              |
    |-trace | -t                                                   |
    | Trace level for internal logging and traces. Possible values |
    | are:                                                         |
    | 0 To receive error messages only.                            |
    | 1 Indicates the fine level, to receive the most important    |
    |   messages with the lowest volume.                           |
    | 2 Indicates the finer level, to activate entry and exit      |
    |   traces.                                                    |
    | 3 Indicates the finest level, to receive the most detailed   |
    |   tracing output. The default value is 0.                    |
    |You find the trace output in the log of the job that run      |
    | filewatch.                                                   |
    |                                                              |
    |Example                                                       |
    |//FLWATCH EXEC PGM=EELFLWAT,PARM= ENVAR(TZ=GMT-1CET)/-co wcr  |
    |  -dead 30                                                    |
    |// -fi /u/falsi/prova -int 30 -t 2                            |
    |In the previous example ENVAR(GMT-1CET) is used to change the |
    |time zone to Central Europe Time. GMT-1 is the time zone value|
    |and CET is the selected daylight saving time.                 |
    +--------------------------------------------------------------+
    +--------------------------------------------------------------+
    |TITLE:  IBM TIVOLI WORKLOAD SCHEDULER,                        |
    |        Scheduling with the agent for zOS       SC27-2771-02  |
    |                                                              |
    |Chapter 2. Installing and Configuring                         |
    |                                                              |
    |Add a new row at the end of the "Table 4: Sample jobs created |
    |by the installation aid":                                     |
    |                                                              |
    |   Sample name      Description                               |
    |   -----------      ---------------------------------------   |
    |   EELFLWAS         File Watch feature sample                 |
    +--------------------------------------------------------------+
    

APAR Information

  • APAR number

    PI09318

  • Reported component name

    TWSD AGENT FOR

  • Reported component ID

    5698AA300

  • Reported release

    860

  • Status

    CLOSED UR1

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2014-01-10

  • Closed date

    2014-05-09

  • Last modified date

    2016-04-20

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

    UI17846

Modules/Macros

  • EELFLWAS EELFLWAT EELINST  HEEL860J
    

Publications Referenced
SC27277101SC27277102   

Fix information

  • Fixed component name

    TWSD AGENT FOR

  • Fixed component ID

    5698AA300

Applicable component levels

  • R860 PSY UI17846

       UP15/06/06 P F506

Fix is available

  • Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.

[{"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Product":{"code":"SG19M","label":"APARs - z\/OS environment"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"860","Edition":"","Line of Business":{"code":"","label":""}}]

Document Information

Modified date:
20 April 2016