Configure Data Sync for Offline Application

As an administrator or implementor, you can optimize the offline mobile experience by configuring the objects and data for offline sync. By marking the appropriate subset of the data objects, you can manage the sync routines and improve the efficiency of the field operations.

  • Define the objects, attributes, and records for sync.

  • Use the filters to determine the data set for download.

  • Balance the data needs with the device memory constraints.

  • Enable download of the required data to suit the needs of your organization.

  • Manage offline data objects and records based on user security and privileges.

  • Improve the offline experience of the mobile application and device.

Prerequisites

Run the Enable Consumer Goods Object Extension for the Mobile Application job to generate the seeded sync rules. For more information, see Run the ESS Jobs.

Note:

You must run this scheduled process job to see the seeded rules.

Create Sync Rule

To improve the overall mobile application experience, configure the data sets, objects, and attributes to filter the information required for managing the store visits routines. You can configure the objects related to the active contracts, select attributes, and filter the records for offline sync. As a sales administrator, here's how you create a sync rule:

  1. On the springboard, go to Sync Rules > Create.

  2. Specify the values for the fields such as the rule name, object, parent object, and sync settings details.

  3. Click Save and Close.

  4. Go to the Object Attributes subtab.

  5. Search and select an object attribute from the list and click Save to map attributes to the sync rule.

  6. Go to Filter Criteria Group > Create.

  7. Specify the group name, filter operation such as And or Or. You can have multiple filter criteria groups.

  8. On the Filter Criteria Group summary page, go to Filter Criterion > Create.

  9. Specify the criterion name, type, filter operation, and values from the available list.

    Note:

    Based on your selection, you can use various types and filters.

    For example, for the date type, you can use the following filters:

    • Operations: After, Before, Between,=, >, >=, <, <=, !=, Is.

    • Values: Today, Today-1D, Today+1D, Today-1M, Today+1M, Today-1Y, Today+1Y, (YYYY-MM-DD HH24:MI), and Blank.

      D is day, M is month, and Y is year.

  10. Click Save and Close.

    You can view the Sync rule.

Sync Rule: Use Cases

Here are a few samples that you can use as sync rules and publish the data to your offline mobile application.

  1. On the springboard, go to Sync Rules > Find.

  2. Search for the objects related to your requirements, for example, CGContract_c.

    You can apply sync rules for both seeded and custom objects.

  3. On the sync rule summary page, see the rule name, object, parent object, and other details. Ensure you select the Sync option.

  4. Go to Filter Criteria Group > Filter Criterion.

    Verify the group name, filter operation such as And or Or. Select the operations to suit your filter criteria groups.

  5. On Filter Criterion subtab, specify the filter criteria name, and the following type, operation, and values from the available list.

    • For active contracts:

      Use the following sync rules to filter out the required contracts information. You can configure the objects related to the active contracts, select attributes, and filter the records for offline sync.

      1. Specify the criteria name, search and select the field __ORACO_Status_c.

      2. Select Picklist from the Type drop-down list and specify In from Filter Operation list.

      3. Specify ACTIVE in the value field.

      4. Click Save and Close.

      This filter criterion downloads the objects with the active contracts to your mobile app.

    • For store visits and activity:

      Use the following sync rules to help you with the activity for today and next two days:

      1. Create multiple criteria by specifying the criteria name, search and select the field ActivityStartDate.

        • Select the Date from the available Type list, specify the filters >= from Filter Operation list, and specify Today in the value field

        • Select the Date from the available Type list, specify the filters <= from Filter Operation list, and specify Today+2D in the value field

      2. Create another criterion by specifying the criteria name, search and select the field __ORACO_StoreVisit_c

        • Select checkbox from the Type, specify the filters = from Filter Operation list, and specify Y in the value field

      3. Click Save and Close.

      This filter criterion downloads the objects with the store visit activity for the next two days.

  6. Once you configure the sync rules, run Prepare Consumer Goods Appointment Download Document job.

After you run the job, as a salesperson, you can see the required information from your mobile application:

  1. Go to the mobile application and sync the data using the Pending Sync option.

    Based on your sync rules, your mobile application shows the filtered data.

  2. Go to Accounts > Contracts to see the contracts in the active status.

Similarly, your mobile application shows the required data per your sync rules and filters.

Objects in Sync Package

The following list shows the objects in the sync package.

Object Name

Description

Route

Indicates the routes based on the criteria.

Manufacturer

Indicates the manufacturers.

DetailingProduct

Indicates the detailing products.

Activity

Indicates the activities which aren't completed, store visit is Y, and RouteID is the route being processed.

ProductDetailing

Indicates the product detailing records related to the activity.

Accounts

Indicates the accounts related to the activity and the route.

__ORACO__CGContractPrintTpt_c

Indicates the contract print template records related to the accounts, order, payment, invoice, contract, inventory load, inventory reload, and route settlement.

__ORACO__TemplateFile_c

Indicates the template file related to the print template.

Person

Indicates the contact person of the account.

Resource

Indicates the resource of the account.

Visit History

