1. Loyalty Administration Guide
  2. What’s New in This Release

10Siebel Loyalty Workflow, Task Flow, and Methods Reference

Siebel Loyalty Workflow, Task Flow, and Methods Reference

This appendix documents workflows, task flows, and methods that are specific to Siebel Loyalty. It includes the following topics:

Siebel Loyalty Workflows

Workflows for Siebel Loyalty are described in the following topics:

LOY ABB New Member Process Workflow

The LOY ABB New Member Process workflow, shown in the following image, calls the LOY Action Based Bonus Subprocess, querying for Part Number equals Registration Bonus. If needed, then it also calls LOY Action Based Bonus Referral SubProcess to:

  • Create whether a new transaction has an action-based bonus of the type Registration Bonus.

  • Check whether there is need to create a referral-bonus transaction.


LOY ABB New Member Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • LOY Action Based Bonus Subprocess. This step calls a subprocess called LOY Action Based Bonus Subprocess which creates a new transaction for an Action Based Bonus of the type Registration Bonus.

  • Need for Referral Bonus. This step ends the workflow if a referral bonus is not required.

  • LOY Action Based Bonus Referral SubProcess. If Referral Bonus is required, then this step calls LOY Action Based Bonus Referral SubProcess, which creates a new transaction that gives a bonus to the referring member.

LOY ABB Web Update Process Workflow

The LOY ABB Web Update Process workflow, shown in the following image, calls LOY Action Based Bonus Subprocess, querying for Part Number equals Registration Bonus, to create a new transaction that gives an action-based bonus of the type Web Update Bonus.


LOY ABB Web Update Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • LOY Action Based Bonus Subprocess. This step calls called LOY Action Based Bonus Subprocess, which creates a new transaction to give an action-based bonus of the type Web Update Bonus.

LOY ABB Web Update Shell Process Workflow

The LOY ABB Web Update Shell Process workflow, shown in the following image, calls the workflow LOY ABB Web Update Process when certain member data are updated in the customer application.


LOY ABB Web Update Shell Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • LOY ABB Web Update Process. This step calls the LOY ABB Web Update Process workflow, which creates a new transaction to provide an action-based bonus of type Web Update Bonus.

LOY Action Based Bonus Referral SubProcess Workflow

The LOY Action Based Bonus Referral SubProcess workflow, shown in the following image, creates a new transaction for the referring member with an action-based bonus of the type Referral Bonus.

LOY Action Based Bonus Referral SubProcess Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Retrieve Member Data. This step retrieves member data.

  • Retrieve Product Id. This step retrieves Product Id.

  • Create ABB Transaction. This step creates a transaction to provide an action-based bonus of the type Referral Bonus.

LOY Action Based Bonus Subprocess Workflow

The LOY Action Based Bonus Subprocess workflow, shown in the following image, creates two types of action based bonuses.

  • When called by LOY ABB New Member Process, it creates a new transaction to provide an action-based bonus of the type Registration Bonus.

  • When called by LOY ABB Web Update Process, it creates a new transaction to provide an action-based bonus of the type Web Update Bonus.


LOY Action Based Bonus Subprocess Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Retrieve Member Data. This step retrieves member data.

  • Retrieve Product Id. This step retrieves Product Id.

  • Create ABB Transaction. This step creates an action-based bonus transaction of the type Registration Bonus when called by LOY ABB New Member Process and of the type Web Update Bonus when called by LOY ABB Web Update Process.

LOY Activate Promotion Process Workflow

The LOY Activate Promotion Process workflow, shown in the following image, is invoked when a promotion is activated. It validates whether the minimum necessary rules, criteria, and actions required by the promotion are defined.

