Top
Systemwalker Software Configuration Manager Reference Guide
FUJITSU Software

2.4.4 Job Details File

File name

Any name

Description

This file can be used to check detailed information about a job, such as processing details and processing results of a job requested by the patch application wizard, parameter setting wizard, script execution wizard, or parameter setting command. Details and results of the job processes for patch application, patch deployment, parameter settings, script execution, and configuration modification can be checked. Specify this file in the "-get" option of swcfmg_job (Job Information Management command).

File location

Any folder

File format

XML format:

<?xml version="1.0" encoding="UTF-8"?>
<job>
  <jobName>jobName</jobName>
  <jobId>jobId</jobId>
  <jobType>jobType</jobType>
  <jobStatus>status</jobStatus>
  <jobOwner>administrator</jobOwner>
  <jobTenant>tenant</jobTenant>
  <jobStartDate>startDate</jobStartDate>
  <jobEndDate>endDate</jobEndDate>
  <jobTargetType>targetType</targetType>
  <jobTarget>target</target> 
  <processes>
    <process>
      <processName>processName</processName>
      <processOrder>processOrder</processOrder>
      <processType>processType</processType>
      <processParameters>

     - When the process type is "Schedule standby":
        <scheduleDate>scheduleDate</scheduleDate>

     - When the process type is "Server operation check":
        <serverName>serverName</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>ipAddress</ipaddress>
        <monitorTime>Monitoring time</monitorTime>

     - When the process type is "Patch application" (Windows operating system patch):
        <serverName>serverName</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>ipAddress</ipaddress>
        <windowsUpdates>
          <windowsUpdate>
            <patchId> Patch name </patchId>
            <requiredLevel>applicationLevel</requiredLevel>
            <patchType>patchType</patchType>
            <updateId>Update ID</updateId>
          </windowsUpdate>
          ...
        </windowsUpdates>

     - When the process type is "Patch application" (Linux operating system patch):
        <serverName>serverName</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>ipAddress</ipaddress>
        <rpms>
          <rpm>
            <packageName>packageName</packageName>
            <packageVersion>version</packageVersion>
            <packageRelease>release</packageRelease>
          </rpm>
          ...
        </rpms>

     - When the process type is "Patch distribution":
        <serverName>serverName</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>ipAddress</ipaddress>
        <fjmwPatches>
          <fjmwPatch>
            <patchId> Patch name </patchId>
            <importance>importance</importance>
            <updateType>updateType</updateType>
          </fjmwPatch>
          ...
        </fjmwPatches>

     - When the process type is "Parameter setting":
        <serverName>serverName</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>ipAddress</ipaddress>
        <parameterSettings>
          <parameterSetting>
            <settingOrder>settingOrder</settingOrder>
            <softwareName>softwareName</softwareName>
            <softwareId>softwareId</softwareId>
            <softwareVersion>softwareVersion</softwareVersion>
            <parameterSettingDefinitionId>parameterSettingDefinitionId</parameterSettingDefinitionId>
            <parameterInformationName>parameterInformationName</parameterInformationName>
            <parameterInformationId>parameterInformationId</parameterInformationId>
          </parameterSetting>
          ...
        </parameterSettings>

     - When the process type is "Script execution":
        <serverName>serverName</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>ipAddress</ipaddress>
        <scriptName>scriptFileName</scriptName>
        <argument>Argument</argument>
        <assetName>Asset name</assetName>
        <assetUrl>Asset URL</assetUrl>
        <successValues>Normal return value</successValues>
        <singleUserMode>Single user mode</singleUserMode>

     - When the process type is "Pre-execution script" or "Post-execution script":
        <serverName>Server name</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>IP address</ipaddress>
        <scriptName>Scriptfile name</scriptName>
        <successValues>Normal return value</successValues>

     - When the process type is "OS restart":
        <serverName>Server name</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>IP address</ipaddress>

     - When the process type is "Command execution":
        <serverName>Server name</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>IP address</ipaddress>
        <command>Command</command>
        <argument>Argument</argument>
        <successValues>Normal return value</successValues>
        <singleUserMode>Single user mode</singleUserMode>

     - When the process type is "File distribution":
        <serverName>Server name</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>IP address</ipaddress>
        <distributionFileName>Distributed file name</distributionFileName>
        <assetName>Asset name</assetName>
        <assetUrl>Asset URL</assetUrl>
        <destinationDirectory>Distribution destination</destinationDirectory>

     - When the process type is "File collection":
        <serverName>Server name</serverName>
        <serverId>Server ID</serverId>
        <ipaddress>IP address</ipaddress>
        <collectionFile>Collected file name</collectionFile>
        <storageDirectory>Storage location</storageDirectory>

      </processParameters>
    </process>
    ...
  </processes>
  <results>
    <result>
      <processName>processName</processName >
      <processOrder>processOrder</processOrder>
      <processType>processType</processType>
      <processExecutor>executor</processExecutor>
      <processStatus>status</processStatus>
      <processStartDate>startDate</processStartDate>
      <processEndDate>endDate</processEndDate>
      <messages>
        <message>
          <messageId>messageId</messageId>
          <messageText>messageText</messageText>
          <errorType>errorType</ErrorType>
          <messageParameters>
            <messageParameter>parameter{0}</messageParameter>
              ...
          </messageParameters>
        </message>
       ...
      </messages>
      <actions>

     - When an action can be executed:
        <selectable>
          <action>action</action>
          ...
        </selectable>

     - When an action has been executed:
        <selected>
          <action>action</action>
        </selected>
      <actions>
    </result>
    ...
  </results>
