Managing Instances

Overview

After an instance is created, you can view and edit the instance configuration information on the console, including basic information, configuration parameters, and data dictionaries, as well as import and export assets.

Viewing Details of an Instance

Modifying Configuration Parameters

On the Instance Information page of the ROMA Connect console, click the Configuration Parameters tab and view the configuration parameters of the instance. You can also change the values of Current Value.

Creating a Data Dictionary

A data dictionary is used to open up key values in a system database to users. DEVICE_TYPE3 is the default data dictionary. You can also customize a data dictionary. To create a data dictionary, perform the following steps:

1. On the Instance Information page of the console, click the Data Dictionaries tab.
2. Click Create Data Dictionary.
3. In the Create Data Dictionary dialog box, set dictionary parameters and click OK.

   Table 3 Parameters for creating a data dictionary

   Parameter	Description
   Dictionary Code	Enter the unique ID of a dictionary.
   Dictionary Name	Enter a dictionary name.
   Extended Field 1	These parameters are reserved for the dictionary and can be left empty.
   Extended Field 2
   Description	Enter a brief description of the dictionary.

4. After the data dictionary is created, click next to the dictionary name to expand the dictionary item list.
5. Click Create Dictionary Item.
6. In the Create Dictionary Item dialog box, set dictionary item parameters and click OK.

   Table 4 Parameters for creating a dictionary item

   Parameter	Description
   Item Code	Enter the unique ID of a dictionary item.
   Item Name	Enter the dictionary item name.
   Extended Field 1	These parameters are reserved for the dictionary item and can be left empty.
   Extended Field 2
   Description	Enter a brief description of the dictionary item.

Importing and Exporting Assets

ROMA Connect allows you to export application and task assets of an instance as files to a local PC or import local asset files to ROMA Connect to migrate assets in batches.

NOTE:

• Ensure that the instance configurations during import and export are the same. Otherwise, the import may fail. For example, if app_route is not enabled on the exported instance but is enabled on the instance to be imported, the asset import may fail when the imported asset package contains APIs with conflict paths.
• Request throttling policies, access control policies, and signature keys of APIs cannot be imported or exported.

• Importing assets
  1. On the Instances page of the console, click Import Asset in the upper right corner.
  2. In the Import Asset dialog box, select Append or Overwrite based on the site requirements.
     • The data source IDs of different instances must be different. If the data source IDs are the same, select Overwrite.
     • The data integration task names in different instances must be different. If the data integration task names are the same, enter a prefix in the text box.
  3. In the dialog box displayed, select a local asset file and import it.
  4. After the import is complete, click Close. You can view the imported asset in the instance.
  NOTE:

  • The custom authorizer name is globally unique. If a custom authorizer with the same name already exists in the instance when the asset is imported, random characters will be added to the end of the imported custom authorizer name to avoid duplicate names.
  • If the following error information is displayed during asset import, contact technical support to upgrade the instance:

    "CipherEntry":{"reason":"{\"resourceType\":\"cipherEntries\",\"resourceId\":\"\",\"resourceName\":null,\"errorCode\":\"APIG.9999\",\"errorMsg\":\"System error\"}"}

• Exporting assets
  1. On the Instances page of the console, click Export Asset in the upper right corner.
  2. Export assets.
     • Exporting specified assets: Select the application or task assets to be exported and click Export Selected to export the asset files to the local PC.
     • Exporting all assets: Click Export All to export all asset files to the local PC.

     If you need to export all API asset information when exporting application assets, select Export all assets in applications. All API asset information including self-created and authorized APIs will be exported. If you do not select this parameter, information about self-owned and self-authorized APIs will be exported.

  3. After the export is complete, click Close. You can view the exported assets in the local PC.