...
h3. Component: com.avoka.livecycle.businesstime 8.0
h2. BusinessTime Service
Business Time: Business time related features such as date calculation, wait and scheduling, with business calendar awareness.
h3. Operation Title: Business Time Calculate (calculate)
Business Time Calculate: Calculate date after adding or subtracting a certain time unit, taking into consideration the business time setup.
|| Input Parameter || Type || Description || Editor ||
|
| Use Current Date | boolean | Use current date as input date. | |
| Input Date | java.util.Date | The input date to perform date calculation on. This will be ignored if you check using current date. | | |
| |
Settings
Working Week
| XML | An XML document (or GUI setting) specifying working day in a week with working hours for each day of the week.| [View|#WorkWeekConfiguration.jpg] | |
| Holidays | XML | An XML document (or GUI settings) specifying holidays.| [View|#HolidaysConfiguration.jpg] |
| Add/Subtract | int | The time period to add or subtract from the input date. | | |
... | Test | N/A | Click on "Test" button to test the business time calculation. Note: All parameters have to be specified literally for testing.| [View|#Test.jpg] |
|| Output Parameter || Type || Description ||
| Result Date | java.util.Date | The process variable to store the result of the date calculation. |
h3. Operation Title: Business Time Wait (wait)
Business Time Wait: Wait for a certain period of time, taking into consideration the business time setup. Please note that this is a long-lived operation and can only be dropped into a long-lived process. The Process Management component of LiveCycle ES needs to be installed in order to run a long-lived operation.
|| Input Parameter || Type || Description || Editor || |
| Use Current Date | boolean | Use current date as input date. | |
| Input Date | java.util.Date | The input date to perform date calculation on. This will be ignored if you check using current date. | | |
| |
Settings
Working Week
| XML | An XML document (or GUI setting) specifying working day in a week with working hours for each day of the week.| [View|#WorkWeekConfiguration.jpg] | |
| Holidays | XML | An XML document (or GUI settings) specifying holidays.| [View|#HolidaysConfiguration.jpg] |
| Wait | int | The time period to wait | | |
... | Test | N/A | Click on "Test" button to test the business time calculation. Note: All parameters have to be specified literally for testing.| [View|#Test.jpg] |
h3. Operation Title: Schedule (getScheduleDate)
Schedule: Schedule wait for recurring action. Note: This operation is designed to be used in a process loop.
|| Input Parameter || Type || Description || Editor ||
| Working Day Specification | java.util.List | List of working days in a week. | |
| Holidays | XML | An XML document (or GUI settings) specifying holidays.| [View|#HolidaysConfiguration.jpg] |
| Business Day Aware Scheduling | boolean | Specify if the scheduling logic to be aware of business day settings| [View|#ScheduleConfiguration.jpg] |
| Schedule Time - Hour | java.lang.String | Specify the hour for the next scheduled time| [View|#ScheduleConfiguration.jpg] |
| Schedule Time - Minute | java.lang.String | Specify the minute for the next scheduled time| [View|#ScheduleConfiguration.jpg] |
| Schedule Time - Second | java.lang.String | Specify the second for the next scheduled time| [View|#ScheduleConfiguration.jpg] |
| Schedule Type | java.lang.String | Specify the scheduling pattern type, whether it is on daily, weekly or monthly basis.
Depending on what type of scheduling is selected here, different properties set will be prompted
to allow user to specify the complete scheduling logic.| [View|#ScheduleConfiguration.jpg] |
| Everyday | boolean | This property is enabled when the scheduling type is selected to "Daily".
Specify the scheduling pattern to be every day.| [View|#ScheduleConfiguration.jpg] |
| Every 'N' Day(s) | java.lang.String | This property is enabled when the scheduling type is selected to "Daily".
Specify the frequency of the daily recurrence to be of every certain amount of day(s).| |
| Recur every 'N' week(s) | java.lang.String | This property is enabled when the scheduling type is selected to "Weekly".
Specify the frequency of the weekly recurrence to be of every certain amount of week(s).| |
| Every 'N' Day(s) | java.lang.String | This property is enabled when the scheduling type is selected to "Weekly".
Specify the scheduling pattern to be on weekly basis on a certain week day.| |
| Use Date Recurrence | boolean | This property is enabled when the scheduling type is selected to "Monthly".
Specify if the scheduling pattern to be on a particular date of the month on monthly basis,
otherwise the scheduling pattern will be on a certain weekday of a certain week on monthly basis.| [View|#ScheduleConfigurationMonthly.jpg] |
| Date | java.lang.String | This property is enabled when the scheduling type is selected to "Monthly", and "Use Date Recurrence" is selected.
Specify the date of the month in which the monthly scheduling should recur.| [View|#ScheduleConfigurationMonthly.jpg] |
| Every 'N' Month(s) | java.lang.String | This property is enabled when the scheduling type is selected to "Monthly", and "Use Date Recurrence" is selected.
Specify the frequency of the monthly recurrence to be of every certain amount of month(s).| [View|#ScheduleConfigurationMonthly.jpg] |
| N-th Week | java.lang.String | This property is enabled when the scheduling type is selected to "Monthly", and "Use Date Recurrence" is not selected.
Specify the N-th week in which the monthly scheduling should recur.| [View|#ScheduleConfigurationMonthly.jpg] |
| Week Day | java.lang.String | This property is enabled when the scheduling type is selected to "Monthly", and "Use Date Recurrence" is not selected.
Specify the day of the week in which the monthly scheduling should recur.| [View|#ScheduleConfigurationMonthly.jpg] |
| Every 'N' Month(s) | java.lang.String | This property is enabled when the scheduling type is selected to "Monthly", and "Use Date Recurrence" is not selected.
Specify the frequency of the monthly recurrence to be of every certain amount of month(s).| [View|#ScheduleConfigurationMonthly.jpg] |
|| Output Parameter || Type || Description ||
| Next Schedule Time | java.util.Date | Variable to store the next schedule time. |
h3. Operation Title: Wait Until (waitUntil)
Wait Until: Wait until the specified date is reached. Please note that this is a long-lived operation and can only be dropped into a long-lived process. The Process Management component of LiveCycle ES needs to be installed in order to run a long-lived operation.
|| Input Parameter || Type || Description || Editor ||
| Wait Until Date | java.util.Date | The date to wait until. | |
h5.
{panel:borderStyle=solid}
For how to configure license information for this component service - Business Time, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]
Please send us any questions or comments on this documentation regarding Business Time by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: Business Time]
{panel}
h3. Licence Configuration:
|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
{anchor:HolidaysConfiguration.jpg}
!HolidaysConfiguration.jpg!
{anchor:WorkWeekConfiguration.jpg}
!WorkWeekConfiguration.jpg!
{anchor:ScheduleConfiguration.jpg}
!ScheduleConfiguration.jpg!
{anchor:ScheduleConfigurationMonthly.jpg}
!ScheduleConfigurationMonthly.jpg!
{anchor:Test.jpg}
!Test.jpg! |
Business Time DSC
