Account Module Documentation

Overview

This document provides detailed information and examples for the Account module within the FowCRM platform. The Account module is designed to manage customer accounts, track their interactions, and maintain account-related data.

Module Features

List Screen

• Filtering: Users can filter accounts using various fields such as City, County, AnnualRevenue, etc. Filters can be combined using AND/OR logic.
• Keyword Search: Users can perform searches across account records using keywords.
• Column Customization: Users can select which columns to display and save their preferences for future use.
• Views: Users can create and save custom views, including Table and Board (Kanban) views, for easier data management.
• URL Format: The list screen can be accessed via modules/account.

Detail Screen

• URL Format: The detail screen for a specific account can be accessed via modules/account/{id}.
• Ownership: Each account record has an owner and an owner group, which can be changed only through a transfer action.
• Forms: The module includes forms for adding and editing account information, accessible from the list and detail screens respectively.

Best Practices

• Ensure that all mandatory fields are filled out when creating or editing an account.
• Regularly update account information to keep records accurate and up-to-date.
• Utilize filters and views to efficiently manage and analyze account data.

Module Fields

fieldName	displayName	fieldType	queryTypes	isFilter	isDefaultColumn	isOrderable	isCurrencyField	isArray	isFormField
City	City	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	false	false	false	true
County	County	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	false	false	false	true
AnnualRevenue	Annual Revenue	Double	[ GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, Equal ]	true	false	false	true	false	true
CurrencyId	Currency	Guid	[ Equal, NotEqual ]	true	false	false	false	false	true
Name	Name	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	true	true	false	false	true
PhoneNumber	Phone Number	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	true	true	false	false	true
Email	Email	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	true	true	false	false	true
Description	Description	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	true	false	false	false	true
CreationTime	Creation Time	Date	[ Equal, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual ]	true	true	true	false	false	false
LastModificationTime	Last Modification Time	Date	[ Equal, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual ]	true	true	true	false	false	false
CountryId	Country	Guid	[ Equal, NotEqual ]	true	false	false	false	false	true
IndustryId	Industry	Guid	[ Equal, NotEqual ]	true	false	false	false	false	true
IsParent	Is Parent	Boolean	[ Equal, NotEqual ]	true	false	false	false	false	true
WebSite	Website	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	true	false	false	true
EmployeeCount	Employee Count	Integer	[ Equal, NotEqual, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual ]	true	false	true	false	false	true
FaxNumber	Fax Number	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	true	false	false	true
TaxNumber	Tax Number	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	true	false	false	true
TaxOffice	Tax Office	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	true	false	false	true
IntegrationId	Integration	String	[ Equal, NotEqual, IsNull, IsNotNull, StartsWith, EndsWith, Contains ]	true	false	false	false	false	false
CreatorUserId	Creation User	Long	[ Equal, NotEqual ]	true	false	false	false	false	false
LastModifierUserId	Last Modification User	Long	[ Equal, NotEqual ]	true	false	false	false	false	false

Usage Examples

Adding a New Account

1. Navigate to the list screen at modules/account.
2. Click on the "Add" button to open the Add Form.
3. Fill in the necessary fields such as Name, Email, PhoneNumber, etc.
4. Save the new account by submitting the form.

Editing an Existing Account

1. From the list screen, click on an account to view its details.
2. On the detail screen, click the "Edit" button to open the Edit Form.
3. Update the fields as required.
4. Save the changes to update the account information.

Filtering Accounts

1. On the list screen, use the filter options to select criteria such as City or AnnualRevenue.
2. Apply the filter to view a subset of accounts that match the criteria.
3. Save the filter as a custom view for quick access in the future.

Reporting and Analysis

• Utilize the saved views to generate reports on account data.
• Analyze account trends and performance using the platform's reporting tools.

Conclusion

This document serves as a guide for the Account module within FowCRM. By following the outlined features, field details, and usage examples, users can effectively manage and analyze account information to support business operations.