User Guide > Objects > Working with Objects > System Return Codes of Executable Objects

System Return Codes of Executable Objects

Various return codes are set while executable objects are processed. A value range between 1000 and 2000 is reserved for these system return codes. The system return code is linked to a specific job status.

System Return Codes and Assigned Task States in the Workflow / Schedule Objects

[System return codes] [Task Status] [Manual Modification]

In workflows, a task responds to a preceding one. The condition or task status to which a preceding task responds can be selected in the properties dialog of the object's Dependencies tab.

Example:
You can define in a workflow task that it must only run if its preceding task has ended with ANY_SKIPPED.

ANY_SKIPPED combines conditions that correspond to the return codes 1920, 1922, 1930, 1931 and 1940 (table 1). Accordingly, the task runs if the preceding task ended with one of the following conditions (table 3): ENDED_INACTIV (1920), ENDED_INACTIVE (1922), ENDED_SKIPPED (1930), ENDED_SKIPPED (1931) or ENDED_TIMEOUT (1940).

In workflows, the following states are also possible:

ENDED_INACTIVE_MANUAL (equilvalent to 1922)
ENDED_INACTIV (equilvalent to 1920,1921,1922)
ENDED_OK_OR_INACTIV (equilvalent to 1900,1920,1921,1922)

The following two tables list all available conditions or task states and their meanings.

Task Status/Condition	Description	System return code
ANY_ABEND	The preceding task ended abnormally. ANY_ABEND combines all conditions with return codes between 1800 and 1899.	1800-1899
ANY_ABEND_EXCEPT_FAULT	Conditions of ANY_ABEND without FAULT*	1800-1815, 1850-1899
ANY_EXCEPT_FAULT	Conditions of ANY_ABEND and ANY_OK without FAULT*	1800-1815, 1850-1999
ANY_OK	The preceding task ended without errors. ANY_OK combines all conditions with return codes between 1900 and 1999.	1900-1999
ANY_SKIPPED	The preceding task has been skipped. ANY_SKIPPED is a listing of certain conditions (these conditions are also available in ANY_OK).	1920,1922,1930,1931,1940, 1941, 1942
ENDED_CANCEL	The preceding task has been canceled. The job itself or the whole workflow can have been canceled.	1850,1851
ENDED_EMPTY	The preceding task is empty. The activation has ended without an error message (STOP NOMSG - script statement).	1910
ENDED_INACTIV	The preceding task is inactive.	1920, 1912, 1922
ENDED_INACTIVE_OBJECT	The task is inactive because of its object definition.	1925
ENDED_NOT_OK	The preceding task has been aborted (return code <> 0).	1800
ENDED_OK	The preceding task has ended normally (return code = 0).	1900
ENDED_OK_OR_EMPTY	The preceding task has ended normally or is empty.	1900,1910
ENDED_OK_OR_INACTIV	The preceding task has ended normally or is inactive.	1900,1920,1922
ENDED_ROLLBACK_EMPTY	No rollback defined.	1913
ENDED_ROLLBACKED	Task was rolled back successfully.	1904
ENDED_SKIPPED	The preceding task has been skipped because of a WHEN clause.	1930
ENDED_TIMEOUT	The preceding task has not been executed because of a timeout (WHEN clause).	1940
ENDED_UNDEFINED	The preceding task has ended in an undefined manner (the agent has ended prematurely).	1815
ENDED_VANISHED	The preceding task has vanished.	1810
ENDED_WF_ROLLBACKED	Workflow was rolled back successfully.	1905
FAULT_ALREADY_RUNNING	The group is already running.	1822
FAULT_CUSTOM_BACKUP	Error in custom backup	1825
FAULT_CUSTOM_ROLLBACK	Error in custom rollback	1827
FAULT_FILE_BACKUP	Error in file backup	1826
FAULT_FILE_ROLLBACK	Error in file rollback	1828
FAULT_HOSTGROUP_ROLLBACK	Error in agent group rollback	1829
FAULT_ROLLBACK	General error in rollback	1830
FAULT_NO_HOST	The preceding task could not start because the host is not available.	1821
FAULT_OTHER	The preceding task could not start because of another error.	1820

You can supplement conditions and task states that are predetermined by the system by adding user-defined ones. The following examples show five conditions that are not based on system return codes. They use user-defined return codes.

Task Status/Condition	Description	User return code
USER_100_200	The preceding task has ended with a user return code between 100 and 200.	0100-0200
USER_147	The preceding task has ended with the user return code 147.	0147
USER_201_299	The preceding task has ended with a user return code between 201 and 299.	0201-0299
USER_300	The preceding task has ended with the user return code 300.	0300
USER_500_600	The preceding task has ended with a user return code between 500 and 600.	0500-0600

System Return Codes and Assigned Task States During Execution

[System return codes] [Task Status] [Manual Modification]

A task can show various conditions while it is being processed. These conditions correspond to a specified return code.