LOY Activate Promotion Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Is Promotion Active? If the promotion is active, then this step ends the workflow. Otherwise, this step calls the next step, Get Products.

  • Get Products. This step queries for the Products.

  • Is All Products? This step checks whether the Product Inclusion Rule is All Products.

  • Check there are No Products. If the product inclusion rule is All Products, then this step checks whether there are any products associated with the promotion. If there are products, then it displays an error message saying that there are products associated with the promotion but the product inclusion rule is All Products. Otherwise, it calls the step Get Rules.

  • Check there are Products. If the product inclusion rule is not All Products, then this step checks whether there are any products associated with the promotion. If there are no products, then it displays an error message saying there are no products associated with the promotion but the product inclusion rule is either Include or Exclude Products. Otherwise, it calls the step Get Rules.

  • Get Rules. This step retrieves the rules.

  • Any Rules. This step checks if there are any rules. If there are no rules, then it displays an error message saying the promotion has no rule defined for it. Otherwise, it calls the next step, Get Promotion Point Blocks.

  • Get Promotion Point Blocks. This step retrieves the point blocks associated with the promotion.

  • Is Point Limited? This step checks whether the promotion is a point-limited promotion.

  • Has Point Blocks? If the promotion is point-limited, then this step checks whether it has any point blocks. If it does not have point blocks, then this step displays an error message saying there are no point blocks assigned to the point limited promotion. Otherwise, it calls the step Execute Rules BC.

  • Has any Point Blocks? If the promotion is not point-limited, then this step checks whether it has any point blocks. If it has point blocks, then this step displays an error message saying there are point blocks assigned to the unlimited points promotion. Otherwise, it calls the step Execute Rules BC.

  • Execute Rules BC. This step calls the method BCNextRecord of the SIA BC Utility Service Business Service, which retrieves the next record in the business component.

  • Any More Rules? If a rule exists, then this step calls Get Actions. Otherwise, it calls the step All OK. Activate Promotion.

  • Get Actions. This step retrieves the actions of the rule.

  • Any Actions? If any Action exists, then this step calls the step Get Actions w/ Inactive Attributes. Otherwise, it calls the step Is Promotion Type: Eligibility.

  • Is Promotion Type: Eligibility. This step checks the promotion type. If it is of type Eligibility, then this step calls the step Get Actions w/ Inactive Attributes. Otherwise, it calls Is Rule Type: Criteria.

  • Is Rule Type: Criteria. This step checks the rule type. If it is of type Criteria, then this step calls the step Get Actions w/ Inactive Attributes. Otherwise, it displays an error message saying the promotion rule does not have any action defined.

  • Get Actions w/ Inactive Attributes. This step gets actions that have an attribute id specified, but that have the active flag for the corresponding attribute as N (which means inactive) or NULL (which means deleted).

  • More Actions? If any actions with inactive attributes exist, then this step displays an error message saying that the action refers to an attribute definition that is either inactive or is no longer available. Otherwise, it calls the next step, Get Criteria w/ Inactive Attributes.

  • Get Criteria w/ Inactive Attributes. This step gets criteria that have an attribute id specified, but that have the active flag for the corresponding attribute as N (which means inactive) or NULL (which means deleted).

  • Any Criteria? If any criteria with inactive attributes exist, then this step displays an error message saying that the criteria refer to an attribute definition that is either inactive or is no longer available. Otherwise, it calls the step Execute Criteria BC.

  • Execute Criteria BC. This step calls the method BCNextRecord of the SIA BC Utility Service Business Service, which retrieves the next record in the business component.

  • Any More Criteria? If any criteria exist, then this step calls the next step, Get Criteria Value. Otherwise, it calls Execute Rules BC.

  • Get Criteria Value. This step retrieves the criterion value.

  • Has Criteria Value? If the criterion does not have any value, then this step displays an error message saying that the criterion has no criteria values specified but is of type Compare to Values. Otherwise, it calls the step Execute Criteria BC.

  • All OK. Activate Promotion. This step activates the promotion.

  • Update Cache. This step calls the method Update Cache of the LOY Cache Manager Update Business Service, which updates the cache.

LOY Approval Process Workflow

The LOY Approval Process workflow, shown in the following image, approves point blocks and transactions.

LOY Approval Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Inbox_Item_Exist. This step calls the method InboxItemExist of the LOY Approval Process Business Service, which checks whether the inbox item exists and returns the Inbox item Id.

  • Inbox Item Exist? If inbox item exists, then this step checks whether there are active owners. Otherwise, it calls the step Create Inbox Item.

  • Has Active Owners? If there are active owners for the inbox item, then this step calls the step Update Existing Task. Otherwise, it calls the step Create First Task.

  • Create Inbox Item. This step calls the method CreateInboxItem of the LOY Approval Process Business Service, which creates the inbox item.

  • Create First Task. This step calls the method CreateNewTask of the LOY Approval Process Business Service, which creates the task for the inbox item.

  • Update Inbox Item And Task. This step calls the method UpdateInboxItemAndTask of the LOY Approval Process Business Service, which updates the owner information for the task.

  • Update Existing Task. This step calls the method UpdateExistingTask of the LOY Approval Process Business Service, which updates the owner information for the task.

  • End Point? This step checks if the status is at the last step of the approval process. If so, then it calls the next step, Deactivate. Otherwise, it calls the step Create New Task.

  • Deactivate. This step calls the method DeactivateTask of the LOY Approval Process Business Service, which deactivates all the active Inbox Tasks for the given Inbox Item.

  • Create New Task. This step calls the method CreateNewTask of the LOY Approval Process Business Service, which creates a new item task for the object and deactivates all the active tasks.

  • Update New Task. This step calls the method UpdateNewTask of the LOY Approval Process Business Service, which updates the newly created item task with the values of Inbox Name and Start Working Time.

LOY Batch Redemption Process Workflow

The LOY Batch Redemption Process workflow, shown in the following image, creates a redemption batch transaction for all the members whose point balance is greater than the defined threshold value.

LOY Batch Redemption Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Query Program. This step queries the Threshold Point, Partner Id and Program Id fields.

  • Query Point Type. This step queries the Point Internal Name field.

  • Query Product. This step queries the Product Id field.

  • Batch Redemption. This step calls the method BatchRedemtion of the LOY Redemption Service (Business Service) which creates a redemption batch transaction.

LOY Bulk Action Process Workflow

The LOY Bulk Action Process workflow, shown in the following image, is used by the Bulk Administration screen, which is launched in asynchronous mode for performing bulk actions.

