System user functions

Ignition
1

I was trying to figure out how to write a bunch of roles to a set of users.

I have a script that I was given.
It has some functions like getContactInfo() and getRoles().

image
image344×827 7.51 KB

I don't see getContactInfo() in the list

So I thought maybe there are functions that I don't know about that will help me that I should ask about.

I basically want to add some roles to a list of users in a script to save time.

I can get their emails with my current script.
I don't now how to set their roles though.

2

system.user.getUser() returns a user object which has functions like getContactInfo and getRoles. Based on this javadoc if you have a User object, you can use setRoles(java.util.Collection<java.lang.String> roles).to add roles to a user.

3 Likes
3

It looks like once you have that user object, you could also use some combination of:

system.user.addRole(userSource, role)
system.user.editRole(userSource, oldName, newName)
system.user.removeRole(userSource, role)
2 Likes
4

What Aaron and Mark said.

Additionally, the docs section on user properties will be helpful.

2 Likes
5

I think those change roles for the usersource, not the user.

6

Once you edit the User object you call system.user.editUser to save those changes.

3 Likes
7

My best guess with ChatGPT help is below.

I tested it without the system.user.editUser call.
Seems to print normal.

The nesting part is a bit confusing for me.

# List of emails to check against
email_list = ["email1@example.com", "email2@example.com", "email3@example.com"]

# Retrieve all users
users = system.user.getUsers('default')

# Loop through each user
for user in users:
    # Get contact info for the user
    contacts = user.getContactInfo()
    
    # Check if any contact is an email in the email_list
    for contact in contacts:
        if contact.contactType == "email" and contact.value in email_list:
            # Get the user's current roles
            current_roles = user.getRoles()
            
            # Append the "Pilot" role if not already present
            if "Pilot" not in current_roles:
                current_roles.append("Pilot")
                
                # Update the user's roles
                user.setRoles(current_roles)
                
                # Save the changes
                system.user.editUser("default", user)

                print(f"Added 'Pilot' role to user: {user.getName()}")
8

f strings don't exist in Python 2, and the print function is only available behind a from __future__ import. This code is going to throw a syntax error when it reaches this conditional, if it even compiles. You cannot trust ChatGPT et al for general purpose Ignition help, full stop.

5 Likes
9

Okay, but other than that line?

When I print the user, I don't get a dictionary, and that part confuses me a bit.
I think it works other than just not able to print out the username at the end.

10

It looks approximately correct, but I don't have time to debug further.

1 Like
11

I attempted the system.user.editUser function on a user that exists, but is not a real user.

# List of emails to check against
email_list = ["email1@example.com"]

# Retrieve all users
users = system.user.getUsers('default')

# Loop through each user
for user in users:
    # Get contact info for the user
    contacts = user.getContactInfo()
    
    
    # Check if any contact is an email in the email_list
    for contact in contacts:
        if contact.contactType == "email" and contact.value in email_list:
            # Get the user's current roles
            current_roles = user.getRoles()
            print 'current roles'
            print (current_roles)
            
            # Append the "Pilot" role if not already present
            if "Pilot" not in current_roles:
                current_roles.append("Pilot")
                
                # Update the user's roles
                user.setRoles(current_roles)
                print 'user'
                print (user)
                print (user.get('username'))
                system.user.editUser("default", user)

I got back an error.
com.inductiveautomation.ignition.common.messages.UIResponse@25f99185

12

That is not necessarily an error, it is a UIResponse object (details here)

On that response you can call methods like getErrors(), getInfos(), getWarns()

13

I searched for how to do what you are saying.
added to my script, hope I did it right:

from com.inductiveautomation.ignition.common.messages import UIResponse
......

print(UIResponse.getErrors(system.user.editUser("default", user)))

I got this to print:

[class org.python.core.PyString cannot be cast to class java.lang.String (org.python.core.PyString is in unnamed module of loader 'app'; java.lang.String is in module java.base of loader 'bootstrap')]
14

you shouldn't need to import the class

response = system.user.editUser("default",user)
print response.getErrors()
print response.getInfos()
print response.getWarns()
1 Like
15

Is it upset that I tried to append "Pilot"?

I think it is upset that I tried to pass a string into the sequence.
The tuple prints fine.
I don't think I matched the expectations of the object though.

16

No, you tried to run the methods on the class you imported, instead of the instance you received.

17

That went over my head.

Do you mean the UIResponse methods or you mean the User methods?

Like I am getting the wrong error information or the error information says that my User methods are wrong?

18

You imported that class unnecessarily. The class's methods are placeholders. The response object instance has the usable methods.

4 Likes
19

Thanks

I got the same error both ways.

Says I can't cast a PyString as a Java String I think. I don't know what it wants me to do though.

I think I have a syntax error that I don't recognize.

Doesn't everyone have a script for setting roles and could easily help me?
Setting roles on the gateway takes like 20 seconds per person when pressing the save button.

I feel I am struggling with something that should just be a code snippet on the manual, that setting user roles via script is the only way to effectively set roles.
I don't think it is something I would know by reading programming books.
I think it is something obvious to maybe someone who worked with 7.9 and before though. I think I am new in 8.1, and need help with knowing what I am doing wrong in the script.

I am looking over the java doc for the user object. This has wasted a lot of my time, very frustrating. I am nearly certain the error is obvious to another person.

ChatGPT said I might be copying the older user object and need to create a new one. Testing it.

20

I'm fairly certain you are getting the error because Pilot does not already exist as a role. Make sure Pilot is an available role before trying to assign it to a user.

1 Like