Modifying a segment

Use EDIT from the Actions' menu to enter edit mode and update the criteria.  This will result in a different segment. The template and criteria can be edited in both draft or posted segments, but the entity cannot be modified in any case.

Including specific records in the segment

Define a set of records that should be included in the segment regardless of specified criteria. The type of information that can be added to the static items depends on the selected entity. Use the 'Manage Static Items' action available from the Actions Menu to add items from a segment. If you would like to remove specific items then just click on the remove icon next to the item.

Previewing and exporting segments

You can preview a number of the records that will be included in a segment through the Matched Items section

It is also possible to view a comprehensive list of the records included in a segment by exporting them as a CSV file through Export button in the Matched Items section

Segment preview information includes: 

1. Entity ID
2. Entity number (where applicable)
3. Entity name
4. Entity alternative code (where applicable)
5. Entity description (where applicable)

Preview information additionally displays either the Accounts Receivable Name or the Contact Information Name depending on whether the entity is an accounts account receivable-based or a contact information-based entity.

• The Accounts Receivable Name is available when previewing segments for:
  • Bills
  • Buy In Advance Requests
  • Credit Notes
  • Invoices
  • Invoice Cancellations
  • Jobs
  • Payments
  • Payment cancellations
  • Payment gateway cards
  • Payment gateway requests
  • Refunds
  • Rewards Participants
  • Award Transactions
  • Spend Transactions
  • Award Expiration Transactions
  • Service Requests
  • Subscriptions
  • Wallets
  • Write Offs
  • Subscription Actions
• The Contact Information Name is available when previewing segments for:
  • Activities
  • Leads

Back to top

Using segments throughout the system

Business Flows

Panel
borderColor Turquoise borderStyle dashed title Provide discount for customers which belong in a segment borderStyle dashed
Scenario Aluxsat Co. wants to offer a discount to its subscribers on the month of their birthday. Configuration Segments Create the following Segment: Name: Subscriber - birthday month   Entity: Accounts receivable Criteria:  accounts_receivable.contact_information.month_of_birth = current_month()   Additive Discount   Create an auto apply discount for subscriptions. In the Discount Rules section, define that the discount will be applied once a year Add the segment in the non-usage segment criteria.   Notification   Create a notification type for subscriptions. Create a communication template which will wish the subscriber a happy birthday and inform them of the discount: Dear #subscription.accounts_receivable.name   Happy Birthday !!! We value our customers and would like to celebrate your birthday with you by offering you a 50% discount on your current subscription fee for this month for subscription:  #subscription.number   Best Regards Company ZX Team Add the segment in the notification criteria. Execute a notification run before the billing is executed so that the customers are informed of the discount.   Process   During billing, the system will retrieve the segment of subscribers who have their birthday during the current month and will discount their monthly bill

 

Back to top

 

Panel
borderColor Turquoise borderStyle dashed title Using Segment Criteria Templates borderStyle dashed
Scenario Aluxsat Co. wants to identify non-VIP customers that owe money to the company for use in various business processes.  Configuration Segment Criteria Template Create the following Segment Criteria Template: Name:  Accounts receivable in debt excluding VIP Segmented Area: Accounts receivable Criteria: accounts_receivable.balance > 0 and accounts_receivable.credit_status = "Exceeded" and accounts_receivable.classification!= "VIP" Segment Create the following segment using the above template: Template: Accounts receivable in debt, excluding VIP  Name: Accounts receivable in debt, excluding VIP

 

