Skip to content

Retrieve System Status

The public method Get_System_Status in Scheduling_Utility_API can be used to retrieve the system status of IFS Planning & Scheduling Optimization (PSO) server.

This method accepts three parameters:

  • response_, out parameter of type CLOB, to which the response will be written.
  • response_format_, optional parameter to specify the response format. Possible values are 'XML', 'JSON' and 'IFS_MESSAGE'. If not specified 'IFS_MESSAGE' will be used as the default format.
  • scheduling_config_id_, optional parameter to specify the Configuration ID from Scheduling Optimization and Machine Learning Configuration to use. If not specified the 'DEFAULT' configuration will be used.
BEGIN  
  Scheduling_Utility_API.Get_System_Status(response_             => :response_, -- Clob parameter to accept response data  
                                           response_format_      => 'XML'),     -- Requested response format ('XML' / 'JSON' / 'IFS_MESSAGE')  
                                           scheduling_config_id_ => 'DEFAULT'); -- Configuration ID to use  
END;

For the above call, the response may look as following. The response may vary depending on the IFS Planning & Scheduling Optimization (PSO) version being used. For more details about retrieving system status please see the PSO Interface Guide.

<SystemStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RESTfulGateway.ResponseObjects">  
  <Id>2320</Id>  
  <LastStatusTime>2021-02-03T15:32:28.623+01:00</LastStatusTime>  
  <LastSystemTestQueryDuration>PT0S</LastSystemTestQueryDuration>  
  <LastSystemTestSuccessful>true</LastSystemTestSuccessful>  
  <LastSystemTestTime>0001-01-01T00:00:00</LastSystemTestTime>  
  <LastSystemTestTimeTaken>PT0S</LastSystemTestTimeTaken>  
  <LastSystemTestTimeTakenDSE>PT0S</LastSystemTestTimeTakenDSE>  
  <LicencedCustomerName>IFS</LicencedCustomerName>  
  <RecentErrorCount>0</RecentErrorCount>  
  <RecentWarningCount>0</RecentWarningCount>  
  <TotalDSECapability>49.68651308664279</TotalDSECapability>  
  <TotalLiveDatasetFootprint>0.7</TotalLiveDatasetFootprint>  
  <TotalWaitingDatasetFootprint>0</TotalWaitingDatasetFootprint>  
</SystemStatus>

Tip: The IFS Message response format ('IFS_MESSAGE') allows using existing methods in Message_SYS package to handle the response which may be simpler to use in the PL/SQL code than 'XML' or 'JSON'.