Indicates the completed activities related to the account.

Product Detailing

Indicates the product detailing records of the activity.

Inventory

Indicates the inventory related to the account.

AccountPromotion

Indicates the account promotion records related to the account.

Promotion

Indicates the promotion records based on the account promotion records including all child records.

__ORACO__ComboGroupDSD_c

Indicates the combo group records related to the promotion.

Promotion Survey Template

Indicates the promotion survey template records.

Pricebook

Indicates the price book related to the account.

Product assortment

Indicates the assortment related to the account.

Assortment Line

Indicates the assortment lines related to the assortment of the account.

Products

Indicates the products added to the assortment line.

UOM Conversion

Indicates the UOM conversion records for the product.

Assortment Line Relationship

Indicates the assortment line relationship records related to the account.

Priority Portfolio

Indicates the priority portfolio records related to the account.

PriorityGroup

Indicates the priority groups related to the portfolio.

ProductGroup

Indicates the product groups related to the priority portfolio.

ProductGroupProduct

Indicates the products added to the priority group.

__ORACO__MerchLocation_c

Indicates the merchandising locations related to the account.

__ORACO__AssignedAssets_c

Indicates the assets assigned to the merchandising location.

__ORACO__AccountObjective_c

Indicates the objective IDs related to the account.

businessPlans

Indicates the business plans related to the account objective.

__ORACO__KPIRelationship_c

Indicates the KPI relationships related to the business plan.

ObjectiveTask

Indicates the objective tasks related to the business plans.

__ORACO__AccountCluster_c

Indicates the cluster IDs the account is a part of.

__ORACO__Cluster_c

Indicates the cluster details of the account.

__ORACO__CTemplateCluster_c

Indicates the template cluster details.

__ORACO__ForecastAttainment_c

Indicates the forecast attainment for the account.

__ORACO__BankAccount_c

Indicates the bank account details of the account.

Account Survey template

Indicates the survey template details of the account.

AccountDistributor

Indicates the account distributor information for the account.

Account Shopping cart template header

Indicates the shopping cart template header ID related to the account.

shopping cart template header

Indicates the shopping cart template header details.

__ORACO__ShoppingCartTmpl_c

Indicates the shopping cart details including child records.

__ORACO__AccountTaskDetails_c

Indicates the account task details related to store visit tasks associated to an activity.

__ORACO__SurveyTemplate_c

Indicates the survey template records related to the tasks of the activity.

__ORACO__AccountContract_c

Indicates the account contracts for the accounts of the activity.

__ORACO__CGContract_c

Indicates the contract details of the account.

ContractTask

Indicates the tasks related to the contract.

__ORACO__PrintDocument_c

Indicates the print documents related to the contract.

__ORACO__Term_c

Indicates the terms related to the contract.

__ORACO__Benefit_c

Indicates the benefits related to the contracts and contract templates.

__ORACO__ProductBenefit_c

Indicates the product benefits.

products

Indicates the products details of the product benefits.

__ORACO__ComplianceHistory_c

Indicates the compliance history related to the benefit.

__ORACO__Condition_c

Indicates the conditions related to the benefit.

__ORACO__ConditionComplHist_c

Indicates the condition compliance history records.

__ORACO__AttainmentTarget_c

Indicates the attainment target for both benefit and condition.

__ORACO__ConditionProduct_c

Indicates the products of the condition.

__ORACO__ConditionGuard_c

Indicates the condition guards.

__ORACO__Resolution_c

Indicates the resolutions related to the benefit.

__ORACO__ManualAccrualSched_c

Indicates the manual accrual schedule for the benefit.

__ORACO__BenefitGuard_c

Indicates the benefit guard.

Currencies

Indicates the currencies available.

ConditionTemplate

Indicates the condition templates available.

Contract templates

Indicates the contract templates available.

products

Indicates the products details.

__ORACO__ConditionGuard_c

Indicates the guards related to the condition.

__ORACO__ConditionProduct_c

Indicates the products of the condition.

__ORACO__Term_c

Indicates the terms related to the contract template.

DistributeCentre

Indicates the distribution center of the route.

Route allocations

Indicates the route allocations in the distribution center.

Route resource

Indicates the route resource details.

Resource

Indicates the resources related to the route.

Route pricebook

Indicates the price book details of the route.

Route assortments

Indicates the assortments related to the route.

Payments

Indicates the payments related to the account.

Payment Lines

Indicates the payment lines.

Order

Indicates the orders related to the account.

Order Lines

Indicates the order lines of the order.

Shipment

Indicates the shipments and their status.

Shipment lines

Indicates the shipment lines.

Invoices

Indicates the invoices of the shipment.

Invoice lines

Indicates the invoice lines available.

Credit line

Indicates the credit lines related to the account.

Credit note

Indicates the credit notes related to the account.

Most objects included in sync follow direct data relationships to either route, account, or appointment. Your sync package includes contract templates and condition templates, though these two objects have no direct relationship to route, account, or appointment. To improve the data relevance, the contract templates and condition templates in your mobile sync package are automatically filtered based on the route segment value.