Ui expand
title CRMQL Examples
Contact Information Panel nameid yellow2 title Aluxsat Co. needs to create segments based on contacts Retrieve Contact Information of type 'Person' living in Nicosia. Code Block language sql contact_information.type = "Person" and exist(contact_information.address.area = "Nicosia")   Retrieve Contact Information of type 'Person' that have their birthday in the current month. Code Block language sql contact_information.type="Person" and contact_information.month_of_birth = current_month() Code Block language sql contact_information.type="Person" and contact_information.month_of_birth > current_month() and contact_information.month_of_birth <= (current_month()+1)   Subscriptions Panel nameid yellow2 title Aluxsat Co. needs to create segments based on subscriptions Retrieve Subscriptions of type 'Normal' that have at least one 'Effective' service. Code Block language sql subscription.type = "Normal" and exist(subscription.service.life_cycle_state = "Effective")   Retrieve Subscriptions of type 'Normal' that do not have an 'Effective' movie service. Code Block language sql subscription.type="Normal" and not exist (subscription.service.life_cycle_state="Effective" and subscription.service.product= "movies" )   Retrieve Subscriptions of type 'Normal' that have at least one 'Not Effective' service that was terminated in the last 15 days. Code Block language sql subscription.type="Normal" and exist(subscription.service.life_cycle_state="Not Effective" and subscription.service.life_cycle_state_start_date <= day_end() and subscription.service.life_cycle_state_start_date >= days_before(day_end(),15) )   Accounts Receivable Panel nameid yellow2 title Aluxsat Co. needs to create segments based on accounts receivable Retrieve Accounts Receivable with a balance greater than '0', a credit status that is 'Exceeded', and a classification that is not 'VIP'. Code Block language sql accounts_receivable.balance > 0 and accounts_receivable.credit_status = "Exceeded" and accounts_receivable.classification!= "VIP" Retrieve Accounts Receivable that are not set to receive bills by email. Code Block language sql accounts_receivable.life_cycle_state="Active" and not exist(accounts_receivable.presentment_preference.presentment_method="Email" and accounts_receivable.presentment_preference.active=true)   Bills Panel nameid yellow2 title Aluxsat Co. needs to create segments based on bills Retrieve Bills that are partially paid and their outstanding or unsettled amount is less than '10'. Code Block language sql bill.status = "Partially_settled" and (bill.outstanding_amount < 10 or bill.unsettled_amount < 10) Retrieve Bills that are due at the end of the month and are yet to be communicated by email. Code Block language sql bill.due_date=month_end() and not exist(bill.communication_queue.media="Email" and bill.communication_queue.life_cycle_state="Completed") Retrieve Bills that are due at the end of the month and were communicated with errors. Code Block language sql bill.due_date=month_end() and exist(bill.communication_queue.media="Email" and bill.communication_queue.life_cycle_state="Rejected") and not exist(bill.communication_queue.media="Email" and bill.communication_queue.life_cycle_state="Completed")   Activities Panel nameid yellow2 title Aluxsat Co. needs to create segments based on activities Retrieve Activities of type 'Installation' that are still in progress and are past their estimated completion date. Code Block language sql activity.type="Installation" and activity.life_cycle_state = "In progress" and activity.estimated_completion_date < day_start()   Jobs Panel nameid yellow2 title Aluxsat Co. needs to create segments based on jobs Retrieve Jobs of type 'Maintenance' that were completed yesterday. Code Block language sql job.type="Maintenance" and job.life_cycle_state = "completed" and job.actual_completion_date < day_start() and job.actual_completion_date >=days_before(day_start(),1)   Rewards Participants  Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Rewards Participants Retrieve Rewards Participants who have signed up today. Code Block language sql rewards_participant.sign_up_date >= day_start() Retrieve Rewards Participants who signed up to a specific scheme today. Code Block language sql rewards_participant.sign_up_date >= day_start() and exist(rewards_participant.participating_reward_scheme.name="New Customers")   Award Reward Transactions  Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Award Reward Transactions Retrieve Award Reward Transactions submitted this week by a specific offer. Code Block language sql award_reward_transaction.submitted_date >= week_start() and award_reward_transaction.submitted_date <= week_end() and award_reward_transaction.reward_offer.number="00034   Spend Reward Transactions  Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Spend Reward Transactions Retrieve Spend Reward Transactions with a total amount of more than '10', submitted by specific units. Code Block language sql spend_reward_transactions.total_amount > 10 and (spend.reward_transactions.submitted_by_unit="Sales Department 1" or spend.reward_transactions.submitted_by_unit="Sales Department 2" )   Service Requests Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Service Requests Retrieve Service Requests of classification 'Request for Change' that were completed yesterday. Code Block language sql service_request.classification ="Request for Change" and service_request.life_cycle_state = "completed" and service_request.actual_completion_date < day_start() and service_request.actual_completion_date >= days_before(day_start(),1) Payment Gateway Cards Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Payment Gateway Cards Retrieve Payment Gateway Cards that are going to expire in the next month. Code Block language sql payment_gateway_card.payment_gateway_provider="Stripe"  and ( payment_gateway_card.expiration_year=current_year()  and payment_gateway_card.expiration_month=(current_month()+1) or ( payment_gateway_card.expiration_year=(current_year()+1)  and payment_gateway_card.expiration_month=1  and current_month()=12 ) ) Retrieve Payment Gateway Cards that failed the security code check. Code Block language sql payment_gateway_card.payment_gateway_provider="Stripe"  and payment_gateway_card.security_code_check_result=FAIL   Payment Gateway Requests Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Payment Gateway Requests Retrieve Payment Gateway Requests that were rejected during the last month. Code Block language sql payment_gateway_request.payment_gateway_provider="Stripe"  and payment_gateway_request.life_cylce_state="REJECTED"  and payment_gateway_request.created_date<=month_start() Retrieve Payment Gateway Requests that were posted successfully during the last month. Code Block language sql payment_gateway_request.payment_gateway_provider="Stripe"  and payment_gateway_request.life_cylce_state="POSTED"  and payment_gateway_request.created_date<=month_start()   Payments Panel nameid yellow2 title Aluxsat Co. needs to create segments based on Payments Retrieve Payments of Type 'Web Payments' posted within the last day. Code Block language sql payment.type="Web Payments"  and posted_date <= day_end()  and posted_date>= day_start() Retrieve Payments that were posted through Vouchers within the last week. Code Block language sql posted_date<= day_end() and posted_date >= weeks_before(day_end(),1) and payment.voucher.life_cycle_state="Used" Retrieve Payments that were posted within the last day and are yet to be communicated by email. Code Block language sql posted_date <= day_end() and posted_date>= day_start() and not exist(payment.communication.direction="Outgoing" and payment.communication.media="Email" and payment.communication.life_cycle_state="Completed")

Ui expand
title Useful Links
Filter by label (Content by label) showLabels false spaces V4Manual showSpace false cql label = "global" and space = "V4Manual" labels global