This lesson is part of the Vision Components and Property Bindings course. You can browse the rest of the lessons below.

Supplemental Videos


Learn how to manage users, schedules, and rosters from the Ignition client using components to affect the User Sources in the Gateway.

Video recorded using: Ignition 8.1


(open in window)

[00:00] While we typically manage users, rosters, and schedules within the gateway webpage, it is possible to do all of this from the client. The easiest way is to use the built-in components that we've provided for you. The user management component, the roster management component, and the schedule management component. All three of these components can be found in the admin section of the component pallet. Each of these components can be dragged onto the window and then used like any other component. Let's start with looking at the user management component. This component allows you to add, edit, or delete user and role information. I could edit this admin user here and add some contact information. Then I'll hit the save button to save the changes. However, doing so produces an error stating you are not authorized to modify the gateway system user source. To get around this, we need to enable the gateway setting, allow user admin under the general settings. This allows the user management component to make changes to the user source on the gateway.

[01:07] The components mode, user source, and username properties determine which user source or specific users to manage. The manage users mode makes it so all the users and roles in the specified user source can be added, removed, or edited in edit single mode. The component only edits a single user, which user is being edited, is controlled by the user source and username properties, so I could edit only the guest user by typing in guest to the username property. Finally, the edit current mode looks at the user who is currently logged into the project, allowing them to edit their own user. We need to consider if an identity provider is used in this project as it would not allow me to use the component in edit current mode. We can see the error message here is produced because we are using an identity provider. The authentication strategy could be changed under our project's vision login properties.

[02:05] When I switch back into edit current, the error message will go away. One other configuration that is necessary for our management components is with the schedule manager. In order to use this component, we need to ensure the user management project permission is enabled. Now we can add, edit, or delete schedules with the component. I'll add a new schedule. Schedules can be defined by specifying which days of the week and which times of the day they are active on. The times of day are defined using a string of time ranges where the times are specified in 24 hour format with dashes between the beginning and the end. Multiple ranges can be specified by separating them with commas. For example, I could have 8:00 AM to 12:00 PM and 12:45 to 2:00 PM for a set of time ranges. Schedules that alternate weekly or daily can be specified using the repetition settings.

[03:04] Finally, the on-call roster component works very similarly to the gateway roster settings. You can add, edit, or delete any rosters and it doesn't need any additional configurations to work. In addition to these components, you can also use scripting to modify your users rosters and schedules. If I go to my script console, you'll notice I have a scripting function listed here. The function system dot user remove schedule will allow me to remove the schedule that i've called example. There are many functions similar to this in the system user section of our functions, allowing you to modify users schedules and rosters. If you would like to learn more about each of these components or any of the scripting functions available to you, check out our user manual where you can find all the information in the appendix section.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.