LOY Bulk Action Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Import Data. This step calls the Process method of the Business Service- LOY Member Admin Service, which processes the actions of the promotions.

LOY Bulk Import Accrual Process Workflow

The LOY Bulk Import Accrual Process workflow, shown in the following image, is used by Bulk Accrual Import process to validate that there are records in the staging table. You can modify this workflow to include custom validations.

LOY Bulk Import Accrual Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Import Process. This step calls the ImportAccruals method of the LOY Bulk Accrual Service Business Service, which validates that there are records in the staging table.

LOY Bulk Member Admin Process Workflow

The LOY Bulk Member Admin Process workflow, shown in the following image, is called in asynchronous mode for each work unit used in bulk member administration. For more information about work units, see About Bulk Loyalty Membership Administration.

LOY Bulk Member Admin Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • ProcessWorkUnit. This step calls the ProcessWorkUnit method of the LOY Member Admin Service business service, which processes the subset of member administration records that is passed to the workflow by the LOY Member Admin Integration Object.

LOY Bulk Simulation Process Workflow

The LOY Bulk Simulation Process workflow, shown in the following image, simulates processing of multiple transactions received as input from an XML/CSV file.

LOY Bulk Simulation Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  1. Process. This step calls the method GetPropSetFromFile of the LOY Member Services Business Service, which reads the XML/CSV file.

  2. UpdateBulkTxnStatus. This step calls the method UpdateBulkTxnStatus of the LOY Member Services Business Service, which updates the status to Processed.

  3. Stop 0. This step generates an error, if the file read process fails.

LOY Cancel Transaction Process Workflow

The LOY Cancel Transaction Process workflow, shown in the following image, cancels a transaction.

LOY Cancel Transaction Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Query for Original Transaction. This step retrieves data from original transaction.

  • Is Processed. If the Transaction has been processed, then this step calls the step Is Corporate Reference. Otherwise, it displays an error message saying that the selected transaction cannot be canceled either because its Status is not Processed or because it has updated Tier or Promotion Attributes, that instead this transaction must be cancelled manually.

  • Is Corporate Reference. This step checks whether the Corporate Reference field is NULL. If it is not NULL, then it calls the step Copy of Query for Original Transaction. Otherwise, it calls the step Copy 1 of Query for Original Transaction. If there is a corporate reference, then two transactions would have been created, one for the corporate account and one for the individual.

  • Copy of Query for Original Transaction. This step retrieves data from the original transaction.

  • If Txn Exist. If the Order is not NULL, then this step calls the step Copy of Insert Transaction. Otherwise, it calls Copy 1 of Query for Original Transaction.

  • Copy of Insert Transaction. This step creates a redemption transaction.

  • Copy of Update Txn Status. This step updates the status of the corporate transaction to Cancelled.

  • Copy 1 of Query for Original Transaction. This step retrieves data from the original transaction.

  • Insert Transaction. This step creates a redemption transaction.

  • Update Txn Status. This step updates the status of the individual transaction to Cancelled.

  • Is Auto Accrual Txn? If the transaction is Auto Accrual, then this step calls the step Update the Auto Accrual. Otherwise, it checks the transaction subtype.

  • Update the Auto Accrual. This step updates the transaction with the transfer member Id.

  • Is Original Txn Sub Type: Auto Accrual? If the Transaction Sub Type is Auto Accrual, then this step calls the step Update new Transaction. Otherwise, the workflow ends.

  • Update New Transaction. This step updates the status of the transaction.

LOY Cannot Copy Promotion Process Workflow

The LOY Cannot Copy Promotion Process workflow, shown in the following image, displays an error message when promotion copying is disabled. It is used in conjunction with the LOY Tier Promotion Copy Error Message runtime event action set.

LOY Cannot Copy Promotion Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Stop. This step displays an error message saying that Loyalty Promotions with type Tier cannot be copied when promotion copying is disabled.

LOY Change Member Tier Workflow

The LOY Change Member Tier workflow, shown in the following image, invokes a business service method to change the tier.

LOY Change Member Tier Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Invoke Change Tier Business Service. This step calls the method ChangeTier of the LOY Change Member Tier Service Business Service, which makes the tier changes.

LOY Deactivate Promotion Process Workflow

The LOY Deactivate Promotion Process workflow, shown in the following image, makes a promotion inactive and removes it from the cache.

LOY Deactivate Promotion Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Is Promotion Active. If the promotion is active, then this step calls Deactivate the Promotion. Otherwise, it ends the workflow.

  • Deactivate The Promotion. This step makes the promotion inactive.

  • Update Cache. This step calls the Update Cache method of the LOY Cache Manager Update Business Service, which removes the promotion from the cache.

LOY EAI Export Program Workflow

The LOY EAI Export Program workflow, shown in the following image, enables you to export program data from a third-party application into your Siebel Business Application through the Siebel EAI Adapter. This workflow can also be used to move Loyalty data, such as Loyalty Promotion Rules, from the development to the production environment. It is a sample workflow that you can modify to suit your business requirements.

