Skip to main content
Version: 7.9

system.groups.loadFromFile

This function is used in Python Scripting.

Description​

Loads a transaction group configuration from an xml export, into the specified project (creating the project if necessary). The mode parameter dictates how overwrites occur.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.groups.loadFromFile(filePath, projectName, mode)

Parameters​

TypeParameterDescription
StringfilePathThe path to a valid transaction group xml or csv file.
StringprojectNameThe name of the project to load into.
intmodeHow duplicates will be handled:
  • 0 = Overwrite
  • 1 = Ignore
  • 2 = Replace the existing project with this one

Returns​

Nothing

Scope​

Gateway

Code Examples​

Example #1
# Note that backslashes are used in Windows filepaths, but are also escaped in Python. Thus, we use the double-backslashes here.
path = "C:\\Users\\user\\Desktop\\group.xml"

projName = "MyProject"

# Read a Transaction Group from a file, and overwrite any preexisting groups that match those in our file.
system.groups.loadFromFile(path, projName, 0)