Skip to main content

Configure a Fxiaoke data source

Last updated 11/03/2026

The Fxiaoke data source reads data from CRM objects through Offline Sync and writes it to the platform's built-in data warehouse. This article covers application authorization in Fxiaoke, data source configuration, sync plan creation, and mounting on a Flow.

Limitations and prerequisites​

Before you start, confirm the following limitations and prerequisites:

  • Fxiaoke is supported only as a data source, not as a Data Target, and nothing is written back to Fxiaoke.
  • An enterprise administrator with application management permissions must create and maintain the custom application. A CRM administrator must configure the object, field, and record permissions for the employee whose identity is used to access the data.
  • Prepare an active employee account that can be maintained over the long term as the access identity, and identify the account owner and the person responsible for maintaining its permissions.
  • Confirm which objects, fields, and records you need to sync, and whether the platform's runtime environment can access the Fxiaoke open platform for the cloud that hosts your enterprise.
Environment configurationUse casesRequirements
not distinguish environmentThe development and production environments share one connection configurationPrepare one set of application credentials and an Employee ID, and confirm that its access permissions meet your requirements
Independent settingMaintain separate connection configurations for the development and production environmentsPrepare valid credentials and an Employee ID for each environment, check object and field permissions in both environments, and test connectivity separately

Complete application authorization in Fxiaoke​

Create and enable an enterprise custom application​

  1. Sign in to the Fxiaoke web application with an enterprise administrator account and open the administration console.
  2. Open Application List, select Create Enterprise Custom Application, enter the application name, description, and other information, then save.
  3. Open the application configuration page, enable developer mode, and configure the domain of the page that initiates login authorization and the IP allowlist as required by the page.
  4. Confirm that the application is enabled in the current enterprise, and obtain its App ID, App Secret, and Permanent Code (permanent authorization code).

The IP allowlist must contain the public egress IP addresses of the servers that actually send API requests. Ask the platform deployment and maintenance team for these addresses, and register all of them if there are multiple egress addresses. Do not provide the IP address of the computer running your browser as the server's egress IP.

For specific entry points and configuration instructions, see the official Fxiaoke Quick Start.

Grant application query permissions and employee data permissions​

In the custom application, open CRM API Query Permission Settings and grant the following query permissions for the objects you need to read.

Permission purposeAPI path
Query the object list/cgi/crm/v2/object/list
Query object descriptions and field information/cgi/crm/v2/object/describe
Query preset object data/cgi/crm/v2/data/query
Query custom object data/cgi/crm/custom/v2/data/query

Application API permissions and employee data permissions must be configured separately. The CRM administrator must also check the following permissions for the employee whose identity is used to access the data:

Permission levelWhat to check
Object permissionsCan view the business objects that need to be synced
Field permissionsCan read the fields that need to be synced
Record scopeCan view the records required by the business, including data within the relevant department, owner, or sharing scope

For example, to read a department's customer records, the employee's data scope must cover that department. An employee who can view only their own records must not be treated as having access to all records in the department during acceptance testing. See the official data permissions documentation.

Obtain the Employee ID and verify access​

Ask an administrator to look up the target employee's openUserId and use it as the Employee ID in the data source. The administrator can verify the employee through a process such as the official Get brief information about members in a department API and record the returned openUserId. Do not enter a phone number, login account, employee number, or enterprise ID.

Ask an administrator to confirm the API domain for the cloud that hosts your enterprise. The default is open.fxiaoke.com. For domains of other clouds, see the official enterprise cloud domain documentation and confirm that the current platform accepts the configuration. The official cloud domain list does not mean that the current platform supports every listed domain.

After access is configured, provide the API domain, App ID, App Secret, Permanent Code, Employee ID, authorized data scope, registered egress IP addresses, and maintenance owner to the person configuring the platform. Share the App Secret and Permanent Code through a secure channel approved by your enterprise. Do not put them in ordinary documents, logs, or tickets.

Verify credentials, APIs, objects, fields, and record scope using the same application, the same Employee ID, and the actual server egress. An enabled application or a successfully obtained access token does not mean that the employee has all the required data permissions.

Create a Fxiaoke data source​

  1. Go to DataOps Platform > Integration > Data Source and click + Data Source.
  2. Select Fxiaoke, click Next step, and enter the data source name and remarks.
  3. Select not distinguish environment or Independent setting. With independent settings, you need to configure the development and production environments separately.
  4. Enter API Domain, App ID, App Secret, Permanent Code, and Employee ID.
  5. Under Connectivity Test, click Test. When Connectable is shown, click Complete.

Enter the connection parameters and check the environment configuration method.

Enter the Fxiaoke production environment connection parameters
Configuration ItemDescription
Data source nameThe name of the data source in the current space; it must pass the name and uniqueness validation on the page
RemarksOptional; describe the purpose or maintenance information
API DomainThe API domain of the Fxiaoke open platform; the default is open.fxiaoke.com. Configure it according to the cloud that hosts your enterprise and the domains supported by the platform
App IDThe application ID of the enterprise custom application; required
App SecretThe application secret of that application; required
Permanent CodeThe permanent authorization code of that application; required
Employee IDThe openUserId of the employee used to read data; required. The employee must have the necessary data permissions