LOY EAI Export Program Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Query for Program. This step calls the Query method of EAI Siebel Adapter Business Service, which retrieves the program information.

  • Write Program to XML File. This step calls the WriteEAIMsg method of the EAI XML Write to File Business Service, which writes the information to the XML file.

LOY EAI Export Promotions Workflow

The LOY EAI Export Promotions workflow, shown in the following image, is used by the Promotions screen to export selected promotions to an .xml file, which is used by an external loyalty engine. The location of the exported .xml file is specified as the process property File Name in the workflow.

LOY EAI Export Promotions Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Query for Promotions. This step calls the Query method of EAI Siebel Adapter Business Service, which returns the selected promotions.

  • Write Promotions to XML File. This step calls the WriteEAIMsg method of the EAI XML Write to File Business Service, which writes the promotions to the XML file.

LOY EAI Export Transactions Workflow

The LOY EAI Export Transactions workflow, shown in the following image, can be scheduled by the background process which exports promotions to an .xml file if the promotions have the status Partner Pending. The .xml file is used to send disputed transactions to a partner for validation. The location of the exported .xml file is specified as the process property File Name in the workflow.

LOY EAI Export Transactions Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Query for Transactions. This step calls the Query Page method of EAI Siebel Adapter Business Service, which queries the pending transactions.

  • Write Program to XML File. This step calls the WriteEAIMsg method of the EAI XML Write to File Business Service, which writes the transactions to the .xml file.

LOY EAI Import Program Workflow

The LOY EAI Import Program workflow, shown in the following image, is used to import program data from a third-party application into your Siebel Business Application through the Siebel EAI Adapter. This workflow can also be used to move Loyalty data, such as Loyalty promotion rules, from the development to the production environment. It is a sample workflow that you can modify to suit your business requirements.

LOY EAI Import Program Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Read Program from XML File. This step calls the ReadEAIMsg method of EAI XML Read from File Business Service, which interprets the specified .xml file as an EAI message, parses it, and returns the program data in the output property set.

  • Write Program to Database. This step calls the Synchronize method of the EAI Siebel Adapter Business Service, which synchronizes the program data.

LOY EAI Import Promotion Workflow

The LOY EAI Import Promotion workflow, shown in the following image, allows you to import data for one or more promotions into a Siebel Loyalty program through the Siebel EAI Adapter. You can use this workflow to move Siebel Loyalty promotion data from the development to the production environment. It is a sample workflow that you can modify to suit your business requirements.

LOY EAI Import Promotion Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Read Promotions from XML File. This step calls the ReadEAIMsg method of the EAI XML Read from File Business Service, which interprets the specified .xml file as an EAI message, parses it, and returns the promotion data in the output property set.

  • Write Promotions to Database. This step calls the Upsert method of the EAI Siebel Adapter Business Service, which either inserts or updates the promotion data.

LOY eMember - Checkout Process Workflow

The LOY eMember - Checkout Process workflow, shown in the following image, checks out order transactions in the shopping cart.

LOY eMember - Checkout Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Get Property: Explicit Login. This step gets the value of the property Explicit Login.

  • Member Id NULL? If the Member Id is not NULL, then this step calls the step Get MemberShip Count. Otherwise, it calls Check Redemption Quote.

  • Get MemberShip Count. This step gets the total number of members.

  • How many memberships? If the number of members is 0, then this step calls the step No Memberships - Log Error. If the number of members is 1, then it calls the step Pick Membership Id. If the number of members is greater than one, then it calls Pick Member List View.

  • No Memberships - Log Error. This step calls the Subprocess eSales - Display Error Process, which displays the error message.

  • Pick Member List View. This interactive step displays the LOY Select Membership View (eMember). When the user selects a member, it calls the step Get Picked Member Id.

  • Get Picked Member Id. This step retrieves the Id of the member selected by the user.

  • Pick Membership Id. This step calls the method SelectPrimary of the CUT eSales Order Entry Toolkit Service Business Service, which retrieves the Membership Id.

  • Check Redemption Quote. This step calls the method CheckRedemptionQuote of the LOY Redemption Service Business Service, which checks whether the Quote is of the type Redemption.

  • Is Redemption Quote? If the Quote is of the type Redemption, then this step calls the step Check Price View. Otherwise, it calls Check Availability.

  • Check Price View. This interactive step displays the navigate to LOY Current Quote View (eSales) Simulation view. If the user selects SimulatePrice, then it calls the step Update Quote Price. If the user selects ModifyCart, then it calls the step Shopping Cart View.

  • Update Quote Price. This step calls the method UpdateQuotePrice of the LOY Redemption Service Business Service, which updates the Quote Lines with simulated Price Options.

  • Check Availability. This step calls the method CheckPointBalance of the LOY Customer Action Business Service, which checks whether the shopping cart contains only Redemption Products.

  • Error? If any error has been reported during Check Availability or Update Quote Price, then this step calls the step Display Error Process. Otherwise, it calls Checkout.

  • Display Error Process. This step calls the Subprocess eSales - Display Error Process, which displays an error message.

  • Shopping Cart View. This interactive step displays the Current Quote View (eSales).

  • Checkout. This step calls the Subprocess eSales - Checkout Process which starts the actual checkout process.

  • Order To Transaction. This step calls the method OrderToTxn of the LOY Customer Action Business Service Business Service, which creates a transaction record for every line item in that order.

  • Set Pending Request. This step calls the method SetPendingRequest of the Shopping Service Business Service, which sets the Profile attribute Pending Request, which is used to continue an operation after login.

  • Login View. This step calls the subprocess named eSales - Login View, which uses an interactive workflow step to navigate to the Login view.

