Forum Discussion

DK_OS's avatar
DK_OS
New Contributor
2 days ago
Solved

How to export data out of BR

Hi All, I created a Business Rule to export all the GROUPS that i have in OS applciation. i try to export the data in a file. i tried below option , it did not work created BR and executed ther...
Admin
System
  • MarcusH's avatar
    MarcusH
    2 days ago

    I don't know why you are making things complicated. sameburn​ gave you a great starting point. I have updated your script.

    Try
	' Get all security groups
	Dim groupsObj As List(Of Group) = BRApi.Security.Admin.GetGroups(si)

	' FORMATTED OUTPUT FOR EASY VIEWING
	Dim output As New List(Of String)
	output.Add("=== SECURITY GROUPS LIST ===")
	output.Add("Generated: " & DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"))
	output.Add("")
	
	For Each varGroup As Group In groupsObj
		output.Add(varGroup.Name)
	Next
	
	output.Add("")
	output.Add("=== END OF LIST ===")
	output.Add("Total groups: " & groupsObj.Count.ToString())
	
	BRApi.ErrorLog.LogMessage(si, output.ToString)
	
	Return Nothing

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

    Extender rules do not return anything so you will either have to save the file to the fileshare (search this forum for XFFile) or to your user temp folder (search for usertemp in the BR help).

MarcusH's avatar
MarcusH
Valued Contributor
2 days ago

I don't know why you are making things complicated. sameburn​ gave you a great starting point. I have updated your script.

Try
	' Get all security groups
	Dim groupsObj As List(Of Group) = BRApi.Security.Admin.GetGroups(si)

	' FORMATTED OUTPUT FOR EASY VIEWING
	Dim output As New List(Of String)
	output.Add("=== SECURITY GROUPS LIST ===")
	output.Add("Generated: " & DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"))
	output.Add("")
	
	For Each varGroup As Group In groupsObj
		output.Add(varGroup.Name)
	Next
	
	output.Add("")
	output.Add("=== END OF LIST ===")
	output.Add("Total groups: " & groupsObj.Count.ToString())
	
	BRApi.ErrorLog.LogMessage(si, output.ToString)
	
	Return Nothing

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

Extender rules do not return anything so you will either have to save the file to the fileshare (search this forum for XFFile) or to your user temp folder (search for usertemp in the BR help).

DK_OS's avatar
DK_OS
New Contributor
24 hours ago

thanks Marcs,

I was able to export the file to the FileSHare, below is my actual code.

            Try
                ' Get all security groups
                Dim groupsObj As List(Of Group) = BRApi.Security.Admin.GetGroups(si)
                Dim names As New List(Of String)

                For Each varGroup As Group In groupsObj
                    names.Add(varGroup.Name)
                Next

    
                Dim fileName As String = "SecurityGroups"
                Dim filePath As String = $"Documents/Users/{StringHelper.RemoveSystemCharacters(si.UserName, False, False)}"

                ' Use a string builder object
                Dim filesAsString As New StringBuilder()
                
         
                filesAsString.AppendLine("=== SECURITY GROUPS LIST ===")
                filesAsString.AppendLine("Generated: " & DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"))
                filesAsString.AppendLine("Total Groups: " & names.Count.ToString())
                filesAsString.AppendLine("")
                
                ' Add all group names
                For Each name As String In names
                    filesAsString.AppendLine(name)
                Next
                
                filesAsString.AppendLine("")
                filesAsString.AppendLine("=== END OF LIST ===")

                ' Convert the string to an array of byte
                Dim fileAsByte() As Byte = System.Text.Encoding.Unicode.GetBytes(filesAsString.ToString)

                ' Save file using COMMUNITY METHOD
                Dim fileDataInfo As New XFFileInfo(FileSystemLocation.ApplicationDatabase, $"{fileName}.txt", filePath)
                Dim fileData As New XFFile(fileDataInfo, String.Empty, fileAsByte)
                BRApi.FileSystem.InsertOrUpdateFile(si, fileData)

                Return Nothing

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

 

Appreciate your help on this. I need to update the security USERS/GROUPS from a CSV file.

Should i ABle to update using BR to the backend tables or should i use the BR API similar to the above code.

1. Update user access , remove or add groups
2. Update Users - delete or add new users

 


May i ask you one more question, i am not great in VB.net coding. is there any specific course or site that i should go through to understand the API and functions calling details?