4.4 Accessing the Resource Planner

Handyman 6.0 Build 698 and newer includes the possibility access the built in Resource Planner.

An application that demonstrates the use of ePocket.COMInterface.dll is included.
Handyman must be installed on your computer to be able to run the application. 

Sample code is provided in a VisualBasic project. If you do not have Visual Basic installed you can look at the source code samples here.

The class for accessing the Resource Planner is located in ePocket.COMInterface.dll and is called ResourcePlanner. An instance of the object can be made (in Visual Basic or Visual FoxPro) with the statement:

oResourcePlanner = CreateObject("ePocket.COMInterface.ResourcePlanner")

There is one function used to access the Resource Planner:

Function definition:

Public Function ShowResourcePlanner( _
                  ByVal aClientID As String, _
                  Optional ByVal aOrderId As String = "", _
                  Optional ByVal aUserID As String = "") As Long   

Sample code:

• aClientID must be provided to compatible with MultiClient installations
• aOrderID is the order to get focus in the Resource Planner.
• aUserID is the ID of the official in charge. If not provided the official in charge of the order is used.
  The ID is the same as EmployeeNo for the user.
• if the installation does not have a license for the resource planner, the function returns -1, otherwise it returns 1.
  
• Get the list of changed orders in the ChangedOrders property. This is a string with semicolon separated order numbers that was changed.
  Use this list to fetch data from Handyman (using 4.1.1 QueryOrder) to update own orderdata without synchronizing.
  - The order start and finish date may have changed
  - Dates on participants, and the number of participants on the order may have changed

    Dim oResourcePlanner As Object
    Dim llReturnCode As Long
    Dim lsChangedOrders As String
       
    Set oResourcePlanner = CreateObject("ePocket.COMInterface.ResourcePlanner")
   
    With oResourcePlanner
        ''' supported languages
        ' Norwegian = "nb-NO"
        ' Swedish = "sv-SE"
        ' Danish = "da-DK"
        ' German = "de-DE"
        ' English = "en-GB"
       
        ' if culture is not set, it will default to language for company
        ' .Culture = "en-GB" ''' english
       
        ' Specify order that will have focus, order must exist in Handyman
        ' Official in charge should be specified to get correct access level in the resource planner
        llReturnCode = .ShowResourcePlanner("000", txtOrder.Text, txtOfficialInCharge.Text)
       
        ' if license for resource planner is not active returncode = -1, otherwise 1
        If llReturnCode = -1 Then
            MsgBox "No license", vbCritical, "Handyman Resource planner"
        End If

        ' get list of changed orders
        lsChangedOrders = .ChangedOrders
        If lsChangedOrders <> "" Then
            ' get order data from handyman using QueryOrder and update own list of orders
        End If

    End With

    Set oResourcePlanner = Nothing