LOY Engine - Process Batch Workflow

The LOY Engine - Process Batch workflow, shown in the following image, invokes the Loyalty Engine in batch mode for processing.

LOY Engine - Process Batch Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Invoke LPE in Batch Mode. This step calls the method ProcessBatch of the LOY Processing Engine Business Service, which invokes the Loyalty Engine in batch mode.

LOY Engine - Process Expired Accruals Workflow

The LOY Engine - Process Expired Accruals Workflow workflow, shown in the following image, processes an expired accrual on the real-time component.

LOY Engine - Process Expired Accruals Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Invoke Engine to Process Expired Accruals. This step calls the method ProcessObject of the LOY Processing Engine Business Service, which processes the expired accrual.

LOY Engine - Process Object Workflow

The LOY Engine - Process Object workflow, shown in the following image, submits a component request to the real-time processing engine component to process the object.

LOY Engine - Process Object Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Compare Statuses. This step calls the Echo method of the Workflow Utilities Business Service, which compares the Required Status with the Object Status

  • Check Status. If the previous step returns true, then this step calls the Invoke Submit Object step. Otherwise, it stops.

  • Invoke Submit Object. This step calls the SubmitObjectForProcessing method of the LOY Processing Engine Business Service, which submits the object to the real time processing engine.

  • Stop.Incorrect Status. This step displays an error message saying that the selected record cannot be submitted for processing.

LOY Engine - Process Promotion Bucket Workflow

The LOY Engine - Process Promotion Bucket workflow, shown in the following image, processes a bucket on the real-time component.

LOY Engine - Process Promotion Bucket Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Invoke Engine to Process Promotion Bucket. This step calls the method ProcessObject of the LOY Processing Engine Business Service, which processes the bucket on the real-time component.

LOY Engine - Process Tier Workflow

The LOY Engine - Process Tier workflow, shown in the following image, processes a tier on the real-time component.

LOY Engine - Process Tier Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Invoke Engine to Process Tier. This step calls the method ProcessObject of the LOY Processing Engine Business Service, which processes the tier on the real-time component.

LOY Engine - Process Transaction Workflow

The LOY Engine - Process Transaction workflow, shown in the following image, processes a transaction on the real-time component.

LOY Engine - Process Transaction Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Invoke Engine to Process Transaction. This step calls the method ProcessObject of the LOY Processing Engine Business Service, which invokes the Loyalty Engine in real-time mode to process the transaction.

  • Get Txn Results. This step retrieves transaction results, such as transfer transaction Id, transaction status, transaction type, and so on.

  • Check Results. This step checks the results of the transaction and takes appropriate step.

  • Get CancelTxn of Auto Accrual Member. If the transaction type is Redemption, the transaction subtype is Cancellation, and the transaction status is Processed, then this step retrieves the transaction Id of the cancelled transaction.

  • Process CancelTxn for Auto Accrual Member. This step processes the transaction.

  • Cancel Original Txn. If the transaction subtype is Incorrect Accrual and the status is Processed, then this step calls the subprocess LOY Cancel Transaction Process, which cancels the Transaction.

  • Process Accrual Txn. If transfer transaction Id is not NULL and transaction status is Processed and transaction subtype is Auto Accrual or Transfer, then this step calls the method ProcessObject of the LOY Processing Engine business service, which processes the transaction.

  • GenerateStatement. If the transaction subtype is Manual Credit or Manual debit, then this step calls the method GenerateStatement of the LOY Statement business service, which generates the statement.

LOY Engine - Simulate Object Workflow

The LOY Engine - Simulate Object workflow, shown in the following image, simulates the Promotions by evaluating its actions. It uses transactional data from an XML file and does not perform any DML operations.

LOY Engine - Simulate Object Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Simulate Object. This step calls the method SimulateObject of the LOY Processing Engine Business Service, which simulates the actions of the promotions.

LOY Engine - Start Engine Workflow

The LOY Engine - Start Engine workflow, shown in the following image, submits the required number of component requests to start the engine. The user must specify the number of processes and the number of processing threads for each process.

LOY Engine - Start Engine Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Get Number of Requests. This step calls the Echo method of the Workflow Utilities Business Service, which calculates the number of requests.

  • Is Done? If all the requests have been submitted, then this step ends the workflow.

  • Submit One Request. This step calls the method SubmitRequest of the Server Requests Business Service, which submits the request.

LOY Engine - Update Cache Workflow

The LOY Engine - Update Cache workflow, shown in the following image, updates the cache used by the Loyalty Engine without restarting the engine.

