The OneStream Community is temporarily frozen until June 29th due to the ongoing maintenance. Please read the blog post here to learn more.

Forum Discussion

OS_Pizza's avatar
OS_Pizza
Contributor III
4 years ago

How to automate lock and unlock workflow using Business rule

I am looking for a business rule or function to lock and unlock workflow and then set it as scheduled task.
Workflow
Oscar's avatar
Oscar
Contributor
4 years ago

Great find! However, the function asks for workflowChannelKey ... How can I generate that parameter for the suggested function:

BRApi.Workflow.Locking.LockWorkflowUnitDescendants(si, si.WorkflowClusterPk, WorkflowProfileTypes.AllProfiles, workflowChannelKey)

  • LeeB's avatar
    LeeB
    Contributor III
    4 years ago

    Hi Oscar,

     

    You could leave empty to lock all channels, or specify an individual Workflow Channel, see examples below.

     

    Dim wfChannelId As Guid = guid.Empty
' Dim wfChannelId As Guid = WorkflowChannel.NoDataLock.UniqueID
' Dim wfChannelId As Guid = WorkflowChannel.AllChannelInput.UniqueID
' Dim wfChannelId As Guid = WorkflowChannel.Standard.UniqueID

     

     Then use:

     

    BRapi.Workflow.Locking.LockWorkflowUnitDescendants(si, si.WorkflowClusterPk, WorkflowProfileTypes.AllProfiles, wfChannelId)

     

     

    • AHarding's avatar
      AHarding
      New Contributor II
      3 years ago

      Hi Lee

      Any ideas on how to get .LockWorkflowUnitDescendants with a non standard channel (i.e. added by the customer)? The logic seems to allow express use of 'NoDataLock', 'AllChannelInput' and 'Standard', but for custom WF Channels, can't seem to identify how to get the UniqueId info.

      Br

      Alex

       

      • OS_Pizza's avatar
        OS_Pizza
        Contributor III
        3 years ago

        AHarding @lee Were you able to complete using non standard channel ? Same challenge here.

        Dim wfChannelId As Guid = WorkflowChannel.<Custom channelname>
  • OS_Pizza's avatar
    OS_Pizza
    Contributor III
    4 years ago

    I have created the below BR and it works like a charm . Let me know if it doesn't work for you.

     

    Public Function Main(ByVal si As SessionInfo, ByVal globals As BRGlobals, ByVal api As Object, ByVal args As ExtenderArgs) As Object
    Try


    Dim wfClusterPk As New WorkflowUnitClusterPk()

    Dim Pname As String = "Your workflow name"
    Dim Sname As String = "Scenerio name"
    Dim Tname As String = "Timeperiod Eg- 2022M4"

    wfClusterPk = BRAPi.Workflow.General.GetWorkflowUnitClusterPk(si,Pname,Sname,Tname)


    'To Lock
    Brapi.Workflow.Locking.LockWorkflowUnit(si,wfClusterPk)


    'To unlock
    'Brapi.Workflow.Locking.UnlockWorkflowUnit(si,wfClusterPk)


    Return Nothing
    Catch ex As Exception
    Throw ErrorHandler.LogWrite(si, New XFException(si, ex))
    End Try
    End Function