DataV:manage-widget-packages

Create a widget group

1. Log on to the DataV console.

2. On the console page, click Component Package under Component Development.

3. On the Component Package Development page, click Create Component Package.

   

4. In the Create Widget Package dialog box, enter the following information and click OK.

   

   Parameter	description
   Name	The ID of the widget group. The name must be within 20 characters in length and can contain only letters, digits, decimal points, and hyphens. It cannot contain spaces and cannot start with a digit. The format must be xxx.xxx or xxx-xxx, we recommend that you use company name. Component package name or company Name-Component Package Name the name of the format. You cannot modify the format after it is created. Example: alibaba-interaction.
   Display Name	The display name of the custom widget package. The display name must be 20 characters or less and can be modified after creation.
   Group Cover	Click the Project Cover icon to replace the image. You can also drag the image to the Project Cover icon to replace the image. The size of the image must be within 200KB.
   Package Description	The description of the widget group. The description cannot be more than 100 characters in length and can be modified after you create the widget group.

5. Wait for the created widget group to be reviewed. The review is complete within one or two days.

   Note

   If you want your widget group to be quickly reviewed, join the DingTalk group provided in the announcement on the top of the DataV console and contact DataV technical support engineers.

   • If the review is successful, you can choose Component Development> Component Packages> Component Package Development to view the approved component packages and upload your components.

     Important

     After the component package is created, you can obtain a developer identifier. Keep the developer identifier for your credentials. For more information, see Quick start of component development.

   • If the review fails, check whether the widget group information contains the following errors:

     • The group ID contains characters that are not allowed or reserved keywords.

     • The display name has the keyword for product locking.

     • The group cover image is invalid.

     After you check for the errors, click the Refresh icon. In the Edit dialog box, modify the invalid information and click Edit to submit the widget group for review again. You can also click the Delete icon to delete the failed widget group and create a new group for review.

     Note

     If you fix the preceding errors but the review fails again, contact DataV technical engineers.

Upload a widget

After the widget package is created, you can upload the developed widget to the widget package for management.

1. On the Widget Package Development page, move the pointer over the approved widget package and click View Widget Package.

   

2. On the Widgets page, click Upload.

3. In the Upload Component dialog box, click or drag the package file to the dotted box to upload the package file.

   Important

   The widget package cannot exceed 20 MB in size and must be a .tar.gz file.

4. After the widget package is uploaded, click Save to save the widget to the DataV widget group.

   Important

   Users of the Enterprise edition can upload up to three custom widgets to a widget package. Users of the Professional or Premium edition can upload up to three custom widgets to a widget package.

Authorize a widget group to another user

You can authorize your widget group to another user. This allows you to share the widgets in the group.

1. Log on to the DataV console.

2. On the console page, click Component Package under Component Development.

3. On the Widget Package Development page, select the widgets that you want to authorize.

4. Click the icon in the upper-right corner of the widget package.

5. In the Authorize dialog box, specify the required information.

   

   Parameter	description
   Transfer ID	Enter the transfer ID of the user whom you want to authorize. You can move the pointer over the username in the upper-right corner of the DataV console to obtain the transfer ID. Important Transfer IDs are case-sensitive.
   Authorization Levels	Specify an authorization level. Valid values: Subscriber and Developer. Subscriber: The authorized user can only view widgets that are brought online on the Widgets page. Developer: The authorized user can develop and upload widgets, and view widgets that are under review and that are brought online on the Widgets page.
   Expiration date	Click the time picker to select the expiration time of the authorization.
   Authorized Records	You can search for authorized records by the identification code.

6. After the component package is authorized, click the icon in the upper-right corner to authorize the component package and view the Authorized Records.

Search for an authorized user and revoke the authorization

In the Authorized Records section, you can use the following methods to find the authorized users or remove the authorization.

• In the upper-right corner of the Authorized Records section, enter the User ID in the search box to search for an authorized user.

• Find the authorized user and click Cancel Authorization in the Actions column.

  Important

  The authorization cannot be restored after it is revoked. Proceed with caution.

Search for component packages

1. Log on to the DataV console.

2. In the Component Development section, click Component Package.

3. In the upper-right corner of the component package card page, you can perform the following operations.

   • Click Modified At to sort the widget by Name, Modified At, or Created At.

   • Click the search box and enter the package name to quickly locate the required package.

Rename a component package

Click the icon in the lower-right corner to modify the display name of the widget package.

edit a widget package

Click the icon in the lower-right corner of the widget package and select Edit Widget Package to modify the Display Name, Project Cover, and Description of the widget package. You cannot change the name of a widget package.

Delete a widget package

Click the icon in the lower-right corner and select Delete.