LOY Engine - Update Cache Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Invoke Service. This step calls the method UpdateCache of the Business Service LOY Processing Engine, which updates the cache.

LOY Engine - Update Program Cache Workflow

The LOY Engine - Update Program Cache workflow, shown in the following image, updates the cache used by the Loyalty Engine without restarting the Loyalty engine.

LOY Engine - Update Program Cache Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Invoke Service. This step calls the method UpdateCache of the LOY Processing Engine Business Service, which updates the cache for the program.

LOY Get Txn Enhanced Log New Workflow

The LOY Get Txn Enhanced Log New workflow, shown in the following image, populates the enhanced transaction processing log.

LOY Get Txn Enhanced Log New Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Check/Set Job Param. This step calls the method CheckParameters of the LOY Member Admin Service Business Service, which queries the parameters table.

  • Validate Input. This step calls the method ValidateGetTxnLogInputs of the LOY Member Admin Service Business Service, which validates the log inputs for at least one search criterion.

  • Atleast one search criteria provided. If no search criterion is provided, then this step generates an error. The name of the step in this description literally reproduces the name of the step in the user interface.

  • Update Txn Enhanced Processing Log. This step calls the method UpdateTxnEnhancedLog of the LOY Member Admin Service Business Service, which populates the Transaction Enhanced Log tables.

LOY Loan Repayment Workflow

The LOY Loan Repayment workflow, shown in the following image, creates a loan repayment transaction for members, if they have sufficient point balance to repay the loan.


LOY Loan Repayment Workflow

Workflow Description. This workflow performs the following actions:

  • Get Txn Details. This step calls the method Echo of the Workflow Utilities Business Service, which retrieves the transaction details.

  • Check Available Points for Loan Repay. This step calls the method AvailPtsForLoanRepay of the LOY Customer Action Business Service, which calculates the points available for Loan repayment.

  • Points Available? If no points are available, then this step ends the workflow.

  • Loan Repayment. If points are available, then this step creates a loan repayment transaction.

LOY Member Enrollment Process Workflow

The LOY Member Enrollment Process workflow, shown in the following image, processes new member enrollments.

LOY Member Enrollment Process Workflow

Workflow Description. This workflow performs the following actions:

  • Member Type. This step checks the Member Type and redirects members to the appropriate views. If the Member Type is not given, then it displays an error message saying the member type is missing.

  • New Account Membership Info View. This interactive step displays the LOY Enroll Program Account Member Detail View (eApps). If the user clicks Cancel, then the workflow ends. If the User clicks Submit, then this step calls the step Account is Null?

  • Account is Null? This step checks whether the Account Is Null. If it is Null, then it displays an error message saying the account is missing. Otherwise, it calls the step SetNametoAccount.

  • SetNametoAccount. This step calls the method Echo of the Workflow Utilities Business Service, which sets the name for the member.

  • New Membership for Account. This step adds the new member to the account.

  • New Household Membership Info View. This interactive step displays the LOY Enroll Program Household Member Detail View (eApps). If the user clicks Cancel, then the workflow ends. If the user clicks Submit, then it calls the step Household is Null?

  • Household Is Null? This step checks whether the Account Is Null. If it is Null, then it displays an error message saying that household is missing. Otherwise, it calls the step SetNametoHousehold.

  • SetNametoHousehold. This step calls the method Echo of the Workflow Utilities Business Service, which sets the name for the member.

  • New Individual Membership Info View. This interactive step displays the LOY Enroll Program Member Detail View (eApps). If the user clicks Cancel, then the workflow ends. If the user clicks Submit, then it calls the step SetNametoContact.

  • SetNametoContact. This step calls the method Echo of the Workflow Utilities Business Service, which sets the name for the member.

  • New Membership. This step adds the member to the Household or Contacts list.

  • BS GoToView. This step calls the method GotoView of the CUT eSales Order Entry Toolkit Service Business Service, which navigates to the view LOY Member List View (eApps).

LOY Modify Promotion Process Workflow

The LOY Modify Promotion Process workflow, shown in the following image, makes the promotion inactive and available for editing.

LOY Modify Promotion Process Workflow

Workflow Description. This workflow performs the following actions:

  • Is Promotion Active? If the promotion is inactive, then the workflow ends. Otherwise, this step calls the step Deactivate the Promotion.

  • Deactivate the Promotion. This step makes the promotion inactive and available for editing.

LOY Optin Promotion Process Workflow

The LOY Optin Promotion Process workflow, shown in the following image, is used by the eLoyalty customer application. It enables users to enroll in a promotion.


LOY Optin Promotion Process Workflow

