Page History

<%
/*
 * SAVESCHEDULE Example.    ws_saveschedule.jsp.
 * A more complete example can be found in ws_admin_schedule_management.jsp
 */
%>
 
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="java.text.*" %>
<%@ page import="java.util.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="com.hof.mi.web.service.schedule.*" %>
<%@ page import="com.hof.web.form.*" %>
 
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
  
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the above account
rsr.setOrgId(1);
 
// normally you would load a schedule first and do some sort of modification
rsr.setFunction("LOADSCHEDULE");
 
// existing Schedule UUID to load. Adjust this value
String[] parameters = {
    "SOME_UUID"
};
rsr.setParameters(parameters);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
AdministrationSchedule editingSchedule = null;
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    editingSchedule = rs.getSchedule();
     
} else {
    out.write("LOADSCHEDULE Failure");
    out.write(" Code: " + rs.getErrorCode() );
    return;
}
 
 
editingSchedule.setScheduleActive(true);
 
WeeklyFrequency newFreq = new WeeklyFrequency();
newFreq.setDayOfWeek(ScheduleFrequency.MONDAY);
newFreq.setLocalRunTime(3 * 60 * 60); // 9am
newFreq.setLocalTimezoneCode("AUSTRALIA/SYDNEY");
 
editingSchedule.setFrequency(newFreq);
rsr.setSchedule(editingSchedule);
rsr.setParameters(null);
rsr.setFunction("SAVESCHEDULE");
rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    AdministrationSchedule updatedSchedule = rs.getSchedule();
    out.write("Loaded schedule: " + updatedSchedule.getScheduleUUID() + "<br>");
     
    out.write("Schedule Type: " + updatedSchedule.getScheduleTypeCode() + "<br>");
    out.write("Description: " + updatedSchedule.getScheduleDescription() + "<br>");
    out.write("Is Active: " + updatedSchedule.isScheduleActive() + "<br>");
    out.write("Last Run Status: " + updatedSchedule.getLastRunStatus() + "<br>");
    out.write("Last Run Error: " + updatedSchedule.getLastRunError() + "<br>");
    out.write("Last Run Date: " + updatedSchedule.getLastRunDateTimeGMT() + "<br>");
    out.write("Next Run Date: " + updatedSchedule.getNextRunDateTimeGMT() + "<br>");
     
    // Some schedule types have extra information that you can access, see reference for details
    if (updatedSchedule instanceof ReportRefreshSchedule) {
        ReportRefreshSchedule rrs = (ReportRefreshSchedule)updatedSchedule;
        out.write("Report To Refresh: " + rrs.getReportId() + "<br>");
    }
     
    // these values all have different meanings depending on FrequencyType, see reference for details
    out.write("Frequency Type: " + updatedSchedule.getFrequency().getFrequencyTypeCode() + "<br>");
    out.write("Frequency Code: " + updatedSchedule.getFrequency().getFrequencyCode() + "<br>");
    out.write("Frequency Unit: " + updatedSchedule.getFrequency().getFrequencyUnit() + "<br>");
    out.write("Frequency Local Time: " + updatedSchedule.getFrequency().getLocalRunTime() + "<br>");
    out.write("Frequency Local Timezone: " + updatedSchedule.getFrequency().getLocalTimezoneCode() + "<br>");
     
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
          <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>DELETESCHEDULE</function>
            <parameters>
                <string>75a2f5b5-162b-49b5-b197-53643f7dc0de</string>
            </parameters>             
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>7b8e70f20d25079f86cf26f5712d15f9</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
  
  

  Code Block
  language java theme Eclipse
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("DELETESCHEDULE");

  
  

• 削除する既存のスケジュールを指定します。

  
  

  Code Block
  language java theme Eclipse
  // This is the Yellowfin Schedule UUID String[] parameters ={ "SOME_UUID" }; rsr.setParameters(parameters);

  
  

• リクエストを構成したら、呼び出しを実行します。
  
  

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

• 返される応答には、StatusCodeパラメーターが含まれます。（より詳細な情報は、上記応答パラメーターの表を参照してください）
  
  

<%
/*
 * DELETESCHEDULE Example.        ws_deleteschedule.jsp
 * A more complete example can be found in ws_admin_schedule_management.jsp
 */
%>
 
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="java.text.*" %>
<%@ page import="java.util.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="com.hof.mi.web.service.schedule.*" %>
<%@ page import="com.hof.web.form.*" %>
 
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
  
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("DELETESCHEDULE");
 
String scheduleUUID = "SOME_UUID";
// existing Schedule UUID to delete
String[] parameters = {
    scheduleUUID
};
rsr.setParameters(parameters);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Successfully deleted schedule: " + scheduleUUID);
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

• 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
  
  

  Code Block
  language java theme Eclipse
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("RUNSCHEDULENOW");

  
  

• 実行する既存のスケジュールを指定します。

  
  

  Code Block
  language java theme Eclipse
  // This is the Yellowfin Schedule UUID String[] parameters ={ "SOME_UUID" }; rsr.setParameters(parameters);

  
  

• リクエストを構成したら、呼び出しを実行します。
  
  

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

• 返される応答には、次のパラメーターが含まれます。：StatusCodeとSchedules（より詳細な情報は、上記応答パラメーターの表を参照してください）
  
  

<%
/*
 * RUNSCHEDULENOW Example.     ws_runschedulenow.jsp
 * A more complete example can be found in ws_admin_schedule_management.jsp
 */
 %>
  
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="java.text.*" %>
<%@ page import="java.util.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="com.hof.mi.web.service.schedule.*" %>
<%@ page import="com.hof.web.form.*" %>
  
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
   
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
   
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("RUNSCHEDULENOW");
  
