Manage release tasks

Limitations

After you turn on Enable Directory Permissions in Management Center > System Settings > R&D Platform Settings, you can only operate on tasks in directories that you have permission to view.

Release tasks

When you release a task, it is deployed from the list of objects to be released. If the task was modified in the development environment, the release updates the existing version in the production environment.

• Before any release, the system performs a pre-check to verify that you have enough data processing units. If the quota is exceeded, the release is blocked.

• If the pre-check passes, the system validates each object individually. After validation, it performs a final quota check for each object. If an object would exceed the quota, its release fails.

Procedure

1. In the top navigation bar of the Dataphin homepage, choose Develop > Task Release.

2. In the left-side navigation pane, choose Release Object Management > To Be Released.

3. (Optional) On the To Be Released page, click Filter to find objects by project, latest committer, object type, latest commit time, or change type. You can also select Submitted by Me and Submitted Today to quickly filter the list.

4. On the To Be Released page, you can perform a single release or a batch release.

   • Single release: In the Operation column for the target object, click the icon to open the release configuration dialog box.

   • Batch release

     1. Select multiple objects, or click Select All on This Page at the bottom of the page.

     2. Click Batch Release at the bottom of the page to open the release configuration dialog box.

5. In the release configuration dialog box, enter a Release Name and Release Remarks, and then select the Dependencies and Release Scope.

   • Dependencies: This list shows all upstream dependencies of your selected objects that are also pending release. If a dependency does not appear in this list, it means you do not have permission to release it; in this case, the system automatically generates an approval request.

   • Release scope: You can select Required and optional dependencies, Required dependencies only, or Selected only (do not release upstream dependencies). By default, Selected only (do not release upstream dependencies) is selected. After you select Selected only (do not release upstream dependencies), the system automatically clears the dependency list. During the release, only the items that you currently select are released, and the upstream dependencies of the task are not released.

     Note

     Assume that object A depends on object B (for example, task A depends on task B, or atomic metric A depends on its source logical table B). When you release them:

     • Required dependency: If the change type of B is New, and the change type of A is New or Changed (meaning A adds a new upstream dependency on B), you must release B before you release A. Otherwise, the release of A fails. In this case, B is a required dependency of A. When the change type for both A and B is Delete, A is a required dependency of B.

     • Optional dependency: If the change type of B is Changed, and the change type of A is New or Changed, it is possible to release A successfully without first releasing B. In this case, B is an optional dependency of A. Note that if you release only A, A runs based on the old logic of B, which might cause unexpected results.

     • If you do not have permission to release B, B does not appear in the list of objects to be released. Downstream releases that depend on B might fail.

6. Click OK to complete the release.

   The system releases the objects according to their dependency order.

   For example, assume you are releasing object A, and its dependency chain is A <- L1 <- L2 <- L3, where A depends on L1, L1 depends on L2, and L2 depends on L3. Each is a required dependency. If you have release permissions for L1 and L3 but not for L2, the release list will contain records for L3, L1, and A. The releases for L1 and A will both fail. The release record for L2 will not be included.

After a task is released, you can view its check details in the release details. For more information, see View release details.

Re-release

If a task release fails, you can correct the issue based on the failure message and re-release it from the release history list.

• If an object requires release approval that has already been granted, you do not need to request it again for a re-release. The system automatically applies the existing approval.

• A quota check is performed for every re-release.

Procedure

1. In the top navigation bar of the Dataphin homepage, choose Develop > Task Release.

2. In the left-side navigation pane, choose Release Object Management > Release History.

3. On the Release History page, select Release Failed in the upper-right corner to quickly filter for all failed objects.

4. (Optional) In the upper-right corner of the page, click the filter icon to find objects by project, releaser, object type, release time, change type, or release status.

5. From the release history list, re-release one or more objects.

   • Re-release a single object: In the Operation column for the target object, click the icon to re-release it.

   • Re-release failed and canceled objects: Click the icon next to the release name to release all failed and canceled objects in that release package.

