ManPageW Scheduler

From ADempiere ERP Wiki

Jump to: navigation, search

Return to Index

Enjoy it, and help to fill it! But please, always respecting copyright.

Please write your contributions under the Contributions Section



Contents

Window: Scheduler

Description : Maintain Schedule Processes and Logs

Help : Schedule processes to be executed asynchronously



Tab: Schedule Process

Description : Schedule processes

Help : Schedule processes to be executed asynchronously

Table Name  : AD_Scheduler

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Name Alphanumeric identifier of the entity The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. Name

NVARCHAR2(60)

String

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String

Active The record is active in the system There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Process Process or Report The Process field identifies a unique Process or Report in the system. AD_Process_ID

NUMBER(10)

TableDir

Schedule Type Type of schedule Define the method how the next occurance is calculated ScheduleType

CHAR(1)

List

Day of the Month Day of the month 1 to 28/29/30/31 MonthDay

NUMBER(10)

Integer

Day of the Week Day of the Week WeekDay

CHAR(1)

List

Frequency Type Frequency of event The frequency type is used for calculating the date of the next event. FrequencyType

CHAR(1)

List

Frequency Frequency of events The frequency is used in conjunction with the frequency type in determining an event. Example: If the Frequency Type is Week and the Frequency is 2 - it is every two weeks. Frequency

NUMBER(10)

Integer

Supervisor Supervisor for this user/organization - used for escalation and approval The Supervisor indicates who will be used for forwarding and escalating issues for this user - or for approvals. Supervisor_ID

NUMBER(10)

Table

Days to keep Log Number of days to keep the log entries Older Log entries may be deleted KeepLogDays

NUMBER(10)

Integer

Date last run Date the process was last run. The Date Last Run indicates the last time that a process was run. DateLastRun

DATE

DateTime

Date next run Date the process will run next The Date Next Run indicates the next time this process will run. DateNextRun

DATE

DateTime


Tab: Parameter

Description : Scheduler Parameter

Help : Provide parameter for scheduled process

Table Name  : AD_Scheduler_Para

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Scheduler Schedule Processes Schedule processes to be executed asynchronously AD_Scheduler_ID

NUMBER(10)

TableDir

Process Parameter AD_Process_Para_ID

NUMBER(10)

TableDir

Active The record is active in the system There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Default Parameter Default value of the parameter The default value can be a variable like @#Date@ ParameterDefault

NVARCHAR2(60)

String

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String


Tab: Scheduler Recipient

Description : Recipient of the Scheduler Notification

Help : You can send the notifications to users or roles

Table Name  : AD_SchedulerRecipient

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Scheduler Schedule Processes Schedule processes to be executed asynchronously AD_Scheduler_ID

NUMBER(10)

TableDir

Active The record is active in the system There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

User/Contact User within the system - Internal or Business Partner Contact The User identifies a unique user in the system. This could be an internal user or a business partner contact AD_User_ID

NUMBER(10)

Search

Role Responsibility Role The Role determines security and access a user who has this Role will have in the System. AD_Role_ID

NUMBER(10)

TableDir


Tab: Log

Description : Scheduler Log

Help : Result of the execution of the Scheduler

Table Name  : AD_SchedulerLog

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Scheduler Schedule Processes Schedule processes to be executed asynchronously AD_Scheduler_ID

NUMBER(10)

TableDir

Created Date this record was created The Created field indicates the date that this record was created. Created

DATE

DateTime

Summary Textual summary of this request The Summary allows free form text entry of a recap of this request. Summary

NVARCHAR2(2000)

Text

Error An Error occured in the execution IsError

CHAR(1)

YesNo

Reference Reference for this record The Reference displays the source document number. Reference

NVARCHAR2(60)

String

Text Message Text Message TextMsg

NVARCHAR2(2000)

Text

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String

Contributions

Tab: Schedule Process

After Feb 22/2010 (rev 1145) the scheduler can be defined following a Cron Scheduling Pattern

Tab: Parameter

Note that the Default Value must be filled with the internal ID of the record.

For example to define the parameter for accounting schema GardenWorld US/A/US Dollar you must write 101 (the column C_AcctSchema_ID) on the default value.

You can use these context variables in default value:

  • @#AD_Client_ID@ - the client of the scheduled process
  • @#AD_Language@ - the language for the client of the scheduled process
  • @#AD_Org_ID@ - the organization of the scheduled process (if any)
  • @#M_Warehouse_ID@ - the default warehouse from the organization of the scheduled process (if any)
  • @#AD_User_ID@ - the user of the scheduled process (this is the supervisor, if not supervisor then the user who created the record)
  • @#SalesRep_ID@ - same as the previous
  • @#AD_Role_ID@ - the first role assigned to the user on the organization (ordered by AD_Role_ID)
  • @#Date@ - the date of the process running

Tab: Scheduler Recipient

If defined a user AND a role - then it will notify the user and all the users on that role, you can define several records and all of them will be notified.

Running a scheduled process

Note: These comments applies after march 13/2010 (revision 11656)

A scheduled process is executed in a context according to the client, organization, and user (supervisor or creator) of the schedule record. The role for the execution of the process will be the first role assigned (according to AD_Role_ID) for the user on the organization.

For example, if SuperUser creates a scheduled execution of Aging report for client GardenWorld, organization HQ, supervisor GardenAdmin; then the process will be executed with:

  • Client = GardenWorld
  • Organization = HQ
  • User = GardenAdmin (supervisor)
  • Role = GardenWorld Admin (first role assigned to user GardenAdmin on organization HQ)

The process is executed and:

  • On Failure a notification and/or e-mail is sent to the supervisor
  • On Success a notification and/or e-mail is sent to the recipients - if no recipients then it will be sent to the user that created the schedule

The notification is sent by notice and/or e-mail accordingly to the Notification Type defined for the User (on User or BP/Contact window).

Personal tools