pp108 : CreateSchedule

CreateSchedule

  


This method is used to create a schedule. CreateSchedule is a part of the Methodset Scheduler 1.0 in the Cordys Scheduler application package.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <CreateSchedule xmlns="http://schemas.cordys.com/scheduler/1.0">
            <tuple>
                <new>
                    <schedule count="-1" lastupdated="1360215902409"
                        name="Test"
                        templateOrganization="o=system,cn=cordys,cn=test,o=test.com" templateid="00215A63-1B7C-11E2-EE1D-22208A01BF4D">
                        <datetime>
                            <daily>
                                <time>14:0</time>
                            </daily>
                        </datetime>
                        <listener>cn=Northwind Service,cn=soap nodes,o=system,cn=cordys,o=test.com</listener>
                        <parameters>
                            <GetEmployee xmlns="http://schemas.cordys.com/1.0/demo/northwind">
                                <EmployeeID>101</EmployeeID>
                            </GetEmployee>
                        </parameters>
                    </schedule>
                </new>
            </tuple>
        </CreateSchedule>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

templateid (deprecated)

ID of the schedule model

The attribute templateid is deprecated in Cordys BOP 4.2. Therefore, do not provide any value for this attribute.

Note: Continuing the usage of this attribute can result in an unexpected behavior.

 No GUID of the schedule model if the schedule model is already deployed

name

Name of the schedule model

Yes

Schedule model name

count

Number of times the schedule instance will be executed:

  • A positive value indicates the number of times the instance will be executed.
  • A value of '-1' indicates that the schedule instance will execute infinitely based on the defined conditions such as a specified duration.

No

  

templateOrganization

 DN of the organization where the schedule model is deployed. This field is required only when the templateid is provided. No DN of the organization where the schedule model is deployed.

lastupdated

 Last updated time of the schedule model. This field is required only when the templateid is provided. No Last updated time of the schedule model
datetime Details of the schedule types as defined in the schedule model. For example, hourly, daily, weekly, monthly, firstdayofmonth, lastdayofmonth, firstweekday, lastweekday, fortnightly, and so on. If the schedule model is defined only for manual execution, then the value will be 'runnow'. Yes

You must provide one of the following datetime values:

  • <hourly> - accepts <minutes> in the 'mm' format
  • <daily> - accepts <time> in the 'mm:ss' format
  • <weekly> - accepts <weekday> in the 'dd hh:mm' format
  • <monthly> - accepts <time> in the 'hh:mm:ss' format
  • <firstdayofmonth> - accepts <time> in the '' format
  • <lastdayofmonth> - accepts <time> in the 'hh:mm' format
  • <firstweekday> - accepts <time> in the 'hh:mm' format
  • <lastweekday> - accepts <time> in the 'hh:mm' format.
  • <fortnightly> - accepts <time> in the 'hh:mm' format.

listener (deprecated)

DN of the service container, which must participate when the schedule is executed at the specified time. The value of the listener is based on the actions defined in the schedule model.

Note: The attribute listener is deprecated in Cordys BOP 4.2. Therefore, do not depend on the value for this attribute.

No

  

parameters

SOAP request that will be considered for triggering the action at the scheduled time

No

Specify the required inputs for the parameters.

 

SOAP Response

<CreateScheduleResponse xmlns="http://schemas.cordys.com/scheduler/1.0">
    <tuple>
        <new>
            <schedule count="3" templateid="{7F0EDCA7-E3FD-482D-A206-53813B926334}">
                <scheduleid>{B87D16D2-95FB-4369-B4A8-80145144E0A5}</scheduleid>
                <name>HourlySchedule</name>
                <organizationalcontext>o=system,cn=cordys,o=test.com</organizationalcontext>
                <datetime>
                    <hourly>
                        <minutes>0</minutes>
                        <minutes>30</minutes>
                    </hourly>
                    <starttime>2007-03-07 12:00:00</starttime>
                    <endtime>-1</endtime>
                </datetime>
                <scheduleat>2007-03-07 12:00:00</scheduleat>
                <listener>cn=Northwind Service,cn=soap nodes,o=system,cn=cordys,o=test.com</listener>
                <parameters>
                    <GetEmployee xmlns="http://schemas.cordys.com/1.0/demo/northwind">
                        <EmployeeID>101</EmployeeID>
                    </GetEmployee>
                </parameters>
                <owner>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=test.com</owner>
            </schedule>
        </new>
    </tuple>
</CreateScheduleResponse>
Response Parameters

Parameter

Description

count

Number of times the schedule instance will be executed:

  • A positive value indicates the number of times the instance will be executed.
  • A value of '-1' indicates that the schedule instance will execute infinitely based on the conditions that were defined such as a specified duration.

templateid

ID of the schedule model

scheduleid

ID of the schedule

name

Name of the schedule model

organizationalcontext

Organization in which the schedule is set to run

datetime

Details of the schedule types as defined in the schedule model. For example, hourly, daily, weekly, monthly, firstdayofmonth, lastdayofmonth, firstweekday, lastweekday, fortnightly, and so on. If the model is defined only for manual execution, then the value will be 'runnow'.

scheduleat

Date and time at which the schedule will run next

listener (deprecated)

DN of the service container, which must participate when the schedule is executed at the specified time. The value of the listener is based on the actions defined in the schedule model.

Do not depend on the value of the listener as it is deprecated .

parameters

SOAP request that will be considered for triggering the action at the scheduled time

owner

User who instantiated the schedule. If the 'auto-deploy' is on, then the user will be the same as the user who deployed the model. If the 'auto-deploy' is off, then it will be the user who activated the schedule.