// existing Schedule UUID to submit for running
String scheduleUUID = "SOME_UUID";
String[] parameters = {
    scheduleUUID
};
rsr.setParameters(parameters);
  
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Successfully submitted schedule " + scheduleUUID + " to be run.");
  
    // NOTE: some properties like last run status/date, etc will not yet be updated,
    // since this call only submits the schedule for run and does not wait until it is complete.
    AdministrationSchedule updatedSchedule = rs.getSchedule();
    out.write("Loaded schedule: " + updatedSchedule.getScheduleUUID() + "<br>");
      
    out.write("Schedule Type: " + updatedSchedule.getScheduleTypeCode() + "<br>");
    out.write("Description: " + updatedSchedule.getScheduleDescription() + "<br>");
    out.write("Is Active: " + updatedSchedule.isScheduleActive() + "<br>");
    out.write("Last Run Status: " + updatedSchedule.getLastRunStatus() + "<br>");
    out.write("Last Run Error: " + updatedSchedule.getLastRunError() + "<br>");
    out.write("Last Run Date: " + updatedSchedule.getLastRunDateTimeGMT() + "<br>");
    out.write("Next Run Date: " + updatedSchedule.getNextRunDateTimeGMT() + "<br>");
      
    // Some schedule types have extra information that you can access, see reference for details
    if (updatedSchedule instanceof ReportRefreshSchedule) {
        ReportRefreshSchedule rrs = (ReportRefreshSchedule)updatedSchedule;
        out.write("Report To Refresh: " + rrs.getReportId() + "<br>");
    }
      
    // these values all have different meanings depending on FrequencyType, see reference for details
    out.write("Frequency Type: " + updatedSchedule.getFrequency().getFrequencyTypeCode() + "<br>");
    out.write("Frequency Code: " + updatedSchedule.getFrequency().getFrequencyCode() + "<br>");
    out.write("Frequency Unit: " + updatedSchedule.getFrequency().getFrequencyUnit() + "<br>");
    out.write("Frequency Local Time: " + updatedSchedule.getFrequency().getLocalRunTime() + "<br>");
    out.write("Frequency Local Timezone: " + updatedSchedule.getFrequency().getLocalTimezoneCode() + "<br>");
  
      
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>

• 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
  
  

  Code Block
  language java theme Eclipse
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("PAUSESCHEDULE");

  
  

• 定期スケジュールを中断する既存のスケジュールを指定します。

  
  

  Code Block
  language java theme Eclipse
  // This is the Yellowfin Schedule UUID String[] parameters ={ "SOME_UUID" }; rsr.setParameters(parameters);

  
  

• リクエストを構成したら、呼び出しを実行します。
  
  

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  管理webサービスを初期化します。実行方法の詳細は、こちらを参照してください。

• 返される応答には、次のパラメーターが含まれます。：StatusCodeとSchedules（より詳細な情報は、上記応答パラメーターの表を参照してください）
  
  

<%
/*
 * PAUSESCHEDULE Example.       ws_pauseschedule.jsp
 * A more complete example can be found in ws_admin_schedule_management.jsp
 */
%>
 
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="java.text.*" %>
<%@ page import="java.util.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%@ page import="com.hof.mi.web.service.schedule.*" %>
<%@ page import="com.hof.web.form.*" %>
 
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
  
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // change to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("PAUSESCHEDULE");
 
// existing Schedule UUID to submit for running
String scheduleUUID = "SOME_UUID";
String[] parameters = {
    scheduleUUID
};
rsr.setParameters(parameters);
 
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("Successfully paused schedule " + scheduleUUID);
     
    AdministrationSchedule updatedSchedule = rs.getSchedule();
    out.write("Loaded schedule: " + updatedSchedule.getScheduleUUID() + "<br>");
     
    out.write("Schedule Type: " + updatedSchedule.getScheduleTypeCode() + "<br>");
    out.write("Description: " + updatedSchedule.getScheduleDescription() + "<br>");
    out.write("Is Active: " + updatedSchedule.isScheduleActive() + "<br>");
    out.write("Last Run Status: " + updatedSchedule.getLastRunStatus() + "<br>");
    out.write("Last Run Error: " + updatedSchedule.getLastRunError() + "<br>");
    out.write("Last Run Date: " + updatedSchedule.getLastRunDateTimeGMT() + "<br>");
    out.write("Next Run Date: " + updatedSchedule.getNextRunDateTimeGMT() + "<br>");
     
    // Some schedule types have extra information that you can access, see reference for details
    if (updatedSchedule instanceof ReportRefreshSchedule) {
        ReportRefreshSchedule rrs = (ReportRefreshSchedule)updatedSchedule;
        out.write("Report To Refresh: " + rrs.getReportId() + "<br>");
    }
     
    // these values all have different meanings depending on FrequencyType, see reference for details
    out.write("Frequency Type: " + updatedSchedule.getFrequency().getFrequencyTypeCode() + "<br>");
    out.write("Frequency Code: " + updatedSchedule.getFrequency().getFrequencyCode() + "<br>");
    out.write("Frequency Unit: " + updatedSchedule.getFrequency().getFrequencyUnit() + "<br>");
    out.write("Frequency Local Time: " + updatedSchedule.getFrequency().getLocalRunTime() + "<br>");
    out.write("Frequency Local Timezone: " + updatedSchedule.getFrequency().getLocalTimezoneCode() + "<br>");
 
     
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode() );
}
%>