Getting Started with the Admin Portal
  • 13 Oct 2022
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Getting Started with the Admin Portal

  • Dark
    Light
  • PDF

Article Summary

Arcot for Merchants Admin Portal (referred to as "Admin Portal" later in the section) is a web-based configuration tool, which provides a consistent unified interface for managing tenants.

This portal offers a true multi-tenant architecture, which lets you use a single instance of Admin Portal to manage multiple tenants or business units within an enterprise. In this model, each tenant or business unit can be set up individually with its own configuration or inherit configuration from its parent.

This section provides information for setting up and managing Arcot for Merchants (AFM) using Admin Portal. It introduces the Admin Portal interface and covers the following topics:

Note

The Admin Portal supports most modern desktop browsers.

About the Admin Portal

The Admin Portal is a web-based, graphical user interface and is accessible from any modern web browser with network access to the portal. You can use the Admin Portal to manage tenant configurations, users, rules, lists and to analyse transactions. Users are assigned permissions as per the tasks that they are authorized to perform in the Admin Portal.

There are four sections on the Admin Portal's interface as shown below.

afm-areas.png

Sidebar - provides access to Dashboard, Transactions, Rules, Lists, Activity, Users, Settings for the current Tenant

Header - contains the links to access the loggedin User's Profile, User's Activity and to logout from the current user session. It also lets you change the current Tenant to another tenant that they wish to work on

Content - displays the content that the user navigates to.

Footer - displays the copyright information and contains external links to Privacy Policy, Cookie Policy, Data Processing and Data Transfer, Supplier Responsibility and Terms of Use related information

Messages

All the information, warning, and error messages that are generated in the course of using the Admin Portal are displayed in the Content area. While the error messages are displayed in red, the messages indicating success are displayed in green.

User Permissions

Every user created in the Admin Portal has access to a set of permissions. These permissions are grouped into the following categories:

  • Tenants
  • Users
  • Transactions
  • Rulesets
  • Lists

You can provide access to users to any, all or none of the above categories depending upon the tasks that they are authorized to perform for a tenant. For each category, you can set the permissions as:

  • View
  • Allow adding/editing
Note

Tenant category can only be set as Allow adding/editing. If this permission is absent, user will not be able to add a new child tenant from the dashboard.

For users who do not have View and Allow adding/editing permissions for a particular category, the corresponding link in the Sidebar area is disabled.

Here is a list of permissions required for key tasks that can be performed by users in the Admin Portal. This list will be updated as we introduce new features in the Admin Portal.

TaskPermissionCategoryComment
Creating a child tenantAllow adding/editingTenants
Searching child tenants in the dashboardNot ApplicableTenantsNo permission required
Navigating to a child tenant in the dashboardNot ApplicableTenantsNo permission required
Updating a tenant's nameAllow adding/editingTenants
Updating the timezone for a tenantAllow adding/editingTenants
Creating a userAllow adding/editingUsers
Assigning tenants to a userAllow adding/editingUsers
Revoking tenants from a userAllow adding/editingUsers
Assigning permissions to a userAllow adding/editingUsers
Revoking permissions from a userAllow adding/editingUsers
Activateing a user in a tenantAllow adding/editingUsers
Deactivating a user in a tenantAllow adding/editingUsers
Updating name of a userAllow adding/editingUsers
Updating primary language for a userAllow adding/editingUsers
Viewing all users assigned to a tenantViewUsers
Searching for user(s) in a tenantViewUsers
Viewing user detailsViewUsers
Searching transactions in a tenantViewTransactions
Viewing test transactions in a tenantViewTransactions
Viewing transaction detailsViewTransactions
Updating review status for a transactionAllow adding/editingTransactions
Viewing activities for a user across all tenantsNot ApplicableActivitiesNo permission required
Viewing activities for a user for the selected tenantNot ApplicableActivitiesNo permission required
Creating a new ruleset using the Rule BuilderAllow adding/editingRulesets
Creating a new ruleset using the Code EditorAllow adding/editingRulesets
Downloading the rules utility libraryViewRulesets
Uploading an existing rulesetAllow adding/editingRulesets
Inactivating an active rulesetAllow adding/editingRulesets
Activating an InActive rulesetAllow adding/editingRulesets
Viewing an existing rulesetViewRulesets
Duplicating an existing rulesetAllow adding/editingRulesets
Downloading an existing rulesetViewRulesets
Deleting an existing rulesetAllow adding/editingRulesets
Adding a listAllow adding/editingLists
Viewing listsViewLists
Viewing list detailsViewLists
Adding items to an existing listAllow adding/editingLists
Deleting items from an existing listAllow adding/editingLists
Deleting a listAllow adding/editingLists
Accessing Transactions Summary widget in the DashboardNot ApplicableDashboardNo permission required
Accessing Transactions Chart widget in the DashboardNot ApplicableDashboardNo permission required
Accessing Child Tenants widget in the DashboardNot ApplicableDashboardNo permission required

Security Recommendations for Using the Admin Portal

To protect AFM Admin Portal from malicious attacks through a browser session, ensure that users:

  • Do not share browser session with other applications.
  • Do not open any other site while working with the Admin Portal.
  • Always log out after using the Admin Portal.
  • Close the browser window or browser tab after the session is over.
  • Assign only the required permissions to users as per the tasks they need to perform for a tenant.

Was this article helpful?