When you edit a saved data source, App Secret and Permanent Code are displayed as masked values. Leaving these values unchanged continues to use the original credentials. To replace them, enter new values and test connectivity again.

tip

After the connectivity test passes, you still need to confirm the target object, fields, and record scope in the offline sync plan. With independent environment configurations, check access permissions separately in the development and production environments.

Create an offline sync plan​

  1. Go to DataOps Platform > Integration > Offline Sync and click + Integration plan.
  2. In Data Source, select Fxiaoke and the data source you created.
  3. Select an Object type: Preset object or Custom object.
  4. In Source object, search by object name or API name and select the object to sync.
  5. Click Data Preview and check that the source object and readable data are as expected.

Select the object type and source object before previewing the data.

Select the Fxiaoke object type and source object
tip

Changing the object type clears the selected object and field mappings. Select the source object again and recheck the field mappings. Data Preview is unavailable until a source object is selected.

Field mapping and sync verification​

Supported field types​

Field categorySupported Fxiaoke field types
Text and single-value referencestext, long_text, html_rich_text, phone_number, email, url, auto_number, select_one, master_detail, object_reference
Region and locationcountry, province, city, district, location
Multi-value fieldsselect_many, department, department_many, employee, employee_many, object_reference_many, tag, array
Numericnumber, currency, percentile
Booleantrue_or_false
Dates and timesdate, date_time, time
Calculated and reference resultscount, formula, and quote, excluding image, attachment, or signature results

The following requirements also apply when reading these fields:

  • Values of text, single-value reference, region, and location fields must be strings. Multi-value fields must contain string arrays, which may include null values.
  • Numeric fields must declare a scale from 0 to 38. The actual total precision must not exceed 38 digits, and the effective scale must be within the range declared for the field.
  • Boolean fields must contain Boolean values. Date and date-time fields must provide integer millisecond timestamps, while time fields must provide integer values.
  • Calculated and reference fields read existing results. Results must be text, numbers, Boolean values, or valid array or object content. For other field types, first confirm the read results through data preview and manual execution.

Unsupported fields and limitations​

  • Images (image), attachments (file_attachment), signatures (signature), and reference results returning such content, such as quote(image), cannot be read. Results of other fields containing media such as attachments or images also cannot be synchronized as ordinary field content.
  • Fields are unavailable if they lack a type declaration, or if a numeric field lacks a valid scale declaration. Source fields that cannot be read are grayed out on the page. Check the reason in the tooltip.
  • Disabled fields are not read. A field group (group) is not read as an independent field; its child fields can be selected according to their own types.

Configuration and verification​

After configuring the data source, select or create a target table in the platform's built-in data warehouse under Data Target, and create field mappings.

tip

With independent environment configurations, manual execution uses the production environment data source configuration. Before running the plan, confirm that the production credentials, object and field permissions, and target table are as expected.

  1. Set the target table and write mode as your business requires.
  2. In Field Mapping, map the source fields you want to read to the target fields.
  3. Do not configure grayed-out fields as available fields. Adjust the fields to synchronize according to the prompts.
  4. Fill in the plan name, owner, and remarks, then save the plan.
  5. Click Run Now, confirm in the execution records that the task succeeded, then check the row count, fields, and data content in the target table.

Source field names identify their business meaning, while API names distinguish the corresponding fields. After configuration, check each mapping to avoid incorrectly linking fields with similar display names.

The following figure is an example of the Field Mapping interface. Check the field correspondences for your actual business needs.

Example mappings between Fxiaoke source fields and target fields
SymptomWhat to check
Connectivity test failsCheck API Domain, all four credential values, and their correspondence. Confirm that the application and employee account have not been disabled
IP not authorized or access deniedAsk the deployment and maintenance team to check the actual server egress IP addresses and confirm that all of them are registered in the application IP allowlist
The object list is empty or the target object cannot be foundCheck the object type, confirm that the application has object list and query permissions, and confirm that the employee has permission to access the object
Fields are missing or cannot be readCheck the application's object description permission and the employee's field read permissions, and confirm whether the object structure has changed
The preview or sync returns fewer records than expectedUsing the same Employee ID, check the employee's department, owner, and sharing scope, and confirm that the readable records meet business requirements
Source fields are grayed out or cannot be readCheck the field tooltip to confirm whether the field type and its actual content are within the supported scope
The development environment works, but production tasks failCheck production credentials, egress IP addresses, application permissions, the employee data scope, and access to the selected object and fields

Mount on a Flow​

After manual verification succeeds, you can mount the offline sync plan on a Flow so that it runs automatically on a schedule.

  1. Open the saved offline sync plan and click Mount on task flow.
  2. Select the target Flow.
  3. Enter the node name, select the execution mode, and set the owner and remarks as needed. The node type and integration plan are filled in automatically.
  4. Click Create node and mount on it. After mounting succeeds, click Go to flow page to check the node's position and its upstream and downstream dependencies.
  5. Save and release the Flow. Production scheduling uses the data source configuration of the production environment.

Before publishing, confirm that the production application, Employee ID, egress IP addresses, and object, field, and record permissions are ready. To change the sync plan or data source, first assess the dependencies of existing Flows, and verify again after the change.

Was this page helpful?