LogoLogo
HomeCommunityLangstack.comCreate free account
  • 🤝Welcome
  • 🙌Support
  • 💡Get started
    • 📕Learn Langstack
      • Introduction to Langstack
        • Application templates
        • Storage frameworks
        • Account administration
      • Basics and essentials
        • What is an API gateway?
        • How to work with an API gateway
        • What is an Entity?
        • What is an Action box?
          • How to create and work with Action boxes
          • How to perform search in Actions
        • What is an Action?
          • How to create and work with Actions
          • Error propagation
          • Actions in Langstack applications
        • What is a Data type?
          • Simple Data types
        • What is a Variable?
          • Naming rules of a Variable
        • What is a Function?
          • Working with Functions
        • Navigating to a Variable or a Function
        • Implicit Type Conversion (ITC)
        • Explicit Type Conversion
        • Implicit and Explicit Type Conversion for Json
        • Next Steps
      • User management
        • What is a Privilege?
        • What are Groups?
        • What are Users?
      • Introduction to REST API
        • API Name
        • API Group name
        • Request and Response body
          • Request body
          • How to create and work with a Request body
          • Response body
          • How to create and work with a Response body
        • Query strings
          • How to create and work with Query strings
        • Headers
          • How to create and work with Headers
        • Path parameter
        • Create your first API: "Hello World!"
          • Working with API options
        • Exercise 1: GET REST API & Return Response Object
          • Step 1: Create API
          • Step 2: Test the API
        • Exercise 2: Delete a published API
        • Next Steps
      • Introduction to Entities
        • Fields
        • Records
        • Relations
        • Options for an Entity
        • Exercise 1: Customer Accounts and Activities
          • Customer accounts
            • Step 1: Create the Customers Entity
            • Step 2: Create the API
            • Step 3: Update entity through API
          • Customer Activities
            • Step 1: Create the Activities entity
            • Step 2: Create a “1 to Many” relation
            • Step 3: Create the API
            • Step 4: Update entity through API
        • Exercise 2: Customer Records
          • Step 1: Create the API
          • Step 2: Test the API
        • Next Steps
      • Programming with Entities
        • Create
        • Read
        • Update
        • Delete
        • JXPResponse
        • Next Steps
      • Using Triggers
        • After Create Trigger
        • After Update Trigger
        • After Delete Trigger
        • Exercise: Entity & Entity triggers
        • Step 1: Define “After Create” Trigger
        • Step 2: Define “After Update” Trigger
      • Connectors
        • Create a connector
        • SFTP Connector
        • MySQL Connector
        • Next Steps
      • Introduction to ETL pipeline
        • Create an ETL pipeline
        • Data Formats in ETL pipeline
          • Reader
          • Writer
          • Field mapping
        • Shared variables for ETL pipeline
        • ETL functions execution sequences overview
        • Displaying Functions
        • How to perform Search in ETL pipeline
        • Exercise 1: Skip Customer records
          • Step 1: Create the ETL pipeline
          • Step 2: Skip records based on Customer_ID
          • Step 3: Store skipped records in a list
          • Step 4: Store the Skipped Customer record
        • Exercise 2: ETL pipeline, CSV source & FTP Connector
        • Exercise 3: ETL pipeline, Database Source & MySQL Connector
        • Exercise 4: ETL pipeline, CSV Source & FTP Connector using Sections
          • Step 1: Create the ETL pipeline
          • Step 2: Reformat the Join_Date Values and define added fields
      • Multiple Executions, Time Duration, Linked App and Execution Status
        • Skip execution while in progress
        • Time duration settings
        • Linked App
        • Options for Delay Types
        • Execution status
      • Validation pipeline
        • Sequence of Validation pipeline
        • Exercise: Customer Information
          • Step 1: Create a Validation pipeline
          • Step 2: Create the API gateway
          • Step 3: Test the Validation pipeline
      • Introduction to Process
        • Create a process
        • Shared variables for a process
        • Exercise: Customer Anniversary Email Activity
          • Step 1: Check if the join date matches the current date
          • Step 2: Test the Process
      • Introduction to Flows & Flow components
        • What is a Flow?
        • What is a Flow component?
          • What is a Flow component Event?
        • Exercise 1: Customer Anniversary Email
          • Step 1: Create the Flow component
          • Step 2: Create the Flow
          • Step 3: Trigger the Flow
          • Step 4: Check records in the target entity
        • Exercise 2: Store list of customers
          • Step 1: Create the Flow component
          • Step 2: Create the Flow
          • Step 3: Create the API
    • 🌍Tour of Langstack (coming soon)
  • 📘In depth learning
    • 📖User Manual (coming soon)
    • 🔗Connectors
      • MS-SQL connector
        • Data type conversions between Langstack and MSSQL
        • Handling data loss in data type conversions
        • Setting up MS-SQL connector
        • MS-SQL connector as Reader and Writer
        • Using MS-SQL connector in ETL pipeline
          • MS-SQL connector as a source
          • MS-SQL connector as a destination
      • Google Drive connector
        • Set up Google Drive Connector
        • Adding Google Drive path in ETL pipeline Streams
        • Setting up GCP Account, GCP Project, API Enablement, and Credentials (Prerequisites)
          • OAuth 2.0 Client Credentials
          • Service Account Key Credentials
          • API Key Credentials
          • Authorization through Redirect URLs
        • Using Google Drive connector in ETL pipeline
          • Specifying file or folder paths
            • Direct file link
            • Folder link and file name
            • Folder path and file name
            • Folder path excluding file name
            • Folder path including file name
          • Google Drive connector as a source
          • Google Drive connector as a destination
      • AWS connector
        • Introduction
        • Set up AWS S3 Connector
          • OAuth 2.0 Client Type
          • Access Key
          • Public
        • Setting up AWS Account
          • Retrieve Client ID and Client Secret
        • Set up Amazon Web Services (Cognito) Console
          • Retrieve Identity Pool Id
          • Manage Permissions for Roles
          • Adding Redirect URL in Amazon Developer Console
          • User Consent for OAuth 2.0 Client through Login with Amazon
          • Retrieve Access Key Credentials
        • Creating a bucket in AWS
        • Using S3 connector in ETL pipeline
          • Specifying paths
          • Examples
            • AWS S3 connector as a source
            • AWS S3 connector as a destination
      • OneDrive connector
        • Set up OneDrive Connector
        • Setting up Microsoft Azure Account
        • Add URL to Authorized Redirect URLs
        • User Consent for Establishing OneDrive Connection
        • Usage of OneDrive Connector in ETL pipeline
          • Examples
          • OneDrive connector as a source
          • OneDrive connector as a destination
      • Dropbox connector
        • Set up Dropbox Connector
        • Setting up Dropbox Account
        • Add URL to Authorized Redirect URLs
        • User Consent for Establishing Dropbox Connection
        • Usage of Dropbox connector in ETL pipeline
          • Dropbox connector path settings
          • Examples
            • Dropbox connector as a source
            • Dropbox connector as destination
  • 🗃️Use Cases (Coming soon)
    • Use Case 1
    • Use Case 2
    • Use Case 3
