Overview

Utilities is a set of tools necessary to are the tools that are used to implement, maintain or support business processes within the system.  These tools include a scheduling engine responsible for scheduling planning and executing batch processes in CRM.COM processes in one flow, a data integration mechanism used for data imports and exports, and an archiving utility for archiving old data to control the size of a databasesaving storage space occupied by unused data.

Major features

• Execute and manage batch process tasks, such as stopping or deleting them
• Supports single entity rollback upon batch process task interruption. For example, if the billing is interrupted after billing 1000 accounts, the changes will not be roll-backed. However, if upon interruption the billing of a single account was not complete, then the system will revert any changes done on the specific account.
• Archiving of  batch processes.
• Roll back single entities if a batch process is interrupted.
• Archive data to control database size. Records associated to
• Mark data associated with archived data are marked for reference.Import hardware directly in  
• Use import files to import hardware directly into a warehouse and to create rewards participants using import files. 
• Export vouchersUse Pentaho kettles for custom-made .
• Customize imports and exports with Pentaho kettles. Schedule imports and exports to run once in the future or on a recurring basis.

...

Related configuration areas

Mandatory modules must be configured for the Utilities the utilities module to work.

...

Using the Archiving Utility

As the exponentially increasing data of many businesses can result in the lack of Data used and generated by businesses increases exponentially.  Insufficient storage space on database servers and the consequent slowing down of a system, archiving older is directly related to slower performance.  Consequently, the need to archive unused data (data created up to a certain date is crucial. The utility compresses ) is expanding.  

The archiving utility:

• Compresses data that no longer has financial or marketing impact

...

• .
• Saves the data in an archived structure in the database.
• Updates the existing entities still available in the system

...

• that are associated with the archived data. 

For A record is created for every 'data archiving entity' a record is created and available from archived data to be downloaded or permanently deleted if it is .  The record is available for download and can be permanently deleted if no longer needed.  The execution of the archiving utility and the deletion of archived data can only be performed by system users designated for each process through a username and password 

Designated system users can execute the archive utility and delete archived data; the processes are password protected.

The following data can be archived:   

• Purchase Customer Eventcustomer events
• Spend Request Customer Eventrequest customer events
• Referral Customer Eventcustomer events
• Social Media Customer Eventmedia customer events
• Web Customer Eventcustomer events
• Achievement Customer Eventcustomer events
• Financial Achievement Customer Eventachievement customer events
• Financial Statement Customer Eventstatement customer events
• Provisioning Requestsrequests
• Process Run Logsrun logs
• Rated Billing Items

...

• billing items

As well as explicitly defined entities other , associated entity records may  can also be archived even if not explicitly defined, when are associated with an archived record. The following entities are subject to archiving.

• Awarded Events
• Spend Reward Transactions
• Provisioning Request Parameters
• Process Run Log Entity
• Applied Additive Discounts

Archiving Data Run Definitions

To archive data you must set up an Archiving Data Run Definition

Image Removed

...

, such as:

• Awarded events
• Spend reward transactions
• Provisioning request parameters
• Process run log entity
• Applied additive discounts

Archiving data run definitions

To archive data, an archiving data run definition must be set up.

Image Added

1. Navigate to Foundation > Utilities > Archiving Utility > Perform Data Archiving Runs and click on NEW from the Actions menu.
2. Provide all the mandatory information along with the Criteriaand criteria.
   1. Data Archiving Entity: the entity you wish to archive Select an entity to archive from the drop-down menu.
   2. Archive Data Created X Months Ago: determines  Identify the data that should to be archived based on using the date on which it was created in was entered into the system. The minimum (and default) value when creating a for new definition definitions is 12 months.
3. Once you configure the definition SAVE, it SAVE the configured definition and SUBMIT to  it to the scheduler so that it is executed and data is archivedto be executed.
4. A list of the previously executed runs (a is available under Process Runs.
   A run is created every each time the definition is submitted) is available in the process runs.