Workflow Description. This workflow performs the following actions:

  • Count Member. This step calls the method GetBCCount of the CUT eSales Order Entry Toolkit Service Business Service, which returns the number of members in the Contact BC.

  • More than one Member? If the number of members is less than one, then this step displays an error message saying that none of the user’s memberships qualify for this promotion, so the user should select another promotion. If the number of members is equal to 1, then it calls the step Check Optin. If the number of members is greater than 1, then it calls the step Select Member.

  • Check Optin. If the number of members is equal to 1, then this step queries if the member has already opted In.

  • Already Optin? If the member has already opted in, then this step displays an error message saying the member is already enrolled into this promotion. Otherwise, it calls the step Calculate Enrol Exp date.

  • Calculate Enrol Exp date. This step calls the method CalculateEnrollmentExpiryDate of the LOY Member Services Business Service, which calculates the Expiry Date for the enrollment.

  • Optin a member. This step enrolls the member into the promotion.

  • Select Member. This interactive step displays the LOY Optin Promotion View (eApps). After the user selects a member, it calls the step Check Dup.

  • Check Dup. This step checks whether the member has already opted in.

  • Dup? If it is a duplicate, then this step displays an error message saying the member is already enrolled in this promotion. Otherwise, it calls the step Calculate Enroll Exp Date.

  • Calculate Enroll Exp Date. This step calls the method CalculateEnrollmentExpiryDate of the LOY Member Services Business Service, which calculates the Expiry Date for the enrollment.

  • Optin the selected member. This step enrolls the member in the promotion.

  • Enter Offer Code. This interactive step displays the LOY Offer Code View (eApps). If the user clicks Cancel, then it calls the interactive step Select Member. If the user clicks Submit, then it calls the step Goto View.

  • Goto View. This step calls the subprocess LOY Optin Promotion Sub Process, which displays LOY Member Promotions View (eApps).

LOY Optin Promotion Sub Process Workflow

The LOY Optin Promotion Sub Process workflow, shown in the following image, is used by the eLoyalty customer application. It enables users to enroll in a promotion.


LOY Optin Promotion Sub Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Goto View. This interactive step displays LOY Member Promotions View (eApps).

LOY Point Transfer Process Workflow

The LOY Point Transfer Process workflow, shown in the following image, transfers points between members.


LOY Point Transfer Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Retrieve Product Id. This step retrieves the Product Id.

  • Create ABB Transaction. This step creates an action-based bonus transaction to transfer the points.

LOY PreAlloted Membership Generation Workflow

The LOY PreAlloted Membership Generation workflow, shown in the following image, assigns a membership status to applicants automatically enrolled in programs based on predefined membership identifiers.

LOY PreAlloted Membership Generation Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Generate Member Numbers. This step calls the method GeneratePreAllotedMembership of the LOY Batch Enrollment Service Business Service, which generates the member numbers.

LOY Return Points to Parent Point Block Workflow

The LOY Return Points to Parent Point Block workflow, shown in the following image, returns the remaining points in a point block associated with a promotion to the parent point block from which the points were originally reserved, when the status of that point block is set to Consumed. To process any monetary refunds due from the return, Siebel Loyalty tracks the returned value at the parent point block level.

LOY Return Points to Parent Point Block Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Update Point Block Returned Points. This step updates the parent point block.

  • Update Promo Point Block Returned Points. This step updates the point block associated with the promotion.

LOY Update Parent Point Block Reserved Points Workflow

The LOY Update Parent Point Block Reserved Points workflow, shown in the following image, exclusively reserves the points allocated for the promotion in the parent point block, when the Status of a point block associated with a promotion is set to Approved. This prevents unlimited points promotions from consuming preallocated points from the parent point block.

LOY Update Parent Point Block Reserved Points Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Update Point Block Reserved Points. This step reserves points in the parent point block.

LOY Update Program Process Workflow

The LOY Update Program Process workflow, shown in the following image, is used by the Loyalty Engine to refresh the program cache.

LOY Update Program Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following action:

  • Update Cache. This step calls the method Update Cache of the Business Service LOY Cache Manager Update, which updates the cache.

LOY User Registration Member Process Workflow

The LOY User Registration Member Process workflow, shown in the following image, creates and registers a new member.

LOY User Registration Member Process Workflow: This image is described in the surrounding text.

Workflow Description. This workflow performs the following actions:

  • Check Member Type. This step checks the Member Type and calls the following steps accordingly. If the member type is not given, then it displays an error message saying that member type is missing.

  • Insert Account. This step inserts the account details into the business component.

  • Dup Addr? This step checks whether the address already exists. If it already exists, then it calls the step Assoc Addr to Account. Otherwise, it calls Insert Address.

  • Assoc Addr to Account. This step associates the address with the account.

  • Set Primary. This step sets the primary address for the account.

  • Insert Address. This step inserts the address for the account.

  • Create Member of Account. This step creates the member of the type Account.

  • Insert Household. This step inserts the household details.

  • Dup Addr 2? This step checks whether the address already exists. If it already exists, then it calls the step Assoc Address to Household. Otherwise, it calls Insert Address2.

  • Assoc Address to Household. This step associates the address with the household.

  • Set Primary for Household. This step sets the primary address for the household.

  • Insert Address2. This step inserts the address for the household.

  • Create Member of Household. This step creates the member of the type Household.

  • Create Member of Contact. If the Member Type is Individual, then this step creates a member of type Individual.

  • Insert Travel Profile. This step associates a travel profile with the member.

