clearString neatComponents
Documentation

Getting Started
The neatComponents Guide
Building & Styling Applications
- A first app walkthrough and Tutorial
- Finding your way around
- Finding your way around
- How to log in to a site
- The Toolbox
- The Text Editor
- The Behavior Editor
- The Layout Manager
- E-Mail Integration
- Numerical URLs
- DirectURLs
- Ajax
- Using Components
- The different types of Component
- Understanding Embeds
- Caching
- Sections and Inheritance
- Automatically created navigation links
- Graphics and Images
- Editing Tools
- Quick-start Videos
- How to log in to get editing permission
- Understanding your workspace
- Sitewide settings
- Using Themes
- Layout Manager
- The Layout Manager
- Dividing appearance from content with Layout Elements
- Layout Elements
- How to Edit Layout Elements
- Using Navigation Zones
- A Horizontal navigation bar
- A Vertical navigation bar
- Adding fly-out (drop down) menus
- Hiding items from the navigation links
- Dynamic Navigation
- Using Text Zones
- Using Image Zones
- Page techniques
- User Editable Pages
- How to rename a page
- How to move a page
- How to delete a page
- How to assign a specific URL to a page
- How to redirect to another page, or to another site
- How to change the page Title
- Page heading / Title control
- How to create a splash page
- Editing within pages
- Using the editing tools
- Toolbox
- Text Editor
- Loading the Text Editor
- Basic text editing
- Formatting Text
- Color Picker dialog
- Table dialog
- Working with Tables
- Inserting Images
- Inserting Links and Anchors
- Embedding objects
- Editing HTML
- Inserting inline scripts
- JavaScript and JQuery
- Inserting an I-frame
- Behavior Editor
- Common Styles
- Common Settings
- Themes
- Introduction to Themes
- Getting Started with Themes
- Theme Levels
- How to Activate Themes
- Restricting editing
- Setting edit permissions
- Using Content Approval to regulate updates
- Abstracts
- Using Abstracts to summarize child pages
- Using Abstracts as a secondary column
- Site Navigation
- Navigating the site
- Configuring navigation
- Using DirectURL to provide memorable shortcuts
- Providing a search engine
- Providing a performance monitor
- Displaying a site tree
- Displaying a navigation route - breadcrumbs
- Redirects
- Redirecting traffic from a page
- Redirecting traffic to the first child
- QR codes
- QR codes
- Creating & displaying QR Codes
- Reading QR codes
- QR code techniques
- Other
- Discussion Forum
- Sending X Twitter Status Updates
A first app walkthrough
- Tutorial
- Part 1 - How to use your app space
- The walkthrough
- Part 2 - How to create a webpage
- Where is everything?
- Creating the Example Site
- What have I got?
- Simple page editing
- The Layout Manager - Changing the Layout
- The Layout Manager - Adding a component
- Part 3 - How to use a Form and Email
- Creating Tables
- Emailing form data
- Part 4 - How to work with Data and Queries
- Adding a Data Entry Form
- Creating Queries
- Defining Views
- Embed Custom View
- Onward - working with neatComponents
- Working with the system
- A complete Blog system
Functionality
Components
- Components
- Component Bank
- Components Reference
- Account
- Account Data Feed
- Account Invoice Data Feed
- Account Payment Data Feed
- Account Transaction Data Feed
- Account Transaction Type Data Feed
- API Key Data Feed
- Calendar View
- Cart Item Data Feed
- Category View
- Collapsible Panel
- Content Approval Manager
- Cookie Clear
- Country Data Feed
- Currency Data Feed
- Custom View
- Data Entry Form
- Data Import
- Digital Rights
- DirectURL View
- Drop Down View
- E-R Diagram
- Email Table Loader
- External Sale Connector
- Forum
- IFrame View
- JSON View
- List View
- Logged in / out text
- News Ticker
- OAuth Consumer
- Order Charge Data Feed
- Order Data Feed
- Order Item Data Feed
- Order Payment Data Feed
- Page
- Performance
- Query
- Query - Grid View
- Query by Example
- Redirect View
- Referral Data Feed
- RSS View
- Sale View
- Search
- Search Box
- Search Log Data Feed
- Search View
- Shopping Cart
- Simple Page
- Site Component Data Feed
- Site Creator
- Site Data Feed
- Site Manager
- Site Tree
- SMS Provider Data Feed
- Surround
- Table
- Telemetry
- Telemetry Data Feed
- Telemetry Descendant Site Data Feed
- Theme Selector
- Theme Selector View
- Ticker View
- Total View
- Two Factor Authentication
- Upload
- User Data Feed
- User Log-In
- User Group Manager
- User Manager
- User Membership Data Feed
- vCard View
Actions
- Actions
- Getting Started with Actions
- Actions Reference
- Account Transaction
- Bind PDF Files
- Clear Site Cache
- Create CSV File
- Create PDF File
- Create User
- Data Import
- Delete Record
- FTP - Create Directory
- FTP - Delete Directory
- FTP - Delete File
- FTP - Export File
- FTP - Import Directory
- FTP - Import File
- FTP - Store SFTP Fingerprint
- Intersite Communication
- LLM AI - Chat Completion
- ML AI - Classify Image
- ML AI - Create Model
- ML AI - Remove Model
- ML AI - Train Model
- ML AI - Update Model
- Regular Expression
- Reload Account Types
- Reload API Keys
- Reload Currencies
- Reload Transaction Types
- Reset Edit Code
- Reset View Code
- Send Email
- Send LinkedIn Status Update
- Send Twitter X Status Update
- Trigger Table Record Event
- Update Field
- User Group Membership
- Execution timing
- Background execution
- Delay and Repeat Actions
- Scheduled Action Management
Datatypes
- Account Type ID
- Component ID
- Check Box
- Country Id
- Created
- Creation Client IP Address
- Creation Client User Agent
- Creation Server IP Address
- Creation Page Referer
- Creation Site Referer
- Currency
- Currency ID
- Date/Time
- Drop Down List
- Edit Code
- Email
- File
- GUID
- Image
- Installation ID
- Integer
- Item Type
- Large Integer
- Large Text
- Multiple Record Link
- Number
- OAuth Token
- Order ID
- Order Item ID
- Product Family
- Radio Button Group
- Record ID
- Record Link
- Record Owner
- Rich Text
- Setting list
- Text
- Timespan
- Transaction Type ID
- Updated
- Updated by
- User ID
- User Group
- View Code
Application Development
Data Integration
- Managing data
- Feeds: What are Tables and Fields?
- What are Queries and Views?
- Data types
- Primary keys
- Relationships
- Designing your database
- Tables, Queries & Views - a simple example
- Why structure data? a case study
- Data Integration Overview
- Tables
- Tables
- Table Modes
- Creating and modifying Tables
- Useful naming conventions
- Table configuration - Fields tab
- Table - Edit Field dialog
- Data types
- Record locking
- Adding fields
- Editing existing fields
- Default values
- Moderator-only fields
- Security options for files and images
- Referential Integrity
- Field Validation
- Using the contents of a field as a DirectURL
- Customizing the text areas
- Events - triggering emails
- Specifying email criteria
- Selecting recipients
- Providing a valid return address
- Automatic vs Custom layout
- Save and Save As
- Entering some initial data
- Queries
- Queries and Views
- Selecting tables and Fields
- Joining multiple tables
- Designing Joins
- Combining resultsets (Union queries)
- Query-based Navigation
- Embedding Queries
- Query Embed dialog
- Query Embed dialog - Components tab
- Query Embed dialog - Surround tab
- Query Embed dialog - Parent Parameters tab
- Query Embed dialog - Records tab
- Query Embed dialog - Initial Page tab
- Query Embed dialog - Ajax tab
- Query Embed dialog - Cookie tab
- Expressions
- Expressions
- Expression Builder
- Working with Expressions
- Expressions - Function Reference
- Expressions - Operators Reference
- Expressions - Date Format
- Views
- Custom View
- Field Usage options
- Formatting Text fields
- Formatting Image fields
- Sorting results
- Defining Links in fields
- Ajax transitions
- Paging controls
- Displaying text if records exist
- Regular Expressions
- Embedding Views within the navigation links
- Calendar View
- News Tickers
- External Lookup Data Feed
- Data Import - XML & CSV
- External Lookup Data Feed
- Triggering Lookups
- General Settings
- Request URLs
- XPath Namespaces
- Fixed Request Parameters
- Cache Table Field Mappings
- Response Errors
- Data Import component
- Data Import component
- Configuring the Data Import
- Bulk Import
- Bulk importing from CSV files
- Bulk Import - Example
- FTP
- FTP Client Actions
- FTP - Store SFTP Fingerprint
- FTP - Import Directory
- FTP - Import File
- FTP - Create Directory
- FTP - Delete Directory
- FTP - Delete File
- FTP - Export File
Process Management
- Introduction to Process Management
- Designing a Process Management system
- Defining Flow State
- Validation
- Auditing and Monitoring
- Performance and Scale
Scaling and Clustering
- Architecture
- Intersite Communication
- Introduction to Intersite Communication
- Security and API Keys
- Preparing Data with JSON
- Send data with an Intersite Communication action
- Receive data with an Intersite Communication event
- Respond with data
- Receive and process the response data
Events
- Events
- Conditions
- Using conditions
- New Record
- Query Record Count
- Record Criteria
- User exists
AI Integration
- Introduction to Artificial Intelligence
- Image recognition
- Image recognition models
- Create a Model
- Update a Model
- Remove a Model
- Train a Model
- Classify an Image
- Chat Completion
- LLM Chat Completion Event Action
- Using LLM Chat Completion
- LLM Endpoints
E-commerce
- Introduction to ecommerce
- Principles
- About ecommerce
- Displaying a catalog
- Choosing a data structure
- Offering assembly options
- The shopping cart
- Forcing the user to login before buying
- Forcing the user to agree to terms before buying
- Getting paid
- Displaying an invoice
- Emailing everyone
- Basic configuration example
- Introduction & Download
- Table 'Product'
- Query 'Q: List'
- Table View
- Query 'Q: Details'
- Sale View
- Page 'Products listing'
- Page 'Description'
- Shopping Cart
- Advanced configuration
- Flow Types
- Tax and Shipping charges
- Charges - introduction
- Item Types
- Charges
- Shopping Cart Delivery Slots
- Stock control
- Stock control - introduction
- Subscriptions
- Usergroup membership
- Associate system
- Associates - introduction
- The Associate usergroup
- Creating the signup process
- The associate link system
- Accounts management
- Designing a data structure for ecommerce
- Payment processors
- Introduction to payment processors
- Integrating with Authorize
- Integrating with iDEAL
- Integrating with PayPal
- Configuring your PayPal account for integrated ecommerce
- Integrating with WorldPay
- Integrating with 2Checkout
- External Sales
- External Sale Connector
- Accounts and currencies
- Using custom currencies
Site security - users and permissions
- Users and Permissions
- Permissions
- Login - Logout
- Logged in / out component
- Not permitted means invisible
- Redirection to the Login component
- Usergroups
- Visitor usergroups
- Defining a hierarchy of control
- Allowing user registration
- Publishing access codes
- Click-through agreements
- Component-specific and inheritable
- Using redirection to first-child as a permission switch
- Behavior Editor Permissions
- Layout Element permissions
- Allowing users to update their own details
- Administering other users
- Resetting passwords
- Changing usergroup membership
- Managing profile forms for users
- Customising the login forms
- Exporting user data - the User Data Feed
- Phantom user status
- Two Factor Authentication
How-to Resources
How-to Resources
- How-To Resources
- Advertising
- Voting System
- Profiles
- Search Engine Optimisation
- Making sites Accessible
- Managing discussions
- Mobile Sites
Techniques & KB Articles
Installing
Installing and Support
On-prem licenses
Download
Release notes
Reselling your Apps
Become a SaaS Provider
- Introduction
- Site Manager
- Client Accounts
- Template sites
- Log-on impersonation
- Managing sites for your own use
- Managing sites for your own use
- Rebranding neatComponents
- Assigning domain names to the site
- Working without a domain name
- Saving a site as a template for reuse
- Upgrading a site
- Managing sites for clients
- Managing sites for clients
- Using charging plans to manage recurring fees
- Reducing balance accounts, and automatic chasing emails
- Oops. Automatic site suspension if they don't pay
- Manual account adjustments
- Impersonating your clients
- Allowing clients to self-serve new sites
- Re-brandable system
- Site 'Demo mode'
- ISPs Hosting and SaaS
The VARs Guide
- Introduction
- VAR Opportunities
- The role of the VAR
- Where does clearString run?
- How much will fit on a server?
- Licensing
- License principles
- Licensing scenarios
- A typical consultancy
- Tools for VARs
- Rebranding
- Charging
- Telemetry
- Site Creator
- Site Updating
- Site Import & Export
- Getting Started
- Next steps

clearString neatComponents
Documentation

Getting Started


	Installing and Support
Getting Started

Installation Advice

The neatComponents server software that powers clearString and powers all your websites and web applications is installed on one machine, accessed either on the LAN (local network) or across the Internet, or in the Cloud or at a hosting company.

Tips:

If you want to try using without the installation hassle, then try one of our free Cloud Trials.
The functionality is identical and the Trials are personal - so you can keep or export your work.
Get a free Cloud trial here...

All design, build and management tasks are then managed using your browser - Safari, Edge, Firefox or Chrome on your regular computer - Linux, Windows or Mac - from anywhere.