Powered by GitBook
On this page
  1. Get started
  2. Learn Langstack
  3. Introduction to Entities
  4. Exercise 1: Customer Accounts and Activities
  5. Customer accounts

Step 1: Create the Customers Entity

PreviousCustomer accountsNextStep 2: Create the API

Last updated 2 years ago

The first step is to create the Entity for storing customer account records.

  • To go to the Entity database section, click “Entity database” under the “Database” menu on the left side panel.

  • To create a new entity, click the [+ Entity] button on the displayed page.

  • The New Entity settings page is displayed. To label the entity, enter the Entity name as “UserName_Acc_customers”.

  • Optionally add a description.

  • The Field tab is preselected with one field created by default. To add a field, click the [+ Field] button.

  • To store customer details in the Entity “Username_Acc_customers”, add and define corresponding fields following the steps below.

  • To define a field storing the primary key for this entity, define the field for Customer ID as follows. (The relation of this Entity with the Activities Entity will also be established through this field.)

    1. Enter the field name as “Customer_ID”.

    2. Select Data Type as “GUID”.

    3. Select “Primary Key”. This field will contain the primary key for this entity.

    4. Select “Auto Generate”. This value of this field will be auto-generated with each new record.

    5. Select “Display”. This field will be displayed in the entity.

  • Add another field.

  • To store the customer’s first name, define the field as follows:

    1. Enter field name as “First_Name”.

    2. Select Data Type as “string”.

    3. Select “Default Field”. This is the default field to be displayed.

    4. Select “Display”.

  • To store the customer’s last name, add and define the field as follows:

    1. Enter field name as “Last_Name”. This contains the customer’s last name.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To describe the status for the customer as Active or Inactive, add and define the field as follows:

    1. Enter field name as “IsActive”. This contains information on whether the customer is active or inactive.

    2. Select Data Type as “Boolean”. This field can either be true or false.

    3. By default, this value is set to “false”.

    4. Select “Display".

  • To store the customer’s phone number, add and define the field as follows:

    1. Enter the field name as “Phone”.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To store the customer’s email address, add and define the field as follows:

    1. Enter the field name as “Email”.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To store the customer’s joining date, add and define the field as follows:

    1. Enter the field name as “Join_Date”.

    2. Select Data Type as “DateTime”. A template of the date and time will be populated as Default Value.

    3. Select “Display”.

  • To store the customer’s address, add and define the field as follows:

    1. Enter the field name as “Address".

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To store the customer’s city, add and define the field as follows:

    1. Enter the field name as “City”.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To store the customer’s Zip Code, add and define the field as follows:

    1. Enter the field name as “Zip_Code”.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To store the customer’s country, add and define the field as follows:

    1. Enter the field name as “Country”.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • A customer value is the amount of business that a customer provides to a company. This can be measured as the amount of expenditure a customer makes to procure the company's products or services. Create and define the field as follows.

    1. Enter the field name as “Customer_Value”.

    2. Select Data Type as “integer”. Enter Default Value as “1”.

    3. Select “Display”.

  • A customer rating is the number allotted to a customer reflecting the number to measure the customer loyalty level and is denoted by a range of numbers e.g. 1=Beginner, 2=Average, 3=Top Profile. To store the rating of the customer, create and define the field as follows.

    1. Enter the field name as “Rating”.

    2. Select Data Type as “integer”. Enter Default Value as “1”.

    3. Select “Display”.

  • To store only day and month of the joining date of the customer, create and define the field as follows:

    1. Enter the field name as “DayMonthJoinDate”.

    2. Select Data Type as “string”.

    3. Select “Display”.

  • To save the Entity, click the [Save] button.

  • To close the Entity, click the [Close] button.

  • To open the created entity, in the list of Entities, click on “Username_Acc_customers”. The list will show the records created if any, and the columns are the fields that are selected with display option.

  • Additional fields such as Modified Date, Created Date and the Actions column will also be populated for additional information on the record. These dates are when the record was created, updated. The Action column is for any action needed to be taken for entity record such as deletion.

  • In this exercise, the record is added through the API (to be created in Step 2). However, users can add a record directly into the Entity. ⠀1.To create a record directly in an Entity, click on the created entity in the Entities listing

    1. To create a record directly in an Entity, in the Entities listing, click on the created entity.

    2. Click the [+ Record] button.

    3. In the displayed form, enter the relevant information to be stored as a record.

  • Click the [Save & Close] button. One record will be updated in the Entity.

  • To create a record in the Entity through an API, proceed to Step 2 of this exercise.

💡
📕