</job>

The following table explains the <job> element, which conveys information about the job.

Tag name

Description

job

Description

Element containing job information

Type

None

Number of occurrences

1

jobName

Description

Job name

Type

UTF-8 string

Number of occurrences

1

jobId

Description

Job ID

Type

int

Number of occurrences

1

jobType

Description

Job type. One of the following values:

  • patchapplication: Patch application

  • patchdistribution: Patch distribution

  • parametersetting: Parameter setting

  • scriptexecution: Script execution

  • configurationchange : Configuration modification

Type

ASCII string

Number of occurrences

1

jobStatus

Description

Job status. One of the following values:

  • running: Running

  • completed: Completed

  • selecting_abnormal: Selecting (abnormal)

  • completed_abnormal: Completed (abnormal)

  • waiting: Waiting

  • canceled: Canceled

Type

ASCII string

Number of occurrences

1

jobOwner

Description

Administrator of the job

Type

ASCII string

Number of occurrences

1

jobTenant

Description

Admin tenant. If the job belongs to the infrastructure administration department, this element is left blank.

Type

ASCII string

Number of occurrences

1

jobStartDate

Description

Start date of the job

Type

ASCII string

Number of occurrences

1

jobEndDate

Description

End date of the job

Type

ASCII string

Number of occurrences

1

jobTargetType

Description

Type of the target of the job

Type

ASCII string

Number of occurrences

1

jobTarget

Description

Target of the job

Type

ASCII string

Number of occurrences

1

processes

Description

Element containing details of the job process. It contains multiple process elements.

Type

None

Number of occurrences

1

results

Description

Element containing the process results of a job. It contains multiple result elements.

Type

None

Number of occurrences

1


The following table explains the <process> element, which conveys information about a process.

Tag name

Description

process

Description

Element containing details of the process

Type

None

Number of occurrences

1 or more

processName

Description

Process name. One of the following values will be output: When the job type is configurationchange (Configuration modification), the process name defined in the template is displayed.

  • Acceptance

  • Schedule standby

  • Server operation check

  • Patch distribution

  • Patch application

  • Parameter setting

  • Script execution

  • Pre-execution script

  • Post-execution script

  • OS restart

Type

UTF-8 string

Number of occurrences

Equal to the number of <process> tags

processOrder

Description

Process order

Type

int

Number of occurrences

Equal to the number of <process> tags

processType

Description

Process type. One of the following values:

  • acceptance: Acceptance

  • scheduleWait: Schedule standby

  • checkServer: Server operation check

  • patchApplication: Patch application

  • patchDistribution: Patch distribution

  • parameterSetting: Parameter setting

  • scriptExecution: Script execution

  • preScriptExecution: Pre-execution script

  • postScriptExecution: Post-execution script

  • reboot: OS restart

  • commandExecution: Command execution

  • fileDistribution: File distribution

  • fileCollection: File collection

Type

ASCII string

Number of occurrences

Equal to the number of <process> tags

processParameters

Description

Element conveying setting information. The elements it contains depend on the process type.

Type

None

Number of occurrences

Equal to the number of <process> tags


The following table explains the <processParameters> element, which conveys information about process parameters, according to the process type.

The following table explains the <fjmwPatch> element, which conveys information about a Fujitsu middleware patch.

Tag name

Description

fjmwPatch

Description

Element containing Fujitsu middleware patch information

Type

None

Number of occurrences

0 or more

patchId

Description

Patch name

Type

ASCII string

Number of occurrences

Equal to the number of <fjmwPatch> tags

importance

Description

Importance

Type

UTF-8 string

Number of occurrences

Equal to the number of <fjmwPatch> tags

updateType

Description

Update type

Type

UTF-8 string

Number of occurrences

Equal to the number of <fjmwPatch> tags


The following table explains the <windowsUpdate> element, which conveys information about a Windows operating system patch.

Tag name

Description

windowsUpdate

Description

Element containing information about Windows OS patch

Type

None

Number of occurrences

0 or more

patchId

Description

Patch name

Type

ASCII string

Number of occurrences

Equal to the number of <windowsUpdate> tags

requiredLevel

Description

Apply level

Type

UTF-8 string

Number of occurrences

Equal to the number of <windowsUpdate> tags

