User Tools

Site Tools


fw_clientsguide

Steps to Fill in the Clients Table (Complete Guide)

This guide provides a step-by-step approach to correctly fill the Clients table. This table stores essential information about each client in the system, including client names, logos, invitation settings, and activation status.

The table is critical for maintaining multi-client environments, where each client may have different configurations, logos, and invitation controls.

For a complete description of the table structure and field explanations, please refer to the → Clients Table Structure

1. Add the ID (id)

This is the primary key (auto-incremented) for the table.
Do not manually enter this value if inserting data directly via the database.
It is automatically generated.

2. Enter the Client Name (clientname)

This column captures the full name of the client. This name will appear in:

  1. Email invitations
  2. Web platforms
  3. App interfaces (if applicable)

Example: clientname = “People Pulse”

3. Set the Client Type (type)

The type column defines the vertical or category of the client. This helps in segmenting and categorizing clients.

Common examples of type: KTO → Referrer Feedback

4. Control Invitation Settings (stopinvitations)

This column controls whether the client can receive email invitations.
Use the following values:

Value Meaning
0 Send Invitations
1 Stop Invitations

Logo Requirements: - Size: 120×32 pixels - Format: PNG, JPG

File Upload Location: clientlogo = Upload File (Binary Data/BLOB)

The clientleftlogo is visible on the left side of the web portal interface.

Logo Requirements: - Size: 165×60 pixels - Format: PNG, JPG

File Upload Location: clientleftlogo = Upload File (Binary Data/BLOB)

7. Upload the Invitation Header Logo (invitationheader)

The invitationheader appears specifically in email invitations if it differs from the main client logo.
If no logo is uploaded, the clientlogo will be used.

Logo Requirements: - Same size as clientlogo (120×32 pixels) or - Custom size based on client preference

File Upload Location: invitationheader = Upload File (Binary Data/BLOB)

This logo appears in mobile applications if the survey is accessible through an app.

Logo Requirements: - Size: 299×126 pixels - Format: PNG, JPG

File Upload Location: appclientlogo = Upload File (Binary Data/BLOB)

9. Set the Client Status (status)

This column determines whether the client is active or inactive in the system.
Use the following values:

Value Status
1 Active
0 Inactive

10. Example: Final Record

Here’s an example of a complete record for a single client:

id clientname type stopinvitations clientlogo clientleftlogo invitationheader appclientlogo status
1 People Pulse KTO 0 [BLOB] [BLOB] [BLOB] [BLOB] 1

✅ Notes

  1. If you do not want email invitations, set stopinvitations = 1.
  2. Avoid uploading large-sized images; adhere to the dimensions specified.
fw_clientsguide.txt · Last modified: 2025/03/11 11:53 by gloria