Skip to content

Registration step scope

Account registration is a scenario that results with the appearance of a new active account (that can be a physical body for B2C case or a company for B2B case) in the system and the user who can normally act in the system on behalf of this account.

Overview

Main entities

Accounts data are managed in the Customer module. Native Virto Commerce functionality contains the following type of accounts and contacts:

Type Description
Organization Represents a buyer organization in the system, an account (in business terms) in B2B case. Is a container for other organizations (brunches or sub-companies) and contacts.
Contact Represents a physical body that can be an account (in business terms) by himself in B2C case or may belong to one or more organization accounts in B2B case.
Vendor Represents a vendor organization in the system, can not contain other entities (vendors or contacts) by default.
Employee Represnts the seller (system owner) employee. May belong to one or more organization accounts in B2B case.

It is important to understand that users, i.e. the security entities that has access to the web store is a dedicated entity, that is linked by relation but physically decupled from contact.

Each user is linked with the set of roles that define permission level for each store.

It means that a contact may be linked with few (any amount) users, where each user belongs to the only store.

Type Description Relations
User A Security entity that has access to the store according to permissions defined by a role (one) contact <-> (many) users; (one) user <-> (many) roles
Role A Security entity that represents a collection of atomic permissions (many) roles <-> (many) permissions

Indexation

Organizations, contacts, vendors, and employees are kept in the index.

Atomic functions / scenarios

Name Module Description Link
Organization management Customer How to manage an organization (module link doesn't work)
Employee management Customer How to create and manage employee (module link doesn't work)
Contact management Customer How to create and manage contact (module link doesn't work)
Vendor management Customer How to create and manage a vendor (module link doesn't work)
Address management Customer How to manage addresses (module link doesn't work)
User management Security How to manage users (module link doesn't work)
Roles management Security How to manage roles (module link doesn't work)
AuthApplications Security Overview (module link doesn't work)
Indexation (module) How to run indexation for organization, contacts, employees, and vendors (add the link)

Extensibility

No-code extensibility (Admin panel UI)

Virto Commerce supports declarative(no-code) extensions through the Admin panel and API to extend the data model, UI, and workflow processing.

Code extensibility

Name Module Description Link
Extend Organization Customer Add field to organization entity Extend Organization
Extend Contact Customer Add field to contact entity Extend Contact
Extend Vendor Customer Add field to vendor entity Extend Vendor
Extend Employee Customer Add field to employee entity Extend Employee

Reactive programming extensibility

Events/Webhooks

Note

Every event contains information about NewEntry, OldEntry and EntryState witch can be one of these states: Added, Modified or Deleted.

Tip

All events are available for all type of extensions: native extensions, webhooks and event bus.

Name Module Description Link
MemberChangingEvent Customer Occurs before a member is saved to the data source. Read more
MemberChangedEvent Customer Occurs when member is saved to the data source. Read more
UserChangingEvent Platform/Security Occurs before an user is saved to the data source. Read more
UserChangedEvent Platform/Security Occurs when an user is saved to the data source. Read more
UserLoginEvent Platform/Security Occurs when an user logins. Read more
UserLogoutEvent Platform/Security Occurs when an user logout. Read more
UserPasswordChangedEvent Platform/Security Occurs when an user changed password. Read more
UserResetPasswordEvent Platform/Security Occurs when an user reset password. Read more
UserRoleAddedEvent Platform/Security Occurs when role is removed from the user. Read more
UserRoleRemovedEvent Platform/Security Occurs when role is removed from the user. Read more

User scenarios

XAPI built-in scenarios

Following built-in business API scenarios can be used by front-end developers "as is" when create registration user experience

Name Description Link
Create Contact Creating a contact entity CreateContact
Create User Creating a user entity CreateUser

Custom user scenario examples

Name Description Link
Organization registration with verification User sends a request for organization registration. Before the moment of manual organization verification a user can not login to the store Contact VC team to get more info

Last update: June 9, 2021