Pause resume command port failure #1424
Conversation
Code analysis and actionsDO NOT DELETE THIS COMMENT.
|
| @@ -670,6 +670,14 @@ error.zosProcStart.jobname.invalid=CWWKE0943E: The z/OS STC procedure {0} failed | |||
| error.zosProcStart.jobname.invalid.explanation=The STC job name specified by the WLP_ZOS_JOBNAME property in the server.env file is not valid. The job name must be no longer than 8 characters and must not contain a comma. | |||
| error.zosProcStart.jobname.invalid.useraction=Verify that the job name is no longer than eight characters and that it does not contain a comma. | |||
|
|
|||
| error.server.pause.command.port.disabled=CWWKE0944E: A pause request was received for server {0}, but the server command port is disabled. The request cannot be processed. | |||
| error.server.pause.command.port.disabled.explanation=The server command port is required for communication with a running server. The command port is disabled for this server, therefore the pause request could not be processed. Note that the command port is disabled by default when a server is started as a started task on z/OS. | |||
| error.server.pause.command.port.disabled.useraction=If the server is running as a started task on z/OS, this dump can be requested from the operator console. See the information center for details. | |||
There was a problem hiding this comment.
@awisniew90 I saw that there were several existing errors that this is based on, but still had some edits and questions (below).
error.server.pause.command.port.disabled=CWWKE0944E: A pause request was received for server {0}, but the server command port is disabled, so the request cannot be processed. [Add brief user action]
error.server.pause.command.port.disabled.explanation=The server command port is required for communication with a running server. The command port is disabled for this server, so the pause request could not be processed. Note that the command port is disabled by default when a server is started as a started task on z/OS.
error.server.pause.command.port.disabled.useraction=If the server is running as a started task on z/OS, you can request this dump (what dump? and why?) from the operator console. For more information, see the documentation.
- This user action appears in the documentation. Which documentation should they be checking, the z/OS documentation? Note that "information center" is an outdated term.
- What if they aren't on z/OS? What action should they take? Presumably something like "Enable the server command port."?
There was a problem hiding this comment.
@cjcarpen - "dump" should be "pause" and "resume" (my mistake). I also added a brief user action to the message and a better description in the useraction section. The useraction section now recommends enabling the command port and/or running the command from the operator console if on z/OS. In this case, the documentation is both z/OS and non z/OS. Would saying "see the Knowledge Center for more information" be sufficient?
| @@ -670,6 +670,14 @@ error.zosProcStart.jobname.invalid=CWWKE0943E: The z/OS STC procedure {0} failed | |||
| error.zosProcStart.jobname.invalid.explanation=The STC job name specified by the WLP_ZOS_JOBNAME property in the server.env file is not valid. The job name must be no longer than 8 characters and must not contain a comma. | |||
| error.zosProcStart.jobname.invalid.useraction=Verify that the job name is no longer than eight characters and that it does not contain a comma. | |||
|
|
|||
| error.server.pause.command.port.disabled=CWWKE0944E: A pause request was received for server {0}, but the server command port is disabled. The request cannot be processed. Enable the command port before requesting a pause for this server. | |||
| error.server.pause.command.port.disabled.explanation=The server command port is required for communication with a running server. The command port is disabled for this server, therefore the pause request could not be processed. Note that the command port is disabled by default when a server is started as a started task on z/OS. | |||
| error.server.pause.command.port.disabled.useraction=Enable the command port for this server in order to issue pause requests from the command line. If the server is running as a started task on z/OS, this pause can alternatively be requested from the operator console. For more information, see the knowledge center documentation. | |||
There was a problem hiding this comment.
I believe the user action should just say: "Enable the command port for this server." or if we need to be more verbose: "Enable the command port for this server. See knowledge center documentation." Adding more than the the first sentence clouds what the action should really be.
There was a problem hiding this comment.
Since the other "command port disabled" messages for actions like start, stop, and dump have the action about using the operator console on z/OS, I think we should keep this in there for consistency.
There was a problem hiding this comment.
When i read the user action ... this is what i get. We are basically saying "... you are issuing the command from the command line and we detected that you had the command port disabled, so enable it and run it again. But just in case also know that you could have issued this command from the console .... " This implies that there should not be an issue when issuing the command is issued from the console when the server is started using a procedure. When the opposite is true (as far as i know) .. that is out of the box the command port is disabled by default for started tasks and enabled by default when using the command line. So, unless i misunderstood what is written, it needs to change. I would even go as far as saying that the user action for the other commands should also be updated.
There was a problem hiding this comment.
You should be able to issue commands at the console even when the command port is disabled. The command port afaik is only needed for issuing commands from the command line. So in the case of starting as a started task, if a user tries to issue the command from the command line, the command port is disabled by default, so the command can only be issued from the console.
There was a problem hiding this comment.
I think it is good to keep that in the user action in case a user thinks they need to enable the command port for a started task when in fact they can just issue the command from the console.
There was a problem hiding this comment.
Thanks for clarifying. The action makes sense then.
| @@ -670,6 +670,14 @@ error.zosProcStart.jobname.invalid=CWWKE0943E: The z/OS STC procedure {0} failed | |||
| error.zosProcStart.jobname.invalid.explanation=The STC job name specified by the WLP_ZOS_JOBNAME property in the server.env file is not valid. The job name must be no longer than 8 characters and must not contain a comma. | |||
| error.zosProcStart.jobname.invalid.useraction=Verify that the job name is no longer than eight characters and that it does not contain a comma. | |||
|
|
|||
| error.server.pause.command.port.disabled=CWWKE0944E: A pause request was received for server {0}, but the server command port is disabled. The request cannot be processed. Enable the command port before requesting a pause for this server. | |||
| error.server.pause.command.port.disabled.explanation=The server command port is required for communication with a running server. The command port is disabled for this server, therefore the pause request could not be processed. Note that the command port is disabled by default when a server is started as a started task on z/OS. | |||
| error.server.pause.command.port.disabled.useraction=Enable the command port for this server in order to issue pause requests from the command line. If the server is running as a started task on z/OS, this pause can alternatively be requested from the operator console. For more information, see the knowledge center documentation. | |||
There was a problem hiding this comment.
Looks good - just made some minor edits. The user action text will appear in the Knowledge Center documentation, so when the user is reading the action, they'll already be in the doc. I'm not sure that it makes sense to refer them to it again unless we're mentioning a specific section or a different product.
Same changes to be made in the other related messages.
error.server.pause.command.port.disabled=CWWKE0944E: A pause request was received for server {0}, but the server command port is disabled. The request cannot be processed. Enable the command port, and try again.
error.server.pause.command.port.disabled.explanation=The server command port is required for communication with a running server. The command port is disabled for this server, therefore the pause request could not be processed. Note that the command port is disabled by default when a server is started as a started task on z/OS.
error.server.pause.command.port.disabled.useraction=Enable the command port for this server. If the server is running as a started task on z/OS, this pause can alternatively be requested from the operator console.
awisniew90
force-pushed
the
pause-resume
branch
from
7b6a54b
to
ff218b7
Compare
|
#build |
|
Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_tDZz0PFzEee7FMdg7u8gzA Target locations of links might be accessible only to IBM employees. |
|
The build awisniew90-1424-20180104-1831 |
awisniew90
force-pushed
the
pause-resume
branch
from
ff218b7
to
469ef85
Compare
|
#build |
|
Your personal build request is at https://wasrtc.hursley.ibm.com:9443/jazz/resource/itemOid/com.ibm.team.build.BuildResult/_2uRK0fIcEee7FMdg7u8gzA Target locations of links might be accessible only to IBM employees. |
|
The build awisniew90-1424-20180105-1442 |
If the command port is disabled when issuing a pause or resume request from the server script, issue a message saying so.