Document metadata

Application name

CSK_Module_UserManagement

Version

1.5.0

Date

2023-06-19

Author

SICK AG

Crowns

C

CSK_Module_UserManagement

Short description

This is an automatically generated CROWN (description not necessary).

CSK_UserManagement

Short description

Module to handle user management on app level.
With this module you can

- create user
- change userlevel / passwords of the users

Other modules can react on the user logins via the provided events ("OnUserLevel[Userlevel]Active") to show/hide content, enable/disable functions, log the active user via "OnNewLoggedInUser", etc.).
Default password for user "Admin" is "admin".

INFO: Please customize the "userManagement_Model.key" for internal encryption for security reason of your specific application.

Overview

Functions

CSK_UserManagement.addUser()
Short description

Add preset user to available users (see "setNewUsername").

Sample (auto-generated)
CSK_UserManagement.addUser()
CSK_UserManagement.loadParameters()
Short description

Load parameters for this module from the CSK_PersistentData module if possible and use them.

Sample (auto-generated)
CSK_UserManagement.loadParameters()
CSK_UserManagement.login()
Short description

Login in as user with preset username+password (see "setLoginUser"/"setLoginPassword").

Sample (auto-generated)
CSK_UserManagement.login()
CSK_UserManagement.logout()
Short description

Logout of current user.

Sample (auto-generated)
CSK_UserManagement.logout()
CSK_UserManagement.pageCalled()
Short description

Function to register "OnResume" of the module UI (only as helper function).

Return values
Name Type Multiplicity Description

empty

STRING

1

Empty string (only needed to simplify binding).
Sample (auto-generated)
empty = CSK_UserManagement.pageCalled()
CSK_UserManagement.removeUser()
Short description

Remove preselected user (see "selectedUser").

Sample (auto-generated)
CSK_UserManagement.removeUser()
CSK_UserManagement.selectedUserViaTable()
Short description

Get selection of UI table to select user to edit.

Parameters
Name Type Multiplicity Description

selection

STRING

1

Selected User in Table.
Sample (auto-generated)
CSK_UserManagement.selectedUserViaTable(selection)
CSK_UserManagement.selectUserToUpdate()
Short description

Selecte user to update.

Parameters
Name Type Multiplicity Description

user

STRING

1

User to update.
Return values
Name Type Multiplicity Description

success

BOOL

1

Selected user exists.
Sample (auto-generated)
success = CSK_UserManagement.selectUserToUpdate(user)
CSK_UserManagement.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_UserManagement.sendParameters()
CSK_UserManagement.setLoadOnReboot()
Short description

Configure if this module should load its saved parameters at app/device boot up.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_UserManagement.setLoadOnReboot(status)
CSK_UserManagement.setLoginPassword()
Short description

Preset password to login in via "login".

Parameters
Name Type Multiplicity Description

password

STRING

1

Password
Sample (auto-generated)
CSK_UserManagement.setLoginPassword(password)
CSK_UserManagement.setLoginUser()
Short description

Preset user to login via "login".

Parameters
Name Type Multiplicity Description

user

STRING

1

User to login.
Sample (auto-generated)
CSK_UserManagement.setLoginUser(user)
CSK_UserManagement.setNewPassword()
Short description

Set new password for preselected user (see "selectUserToUpdate" / "selectUserViaTable").

Parameters
Name Type Multiplicity Description

password

STRING

1

Password
Sample (auto-generated)
CSK_UserManagement.setNewPassword(password)
CSK_UserManagement.setNewUserLevel()
Short description

Set new userlevel for preselected user (see "selectUserToUpdate" / "selectUserViaTable").

Parameters
Name Type Multiplicity Description

level

ENUM
CSK_UserManagement.UserLevel

1

Userlevel
Sample (auto-generated)
CSK_UserManagement.setNewUserLevel(level)
CSK_UserManagement.setNewUsername()
Short description

Preset username to add as new user via "addUser".

Parameters
Name Type Multiplicity Description

name

STRING

1

New username.
Sample (auto-generated)
CSK_UserManagement.setNewUsername(name)
CSK_UserManagement.setParameterName()
Short description

Function to set the name of the parameters if saved/loaded via the CSK_PersistentData module.

Parameters
Name Type Multiplicity Description

name

STRING

1

Name of the parameter
Sample (auto-generated)
CSK_UserManagement.setParameterName(name)

Events

CSK_UserManagement.OnDataLoadedOnReboot
Short description

Event to call if module tried to load parameters and should be ready.

Sample (auto-generated)
function handleOnDataLoadedOnReboot()
  -- Do something
