Configuration

The Configuration extension is built into the Mobile Core extension. It provides several different APIs for you to setup the configuration either remotely in the Data Collection UI or locally.
Configure with App ID per environment
When you configure a mobile property, a unique environment ID is generated that the SDK uses to retrieve your configuration. This ID is generated when an app configuration is created and published to a given environment. The app is first launched and then the SDK retrieves and uses this Adobe-hosted configuration.
As best practice, you should configure a mobile property in the Data Collection UI and use environment IDs to configure your application. Follow the steps in Set up a mobile property if you need to create a new Experience Platform App.
After the configuration is retrieved when the app is initially launched, the configuration is stored in local cache. The SDK tries to refresh the configuration every cold launch or when a new session is detected. If there is no change or a network request error occurs while downloading the configuration file, the cached configuration will be used.
The unique environment ID from the Data Collection UI can be configured with the SDK using the following:
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
Cordova
Unity
Xamarin
Java
Syntax
public static void configureWithAppID(final String appId);
Example
MobileCore.configureWithAppId("1423ae38-8385-8963-8693-28375403491d");
Swift
Syntax
static func configureWith(appId: String)
Example
MobileCore.configureWith(appId: "1423ae38-8385-8963-8693-28375403491d")
Objective-C
Syntax
+ (void) configureWithAppId: (NSString* appId);
Example
[AEPMobileCore configureWithAppId: @"1423ae38-8385-8963-8693-28375403491d"];
Alternatively, you can also place the environment ID in your iOS project's Info.plist with the ADBMobileAppID key. When the SDK is initialized, the environment ID is automatically read from the Info.plist file and the associated configuration.
Swift
Syntax
static func configure(withAppId: String)
Example
ACPCore.configure(withAppId: "1423ae38-8385-8963-8693-28375403491d")
Objective-C
Syntax
+ (void) configureWithAppId: (NSString* __nullable) appid;
Example
[ACPCore configureWithAppId:@"1423ae38-8385-8963-8693-28375403491d"];
Alternatively, you can also place the environment ID in your iOS project's Info.plist with the ADBMobileAppID key. When the SDK is initialized, the environment ID is automatically read from the Info.plist file and the associated configuration.
Cordova
When using Cordova, the configureWithAppId method call must be done in native code which is shown under the Android and iOS tabs.
C#
Syntax
void ConfigureWithAppID([NullAllowed] string appid);
Example
ACPCore.ConfigureWithAppID("1423ae38-8385-8963-8693-28375403491d");
C#
Syntax
public static void ConfigureWithAppID(string appId);
Example
ACPCore.ConfigureWithAppID("1423ae38-8385-8963-8693-28375403491d");
Programmatic updates to configuration
You can also update the configuration programmatically by passing configuration keys and values to override the existing configuration.
Keys that are not found on the current configuration are added when this method is followed. Null values are allowed and replace existing configuration values.
Do not use this API to update the build.environment or any key with an environment prefix, because it can lead to unexpected behavior. For more information, read Environment-aware configuration properties.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Flutter
Cordova
Unity
Xamarin
Java
Syntax
public static void updateConfiguration(final Map<String, Object> configMap);
Example
HashMap<String, Object> data = new HashMap<String, Object>();
data.put("global.privacy", "optedout");
MobileCore.updateConfiguration(data);
Swift
Syntax
@objc(updateConfiguration:)
static func updateConfigurationWith(configDict: [String: Any])
Example
let updatedConfig = ["global.privacy":"optedout"]
MobileCore.updateConfigurationWith(configDict: updatedConfig)
Objective-C
Syntax
+ (void) updateConfiguration: (NSDictionary* __nullable) config;
Example
NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
[AEPMobileCore updateConfiguration:updatedConfig];
Swift
Syntax
static func updateConfiguration(_: [String: Any])
Example
let updatedConfig = ["global.privacy":"optedout"]
ACPCore.updateConfiguration(updatedConfig)
Objective-C
Syntax
+ (void) updateConfiguration: (NSDictionary* __nullable) config;
Example
NSDictionary *updatedConfig = @{@"global.privacy":@"optedout"};
[ACPCore updateConfiguration:updatedConfig];
JavaScript
Syntax
updateConfiguration(configMap?: { string: any })
Example
ACPCore.updateConfiguration({"global.privacy":"optedout"});
Dart
Syntax
static Future<void> updateConfiguration(Map<String, Object> configMap);
Example
FlutterACPCore.updateConfiguration({"global.privacy":"optedout"});
Cordova
ACPCore.updateConfiguration({"global.privacy":"optedout"}, function(handleCallback) {
  console.log("AdobeExperenceSDK: Update configuration successful: " + handleCallback);
}, function(handleError) {
  console.log("AdobeExperenceSDK: Failed to update configuration : " + handleError);
});
C#
Syntax
public static void UpdateConfiguration(Dictionary<string, object> config);
Example
var dict = new Dictionary<string, object>();
dict.Add("global.privacy", "optedout");
ACPCore.UpdateConfiguration(dict);
C#
Syntax
void UpdateConfiguration([NullAllowed] NSDictionary config);
iOS Example
 var config = new NSMutableDictionary<NSString, NSObject>
 {
   ["global.privacy"] = new NSString("optedout")
 };