Anchor
viewing_not_arch_data viewing_not_arch_data

Viewing archived data

Once After the utility is executed, the archived data can be accessed from , downloaded or deleted from a dedicated screen from it can be downloaded or deleted.

Image RemovedImage Added 

Anchor
downloading_arch_data downloading_arch_data

Downloading archived data

1. Navigate to the archived data summary Summary page and search for the data of interestyou are interested in.
2. Click on DOWNLOAD.
   
3. Provide a password.
   The A compressed archived file will be downloaded.

Anchor
deleting_arch_data deleting_arch_data

Deleting archived data

1. Navigate to the archived data summary page and search for the data to delete.
2. Check the select box on the left of the item to be deleted.
3. From Click on Delete from the Actions menu click on Actions > Delete.
   
4. Provide a password.
5. Click on Delete.The archived data will be deleted.

Back to top

Using the Scheduler

...

The scheduler is used to execute the batch tasks that are scheduled in the system.   A batch task is program and execute system tasks that are processed in one flow.  Each task consists of a series of steps involving the simultaneous handling of multiple entries, without the need for manual intervention.

Every Each time a run definition is ' submitted' , a task is created and sent to the scheduler for processing. Depending on the ' The scheduler settings ' defined on in the run definition , determine whether the task may be is executed once and removed from the scheduler (one-off), or whether it may be is recurring (executed and the next upcoming task scheduled instantly (repetitive tasksone scheduled).

The scheduler can be in either one of two states:

• 'Running':  All tasks that are   All 'Effective' and  tasks that have a CRON Expression equal to the current time of the scheduler will be are executed. 
• 'Standby Mode':  No Task will be executed, even if it is scheduledScheduled tasks are not executed.

1. Navigate to the scheduler utility and explore scheduled tasks via through the Summary page. 
2. Click on one of the entries an entry to access the task Data Entry page of the scheduled tasks to and DELETE a scheduled task or STOP a running one.
3. Click on ACTIONS from the Actions menu and select Select one of the following options from the Actions menu:
   • VIEW SCHEDULED TASKS: Displays tasks which are scheduled for the organisation. 
   • VIEW RUNNING TASKS: Displays tasks which are already running for the organisation. 
   • VIEW COMPLETED TASKS: Displays completed tasks. 
   • VIEW LOG: Displays the scheduler log.  The tasks executed during  Click a day of the month to display tasks executed during specific days of the current month and their results can be viewed, by clicking on the day of your interestresults.
   • START SCHEDULER: Starts the scheduler. This  This action can be applied only if the current application server is enabled to run scheduled processes for the specific organisationorganization. More information is available at Scheduler Settings.
   • STOP SCHEDULER: Stops the scheduler.  

Image RemovedImage Added

Task fields

For each task the The following information is available either through the Summary  page

...

for each task on the Summary page. 

Anchor
delete delete

Deleting a scheduled task

A task that has not yet been executed can be deleted , so that it is never executedis not executed. 

1. Navigate to the Scheduler Utilityscheduler utility. 
2. Click on the task to navigate to the task's go to its Data Entry page.
3. Click on DELETEDELETE from the Top Menu.
   
4. The scheduled task is deleted permanently and removed removed from the list.

Anchor
stop stop

Stopping a running

...

task

A task that is already running being processed can be stopped , once the currently executing current step is completed. 

1. Navigate to the Scheduler Utilityscheduler utility.
2. Click on the task to navigate to the task's go to its Data Entry page.
3. Click on STOP.
   1. Provide the a reason for stopping the task.
4. The following information is kept on the associated log entry of the scheduler task:
   
   1. The user that stopped the task.
   2. The date and time that the task was stopped.
   3. The reason for stopping the running task. 

...

Back to top 

Anchor
batch batch

Using Data Imports & Exports

...

Utilities Business Examples

...