end

Script.register("CSK_UserManagement.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_UserManagement.OnNewHidePasswordInfo
Short description

Event to hide password info on UI.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnNewHidePasswordInfo(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewHidePasswordInfo", "handleOnNewHidePasswordInfo")
CSK_UserManagement.OnNewHideWrongPassword
Short description

Event to hide info of wrong password on UI.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnNewHideWrongPassword(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewHideWrongPassword", "handleOnNewHideWrongPassword")
CSK_UserManagement.OnNewLoggedInUser
Short description

Notify currently logged in user.

Callback arguments
Name Type Multiplicity Description

user

STRING

1

User logged in
Sample (auto-generated)
function handleOnNewLoggedInUser(user)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewLoggedInUser", "handleOnNewLoggedInUser")
CSK_UserManagement.OnNewLogInPassword
Short description

Notify empty password with page reload.

Callback arguments
Name Type Multiplicity Description

password

STRING

1

Empty password.
Sample (auto-generated)
function handleOnNewLogInPassword(password)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewLogInPassword", "handleOnNewLogInPassword")
CSK_UserManagement.OnNewParameterName
Short description

Notify name of persistent data parameter.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Parameter name
Sample (auto-generated)
function handleOnNewParameterName(name)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewParameterName", "handleOnNewParameterName")
CSK_UserManagement.OnNewPasswordToUpdate
Short description

Notify empty password with page reload.

Callback arguments
Name Type Multiplicity Description

password

STRING

1

Empty password.
Sample (auto-generated)
function handleOnNewPasswordToUpdate(password)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewPasswordToUpdate", "handleOnNewPasswordToUpdate")
CSK_UserManagement.OnNewStatusLoadParameterOnReboot
Short description

Notify status if parameters should be loaded on app/device boot up.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnNewStatusLoadParameterOnReboot(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_UserManagement.OnNewUserLevelToUpdate
Short description

Notify userlevel for selected user to update.

Callback arguments
Name Type Multiplicity Description

userlevel

STRING

1

Current userlevel of selected user to update.
Sample (auto-generated)
function handleOnNewUserLevelToUpdate(userlevel)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewUserLevelToUpdate", "handleOnNewUserLevelToUpdate")
CSK_UserManagement.OnNewUserList
Short description

Notify list of users to be selectable in UI to login.

Callback arguments
Name Type Multiplicity Description

userList

STRING

1

List of users.
Sample (auto-generated)
function handleOnNewUserList(userList)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewUserList", "handleOnNewUserList")
CSK_UserManagement.OnNewUserTableList
Short description

Notify list of users to be selectable in tableview of UI if logged in as admin to select and update users.

Callback arguments
Name Type Multiplicity Description

userList

STRING

1

User list for table view.
Sample (auto-generated)
function handleOnNewUserTableList(userList)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewUserTableList", "handleOnNewUserTableList")
CSK_UserManagement.OnNewUserToLogIn
Short description

Notify preselected user to login.

Callback arguments
Name Type Multiplicity Description

user

STRING

1

User to log in.
Sample (auto-generated)
function handleOnNewUserToLogIn(user)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewUserToLogIn", "handleOnNewUserToLogIn")
CSK_UserManagement.OnNewUserToUpdate
Short description

Notify preselected user to update to show info in UI.

Callback arguments
Name Type Multiplicity Description

user

STRING

1

Selected user.
Sample (auto-generated)
function handleOnNewUserToUpdate(user)
  -- Do something
end

Script.register("CSK_UserManagement.OnNewUserToUpdate", "handleOnNewUserToUpdate")
CSK_UserManagement.OnPersistentDataModuleAvailable
Short description

Notify status if features of CSK_PersistendData module are available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnPersistentDataModuleAvailable(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_UserManagement.OnUserLevelAdminActive
Short description

Notify if currently logged in user has userlevel "Admin".

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_UserManagement.OnUserLevelMaintenanceActive
Short description

Notify if currently logged in user has userlevel "Maintenance" or higher.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_UserManagement.OnUserLevelOperatorActive
Short description

Notify if currently logged in user has userlevel "Operator" or higher.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_UserManagement.OnUserLevelServiceActive
Short description

Notify if currently logged in user has userlevel "Service" or higher.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
  -- Do something
end

Script.register("CSK_UserManagement.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

Enumerations

C

CSK_UserManagement.UserLevel

Available user level.

Items
Value Name Description 
Operator

Operator

Operator

 
Maintenance

Maintenance

Maintenance

 
Service

Service

Service

 
Admin

Admin

Admin