patchType

Description

Patch type

Type

UTF-8 string

Number of occurrences

Equal to the number of <windowsUpdate> tags

updateId

Description

Update program ID

Type

ASCII string

Number of occurrences

Equal to the number of <windowsUpdate> elements


The following table explains the <rpm> element, which conveys information about a Linux operating system patch.

Tag name

Description

rpm

Description

Element containing information about Linux OS patch

Type

None

Number of occurrences

0 or more

pachageName

Description

Package name

Type

ASCII string

Number of occurrences

Equal to the number of <rpm> tags

packageVersion

Description

Version

Type

ASCII string

Number of occurrences

Equal to the number of <rpm> tags

packageRelease

Description

Release

Type

ASCII string

Number of occurrences

Equal to the number of <rpm> tags


The following table explains the <parameterSetting> element, which conveys information about a parameter setting.

Tag name

Description

parameterSetting

Description

Element containing parameter setting information

Type

None

Number of occurrences

0 or more

settingOrder

Description

Setting order

Type

ASCII string

Number of occurrences

Equal to the number of <parameterSetting> tags

softwareName

Description

Software name

Type

UTF-8 string

Number of occurrences

Equal to the number of <parameterSetting> tags

softwareId

Description

Software ID

Type

ASCII string

Number of occurrences

Equal to the number of <parameterSetting> tags

softwareVersion

Description

Software version

Type

ASCII string

Number of occurrences

Equal to the number of <parameterSetting> tags

parameterSettingDefinitionId

Description

Parameter setting definition ID

Type

ASCII string

Number of occurrences

Equal to the number of <parameterSetting> tags

parameterInformationName

Description

Parameter information name of the predefined parameter

Type

UTF-8 string

Number of occurrences

Equal to the number of <parameterSetting> tags

parameterInformationId

Description

Parameter information ID of the predefined parameter. Not output for customized settings.

Type

ASCII string

Number of occurrences

0 or more


The following table explains the <result> element, which conveys information about execution result of a process.

Tag name

Description

result

Description

Element containing the execution result of the process

Type

None

Number of occurrences

1 or more

processName

Description

Process name of the executed process

Type

UTF-8 string

Number of occurrences

Equal to the number of <result> tags

processOrder

Description

Process order of the executed process

Type

int

Number of occurrences

Equal to the number of <result> tags

processType

Description

Process type of the executed process

Type

ASCII string

Number of occurrences

Equal to the number of <result> tags

processExecutor

Description

Executor. The administrator of the job is output.

Type

ASCII string

Number of occurrences

Equal to the number of <result> tags

processStatus

Description

Status of the process. Outputs one of the following:

  • succeeded: Normal termination (The process terminated normally.)

  • failed: Abnormal termination (The process terminated abnormally.)

  • unexpectedly_terminated: Unexpected error (The process terminated abnormally due to an error.)

  • waiting: Waiting (The process is in scheduled standby.)

Type

ASCII string

Number of occurrences

Equal to the number of <result> tags

processStartDate

Description

Start date of the process in YYYY-MM-DD HH:MM:ss (local time) format

Type

ASCII string

Number of occurrences

Equal to the number of <result> tags

processEndDate

Description

End date of the process in YYYY-MM-DD HH:MM:ss (local time) format

Type

ASCII string

Number of occurrences

Equal to the number of <result> tags

messages

Description

Element containing multiple items of message information. It contains multiple message elements.

Type

None

Number of occurrences

Equal to the number of <result> tags

actions

Description

Element containing action information. It contains multiple action elements.

Type

None

Number of occurrences

0 or more


The following table explains the <message> element, which conveys information about a message.

Tag name

Description

message

Description

Element containing message information

Type

None

Number of occurrences

1 or more

messageId

Description

Message ID

Type

ASCII string

Number of occurrences

Equal to the number of <message> tags

messageText

Description

Message text

Type

UTF-8 string

Number of occurrences

Equal to the number of <message> tags

errorType

Description

Error type. Outputs one of the following values:

INFO: Information

WARNING: Warning

ERROR: Error

Type

ASCII string

Number of occurrences

Equal to the number of <message> tags

messageParameters

Description

Element containing information about multiple parameters of the message. It contains multiple parameter elements.

Type

None

Number of occurrences

Equal to the number of <message> tags

messageParameter

Description

Information about the message parameter

Type

UTF-8 string

Number of occurrences

0 or more


The following table explains the elements within the <actions> element, which conveys information about actions.

Tag name

Description

selectable

Description

Element containing information about actions that can be executed

Type

None

Number of occurrences

0 or more

selected

Description

Element containing information about actions that were executed

Type

None

Number of occurrences

0 or more

action

Description

Action. Displays the following values:

  • retry: Retry

  • retryall: Retry all

  • cancel: Cancel

  • continue: Continue

Type

ASCII string

Number of occurrences

0 or more

Notes

None