Panel | ||
---|---|---|
| ||
The purpose of this module is to:
|
Panel | ||
---|---|---|
| ||
|
Overview
The first steps when setting up delegated role and user management:
- Define what types of services and organizations organisations this system will manage
- Define what roles these services and organizations organisations need to operate
- Migrate customer organizations organisations from e.g. existing CRM system
- Create organization organisation users using role invitation by email. The user confirms their own email address by clicking the link and sets their own password
Configure
organizationorganisation types
- You can use organization organisation types to model:
- A customer organization organisation with various roles
- An online service (MySmartPlanSmartPlan Application) with various roles
- Outcome: Organization Organisation type to be used when creating companies
There are two types of organizationsorganisations: physical and virtual.
- Organizations Organisations are used to for storing user accounts
- Virtual organizations organisations are used to model a organizations organisations and services.
- In virtual organizationsorganisations, the users are not physically located in any of the projects but they are part of them through roles.
! Some preparation work
Before you get started, do the following changes on your eidm2.properties file:
Delete all entries related to:
Panel |
---|
# Base URL |
The system will read the correct values from eidm2_generated.properties file. During system setup, the file eidm2_generated.properties is read first and the eidm2.properties is read and overwrites any settings in eidm2_generated.properties
.Then edit the following:
title | eidm2.properties |
---|
.
com:7443/eidm2 # where to redirect the user after logout has been performed general.default.logoutReturnUrl = https://login.smartplan.com:7443/eidm2Tip | ||
---|---|---|
| ||
eidm is obsolete name for CustomerID. It meant "extranet Identity Management" |
Part 1: Configuring
OrganizationOrganisation Types
Step 1: Configuring Customer
OrganizationsOrganisations
company
to hold customer organization organisation userscompany
organization organisation has two roles, Contact Person and Representative, represented by the technical names mainuser and user respectively.Edit C:\Program Files\Ubisecure\customerid\application\custom\eidm2.properties
Code Block title eidm2.properties organization.type.name.1 = company organization.type.company.1 = mainuser organization.type.company.2 = user
Copy C:\Program Files\Ubisecure\customerid\tools\examples\custom\messages_en.properties to C:\Program Files\Ubisecure\customerid\application\custom\ and then add the following lines to the file.
Code Block title messages_en.properties org.label.company = Customer Organization org.label.company.plural = Customer Organizations
Edit Copy C:\Program Files\Ubisecure\customerid\applicationtools\examples\custom\roles.properties to C:\Program Files\Ubisecure\customerid\application\custom\ and then add the following lines to the file.
Code Block title roles.properties en.friendlyName.mainuser = Contact Person en.description.mainuser = The main user of the company. en.friendlyName.user = Representative en.description.user = Employee of the company.
Step 2: Configuring Service
OrganizationsOrganisations
Create a new organization organisation type to hold MySmartPlan SmartPlan Application roles
This service has three roles: Owner, Member and Visitor
Edit C:\Program Files\Ubisecure\customerid\application\custom\eidm2.properties
Code Block title eidm2.properties organization.type.name.2 = site organization.type.site.1 = owner organization.type.site.2 = member organization.type.site.3 = visitor
Edit C:\Program Files\Ubisecure\customerid\application\custom\messages_en.properties
Code Block title messages_en.properties org.label.site = Service org.label.site.plural = Services
Edit C:\Program Files\Ubisecure\customerid\application\custom\roles.properties to define what each role name is
Code Block title roles.properties en.friendlyName.owner = Ownervisitor = Visitor en.description.visitor = Visitor can view public information. en.friendlyName.member = Member en.friendlyName.visitor = Visitordescription.member = Member can read private information. en.friendlyName.owner = Owner en.description.owner = Owner can write information and manage user rights.
Activate all changes by restarting Wildfly
Note |
---|
Restart of Wildfly is required when changes are made to CustomerID system configuration and localization text files |
Part 2: Configuring
OrganizationOrganisation and user attributes
Step 1: Create Custom
OrganizationOrganisation Attributes
Custom organization organisation attributes are added dynamically to the schema as used. If used, localization localisation must be given.
Define default language text key for the new attribute in C:\Program Files\Ubisecure\customerid\application\custom\messages_en.properties
Code Block title messages_en.properties organization.crmid = CRM ID registerWizard.organization.crmid = CRM ID
Define the order of displaying custom fields on the organization organisation info page by modifying: C:\Program Files\Ubisecure\customerid\application\custom\eidm2.properties
Code Block title eidm2.properties ui.admin.organizationinfo.fields.order = technicalname, friendlyname, crmid
Restart Wildfly
Log in and select an organization. Observe to CustomerID Administration interface https://login.smartplan.com:7443/eidm2/wf/admin as Scott Long. Select an organisation and observe the order of attributes:
As you can observe, there are only administrative organizations organisations such as "Users." The next step is to create customer organizations organisations (companies) in the system.
Part 3: Migrate customer
organizationsorganisations
Step 1: Customer Data Integration with Import Tool
- City Group
- Electric Green Cabs
The VAT number (such as 2184053-5) of the customer organization organisation will be used as the unique identifier.
Go to directory C:\Program Files\Ubisecure\customerid\tools\examples\importtool and create a text file crm.import containing the entries shown on the next table
Code Block title crm.import # City Group entity: organization id: 2184053-5 organizationType: company crmid: 73476543 friendlyName: City Group Inc. # Electric Green Cabs entity: organization id: 4638229-4 organizationType: company crmid: 33241231 friendlyName: Electric Green Cabs Inc.
Open the command prompt. In C:\Program Files\Ubisecure\customerid\tools directory, run the following command:
Code Block import.cmd examples\importtool\crm.import
Successful execution will show a message like this:
ImportTool 5.0.31
Create '2184053-5': OK
Create '4638229-4': OK
- Now log in, find the newly created organization organisation "Electric Green Cabs." Observe its attributes and their order as at the end of Part 2 (Technical name, Name, CRM ID).
Part 4: Create users by email
-based invitation
- by By system or organization organisation administrator using the Customer ID administration user interface orby
- Add a user
- Send an email invitation
- By REST interface
- Add a user
- Send an email invitation
- User Self-registration
- Using Import tool
More Information
You can find more information about the CustomerID Data Model in this page: