IBM Support

PH70713: DOC CHANGE IS NEEDED FOR DWCZ - MIRRORING

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as documentation error.

Error description

  • Change Dynamic Workload Console User's Guide (for example
    Version 10.2.6)
    
    (1) Page 176, replace the following
    -------
    Configuring the Federator to mirror data on a database
    
    Starting from the Dynamic Workload Console V10.2.3, the
    Federator component is automatically installed with the console
    to
    mirror (replicate) the events related to the z/OS current plan
    on a configured database. The supported databases are those
    supported by the Dynamic Workload Console.
    
    Before you begin
    The mirroring function has the following prerequisites:
    -------
    
    WITH
    
    Configuring the Federator to mirror data on a database
    
    Starting from the Dynamic Workload Console V10.2.3 and DB2
    installed on distributed machine (not zos)
    
    the Federator component is automatically installed with the
    console to mirror (replicate) the events related to
    
    the z/OS current plan on a configured database. Starting from
    Dynamic Workload Console V10.2.5 is supported also
    
    a DB2 on zos  with the  following prerequisites:
    .
    (2) Page 177, replace the following info under federator.secret
    -------
    
    The secret key string used to register the z/OS engine to the
    Federator, in the format UTF-8. Ensure that
    you use a character set that is compatible with the CODEPAGE
    parameter specified in the OPCOPTS
    initialization statement(for details about OPCOPTS, see IBM Z
    Workload Scheduler: Customization and
    Tuning).
    This variable is case-sensitive. You can specify up to 36
    alphanumeric characters. Special characters,
    except blanks and single quotation marks, are allowed.
    -------
    WITH
    The secret key string used to register the z/OS engine to the
    Federator, in the format UTF-8,
    
    it must be coincident with the value that you have set in the
    MIRROROPTS statement under SECRET('secret key string').
    Ensure that you use a character set that is compatible with the
    CODEPAGE parameter specified in the OPCOPTS
    
    initialization statement(for details about OPCOPTS, see IBM Z
    Workload Scheduler: Customization and Tuning).
    
    This variable is case-sensitive. You can specify up to 36
    alphanumeric characters. Special characters,
    
    except blanks and single quotation marks, are allowed.
    .
    (3) Page 178, replace the following points
    --------
    4. Edit the following variable in the jwtsso.xml file by
    replacing the value 9443 with the actual port number that you
    are using to connect with the Dynamic Workload Console:
    <variable name="dwc.portNumber" value="9443"/>
    
    5. Copy the jwtsso.xml file to the following path:
    On Windows
    <DATA_dir>\usr\servers\dwcServer\configDropins\overrides
    On UNIX and z/OS
    <DATA_dir>/usr/servers/dwcServer/configDropins/overrides
    -----------
    
    WITH
    
    4. Copy the jwtsso.xml file to the following path:
    On Windows
    <DATA_dir>\usr\servers\dwcServer\configDropins\overrides
    On UNIX and z/OS
    <DATA_dir>/usr/servers/dwcServer/configDropins/overrides
    
    5. Edit the following variable in the jwtsso.xml file by
    replacing the values that
    
    you are using to connect with the Dynamic Workload Console on
    z/os:
    
    
    5.1 the value 9443 with the actual port number
    
    The value of port number to set correspond to <variable
    name="host.https.port" defined in
    
    ports_variables.xml  under
    <DATA_dir>/usr/servers/dwcServer/configDropins/overrides
    
    
    5.2 the value localhost with ip address if the z/os LPAR
    where DWC is installed
    
    <variable name="dwc.url" value=localhost/>
    
    5.3  the value server with the alias specified in your keystore
    
    keyAlias="server"
    
    
    Use this command to get the value
    
    keytool -v -list -keystore TWSServerKeyFile.p12
    .
    (4) Always on Page 178, replace the following points
    
    -----------
    
    6. If you are upgrading from any version earlier than 10.2.3,
    browse to the datasource_db_vendor.xml file, which is
    created at installation time in the following folder:
    On Windows
    <DWC_home>\usr\servers\dwcServer\configDropins\templates\dataso
    urces
    On UNIX and z/OS
    <DWC_home>/usr/servers/dwcServer/configDropins/templates/dataso
    urces
    
    7. In the file, locate the section named jndiName="jdbc/feddb".
    
    8. Copy the section and paste it into the datasource.xml file
    located in the following path:
    On Windows
    <DATA_dir>\usr\servers\dwcServer\configDropins\overrides
    On UNIX and z/OS
    <DATA_dir>/usr/servers/dwcServer/configDropins/overrides
    
    9. Stop and restart the Dynamic Workload Console server
    --------
    in the following way, follow this info please:
    
    Point 6 must remain but the descriptions of points 7 and 8 must
    be part of point 6
    (they must not be separate points).
    
    So point 9 becomes point 7.
    .
    (5) Page 179 remove this
    -----
    The mirroring function has the following prerequisites:
    | IBM Z Workload Scheduler v10.2, or later.
    | If you are using Db2 for z/OS, ensure that you have:
    | Installed IBM Db2 for z/OS V13.1.503, or later.
    | Installed IBM Db2 Accessories Suite for z/OS for Db2 13 for
    z/OS V04.02.00, or later.
    | Defined a Workload Manager (WLM) policy for the required Db2
    for z/OS environment and that a Db2
    procedure for the WLM Application environment is up and running.
    
    ----
    .
    (6) Page 179, under "2. On the z/OS server started task:"
    
    change
    
    SSLKEYSTORE(MDMCSTMRING)
    
    with
    SSLKEYSTORE(name_ring)
    .
    (7) Page 179 replace the following
    ----
    Upon registration completion, the Federator generates the
    authentication token to secure communications with the Z
    controller.
    
    Before expiration time, the token is automatically renewed by
    the Federator and sent to the controller: in this way,
    theoretically, the token never expires. The only exception
    occurs if the connection between the Federator and controller
    is not established for a long period of time; to resolve this
    issue see Troubleshooting on page 181.
    ----
    WITH
    
    Upon registration completion, the Federator generates the
    authentication token to secure communications with the Z
    controller.
    
    Before expiration time, the token is automatically renewed by
    the Federator and sent to the controller.
    The only exception occurs if the connection between the
    Federator and controller is not established
    
    for a long period of time, in this case if:
    
    
    The secret key string that is set in MIRROPTS(SECRET) is still
    coincident with the value set in the
    federator.secret property of the Federator
    When the connection is established again, the Federator
    generates a new token and sends it to
    the controller to be stored locally.
    
    The secret key string that is set in MIRROPTS(SECRET) is no
    longer coincident with the value set in the
    federator.secret property of the Federator
    When the controller tries to connect to the Federator, the
    communication is not established. You
    are required to modify the SECRET parameter of the MIRROPTS to
    be coincident with the value
    set in the federator.secret property. Then restart the
    controller to be registered again on the
    Federator.
    -----
    .
    (8) Remove
    
    Figure 11. Data flow to perform actions on the monitored
    objects
    .
    (9) Remove "Troubleshooting" paragraph on page 181
    
    .
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All users running with DWC interface         *
    ****************************************************************
    * PROBLEM DESCRIPTION: Several points in the                   *
    *                      Dynamic Workload Console User's Guide   *
    *                      needs to be changed                     *
    ****************************************************************
    Several points in the Dynamic Workload Console User's Guide
    needs to be changed
    