ACPCore.UpdateConfiguration(config);
Android Example
var config = new Dictionary<string, Java.Lang.Object>();
config.Add("global.privacy", "optedout");
ACPCore.UpdateConfiguration(config);
Clearing programmatic updates to the configuration
This API is only available in Android and iOS (AEP 3.x).
You can clear any programmatic updates made to the configuration via the clearUpdatedConfiguration API. This will clear programmatic updates to configuration made via the updateConfiguration(configMap)(Android)/ updateConfigurationWith(configDict:)(iOS) API. It will also clear any updates to the MobilePrivacyStatus(Android)/ PrivacyStatus(iOS) made via setPrivacyStatus(privacyStatus)(Android)/ setPrivacyStatus(_ status:)(iOS).
For implementation details, please refer to Configuration API reference.
Using a bundled file configuration
You can include a bundled JSON configuration file in your app package to replace or complement the configuration that was downloaded by using the Configure with App ID per environment approach.
To download the JSON configuration file, use the following URL:
https://assets.adobedtm.com/PASTE-ENVIRONMENT-ID.json
In iOS, the ADBMobileConfig.json file can be placed anywhere that it is accessible in your bundle.
In Android, the ADBMobileConfig.json file must be placed in the assets folder.
You can also load a different ADBMobileConfig.json file by using the ConfigureWithFileInPath method. The Adobe Experience Platform SDKs will attempt to load the file from the given path and parse its JSON contents. Previous programmatic configuration changes that were set by using the UpdateConfiguration method are applied on the bundled file's configuration before setting the new configuration to the Adobe Experience Platform SDKs. If a file-read error or JSON parsing error occurs, no configuration changes are made.
To pass in a bundled path and file name:
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
Xamarin
Java
// Case 1: to use ADBMobileConfig.json in the assets folder
// No code is needed
​
// Case 2: to use a config json from a absolute path:
MobileCore.configureWithFileInPath("absolute/path/to/exampleJSONfile.json");
​
// Case 3: to use a config json in Assets folder
MobileCore.configureWithFileInAssets("exampleJSONfile.json");
Swift
Syntax
static func configureWith(filePath: String)
Example
let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
if let filePath = filePath {
    MobileCore.configureWith(filePath: filePath)
}
Objective-C
Syntax
+ (void) configureWithFilePath: (NSString* __nullable) filepath;
Example
NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"];
[AEPMobileCore configureWithFilePath: filePath];
Swift
Syntax
static func configureWithFile(inPath: String)
Example
let filePath = Bundle.main.path(forResource: "ExampleJSONFile", ofType: "json")
ACPCore.configureWithFile(inPath: filePath)
Objective-C
Syntax
+ (void) configureWithFileInPath: (NSString* __nullable) filepath;
Example
NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile"ofType:@"json"];
[ACPCore configureWithFileInPath:filePath];
C#
Syntax
void ConfigureWithFileInPath([NullAllowed] string filepath);
Example
ACPCore.ConfigureWithFileInPath("absolute/path/to/exampleJSONfile.json");
Environment-aware configuration properties
This feature is only available in iOS ACPCore version 2.0.3 or later, and iOS AEPCore version 3.0.0 and above.
Some extension developers might use different configuration values based on their environment, and the generated configuration might have several entries for the same property. For example, the Adobe Campaign Standard extension has different endpoints for development, staging, and production servers. Here is an example of a raw configuration that supports multiple build environments:
JavaScript
{
  "myExtension.server": "mydomain.com",
  "__dev__myExtension.server": "mydomain.dev.com",
  "__stage__myExtension.server": "mydomain.stage.com"
}
Each time a remote configuration is generated in the Data Collection UI, a build.environment value is set. This value is based on the environment that you are publishing. When the remote configuration is downloaded, the Configuration extension considers the value in build.environment and provides only the non-prefixed version for the current environment in the shared state.
Here is a modification of the previous example, which now includes build.environment:
{
  "build.environment": "dev",
  "myExtension.server": "mydomain.com",
  "__dev__myExtension.server": "mydomain.dev.com",
  "__stage__myExtension.server": "mydomain.stage.com"
}
Here is the resulting shared state from the Configuration extension:
{
  "build.environment": "dev",
  "myExtension.server": "mydomain.dev.com"  
}
Sample configuration
Here's a sample JSON file for the SDK:
{
    "experienceCloud.org": "[email protected]",  
    "target.clientCode": "yourclientcode",  
    "target.timeout": 5,  
    "audience.server": "omniture.demdex.net",  
    "audience.timeout": 5,  
    "analytics.rsids": "mobilersidsample",  
    "analytics.server": "obumobile1.sc.omtrdc.net",  
    "analytics.aamForwardingEnabled": false,  
    "analytics.offlineEnabled": true,  
    "analytics.batchLimit": 0,  
    "analytics.backdatePreviousSessionInfo": false,
    "global.privacy": "optedin",  
    "lifecycle.sessionTimeout": 300,  
    "rules.url": "https://link.to.rules/test.zip"
}

Mobile Core event reference

Configuration API reference

Last modified 5d ago

Export as PDF

Copy link

Edit on GitHub

On this page

Configure with App ID per environment

Programmatic updates to configuration

Clearing programmatic updates to the configuration

Using a bundled file configuration

Environment-aware configuration properties

Sample configuration