System return code	Task Status/Condition
1300	Preparing
1301	Waiting for user-input/a prompt is displayed for the user
1510	Transferred
1520	Ready for transfer (before connect)
1521	Ready to be transferred
1529	Ready for generation
1530	Ready for start
1531	To be called
1540	Start initiated
1541	Checking
1542	Calling
1543	Unknown
1544	Inconsistent
1545	Started
1546	Connecting
1547	Inconsistent RemoteTaskManager
1550	Active
1551	Transferring
1552	Called
1553	Accepted
1554	Sampling Files
1556	Escalated
1557	Custom backup
1558	File backup
1560	Workflow is blocked.
1561	STOP - Client-wide stop of automatic processing.
1562	HELD - Manual stop has been set.
1563	STOP - Automatic processing has been stopped.
1564	STOP - Queue processing has been stopped.
1565	Finished sending task
1569	Skipping Sync object.
1570	Skipping
1571	Canceling
1572	Generating
1573	Generated
1574	Post processing
1575	Ending
1576	Regenerating
1578	Scanning files
1579	Scanning reports
1580	Resolving variables
1581	Checking Postconditions
1582	Checking prompt values
1583	LOOPING
1599	Alive user view
1600	Internal checking
1650	Custom rollback
1651	File rollback
1652	Agent group rollback
1653	Workflow rollback
1655	Waiting for rollback
1681	Waiting for user/a prompt is waiting, but the user is not connected to the engine
1682	Waiting for continuation of variable resolving
1684	Waiting for queue slot (max. parallel tasks exceeded)
1685	Waiting for post processing host
1686	Waiting for start of agent group container
1687	Waiting for end of parallel agent group tasks
1688	Waiting for the host of an agent group.
1689	Waiting for resource (max. file transfers exceeded)
1690	Waiting for external precondition
1691	Waiting for remote system
1692	Waiting for remote SYNC
1693	Waiting for manual release
1694	Waiting for resource (max. jobs exceeded)
1695	Waiting for restart time
1696	Waiting for host
1697	Waiting for SYNC
1698	Waiting for start time
1699	Alive
1700	Waiting for predecessor
1701	Sleeping
1702	Not yet called
1703	Waiting for Preconditions
1705	CHANGING_LOG
1709	Waiting for end of parallel task
1710	Registered
1711	Queue
1800	ENDED_NOT_OK - Aborted
1801	ENDED_NOT_OK - Aborted because of SYNC condition
1802	ENDED_JP_ABEND - Not executed because of abnormal workflow end.
1810	ENDED_VANISHED - Disappeared
1815	ENDED_LOST - Ended undefined (host terminated prematurely)
1820	FAULT_OTHER - Start impossible. Other error.
1821	FAULT_NO_HOST - Start impossible. Cannot reach host.
1822	FAULT_ALREADY_RUNNING - Task is already running
1823	FAULT_POST_PROCESSING - Error in post processing
1824	FAULT_POST_CONDITION - Error in Post-Condition.
1825	FAULT_CUSTOM_BACKUP - Error in custom backup
1826	FAULT_FILE_BACKUP - Error in file backup
1827	FAULT_CUSTOM_ROLLBACK - Error in custom rollback
1828	FAULT_FILE_ROLLBACK - Error in file rollback
1829	FAULT_HOSTGROUP_ROLLBACK - Error in agent group rollback
1830	FAULT_ROLLBACK - General error in rollback
1850	ENDED_CANCEL - Manually canceled.
1851	ENDED_JP_CANCEL - Workflow canceled manually.
1852	Rejected
1853	ENDED_QUEUE_CANCEL
1854	ENDED_CONTAINER_CANCEL
1856	ENDED_ESCALATED - Aborted due to escalation
1860	Notification failed
1898	Blocked
1899	Status blocked manually removed.
1900	ENDED_OK - Ended normally
1901	Confirmed
1902	ENDED_QUEUE_END (status for subordinate tasks of an SAP job that has been ended)
1903	ENDED_CONTAINER_END (status for tasks of an agent group that has been ended)
1904	ENDED_ROLLBACKED - Task was rolled back successfully
1905	ENDED_WF_ROLLBACKED - The workflow was rolled back successfully.
1910	ENDED_EMPTY - Task is empty (STOP NOMSG)
1911	ENDED_TRUNCATE - Transfer incomplete because of the line limit.
1912	ENDED_EMPTY - Nothing found
1913	ENDED_ROLLBACK_EMPTY - No rollback defined.
1919	ENDED_INACTIVE - Inactive due to logical date condition of external dependency
1920	ENDED_INACTIVE - Inactive today because of the calendar.
1921	ENDED_INACTIVE - Task is not active because of the definition.
1922	ENDED_INACTIVE - Task has manually been set inactive.
1923	Deleted
1924	UNPROCESSED
1930	ENDED_SKIPPED - Skipped because of WHEN clause.
1931	ENDED_SKIPPED - Skipped because of SYNC condition.
1932	ENDED_SKIPPED - Schedule ended prematurely.
1933	ENDED_SKIPPED - Skipped because of conditions
1940	ENDED_TIMEOUT - Not executed because of timeout (WHEN clause).
1941	ENDED_TIMEOUT - Start time exceeded.
1942	ENDED_TIMEOUT - Ended untimely.
1944	ENDED_TIMEOUT - Period stopped
1960	Notification successful.
1970	Operation successful.
1999	SYNC check passed.

Manual Modification of Task States

[System return codes] [Task Status] [Manual Modification]

During the execution of tasks, you can also change the task's current status manually. Right-click the task in the Activity Window and select the popup-menu command Modify state manually. You can assign a new status to the task in the dialog window.

Use this function only in exceptional cases.