The purpose of this module is to:
- Get you started with configuring CustomerID
- Give you an overview of organizations, roles
- CustomerID installed
Overview
The first steps when setting up delegated role and user management:
- Define what types of services and organizations this system will manage
- Define what roles these services and organizations need to operate
- Migrate customer organizations from e.g. existing CRM system
- Create organization users using role invitation by email. The user confirms their own email address by clicking the link and sets their own password
Configure organization types
- You can use organization types to model:
- A customer organization with various roles
- An online service (MySmartPlan) with various roles
- Outcome: Organization type to be used when creating companies
There are two types of organizations: physical and virtual.
- Organizations are used for storing user accounts
- Virtual organizations are used to model organizations and services.
- In virtual organizations, the users are not physically located in any of the projects but they are part of them through roles.
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.
Wondering what "eidm" stands for?
eidm is obsolete name for CustomerID. It meant "extranet Identity Management"
Part 1: Configuring Organization Types
Step 1: Configuring Customer Organizations
company
to hold customer organization userscompany
organization 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
eidm2.propertiesorganization.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.
messages_en.propertiesorg.label.company = Customer Organization org.label.company.plural = Customer Organizations
Copy C:\Program Files\Ubisecure\customerid\tools\examples\custom\roles.properties to C:\Program Files\Ubisecure\customerid\application\custom\ and then add the following lines to the file.
roles.propertiesen.friendlyName.mainuser = Contact Person en.friendlyName.user = Representative
Step 2: Configuring Service Organizations
Create a new organization type to hold MySmartPlan roles
This service has three roles: Owner, Member and Visitor
Edit C:\Program Files\Ubisecure\customerid\application\custom\eidm2.properties
eidm2.propertiesorganization.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
messages_en.propertiesorg.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
roles.propertiesen.friendlyName.owner = Owner en.description.owner = Owner of this site with manager rights en.friendlyName.member = Member en.description.member = Member of the site en.friendlyName.visitor = Visitor en.description.visitor = Read only access
Activate all changes by restarting Wildfly
Restart of Wildfly is required when changes are made to CustomerID system configuration and localization text files
Part 2: Configuring Organization and user attributes
Step 1: Create Custom Organization Attributes
Custom organization attributes are added dynamically to the schema as used. If used, localization must be given.
Define language text key for the new attribute in C:\Program Files\Ubisecure\customerid\application\custom\messages_en.properties
messages_en.propertiesorganization.crmid = CRM ID registerWizard.organization.crmid = CRM ID
Define the order of displaying custom fields on the organization info page by modifying: C:\Program Files\Ubisecure\customerid\application\custom\eidm2.properties
eidm2.propertiesui.admin.organizationinfo.fields.order = technicalname, friendlyname, crmid
Restart Wildfly
Log in and select an organization. Observe the order of attributes:
As you can observe, there are only administrative organizations such as "Users." The next step is to create customer organizations (companies) in the system.
Part 3: Migrate customer organizations
Step 1: Customer Data Integration with Import Tool
- City Group
- Electric Green Cabs
The VAT number (such as 2184053-5) of the customer organization 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
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:
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 "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 system or organization administrator using the Customer ID administration user interface
- Add a user
- Send an email invitation
- By REST interface
- Add a user
- Send an email invitation
- User Self-registration
- Using Import tool