Welcome to the Affiliate Management Page of RentalTide! This guide will help you effectively navigate and utilize all the features available on the Affiliate Management Page, ensuring efficient management of your affiliate programs within the Point of Sale (POS) system.
Introduction
The Affiliate Management Page is a crucial component of RentalTide's POS system, designed to streamline the management of affiliate relationships and their associated earnings. This page allows authorized users to:
View Affiliates: Access detailed information about each affiliate associated with your account.
Add New Affiliates: Create new affiliate profiles effortlessly.
Edit Affiliate Earnings: Update the percentage of earnings allocated to affiliates.
Manage Payouts: Add payouts to affiliates based on their performance.
Delete Affiliates: Remove affiliates from the system when necessary.
Track Performance: Monitor total earnings, payouts, and amounts owed to affiliates.
Dashboard Overview
Upon accessing the Affiliate Management Page, you'll encounter the following key components:
Dashboard Header:
Title: "Affiliates"
Subtitle: "Manage your affiliate links"
Actions:
Add Affiliate Button: Located in the header, represented by the AddIcon, allows authorized users to add new affiliates.
Affiliates Table:
Table Columns:
Name: The affiliate's name.
Email: The affiliate's email address.
Code: Unique affiliate identifier.
% Earned: The percentage of earnings allocated to the affiliate.
Total Earned: Total earnings generated by the affiliate.
Paid Out: Total payouts made to the affiliate.
Owed: The remaining amount owed to the affiliate.
Actions: Options to edit, add payouts, or delete the affiliate.
Loading Indicators:
Skeleton Loaders: Displayed while affiliate data is being fetched to indicate loading states.
Dialogs:
Add Affiliate Modal: Form for creating new affiliates.
Edit Percentage Modal: Form for updating an affiliate's earning percentage.
Add Payout Modal: Form for adding payouts to affiliates.
Delete Confirmation Modal: Confirmation prompt before deleting an affiliate.
Notifications:
Snackbar Notifications: Provide real-time feedback on actions such as successful additions, updates, deletions, and error messages.
Managing Affiliates
Efficiently manage your affiliate programs with the intuitive features available on the Affiliate Management Page. This section covers viewing affiliates, adding new affiliates, editing earnings, managing payouts, and deleting affiliates.
Viewing Affiliates
The Affiliates Table provides a comprehensive view of all affiliates associated with your account.
Features:
Affiliate Details:
Name: Displays the affiliate's name.
Email: Shows the affiliate's email address.
Code: Unique identifier for tracking affiliate activities.
% Earned: Indicates the percentage of earnings allocated to the affiliate.
Total Earned: Shows the cumulative earnings generated through the affiliate's efforts.
Paid Out: Displays the total amount paid out to the affiliate.
Owed: Calculates the remaining amount owed to the affiliate (
Total Earned - Paid Out).
Interactive Actions:
Edit Percentage: Click to open the Edit Percentage Modal for updating the affiliate's earning percentage.
Add Payout: Click to open the Add Payout Modal for recording payouts to the affiliate.
Delete Affiliate: Click to open the Delete Confirmation Modal to remove the affiliate from the system.
Usage Tips:
Quick Identification: Utilize the displayed affiliate details to quickly identify and differentiate between affiliates.
Efficient Management: Use the action buttons to perform edits, add payouts, or delete affiliates directly from the table without navigating away.
Monitor Performance: Regularly review the
Total Earned,Paid Out, andOwedcolumns to assess affiliate performance and manage payouts effectively.
Adding New Affiliates
Creating new affiliate profiles ensures that your affiliate programs are up-to-date and comprehensive.
How to Add a New Affiliate:
Access Add Affiliate Button:
Located in the Dashboard Header, click on the Add Affiliate Button (represented by the AddIcon) to open the Add Affiliate Modal.
Fill in Affiliate Details:
Name: Enter the full name of the affiliate.
Email: Provide a valid email address for the affiliate.
Percentage Earned: Specify the percentage of earnings allocated to the affiliate (e.g., 10%).
Note: The percentage earned is set to a default value (e.g., 10%) but can be adjusted later using the Edit Percentage Modal.
Submit the Form:
After filling in all necessary details, click the "Add Affiliate" button to create the new affiliate.
Upon successful creation, the new affiliate will appear in the Affiliates Table, and a success notification will be displayed.
Usage Tips:
Accurate Information: Ensure all required fields are filled accurately to maintain data integrity.
Unique Identifiers: Each affiliate is assigned a unique code for tracking purposes. Avoid duplicating codes to prevent tracking conflicts.
Default Percentage: Set a reasonable default percentage earned, which can be adjusted based on affiliate performance or agreements.
Editing Affiliate Earnings
Updating an affiliate's earning percentage allows for flexibility based on their performance or changing agreements.
How to Edit an Affiliate's Percentage Earned:
Locate the Affiliate:
In the Affiliates Table, find the affiliate whose earnings percentage you wish to update.
Open Edit Percentage Modal:
Click on the Edit Percentage Icon (represented by the EditIcon) associated with the affiliate.
This action opens the Edit Percentage Modal pre-filled with the affiliate's current earning percentage.
Update Percentage:
Modify the Percentage Earned field to reflect the new earning percentage.
Submit the Changes:
Click the "Save Changes" button to update the affiliate's earning percentage.
Upon successful update, the new percentage will reflect in the Affiliates Table, and a success notification will appear.
Usage Tips:
Consistent Updates: Regularly review and update earning percentages to align with affiliate performance and business goals.
Clear Communication: Inform affiliates of any changes to their earning percentages to maintain transparency and trust.
Data Integrity: Ensure that the updated percentage does not exceed or fall below business-defined thresholds.
Managing Payouts
Recording payouts to affiliates ensures timely and accurate compensation for their contributions.
How to Add a Payout to an Affiliate:
Locate the Affiliate:
In the Affiliates Table, find the affiliate to whom you wish to add a payout.
Open Add Payout Modal:
Click on the Add Payout Icon (represented by the MonetizationOnIcon) associated with the affiliate.
This action opens the Add Payout Modal.
Enter Payout Details:
Payout Amount: Specify the amount to be paid out to the affiliate.
Submit the Payout:
Click the "Add Payout" button to record the payout.
Upon successful addition, the Paid Out column will update, and a success notification will be displayed.
Usage Tips:
Accurate Amounts: Ensure that the payout amounts are calculated correctly based on the affiliate's earnings and agreements.
Timely Payments: Regularly process payouts to maintain strong affiliate relationships and encourage continued collaboration.
Record Keeping: Keep a record of all payouts for auditing and financial tracking purposes.
Deleting Affiliates
Removing affiliates that are no longer part of your program helps maintain an organized and efficient system.
How to Delete an Affiliate:
Locate the Affiliate:
In the Affiliates Table, find the affiliate you wish to delete.
Open Delete Confirmation Modal:
Click on the Delete Icon (represented by the DeleteIcon) associated with the affiliate.
A Delete Confirmation Modal will appear to prevent accidental deletions.
Confirm Deletion:
Review the confirmation message and click the "Delete" button to remove the affiliate.
Upon successful deletion, the affiliate will be removed from the Affiliates Table, and a success notification will appear.
Usage Tips:
Confirmation Prompt: Always confirm deletions to avoid accidental removal of active affiliates.
Review Dependencies: Ensure that the affiliate is not associated with any pending payouts or ongoing agreements before deletion.
Permission Checks: Only users with the appropriate permissions can delete affiliates to maintain system integrity.
Permissions and Access Control
Access to the Affiliate Management Page is governed by a robust permissions system to ensure that only authorized users can view and manage affiliate data.
Key Permissions:
affiliates_access: Grants access to view affiliates.
affiliates_add: Allows adding new affiliates.
affiliates_edit: Enables editing affiliate earnings.
affiliates_delete: Permits deleting affiliates.
Managing Permissions:
Role-Based Access: Permissions are typically assigned based on user roles within the organization (e.g., Admin, Manager, Marketing Specialist).
Verification: The Affiliate Management Page checks user permissions before rendering action buttons or enabling functionalities to prevent unauthorized access.
Usage Tips:
Ensure Proper Access: Verify that your user account has the necessary permissions to perform desired actions on the Affiliate Management Page.
Requesting Access: If you lack certain permissions but require them for your role, contact your system administrator or support team to request access.
Error Handling and Notifications
The Affiliate Management Page incorporates robust error handling and user-friendly notifications to keep you informed about the system's status and any issues that may arise.
Key Features:
Snackbar Notifications:
Provide real-time feedback on actions such as successful affiliate additions, updates, deletions, payouts, and error messages when operations fail or encounter issues.
Loading Indicators:
Skeleton Loaders: Displayed while affiliate data is being fetched to indicate ongoing operations and improve user experience.
CircularProgress: Indicates ongoing operations like data fetching or processing actions.
Dialogs and Alerts:
Add Affiliate Modal: Facilitates the creation of new affiliates with form inputs.
Edit Percentage Modal: Allows users to update an affiliate's earning percentage with form inputs.
Add Payout Modal: Assists users in recording payouts to affiliates with form inputs.
Delete Confirmation Modal: Prevents accidental deletions by confirming user intent.
Usage Tips:
Immediate Feedback: Pay attention to snackbar notifications for instant updates on your actions and system status.
Handle Errors Promptly: Address any error messages or dialogs immediately to ensure smooth operations and accurate affiliate management.
Maintain Connectivity: Ensure a stable internet connection to facilitate seamless data fetching and affiliate management.
Frequently Asked Questions (FAQs)
1. How do I add a new affiliate?
Answer: Click on the Add Affiliate Button (represented by the AddIcon) located in the Dashboard Header. Fill in the required affiliate details in the Add Affiliate Modal, such as the name, email, and percentage earned. After completing the form, click "Add Affiliate" to create the new affiliate.
2. Why is the "Add Affiliate" button disabled for me?
Answer: The "Add Affiliate" button may be disabled if your user account lacks the necessary affiliates_add permission or if you have reached the maximum number of affiliates allowed. To resolve this, ensure you have the appropriate permissions and have not exceeded the affiliate limit. If the issue persists, contact your system administrator or support team.
3. How can I edit an affiliate's percentage earned?
Answer: In the Affiliates Table, locate the affiliate whose earnings percentage you wish to update and click on the Edit Percentage Icon (represented by the EditIcon). In the Edit Percentage Modal, adjust the Percentage Earned field and click "Save Changes" to update the affiliate's earning percentage.
4. Why am I seeing an error message when trying to delete an affiliate?
Answer: Error messages during deletion can occur due to network issues, insufficient permissions, or server errors. Ensure that your user account has the affiliates_delete permission and that your internet connection is stable. If the issue persists, contact support with specific error details for assistance.
5. Can I add payouts to affiliates?
Answer: Yes, you can add payouts to affiliates by clicking on the Add Payout Icon (represented by the MonetizationOnIcon) associated with the affiliate in the Affiliates Table. In the Add Payout Modal, enter the payout amount and submit the form. Upon successful addition, the Paid Out column will update accordingly.
6. Is the affiliate data secure on this page?
Answer: Yes, all affiliate data displayed on the Affiliate Management Page is securely transmitted and stored in compliance with data protection standards. Access is restricted based on user permissions to ensure data privacy and security.
7. Why is the affiliate list not loading?
Answer: The affiliate list may not load due to network connectivity issues, server downtime, or insufficient permissions. Ensure that your internet connection is stable and that your user account has the affiliates_access permission. If the issue persists, contact support for further assistance.
Troubleshooting
Issue 1: Unable to Add a New Affiliate
Possible Cause: Insufficient permissions, reaching the maximum affiliate limit, or network connectivity issues.
Solution:
Check Permissions: Ensure your user account has the affiliates_add permission.
Verify Affiliate Limit: Confirm that you have not exceeded the maximum number of affiliates allowed.
Check Internet Connection: Make sure your device is connected to the internet.
Retry Addition: Attempt to add the affiliate again after addressing the above.
Contact Support: If the issue persists, reach out to the support team with specific error details for assistance.
Issue 2: Affiliates Not Loading Properly
Possible Cause: Network connectivity issues, server downtime, or incorrect customer association.
Solution:
Check Internet Connection: Ensure your device is connected to the internet.
Verify Customer Association: Ensure that your account is correctly associated with a customer ID.
Refresh the Page: Click the refresh button or reload the Affiliate Management Page.
Contact Support: If the issue persists, contact support with specific error details.
Issue 3: Cannot Edit Affiliate Percentage
Possible Cause: Insufficient permissions, network issues, or server errors.
Solution:
Check Permissions: Ensure your user account has the affiliates_edit permission.
Verify Connectivity: Confirm that your device is connected to the internet.
Retry Editing: Attempt to edit the affiliate's percentage again after verifying permissions and connectivity.
Contact Support: If the problem continues, contact support with specific error details for assistance.
Issue 4: Add Payout Functionality Not Working
Possible Cause: Insufficient permissions, network issues, or server errors.
Solution:
Check Permissions: Ensure your user account has the affiliates_edit permission.
Verify Connectivity: Confirm that your device is connected to the internet.
Retry Adding Payout: Attempt to add a payout again after verifying permissions and connectivity.
Contact Support: If the issue persists, reach out to support with specific error details.
Issue 5: Delete Affiliate Button Not Working
Possible Cause: Insufficient permissions, network issues, or server errors.
Solution:
Check Permissions: Ensure your user account has the affiliates_delete permission.
Verify Connectivity: Confirm that your device is connected to the internet.
Confirm Deletion: Ensure that you have confirmed the deletion in the Delete Confirmation Modal.
Retry Deletion: Attempt to delete the affiliate again after verifying permissions and connectivity.
Contact Support: If deletion fails repeatedly, reach out to support with detailed information.
Issue 6: Affiliate Data Not Updating After Actions
Possible Cause: Data synchronization issues, caching problems, or server delays.
Solution:
Refresh Data: Click on the Refresh Button in the Dashboard Header to reload the affiliate list.
Clear Cache: Clear your browser's cache to resolve any caching-related issues.
Check Server Status: Ensure that RentalTide's servers are operational.
Contact Support: If the data still does not update, report the issue to support for further investigation.
Issue 7: Error Messages When Performing Actions
Possible Cause: Server-side errors, invalid input data, or network issues.
Solution:
Review Input Data: Ensure that all required fields are filled out correctly and that the data is valid.
Check Permissions: Confirm that your user account has the necessary permissions for the action.
Verify Connectivity: Ensure a stable internet connection.
Retry the Action: Attempt the action again after addressing the above.
Contact Support: If error messages persist, provide the exact error details to support for targeted assistance.