Automic Workload Automation

  • Private Community
Back to discussions
Expand all | Collapse all

Task status

Jessica Isaacson

Jessica IsaacsonJun 02, 2014 12:50 PM

Cool, thanks!
Anon Anon

Anon AnonJul 11, 2014 03:01 AM

Cool, Michael! Thank you.

  • 1.  Task status

    Posted May 23, 2014 06:51 AM

    JobPlanMonitor.Task.getStatus()returns task statuses in a form that does not appear to be documented anywhere. These statuses (e.g,state_running or state_ended), do not correspond to the statuses returned by theTaskDetails class. These statuses also appear to be different from those documented in the User Guide (inSystem Return Codes for Executable Objects).

    Is there a list of all the statuses that can be returned byJobPlanMonitor.Task.getStatus()and what they mean?

    If not, it would be very helpful if someone would publish acomplete list of these statuses, preferably in a table that makes clear how they map to the UC4 system return codes and statuses described the User Guide.

    For example:

                                                                                                           
     

    Code

          		  
    		  

    Status 

          		 
    		  

    Status   Text     

          		 
    		  

    Description

     
     

    1550

     
    		 

    state_running

     
    		 

    Active

     
    		 

    Task   is running

     
     

    1560

     
    		 

    state_blocked

     
    		 

    Workflow   is blocked.

     
    		 

    Workflow   is blocked because a constituent job is blocking it. (Applies only to   workflows.)

     
     

    1562

     
    		 

    state_holded

     
    		 

    HELD   - Manual stop has been set.

     
    		 

    Task   has been manually held (The Set breakpoint checkbox in task properties   is checked).

     
     

    1697

     
    		 

    state_waiting_sync

     
    		 

    Waiting   for SYNC

     
    		 

    Task   is waiting for a SYNC object.

     
     

    1700

     
    		 

    state_waiting

     
    		 

    Waiting   for predecessor

     
    		 

    Task   is waiting for a predecessor.

     
     

    1800

     
    		 

    state_abended

     
    		 

    ENDED_NOT_OK   - Aborted

     
    		 

    Task   ended in error.

     
     

    1850

     
    		 

    state_cancelled

     
    		 

    ENDED_CANCEL   - Manually canceled.

     
    		 

    Task   was manually cancelled.

     
     

    1898

     
    		 

    state_blocking

     
    		 

    Blocked

     
    		 

    Task   ended in error and is blocking successors.

     
     

    1900

     
    		 

    state_ended

     
    		 

    ENDED_OK   - Ended normally.

     
    		 

    Task   completed successfully.

     
     

    1921

     
    		 

    state_inactive_def

     
    		 

    ENDED_INACTIVE   - task not active due to definition.

     
    		 

    Task   has been disabled (The Active checkbox in the task properties is not   checked).

     
     

    1922

     
    		 

    state_inactive_man

     
    		 

    ENDED_INACTIVE   - Task has manually been set inactive.

     
    		 

    Task   has been made inactive (e.g., using MODIFY_TASK).

     
     

    etc.

     
    		 

     

     
    		 

     

     
    		 

     

     

     

    (There is also an API class called TaskState, but it is not clear how this is related.)









  • 2.  Task status

    Posted May 27, 2014 11:29 AM

    Michael, there is currently no list of stati like you request it.

    A complete list of all possible stati is found in Documentation > User Guide > Objects > Working with Objects > Returncodes >System Return Codes of Executable Objects

    Its a  complete list not broken down to the possible stati of each executable objects.

    If you would like this, you can request it over the product suggestion form within support.automic.com


  • 3.  Task status

    Posted May 27, 2014 11:34 AM

    Thanks for the reply, Harald. The table you mentioned (to which I also linked in my original post) does not include the names of the statuses returned byJobPlanMonitor.Task.getStatus(). The possible values returned by this method and their meanings do not appear to be documented anywhere. This is what I’m looking for, and FYI, I also opened a support incident for this.



  • 4.  Task status

    Posted May 27, 2014 12:22 PM
    No answer, just an "amen!"  Thanks for posting those codes and translations. I agree that the way they interact with the job statuses is also important to know, at least if you're working with the system from any non-GUI angle.  Operationally, the task statuses are usually (but not always, of course) more important than the job status. Also, the ejpp/ajpp tables have their own version of job status, which sometimes conflicts with ah_status. 

    I understand the need to be precise, but it's **** to work with externally.  :p  Not sure whether to be comforted or annoyed that the GUI also has trouble with precedence of the statuses; for example, a task that is HELD at breakpoint (a very important status) is only displayed as "waiting for predecessor" in the GUI.

    We have an extensive suite of web reports straight off the database, and rushed to replicate them for UC4 during our AppWorx conversion... not knowing how difficult it would be to display some of the more subtle status distinctions. As I'm upgrading them right now, the status codes and messages (in a text file, what?!?) are killing me! Seems it's time for me to bite the bullet and learn java... the API results at least return text.  :)


  • 5.  Task status
    Best Answer

    Posted May 28, 2014 05:05 AM

    I received a reply to the support incident. The complete table of statuses is below.

     

    Status list 9.00A

     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
    getStatusCode()  
    		getStatus()                       
    		  
    		getStatusText()                                                                
    1005
    		state_waiting
    		Actually running
    1006
    		state_waiting
    		Checked
    1008
    		state_waiting
    		Aborted
    1009
    		state_waiting
    		Done
    1300
    		state_waiting
    		Preparing
    1301
    		state_waiting
    		Waiting for user input
    1310
    		state_waiting
    		operation not initialized
    1510
    		state_waiting
    		Transferred
    1520
    		state_running
    		Ready for transfer (before Connect)
    1521
    		state_running
    		Ready to be transferred
    1529
    		state_running
    		Ready for generation
    1530
    		state_running
    		Ready for start
    1531
    		state_waiting
    		To be called
    1540
    		state_running
    		Start initiated
    1541
    		state_running
    		Checking
    1542
    		state_running
    		Calling
    1543
    		state_running
    		Unknown
    1544
    		state_running
    		Inconsistent
    1545
    		state_running
    		Started
    1546
    		state_running
    		Connecting
    1547
    		state_running
    		Inconsistent RemoteTaskManager
    1550
    		state_running
    		Active
    1551
    		state_running
    		Transferring
    1552
    		state_running
    		Called
    1553
    		state_running
    		Accepted
    1554
    		state_running
    		Sampling files
    1556
    		state_running
    		Escalated
    1557
    		state_running
    		Custom Backup
    1558
    		state_running
    		File Backup
    1560
    		state_jp_blocking
    		Workflow is blocked
    1561
    		state_stopped_sys
    		STOP - Client-wide stop of automatic processing
    1562
    		state_holded
    		HELD - Manual stop has been set
    1563
    		state_stopped_man
    		STOP - Automatic processing has been stopped.
    1564
    		state_stopped_queue
    		STOP - Queue processing has been stopped.
    1565
    		state_running
    		Finished sending task
    1566
    		state_running
    		Skipping - Timeout
    1567
    		state_running
    		Skipping - Conditions
    1568
    		state_running
    		Skipping - manually inactive
    1569
    		state_running
    		Skipping Sync
    1570
    		state_running
    		Skipping
    1571
    		state_running
    		Canceling
    1572
    		state_running
    		Generating
    1573
    		state_running
    		Generated
    1574
    		state_running
    		Post processing
    1575
    		state_ending
    		Ending
    1576
    		state_running
    		Regenerating
    1578
    		state_running
    		Scanning Files
    1579
    		state_running
    		Scanning reports
    1580
    		state_running
    		Resolving variables
    1581
    		state_running
    		Checking Post Conditions
    1582
    		state_running
    		Checking prompt values
    1583
    		state_running
    		LOOPING
    1599
    		state_waiting
    		Alive user view
    1600
    		state_waiting
    		Internal checking
    1650
    		state_waiting
    		Custom Rollback
    1651
    		state_waiting
    		File Rollback
    1652
    		state_waiting
    		AgentGroup Rollback
    1653
    		state_waiting
    		Workflow Rollback
    1655
    		state_waiting
    		Waiting for rollback
    1681
    		state_waiting
    		Waiting for User
    1682
    		state_waiting
    		Waiting for continuation of variable resolving
    1683
    		state_waiting
    		Waiting for user input
    1684
    		state_waiting_queue
    		Waiting for Queue slot
    1685
    		state_waiting
    		Waiting for post processing host
    1686
    		state_waiting
    		Waiting for start of AgentGroup container.
    1687
    		state_waiting
    		Waiting for end of parallel host-group tasks
    1688
    		state_waiting
    		Waiting for the host of an AgentGroup.
    1689
    		state_waiting
    		Waiting for resource (max. FileTransfers exceeded)
    1690
    		state_waiting_ext
    		Waiting for external dependency
    1691
    		state_waiting
    		Waiting for remote system
    1692
    		state_waiting
    		Waiting for remote SYNC
    1693
    		state_waiting_mrel
    		Waiting for manual release
    1694
    		state_waiting
    		Waiting for resource (max. Jobs exceeded)
    1695
    		state_waiting
    		Waiting for restart time
    1696
    		state_waiting
    		Waiting for host
    1697
    		state_waiting_sync
    		Waiting for SYNC
    1698
    		state_waiting_time
    		Waiting for start time
    1699
    		state_waiting
    		Alive
    1700
    		state_waiting
    		Waiting for predecessor
    1701
    		state_sleeping
    		Sleeping
    1702
    		state_waiting
    		Not yet called
    1703
    		state_waiting_precond
    		Waiting for Preconditions
    1704
    		state_waiting
    		Checking Preconditions
    1705
    		state_waiting
    		CHANGING_LOG
    1709
    		state_waiting_parallel_task
    		Waiting for end of parallel task(s)
    1710
    		state_registered
    		Registered
    1711
    		state_waiting
    		Queued
    1799
    		state_abended
    		Dead
    1800
    		state_abended
    		ENDED_NOT_OK - aborted
    1801
    		state_abended
    		ENDED_NOT_OK - aborted because of SYNC condition
    1802
    		state_abended
    		ENDED_JP_ABEND - not executed due to abnormal Workflow end.
    1810
    		state_abended
    		ENDED_VANISHED - disappeared
    1815
    		state_abended
    		ENDED_LOST - ended undefined (host terminated prematurely).
    1820
    		state_abended
    		FAULT_OTHER - Start impossible. Other error.
    1821
    		state_abended
    		FAULT_NO_HOST - Start impossible. Cannot reach host.
    1822
    		state_abended
    		FAULT_ALREADY_RUNNING - task is already running.
    1823
    		state_abended
    		FAULT_POST_PROCESSING - error in post processing.
    1824
    		state_abended
    		FAULT_POST_CONDITION - Error in Postcondition.
    1825
    		state_abended
    		FAULT_CUSTOM_BACKUP - Error in custom backup
    1826
    		state_abended
    		FAULT_FILE_BACKUP - Error in file backup
    1827
    		state_abended
    		FAULT_CUSTOM_ROLLBACK - Error in custom rollback
    1828
    		state_abended
    		FAULT_FILE_ROLLBACK - Error in file rollback
    1829
    		state_abended
    		FAULT_HOSTGROUP_ROLLBACK - Error in AgentGroup rollback
    1830
    		state_abended
    		FAULT_ROLLBACK - General error in rollback
    1850
    		state_abended
    		ENDED_CANCEL - manually canceled
    1851
    		state_abended
    		ENDED_JP_CANCEL - Workflow canceled manually.
    1852
    		state_abended
    		Rejected
    1853
    		state_abended
    		ENDED_QUEUE_CANCEL
    1854
    		state_abended
    		ENDED_CONTAINER_CANCEL
    1856
    		state_abended
    		ENDED_ESCALATED - aborted due to escalation
    1860
    		state_abended
    		Notification failed
    1898
    		state_blocking
    		Blocked
    1899
    		state_abended
    		Status blocked manually removed
    1900
    		state_ended
    		ENDED_OK - ended normally
    1901
    		state_inactive
    		Confirmed
    1902
    		state_inactive
    		ENDED_QUEUE_END
    1903
    		state_inactive
    		ENDED_CONTAINER_END
    1904
    		state_inactive
    		ENDED_ROLLBACKED - Task was rolled back successfully.
    1905
    		state_inactive
    		ENDED_WF_ROLLBACKED
    1910
    		state_inactive
    		ENDED_EMPTY - task is empty (STOP NOMSG).
    1911
    		state_inactive
    		ENDED_TRUNCATE - Transfer incomplete due to line limit.
    1912
    		state_inactive
    		ENDED_EMPTY - nothing found.
    1913
    		state_inactive
    		ENDED_ROLLBACK_EMPTY - No rollback defined
    1919
    		state_inactive
    		ENDED_INACTIVE - inactive due to logical date condition of external dependency.
    1920
    		state_inactive_cale
    		ENDED_INACTIVE - Inactive today because of Calendar.
    1921
    		state_inactive_def
    		ENDED_INACTIVE - task not active due to definition
    1922
    		state_inactive_man
    		ENDED_INACTIVE - Task was manually set inactive.
    1923
    		state_inactive
    		Deleted
    1924
    		state_inactive
    		UNPROCESSED
    1930
    		state_inactive
    		ENDED_SKIPPED - Skipped because of WHEN clause
    1931
    		state_inactive
    		ENDED_SKIPPED - Skipped because of SYNC condition.
    1932
    		state_inactive
    		ENDED_SKIPPED - Schedule ended prematurely
    1933
    		state_inactive
    		ENDED_SKIPPED - Skipped because of conditions.
    1940
    		state_inactive
    		ENDED_TIMEOUT - Not executed because of timeout (WHEN clause).
    1941
    		state_inactive
    		ENDED_TIMEOUT - Start time exceeded.
    1942
    		state_inactive
    		ENDED_TIMEOUT - ended untimely.
    1944
    		state_inactive
    		ENDED_TIMEOUT - period stopped
    1960
    		state_inactive
    		Notification successful
    1970
    		state_inactive
    		Operation successful
    1999
    		state_inactive
    		SYNC check passed

     



  • 6.  Task status

    Posted Jun 02, 2014 12:50 PM

    Cool, thanks!




  • 7.  Task status

    Posted Jun 05, 2014 05:34 AM

    Why can’t I mark my own reply as the answer to the question?:smile: 



  • 8.  Task status

    Posted Jun 12, 2014 04:37 PM

    I went ahead and marked it for you. I've also copied that list out and I will see about also generating KBE's against that as well.



  • 9.  Task status

    Posted Jul 11, 2014 03:01 AM

    Cool, Michael! Thank you.



  • 10.  Task status

    Posted Sep 03, 2014 02:42 PM
    Your list is far more complete than the table UC_ZUTYP, but it also offers a summary of some of the state codes.


  • 11.  Task status

    Posted Sep 05, 2014 09:42 AM
    Very helpful!

    Automic -- could you please see about getting this table added to the official (F1) documentation?


  • 12.  Task status

    Posted Sep 05, 2014 12:06 PM
    The API documentation is now online, and the above list is included as of SP9. See AbstractTask.getStatusCode() (or in context on the AbstractTask manual page).


  • 13.  Task status

    Posted Nov 04, 2014 09:30 AM
    If it is not too much to ask, I would like to repeat my request for descriptions in plain language of the meaning of each status code. The status text is not sufficient as a description.
    1. First of all, it is too short, and not detailed enough.
    2. Second, it provides no context. E.g.,
      • What causes a task to get this status?
      • What causes a task toswitch from this status to a different status?
      • Does this status apply to all executable objects, or just workflows?
      • Etc.
    3. Third, the status text of different statuses is sometimes confusingly similar or even identical, as shown in the example below.
                                             
    getStatusCode()



    		getStatus()



    		getStatusText()
    1301
    		       


    		state_waiting       


    		Waiting for user input
    1681


    		state_waiting


    		Waiting for User
    1683


    		state_waiting


    		Waiting for user input
    How is a user or developer supposed to determine the difference between these three different status codes?

    See the table in my original post for an idea of the sort of descriptions I am looking for. Surely this sort of documentation exists internally at Automic. Someone just needs to prepare it for external publication. This would be greatly appreciated.

    Thanks!


  • 14.  RE: Task status

    Posted Sep 08, 2022 09:20 AM
    We identified a few more status codes that are undocumented in the AbstractTask API class documentation.

    UC4 Status Code UC4 Message UC4 Status
    1712 Waiting for certificate synchronization ?
    1897 Violated ?
    1926 UNPROCESSED_IF - if branch not processed ?
    1934 ENDED_SKIPPED - Skipped manually ?
    1997 Fulfilled ?


    Would someone from Broadcom be kind enough to fill in the blanks? (And would someone perhaps update the documentation?)


    Original Message