...
...
Introduction
Overview of the Admin Panel
The admin panel serves as a centralized platform for managing various aspects of the system. It provides administrators and authorized users with access to powerful tools and functionalities to oversee and control the system's operations. Through the admin panel, users can configure settings, manage user accounts, monitor performance, analyze data, and perform various administrative tasks crucial for the smooth operation of the system.
...
Target Audience
The primary audience for this documentation includes administrators, system operators, and technical personnel responsible for managing and maintaining the system. Additionally, it caters to users who interact with the admin panel to perform specific tasks or access certain functionalities within the system. This documentation is designed to accommodate users with varying levels of technical expertise, providing both basic instructions for beginners and advanced configurations for experienced administrators. Furthermore, stakeholders and decision-makers involved in the system's governance and strategy may also find this documentation valuable in understanding the capabilities and implications of the admin panel.
Roles and Permissions
In the context of the admin panel, roles define the level of access, permissions, and responsibilities granted to different users within the system. Each role is associated with specific privileges and limitations, ensuring that users can only perform actions relevant to their assigned tasks and responsibilities. Here's an overview of the common roles typically found in the admin panel.
Superadmin Role
The Superadmin role is a privileged position within the admin panel that grants unrestricted access and authority over various critical functions and configurations. Unlike other roles, actions performed by users assigned the Superadmin role do not require approval or the creation of tasks for decision-making.
...
The Superadmin role is designed to provide maximum flexibility and control to authorized users, allowing them to manage critical aspects of the system without constraints or delays. With the Superadmin role, individuals can efficiently oversee and administer various operations, configurations, and decisions within the admin panel, ensuring the smooth functioning and optimal performance of the system.
Requester Role
Capabilities and Responsibilities:
...
Upon creation of a request by a Requester, a corresponding task is generated in the Workspace page of the admin panel. Requesters can view the main details of the request and its status following their decision-making process. This integrated workflow ensures transparency, accountability, and streamlined management of system modifications and operations.
Approver Role
Workspace Page for Approvers:
...
Overall, the Workspace page serves as a crucial tool for Approvers, facilitating efficient task management and decision-making within the Admin panel.
Permissions Matrix
View Permission
This permission grants the admin access to particular information or functionalities within the system. Admins with view permission can browse through data, reports, or sections of the application, gaining insight into various aspects of the system's operations. However, they do not possess the authority to make any alterations or edits. Instead, their access is limited to viewing and analyzing the existing data or reports. This permission is crucial for admins who need to monitor the system's performance, review analytics, or access specific information without the need to modify it.
...
viewCurrencyPI
The permission enables the review of settings and main information for connected currency payment interfaces. This encompasses details such as:Currency Type: Denotes the specific type of currency associated with the payment interface, whether it's a cryptocurrency or a fiat currency.
Subunits: Indicates the smaller units or subdivisions of the currency, such as cents for dollars or satoshis for Bitcoin.
Contract Address: Refers to the unique address on the blockchain associated with the currency, particularly relevant for cryptocurrencies like Ethereum.
Blockchain Fee Information: Provides details about the fees associated with blockchain transactions, including any fees required for processing transactions on the blockchain network.
Minimum Collection Amount: Specifies the minimum amount required for collections or incoming payments to be processed through the payment interface.
User Withdrawal Details: Includes information on user-initiated withdrawals, specifying both the minimum and maximum withdrawal amounts allowed.
User Direct Deposit Details: Encompasses details related to direct deposits made by users, including the minimum direct deposit amount, direct deposit fee as a percentage, and the minimum and maximum direct deposit fees.
Proxy Deposit Details: Refers to details concerning proxy deposits, which are temporary deposits created for specific purposes. This includes the minimum deposit amount, the deposit fee as a percentage, and the minimum and maximum deposit fees associated with proxy deposits.
This permission facilitates the comprehensive review of currency payment interface settings and information, ensuring efficient management of financial transactions within the system.
Edit Permission
With edit permission, administrators can modify and update existing data or settings within the system. This includes making changes to user information and adjusting configurations to better align with the organization's needs. Additionally, in scenarios involving workflow settings, admins with edit permission can directly initiate changes.
...
Additionally, there is an additional permission that allows administrators to upload/update the logo for the Payment Interface in the Payment Interfaces subsection on the Configurations page.
Request Operation Permission
These permissions grant administrators the ability to perform operational tasks within the system. This may include managing user balance through deposit and withdrawal operations, managing operations, and performing other administrative duties necessary for the smooth operation of the system.
resolveOperationError
This permission allows administrators to manage operations encountering errors. Administrators can opt to retry collection for deposit operations, retry or reject withdrawal operations, and retry exchange operations to ensure smooth processing and resolve any arising issues. Upon the request to update an operation, a task is created where an employee with approval permissions can review the main details of the request, such as Type, Status, Amount, User, Date, Documents (transactions), Description, and the employee who made the request. Then approver can make an accept or reject decision for the request.
useWorkspace ?
cancelOrder
This permission allows administrators to cancel open orders placed by users within the system. It enables administrators to intervene in trading activities and manage order books effectively, ensuring the integrity and stability of the trading platform.
Upon the request to cancel an open order, a task is created where an employee with approval permissions can review the main details of the request, such as the user's email and the main details for the open order: Status, Market, Type, Side, Date, Amount, Executed Volume, Price, Average Executed Price, Trades and the employee who made the request. Then approver can make an accept or reject decision for the request.requestWithdrawal
This permission allows the admin to request the transfer of funds from the user's wallet balance to an internal account of the system. After the withdrawal request is made, a task is created where an employee with approval permissions can review the main details of the request, such as the user's status, balance, requested withdrawal amount, currency ID, currency payment interface ID, and the employee who made the request. Then approver can make an accept or reject decision for the request.requestDeposit
This permission enables the admin to request deposit operations, initiating the transfer of funds from an internal system account to the user's wallet balance.
Upon the deposit request, a task is created where an employee with approval permissions can review the main details of the request, such as the user's status, balance, requested deposit amount, currency ID, currency payment interface ID, and the employee who made the request. Then approver can make an accept or reject decision for the request.
Approval Permission
The approval permission grants an employee the authority to approve or reject requests, transactions, or configurations from other employees. It enables administrators to review and take action on pending requests, ensuring compliance with established procedures and maintaining operational integrity. This permission allows the user to review task descriptions, general information, and requested updates or new creations in the open tasks. The approver can make decisions with an accept or reject flow by analyzing the task description. If the decision is to accept, the new configurations, changes, or edits will be implemented. Conversely, if the decision is to be rejected, no changes will be made.
...
acceptRole
The permission grants administrators the authority to approve updates to existing Roles or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the Role and its permissions, the requested configurations, and the employee who made the request.
acceptRateSource
The permission allows administrators to modify the status of existing Rate Sources for a market. Other employees submit requests for these changes through task creation. Approvers can review information in the task, including the current status of the Rate Source for the market, the requested status change, and the employee who initiated the request.acceptEmployee
The permission enables administrators to approve updates to existing Employees or create new ones. Other employees submit requests for these actions through task creation. Approvers can review information in the task, including the current settings for the Employee and their roles, the requested roles for the Employee, and the employee who initiated the request.acceptWithdrawalRestrictionLevel
The permission allows administrators to approve updates to existing Withdrawal Restriction Levels or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the Withdrawal Restriction Levels, the requested configurations, and the employee who made the request.
acceptBlockchain
acceptOperation
Workflow Overview
Description of Workflow Process
Roles Involved in Workflow
Workflow Diagram
Creation Process
Steps for Requester
Initiating a Creation Request
Providing Necessary Information
Steps for Approver
Reviewing the Request
Approving or Rejecting the Request
Update Configurations
Steps for Requester
Initiating an Update Request
Providing Details of Configuration Changes
Steps for Approver
Reviewing the Update Request
Approving or Rejecting the Changes
Operations Approval
Steps for Requester
Requesting Approval for Operations
Providing Context and Details
Steps for Approver
Reviewing the Operation Request
Approving or Rejecting the Operation
Best Practices
Tips for Effective Request Submission
Guidelines for Approvers
Troubleshooting
Common Issues and Solutions
Error Messages and Their Meanings
Glossary
Definitions of Key Terms Used in the Documentation
Appendix
...
Additional Resources
...