Siebel Loyalty Task Flows

The following table describes Siebel Loyalty task flows.

Loyalty Task Flows Description

LOY Member Lounge Purchase

This task flow enables members to purchase or renew the lounge available for the desired period or duration. Payment for this service can be made in loyalty points or currency or a combination of points plus currency.

The custom action used in this task to update member's lounge dates is LoungePurchase.

LOY Member Points Gift

This task flow enables members to give gift points to other members enrolled to the same program. The gift points are first purchased by the primary member and then they are transferred to the recipient. This service might require fees to be paid in currency, as determined in the promotion described in Creating the Admin - Gift Promotion.

LOY Member Points Purchase

This task flow enables members to purchase Loyalty points like Miles. Payment made for this service would be in currency.

The custom action method used for accruing the purchased points and updating the member's point balance is PurchasePoints.

LOY Member Points Transfer

This task flow enables members to transfer loyalty points from their accounts to any other member's account. The transferee must belong to the same program and tier and membership type. Payment for this service is made in currency.

The Custom Action used is TransferPoints. It updates the point balances of transferor and transferee by accruing and redeeming points.

LOY Membership Cancellation

This task flow enables members to cancel their memberships. No payment is involved from the member's side. If the membership was paid for, then the monetary part of the payment can be refunded to the credit card used when the member enrolled. After completing the task, the membership is cancelled. It involves no custom action.

LOY Membership Renewal

This task flow enables members to extend or renew their membership period. Payment is done in loyalty points or pay or Points plus (+) Pay.

The custom action used is RenewMembership. It updates membership start and end dates, membership scheme as chosen by the member.

LOY Points Reactivation Task

This task flow enables members to reactivate some or all of their Expired points by paying fees in currency. Members can only reactivate points that expired in a specific time period, specified at the Point Type level. Members can only reactivate non-qualifying point types. This service might require fees to be paid in currency, as determined by the promotion described in Creating the Admin - Points Reactivation Promotion.

LOY Promotion Enrollment

This task flow enables members to enroll themselves in promotions that require enrollment. Members might be rewarded with incentives for enrollment, if they have been set up for the promotion. This service might require fees paid in currency, in points, or in a combination of currency and points, as determined by the promotion described in Creating the Admin - Points Reactivation Promotion.

LOY Redemption Voucher Reissue

This task flow enables members to reissue redemption vouchers.

LOY Redemption Cancellation

This task flow enables members to cancel redemptions.

LOY Member Enrollment

This task flow enables members to enroll in loyalty programs.

Create Accrual Disputes

This task flow enables members to create accrual disputes.

LOY Member Enrollment Payment

This task flow enables members to pay for enrolling in loyalty programs.

LOY Processing Engine Business Service

The LOY Processing Engine Business Service includes the following methods:

ProcessBatch Method

ProcessBatch invokes the Engine. Depending on the role assumed by this task, the engine enters queue or processing mode by calling the appropriate method.

Input Arguments

None

Output Arguments

None

ProcessObject Method

ProcessObject does real-time (single-object) invocation of the LPE. It processes only the single specified object and returns, and it does not use the queue manager.

Input Arguments

Input Arguments are summarized in the following table.

Name Value Description

ObjectType

String

The Type of the Object to process. Valid arguments are:

  • Transaction

  • Bucket

  • Tier

  • Accrual

RowId

Row Id

The Row Id of the Object to Process.

Output Arguments

None

SubmitObjectForProcessing Method

SubmitObjectForProcessing is called when the user clicks the Process button of the UI to process a transaction in real time. If the application is running in server mode, then it submits a synchronous component request to the specified component (with specified workflow and row id). Otherwise, it directly invokes the workflow to process the object in the same thread.

Input Arguments

Input Arguments are summarized in the following table.

Name Value Description

Component

String

The name of the component to submit the request to.

ProcessName

String

The workflow to invoke.

RowId

Row Id

The Row Id of the Object to Process.

Output Arguments

None

UpdateCache Method

UpdateCache updates the Promotion in the Cache, if the engine is already initialized.

Input Arguments are summarized in the following table.

Name Value Description

ObjectType

String

Type of object to update. If Program, then the loyalty program information is updated. Otherwise, promotion information is updated.

ProgramId

Row Id

Target loyalty program to update.

PromotionId

Row Id

Id of the Promotion to load.

Output Arguments

None

LOY Interactive Processing Engine Business Service

The LOY Interactive Processing Engine Business Service includes the following methods:

ProcessInteractiveObject Method

This method processes the transaction in interactive mode.

Input Arguments

Input Arguments are summarized in the following table.

Name Value Description

ObjectType

String

The Type of the Object to process. Valid arguments are:

  • Transaction

  • Bucket

  • Tier

  • Accrual

RowId

Row Id

The Row Id of the Object to Process.

Output Arguments

None

InteractiveProcess Method

This method is called for processing or simulating a set of transactions.

Input Arguments

Input Arguments are summarized in the following table.

Name Value Description

Request Mode

Simulate or Process

Specify whether to process or simulate the transaction.

Output Arguments

None