Problem conclusion

  • +-------------------------------------------------------------+
    |TITLE:    Dynamic Workload Console User's Guide              |
    |              Version 10.2.6                                 |
    |                                                             |
    |-------------------------------------------------------------|
    |                                                             |
    | (1) Page 176, replace the following                         |
    | -------                                                     |
    | Configuring the Federator to mirror data on a database      |
    |                                                             |
    | Starting from the Dynamic Workload Console V10.2.3, the     |
    | Federator component is automatically installed with the     |
    | console to mirror (replicate) the events related to the z/OS|
    | current plan on a configured database. The supported        |
    | databases are those supported by the Dynamic Workload Consol|
    |                                                             |
    | Before you begin                                            |
    | The mirroring function has the following prerequisites:     |
    |                                                             |
    |                                                             |
    | WITH                                                        |
    |                                                             |
    | Configuring the Federator to mirror data on a database      |
    |                                                             |
    | Starting from the Dynamic Workload Console V10.2.3 and DB2  |
    | installed on distributed machine (not zos)                  |
    |                                                             |
    | the Federator component is automatically installed with the |
    | console to mirror (replicate) the events related to         |
    |                                                             |
    | the z/OS current plan on a configured database. Starting    |
    | from Dynamic Workload Console V10.2.5 is supported also     |
    |                                                             |
    | a DB2 on zos  with the  following prerequisites:            |
    |.                                                            |
    |(2) Page 177, replace the following info under federator     |
    | secret                                                      |
    |-------                                                      |
    |                                                             |
    |The secret key string used to register the z/OS engine to the|
    |Federator, in the format UTF-8. Ensure that                  |
    |you use a character set that is compatible with the CODEPAGE |
    |parameter specified in the OPCOPTS                           |
    |initialization statement(for details about OPCOPTS, see IBM Z|
    |Workload Scheduler: Customization and                        |
    |Tuning).                                                     |
    |This variable is case-sensitive. You can specify up to 36    |
    |alphanumeric characters. Special characters,                 |
    |except blanks and single quotation marks, are allowed.       |
    |-------                                                      |
    |WITH                                                         |
    |The secret key string used to register the z/OS engine to the|
    |Federator, in the format UTF-8,                              |
    |                                                             |
    |it must be coincident with the value that you have set in the|
    |MIRROROPTS statement under SECRET('secret key string').      |
    |Ensure that you use a character set that is compatible with  |
    |the CODEPAGE parameter specified in the OPCOPTS              |
    |                                                             |
    |initialization statement(for details about OPCOPTS, see IBM Z|
    |Workload Scheduler: Customization and Tuning).               |
    |                                                             |
    |This variable is case-sensitive. You can specify up to 36    |
    |alphanumeric characters. Special characters,                 |
    |                                                             |
    |except blanks and single quotation marks, are allowed.       |
    |.                                                            |
    |(3) Page 178, replace the following points                   |
    |--------                                                     |
    |4. Edit the following variable in the jwtsso.xml file by     |
    |replacing the value 9443 with the actual port number that you|
    |are using to connect with the Dynamic Workload Console:      |
    |<variable name="dwc.portNumber" value="9443"/>               |
    |                                                             |
    |5. Copy the jwtsso.xml file to the following path:           |
    |On Windows                                                   |
    |<DATA_dir>\usr\servers\dwcServer\configDropins\overrides     |
    |On UNIX and z/OS                                             |
    |<DATA_dir>/usr/servers/dwcServer/configDropins/overrides     |
    |-----------                                                  |
    |                                                             |
    |WITH                                                         |
    |                                                             |
    |4. Copy the jwtsso.xml file to the following path:           |
    |On Windows                                                   |
    |<DATA_dir>\usr\servers\dwcServer\configDropins\overrides     |
    |On UNIX and z/OS                                             |
    |<DATA_dir>/usr/servers/dwcServer/configDropins/overrides     |
    |                                                             |
    |5. Edit the following variable in the jwtsso.xml file by     |
    |replacing the values that                                    |
    |                                                             |
    |you are using to connect with the Dynamic Workload Console on|
    |z/os:                                                        |
    |                                                             |
    |                                                             |
    |5.1 the value 9443 with the actual port number               |
    |                                                             |
    |The value of port number to set correspond to <variable      |
    |name="host.https.port" defined in                            |
    |                                                             |
    |ports_variables.xml  under                                   |
    |<DATA_dir>/usr/servers/dwcServer/configDropins/overrides     |
    |                                                             |
    |                                                             |
    |5.2 the value localhost with ip address if the z/os LPAR     |
    |where DWC is installed                                       |
    |                                                             |
    |<variable name="dwc.url" value=localhost/>                   |
    |                                                             |
    |5.3  the value server with the alias specified in your       |
    |keystore                                                     |
    |keyAlias="server"                                            |
    |                                                             |
    |                                                             |
    |Use this command to get the value                            |
    |                                                             |
    |keytool -v -list -keystore TWSServerKeyFile.p12              |
    |.                                                            |
    |(4) Always on Page 178, replace the following points         |
    |                                                             |
    |-----------                                                  |
    |                                                             |
    |6. If you are upgrading from any version earlier than 10.2.3,|
    |browse to the datasource_db_vendor.xml file, which is        |
    |created at installation time in the following folder:        |
    |On Windows                                                   |
    |<DWC_home>\usr\servers\dwcServer\configDropins\templates\    |
    |datasources                                                  |
    |On UNIX and z/OS                                             |
    |<DWC_home>/usr/servers/dwcServer/configDropins/templates/    |
    |datasources                                                  |
    |                                                             |
    |7. In the file, locate the section named                     |
    | jndiName="jdbc/feddb".                                      |
    |                                                             |
    |8. Copy the section and paste it into the datasource.xml     |
    | file located in the following path:                         |
    |On Windows                                                   |
    |<DATA_dir>\usr\servers\dwcServer\configDropins\overrides     |
    |On UNIX and z/OS                                             |
    |<DATA_dir>/usr/servers/dwcServer/configDropins/overrides     |
    |                                                             |
    |9. Stop and restart the Dynamic Workload Console server      |
    |--------                                                     |
    |in the following way, follow this info please:               |
    |                                                             |
    |Point 6 must remain but the descriptions of points 7 and 8   |
    |must be part of point 6                                      |
    |(they must not be separate points).                          |
    |                                                             |
    |So point 9 becomes point 7.                                  |
    |.                                                            |
    |(5) Page 179 remove this                                     |
    |-----                                                        |
    |The mirroring function has the following prerequisites:      |
    || IBM Z Workload Scheduler v10.2, or later.                  |
    || If you are using Db2 for z/OS, ensure that you have:       |
    || Installed IBM Db2 for z/OS V13.1.503, or later.            |
    || Installed IBM Db2 Accessories Suite for z/OS for Db2 13    |
    |  for z/OS V04.02.00, or later.                              |
    || Defined a Workload Manager (WLM) policy for the required   |
    |  Db2 for z/OS environment and that a Db2                    |
    |  procedure for the WLM Application environment is up and    |
    |  running                                                    |
    |----                                                         |
    |.                                                            |
    |(6) Page 179, under "2. On the z/OS server started task:"    |
    |                                                             |
    |change                                                       |
    |                                                             |
    |SSLKEYSTORE(MDMCSTMRING)                                     |
    |                                                             |
    |with                                                         |
    |SSLKEYSTORE(name_ring)                                       |
    |.                                                            |
    |(7) Page 179 replace the following                           |
    |----                                                         |
    |Upon registration completion, the Federator generates the    |
    |authentication token to secure communications with the Z     |
    |controller.                                                  |
    |                                                             |
    |Before expiration time, the token is automatically renewed by|
    |the Federator and sent to the controller: in this way,       |
    |theoretically, the token never expires. The only exception   |
    |occurs if the connection between the Federator and controller|
    |is not established for a long period of time; to resolve this|
    |issue see Troubleshooting on page 181.                       |
    |----                                                         |
    |WITH                                                         |
    |                                                             |
    |Upon registration completion, the Federator generates the    |
    |authentication token to secure communications with the Z     |
    |controller.                                                  |
    |                                                             |
    |Before expiration time, the token is automatically renewed by|
    |the Federator and sent to the controller.                    |
    |The only exception occurs if the connection between the      |
    |Federator and controller is not established                  |
    |                                                             |
    |for a long period of time, in this case if:                  |
    |                                                             |
    |                                                             |
    |The secret key string that is set in MIRROPTS(SECRET) is     |
    |still coincident with the value set in the                   |
    |federator.secret property of the Federator                   |
    |When the connection is established again, the Federator      |
    |generates a new token and sends it to                        |
    |the controller to be stored locally.                         |
    |                                                             |
    |The secret key string that is set in MIRROPTS(SECRET) is no  |
    |longer coincident with the value set in the                  |
    |federator.secret property of the Federator                   |
    |When the controller tries to connect to the Federator, the   |
    |communication is not established. You                        |
    |are required to modify the SECRET parameter of the MIRROPTS  |
    |to be coincident with the value                              |
    |set in the federator.secret property. Then restart the       |
    |controller to be registered again on the                     |
    |Federator.                                                   |
    |-----                                                        |
    |.                                                            |
    |(8) Remove                                                   |
    |                                                             |
    |Figure 11. Data flow to perform actions on the monitored     |
    |objects                                                      |
    |.                                                            |
    |(9) Remove "Troubleshooting" paragraph on page 181           |
    +-------------------------------------------------------------+
    

Temporary fix

Comments

APAR Information

  • APAR number

    PH70713

  • Reported component name

    TIV WRKLD SCHD

  • Reported component ID

    5697WSZ01

  • Reported release

    A20

  • Status

    CLOSED DOC

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2026-03-30

  • Closed date

    2026-04-03

  • Last modified date

    2026-04-03

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

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

Fix information

Applicable component levels

[{"Business Unit":{"code":"BU029","label":"Software"},"Product":{"code":"SSRULV","label":"IBM Workload Scheduler for z\/OS"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"A20"}]

Document Information

Modified date:
03 April 2026