6. In the dialog box that appears, click OK to complete the re-release.

Release approval

For better control over your workflow, you can enable project-level release approvals. When this feature is on, releasing an object triggers an approval process, and the release proceeds to validation only after it is approved. The following sections describe how to enable this feature and monitor the process.

1. In the top navigation bar of the Dataphin homepage, choose Plan > Projects.

2. On the project management page, click Information Settings on the target project card to open the Information Settings dialog box.

3. In the Information Settings dialog box, go to the Release Settings section and click the switch to enable or disable release approval. After you enable it, you must configure the following parameters:

   • Approver: You can select Project administrators or Custom. If you select Project administrators, all administrators of the current production project are selected. If you select Custom, you must select up to 10 default approvers.

   • Approval policy: The default policy is parallel approval, which means approval from any single approver is sufficient, while a rejection from any single approver denies the request.

4. On the Release History page, click the icon next to the release name to view the release approval process.

   In the release approval process dialog box, you can view the approval status, approvers, and other information for each request. You can click the icon to go to the Task Center and view the details of the corresponding approval request.

5. Approvers can click the icon in the upper-right corner of the page to navigate to the Task Center and approve release tasks. For more information, see View and process tasks.

Edit tasks

1. On the To Be Released page, click the icon in the Operation column for the target object, and then select Edit to go to the corresponding project on the development page.

2. Go to the module for the task and edit the task.

Remove objects

Removing an object takes it out of the list of objects to be released. This action does not affect the task's existing versions in the production or development environments. If you need to change the task, you must commit and release it again.

Procedure

1. (Optional) On the To Be Released page, click Filter to find objects by project, latest committer, object type, latest commit time, or change type. You can also select Submitted by Me and Submitted Today to quickly filter the list.

2. On the To Be Released page, remove one or more objects.

   • Remove a single object: In the Operation column for the target object, click the icon and select Remove.

   • Batch remove objects: Select multiple objects, or click Select All on This Page at the bottom of the page, and then click Batch Remove.

3. In the dialog box that appears, click OK to complete the removal.

View release history

The Release History page lists all released tasks and their version history. From this page, you can perform the following operations:

• View release details: For more information, see View release details.

• Re-release: Re-release an object that failed to release. For more information, see Re-release.

• View version details: Click the number in the Version column for the target object to view detailed information about the current version.

• Go to O&M: This option is available for objects with a Succeeded status and a change type other than Delete. Click the icon in the Operation column for the target object to navigate to the corresponding module on the O&M page.

On the To Be Released page, you can click the icon in the Operation column of a target object to view the release history for its previous versions.

View release details

1. On the Release History page, click the icon in the Operation column for the target object to open the Release Details dialog box.

2. In the Release Details dialog box, you can view the object's Basic Information, process checks, and exception notifications.

   Release check item	Description
   Release approval	This step applies if release approval is enabled. When you re-release an object that was previously approved but failed, this step is automatically approved.
   Control rule check	This step applies if the object matches a release control policy. If a control rule is matched, the Control Policy, Control Rule, Exception Description (if any), and Check Result are displayed. Click the icon in the Operation column to view the rule check details.
   Execution condition check	Validation conditions vary by object type. If a check fails, follow the on-screen tips to correct the issue and re-release. A new approval is not required if the original release was already approved.
   Quota check	This check applies if the object consumes data processing units and applies only to periodic tasks, not manual tasks. Integration and synchronization include offline pipeline tasks, synchronization tasks. Data processing includes offline computing tasks and real-time computing tasks. Standard modeling includes dimension logical tables, fact logical tables, derived metrics, and compound metrics. Note After an object passes all checks, if it consumes data processing units, it must undergo a quota check. Only a periodic task requires this check. For more information, see View resource usage and Statistical methods. Files (from ad hoc queries), table management objects (meta tables, mirrored tables, and offline physical tables), offline computing templates, real-time computing templates, and registered and mounted metrics do not require a quota check.

3. If the object status is Succeeded, click Close. If the status is Failed, click Re-release to try the release again.