Phase Type ExecuteTask

A phase for executing tasks configured in configuration input file(s).
See com.sap.sdt.tools.cfg for more details concerning task configuration.

Author:: Kiril Bratanov
Version:: 1.0
Since:: 700
See:: Detailed Description, Preconditions, Postconditions, and Side Effects, Troubleshooting, Example

Parameters
Parameter	Description	Since	Required
`inputFile`	The name of the xml file containing the configuration containing the task to be executed, for example readProfiles.xml. The file will be looked for in `$(JUMP_ROOT_DIR)/config/` directory	1.0	Yes
`taskName`	The name of the task to be executed, for example `READ_BASIC_PROFILE`	1.0	Yes

Additional Log and Output Files

File Directory Description

Detailed Description

This phase uses {@link com.sap.sdt.tools.cfg.ConfigurationBuilderIF} to build a {@link com.sap.sdt.tools.cfg.ConfigurationIF} from the input file specified. Then tries to find the task in the configuration built specified by the taskName parameter. If the task is found then it is executed, else an exception is thrown signifying what task could not be found.

Preconditions, Postconditions, and Side Effects

Preconditions

Input file must be $(JUMP_ROOT_DIR)/dtd/Configuration.dtd compliant

In case of using macro-variables in the input file the corresponding variables must be present in the data model so that the actual values could be known.

Postconditions

Side Effects

Restartability

If the phase is restarted using the "Repeat the phase" then it executes all operations. If the phase is restarted using "Repeat the phase from the point of failure" then it executes the operations from the error point operation on.

Troubleshooting

When this phase fails, perform these actions in the specified order to determine the actual cause for the failure and possible corrective actions:

1. Check that all required parameters are specified.

2. Check that parameters specified are valid. Make sure the input file is Configuration.dtd compliant and that there exists inside a task with the task name specified.

3. Check that the task in the input file is properly configured and contains valid variables/macroses.

Typical Failure Symptoms

Symptoms Cause Action

Configuration building fails The reason could be that the input file was not Configuration.dtd compliant Search for SAP notes or other specific troubleshooting information related to this error. Contact the technical support. Open a CSN ticket in the CSN component of BC-UPG.

Task execution fails The reason could be that the task doesn't exist in the input file Search for SAP notes or other specific troubleshooting information related to this error. Contact the technical support. Open a CSN ticket in the CSN component of BC-UPG.

Task execution fails The reason could be that the task was not properly configured Search for SAP notes or other specific troubleshooting information related to this error. Contact the technical support. Open a CSN ticket in the CSN component of BC-UPG.

Example


      <Phase name="READ_BASE_PROFILES" type="com.sap.sdt.ucp.phases.PhaseTypeExecuteTask">

        <Parameter name="inputFile">readProfiles.xml</Parameter>

        <Parameter name="taskName">READ_BASIC_PROFILES</Parameter>

      </Phase>

Additional Log and Output Files
File	Directory	Description

Typical Failure Symptoms
Symptoms	Cause	Action
Configuration building fails	The reason could be that the input file was not Configuration.dtd compliant	Search for SAP notes or other specific troubleshooting information related to this error. Contact the technical support. Open a CSN ticket in the CSN component of BC-UPG.
Task execution fails	The reason could be that the task doesn't exist in the input file	Search for SAP notes or other specific troubleshooting information related to this error. Contact the technical support. Open a CSN ticket in the CSN component of BC-UPG.
Task execution fails	The reason could be that the task was not properly configured	Search for SAP notes or other specific troubleshooting information related to this error. Contact the technical support. Open a CSN ticket in the CSN component of BC-UPG.