How to Use Shiply Remote Config & Feature Flags

Under a single config key in Shiply, you can create and publish multiple tasks at the same time, delivering different config or flag values to different user groups. For config pull requests initiated by the SDK, the backend matches tasks from top to bottom in the task list and returns the first published task whose conditions are satisfied.

1. Prerequisites

1.1 Create a Project and Products

Create a project and corresponding Android/iOS/Harmony products on the Shiply platform. See Platform Integration Process.

1.2 Integrate the Remote Config SDK

Integrate the Shiply Remote Config SDK in your app. See:

• Android Remote Config SDK Integration
• iOS Remote Config SDK Integration
• Harmony Remote Config SDK Integration

2. Create a Config

Click New Config in the top-right corner of the config list to open the new config page: Enter the information for the new config:

• Config name (required): Used to distinguish configs; the SDK can pull data for a config by name.
• Owner (required): The owner of the new config; only the owner can edit it.
• Reviewer (required): Release tasks must be approved by the reviewer, who can approve or reject release requests.
• Associated scene (optional): The scene bound to the config; the SDK can pull all configs bound to a scene by scene ID.
• Tags (optional): Used mainly for display and filtering in the console.
• Description (optional).
• Config value template (optional): When enabled, you can set a custom template to standardize config value fields and format, avoiding invalid config caused by typos.

After clicking Confirm, a new config is created as shown below:

3. Create a Task

Click New Task to open the new task page:

A task has three parts:

• Delivery conditions: Rules for task delivery. For example, if the condition is app version > 1.0, only apps with a version greater than 1.0 will receive this task's value.
• Delivery content: Includes config values and switch values. Config values can be any string; switch values are boolean. They are independent—the host app can read config values (RDelivery#getXXXByKey) and switch values (RDelivery#isOnByKey) separately via the SDK.
• Rollout strategy: Gray-release rules for task delivery.

You can set task conditions in two ways:

• Condition template: A predefined set of condition rules from Condition Management. Selecting a template copies its rules, which you can edit without affecting the template.

• Custom conditions: Freely combine condition rules.

After filling in conditions and values, click Confirm to create a task under the current config:

To create additional tasks, click the plus icon in the diagram.

4. Publish a Task

Tasks do not take effect immediately after creation. Click a task in the task list to open its details, then click Start Experience on the right. The task enters the experience phase, and users on the experience list can pull it:

After testing passes, click Submit for Review. The task enters the review phase:

After the reviewer approves, the task automatically enters full or gray rollout (at which point external users can actually pull the task content):

If a config issue is found, you can pause or stop the task:

• Pause task: Users who already pulled this task continue to use it; users who have not pulled it will no longer receive it.
• Stop task: Users who already pulled this task will no longer use it (they will match other tasks); users who have not pulled it will no longer receive it.

5. Update a Config Task

Click Edit to open the task edit page:

After fixing delivery conditions, content, or strategy, click Confirm. Shiply creates a new version of the task:

The new task version also goes through verification, review, and release before it takes effect for external users.

Note

When the new task version enters the release phase, the old version is automatically paused. After the new version reaches full rollout, the old version is automatically stopped.