ISWhiteboardItem.ToProviderGroupID

Description

ID of the provider group that is used to limit the display of whiteboard entries to those that are for this group.

Syntax

object.ToProviderGroupID

Part Attribute Type Description
object Required
The object always implements the ISWhiteboardItem interface

Return Value

int

Example

Display the number of whiteboard items and some information about them, including the names of the provider groups.

sub main
  Dim aFilter
  Dim aWhiteboardItems, aWhiteboardItem
  Dim aMessage
  Dim i

  Set aFilter = Profile.CreateWhiteboardFilter
  aFilter.BoardTypeCode = "NORMAL"
  set aWhiteboardItems = Profile.LoadWhiteboardItems(aFilter)
  aMessage = "Whiteboard Items Count = " & aWhiteboardItems.Count

  for i = 0 to aWhiteboardItems.Count - 1
    set aWhiteboardItem = aWhiteboardItems.Item(i)
    aMessage = aMessage & vbNewLine & " ---------------------- " & vbNewLine &_
       "Acuity: " & aWhiteboardItem.AcuityTypeCode & vbNewLine &_
       "Reason: " & aWhiteboardItem.ReasonTypeCode & vbNewLine &_       
       "Instruction: " & aWhiteboardItem.Instruction & vbNewLine &_  
       "Group: " & aWhiteboardItem.FromProviderGroupID & vbNewLine &_
       "Provider Group Name: " & GetGroupName(aWhiteboardItem.ToProviderGroupID)
  next 
  
  Profile.MsgBox(aMessage)
end sub

function GetGroupName(aGroupId)
  Dim aFilter
  Dim aProviderGroups
  Dim aName
    
  set aFilter = Profile.CreateProviderGroupFilter
  aFilter.ID = aGroupId
  set aProviderGroups = Profile.LoadProviderGroups(aFilter)
  if aProviderGroups.Count > 0 then
    aName = aProviderGroups.Items(0).Name
  else
    aName = ""
  end if  
  GetGroupName = aName     

end function 
Note:

In Profile Client v8 on User Interface ID cannot be found, but Provider Group can be found in Organisation > Work Centre > Work > Whiteboard > Edit Whiteboard Entry > To fields.

Version information

Added in v7.8.0