Knowledge Base

Use Case

• Leveraging the eXtendRoyalties bundle to generate Credit Memos for royalty customers.
  
• Generation of Credit Memos from royalty transactions on a scheduled basis.
  

Configuration Details

1. Create a Saved Search for eXtendRoyalties records to be processed on Credit Memos
   To filter down to the required transaction records for processing via a credit memo, create a saved search against the eXtendRoyalties transaction records to be processed. The eXtendRoyalties Credits for Customers[B] {customsearch_extend_royalty_cm_customer} saved search is included in the eXtendRoyalties bundle to use base criteria. Copy this saved search and apply any additional criteria as per your business requirements.
   
   Note: To avoid duplication of line items in the saved search results, be sure to add a filter to the  applicable credit/debit line. Otherwise, the credit memo will consider the same item twice.
   
   
2. Create the eXtendRoyalty Credit Creation Schedule
   The eXtendRoyalty Credit Creation Schedule record is used to define schedules for the automatic creation of per-customer credit memo records.

   
   

   Go to Customization → Lists, Records, & Fields → Custom Records → eXtendRoyalty Credit Creation Schedule → New to create a new record.
   

   
   
1. CUSTOMER: Select the customer record for which you are creating this schedule record.
   
2. REPORTING FREQUENCY: Select the credit memo generation frequency for this schedule. There are currently two options available: monthly or bi-monthly. Choose the option that best suits your use case.
   
3. NEXT SCHEDULE RUN DATE: Specify the start date for the scheduled execution. The next execution date will be automatically set based on the specified reporting frequency when the script is next executed.
   
4. EMAIL ADDRESS(ES) FOR ROYALTY CMS: You can use this field to add email addresses which can be used in conjunction with a workflow for sending emails for the generated credit memo record.
   
   
   
   Note: If you wish to automatically email the credit memo transactions created from royalties you will need to create a new/separate workflow.
   
5. AUTO-EMAIL CMS?: You can use this field in an email sending workflow to conditionally email credit memos to specific customers.
   
6. DAY: If you want to create credit memos on a specific day, you can specify that day here. Keep in mind that the specified day will be relative to the NEXT SCHEDULED RUN DATE. This means that the process will execute on the specified day which comes after the date specified under NEXT SCHEDULED RUN DATE.
   
   
   

   The following examples will demonstrate how the DAY and NEXT SCHEDULE RUN DATE work together.
   
1. Example 1:
   
   The NEXT SCHEDULED RUN DATE is 07/16/2021 (a Friday)
   DAY is configured as Tuesday.
1. In this scenario, the script will not create the credit memo on 07/16/2021. Instead, it will run the following Tuesday, when it will successfully create the credit memo record. The next scheduled run date will be determined by the specified REPORTING FREQUENCY.
   
2. Example 2:
   
   The NEXT SCHEDULED RUN DATE is 07/16/2021 (a Friday)
   DAY is not specified.
1. In this scenaro, the script will create the credit memo on 07/16/2021 and set the NEXT SCHEDULED RUN DATE based on the REPORTING FREQUENCY.
   
   
3. Map/Reduce Deployment Configuration
   A scheduled script deployment for the eXtendRoyalty Create Credit Memo {customscript_extend_royalty_credit_memo} Map/Reduce script will need to be created. Be sure to schedule this script to run once per day. The timing of actual credit memo creation will be determined by the eXtendRoyalty Credit Creation Schedule custom record during processing for each schedule.
   
   
   In the script parameters, enter the saved search id that you entered in step 1.