Overview

To streamline the integration process and minimize initialization errors, MoEngage supports Script-Based Initialization. This approach allows you to manage App IDs and configuration settings directly within native configuration files, keeping them separate from your application logic.

This article outlines how you can use the form-based interface to generate a validated code snippet for initialization and access module-specific configurations.

Follow these steps to generate your initialization script:

1. Navigate to the Initialization Website.
2. Configure the values based on your application requirements. Refer to the Configuration Parameters tables below:
   • Android
   • iOS
3. Click Generate Code at the bottom of the form.

Android Configuration (XML)

For Android, initialization is handled by placing an XML configuration file in the application's resource directory.

Android Configuration Reference

Below is the comprehensive list of keys available for moengage.xml.

Add Configuration File

1. Create a file named moengage.xml. 

   info

   Information File-Based Init: Calling MoEInitializer.initializeDefaultInstance(context) instructs the SDK to look for and read the moengage.xml file. Code-Based Init: Calling MoEInitializer.initialize(context, moEngage.Builder) will initialize the SDK using the configuration object passed in the parameters, ignoring the XML file even if it exists.

2. Place it in android/app/src/main/res/values/.
3. Add your configuration file generated in the Initialization Website.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- Optional: Enable File Based Init -->
    <bool name="com_moengage_core_file_based_initialisation_enabled">true</bool>
    
    <!-- Mandatory: Your App ID -->
    <string name="com_moengage_core_workspace_id">YOUR_WORKSPACE_ID</string>
    
    <!-- Mandatory: Data Center (Default 1) -->
    <integer name="com_moengage_core_data_center">1</integer>

    <!-- Optional: Custom Proxy Domain -->
    <string name="com_moengage_core_custom_base_domain">data.example.com</string>
    
    <!-- Optional: Notification Settings -->
    <drawable name="com_moengage_push_notification_small_icon">@drawable/ic_notification</drawable>
    <color name="com_moengage_push_notification_color">#FF0000</color>

    <!-- Optional: Logging (0=NoLog, 5=Verbose) -->
    <integer name="com_moengage_core_log_level">3</integer>
</resources>

Step 2: iOS Configuration (Info.plist)

For iOS, initialization is handled by adding a configuration dictionary to your Info.plist.

iOS Configuration Reference

Below is the comprehensive list of keys available for the MoEngage dictionary.

Data Center Values

Configure the integer corresponding to your region. Incorrect values will result in data loss. 

Update Info.plist

1. Open your project's Info.plist ( found in ios/Runner/ ).
2. Create a new Top-Level Key named MoEngage of type Dictionary.
3. Add the configuration file generated in the Initialization Website.

XML Snippet Representation:

<key>MoEngage</key>
<dict>
    <key>WorkspaceId</key>
    <string>YOUR_WORKSPACE_ID</string>
    <key>IsTestEnvironment</key>
    <string>$(SWIFT_ACTIVE_COMPILATION_CONDITIONS)|$(GCC_PREPROCESSOR_DEFINITIONS)</string>
    <key>DataCenter</key>
    <integer>1</integer>
    <key>CustomBaseDomain</key>
    <string>data.example.com</string>
    <key>IsLoggingEnabled</key>
    <true/>
</dict>

Step 3: Framework Level Initialization

After you configure the native files, the initialization code in your hybrid framework is simplified.

Create MoEngageFlutter(YOUR_Workspace_ID) object and in the project's App Widget call initialise() of MoEngageFlutter plugin in the initState() the method as shown below:

import 'package:moengage_flutter/moengage_flutter.dart';
final MoEngageFlutter _moengagePlugin = MoEngageFlutter(YOUR_Workspace_ID);
@override
void initState() {
  super.initState();
  initPlatformState();
  _moengagePlugin.initialise();
}

Step 4: Migration and Precedence

Android Migration Steps

To migrate from manual code-based initialization to the XML file-based approach, follow these steps:

1. Add Configuration File: Place the moengage.xml config file in the correct path (for example, src/main/assets/moengage.xml).
2. Update Application Class: Remove the existing initialization code (the manual MoEngage.Builder logic) from your Application class and replace it with the default instance initialization to enable reading from the XML file.

import com.moengage.flutter.MoEInitializer;
MoEInitializer.INSTANCE.initializeDefaultInstance(this);

import com.moengage.flutter.MoEInitializer
MoEInitializer.initializeDefaultInstance(application)

iOS Migration Steps

To migrate from code-based initialization to the Info.plist based approach, follow these steps:

1. Update Info.plist: Add the required MoEngage configuration keys (for example, WorkspaceId, DataCenter, etc.) directly to your Info.plist file.
2. Update AppDelegate: Remove the existing initialization code (the manual MoEngageSDKConfig logic) from your AppDelegate class and replace it with the default instance initialization to enable reading from the Info.plist file.

@import moengage_flutter_ios;
[MoEngageInitializer.sharedInstance initializeDefaultInstance];

import moengage_flutter_ios
MoEngageInitializer.sharedInstance.initializeDefaultInstance()

Precedence Rules

The source of configuration is determined by the initialization function called in your native code:

• Android:
  • File-Based Init: Calling MoEInitializer.initializeDefaultInstance(context) instructs the SDK to look for and read the moengage.xml file.
  • Code-Based Init: Calling MoEInitializer.initialize(context, moEngage.Builder) will initialize the SDK using the configuration object passed in the parameters, ignoring the XML file even if it exists.
• iOS: Auto-initialization (via Info.plist) occurs first. However, if you subsequently call the manual initialize method with a configuration object in your code, it will update the current instance configuration.

Step 5: Environments (Test vs. Live)

You can configure Test/Live environments within these files.

• Android: Use the key <string name="com_moengage_core_environment">test</string>.
• iOS: Use <key>IsTestEnvironment</key> <true/>