Dataphin:Manage Publishing Tasks

Publish Tasks

Publishing tasks involves moving them from the development to the production environment. Changes to tasks in the development environment will impact the production environment upon publishing.

• A dry run is performed before publishing to ensure the required data processing units do not exceed the available quota. If they do, the publication is halted.

• After a successful dry run, each object undergoes a verification process. If publishing an object would exceed its data processing unit quota, that object's publication will fail.

Procedure

1. Navigate to Development > Task Publishing from the top menu bar on the Dataphin home page.

2. In the left-side navigation pane, select Object Management > Objects To Publish.

3. (Optional) On the Objects To Publish page, you can click Filter to narrow down the objects for publication by project, recent submitter, object type, recent submission time, or change type. Alternatively, select My Submissions or Today's Submissions for a quick filtration of objects to be published.

4. On the Objects To Publish page, choose either Single Publish for individual objects or Batch Publish for multiple objects.

   • Single publish: Open the Publish Configuration dialog box by clicking the Actions column icon next to the desired object.

   • Batch Publish

     1. Select the objects you wish to publish or use the Select All On This Page option at the bottom of the page.

     2. Click Batch Publish at the bottom of the page to open the Publishing Configuration dialog box.

5. In the Publishing Configuration dialog box, enter the Publishing Name and Publishing Remarks, and select the appropriate options for Dependent Objects and Publishing Scope.

   • Dependent Objects: This list includes all upstream objects that the selected objects depend on. If you lack publishing permissions for any dependent objects, the system will automatically generate an approval form.

   • Publishing Scope: Options include Must Follow Dependencies And Optional Dependencies, Only Must Follow Dependencies, or Only Selected (do Not Publish Upstream Dependencies). The default setting is Must Follow Dependencies And Optional Dependencies. Selecting Only Selected (do Not Publish Upstream Dependencies) will clear the dependent objects list, publishing only the selected objects without their upstream dependencies.

     Note

     Consider object A depends on object B (e.g., task A depends on task B, atomic metric A depends on its source logical table B, etc.). During publishing:

     • Must Follow Dependencies: If B's change type is New, and A is New or Changed (A adds a new upstream dependency B), then B must be published first when publishing A, otherwise A will fail to publish. At this time,B is a must-follow dependency of A. When both A and B have a change type of Delete,A is a must-follow dependency of B.

     • Optional Dependencies: If B's change type is Changed, and A is New or Changed, then A may still be published successfully without first publishing B. At this time,B is an optional dependency of A. Note that if B is not published and only A is published, A will run based on B's old logic, which may not meet expectations. Possible Publish Success, at this time B is an optional dependency of A. It should be noted that if only A is published without publishing B in the above scenarios, A will operate based on the old logic of B, which may not align with expectations.

     • If the current user does not have publishing permission for B, B will not be included in the list of objects to be published. At this time, downstream publishing items affected by B may fail to publish.

6. Click OK to finalize the publishing process.

   During publication, the system will release objects in accordance with their dependency order.

   For instance, if you are publishing object A, which depends on a chain of objects A <- L1 <- L2 <- L3, and each layer is a must-follow dependency, the system will attempt to publish them in that order. If you lack publishing permissions for any object in the chain, such as L2, the publishing process will fail for A and any objects depending on L2.

After publishing, you can review the verification details in the publishing history. For more information, see view publishing details.

Republish

If a task fails to publish, modify it according to the failure message and republish it via the Publishing History list.

• For objects that require publishing approval, previously approved tasks can be republished without additional approval, as the system will automatically grant it.

• Each republishing attempt will be subject to a sales check verification.

Procedure

1. At the top menu bar on the Dataphin home page, navigate to Development > Task Publishing.

2. In the left-side navigation pane, go to Object Management > Publishing History.

3. On the Publishing History page, select Publishing Failed from the upper right corner to filter out all objects with publishing failures.

4. (Optional) Use the Filter option in the upper right corner to narrow down the objects by project, publisher, object type, publishing time, change type, and publishing status.

5. In the list of publishing records, choose to republish objects individually or in bulk.

   • Republish a single object: Click the Actions icon next to the desired object to republish it.

   • Republish failed and canceled objects: Click the target object after the publish name icon to publish all failed and canceled objects in the deployment package.

6. In the confirmation dialog box, click OK to finalize the republishing process.

Publishing Approval

Dataphin allows for the configuration of the publishing approval feature at the project level. When enabled, this feature initiates a pending approval process upon the publication of objects, followed by a verification stage to ensure a controlled release process. Below are the steps to activate the publishing approval feature and monitor the approval workflow.

1. Navigate to the top menu bar on the Dataphin home page and select Planning > Project.

2. In the project management area, click Information Settings within the desired project card to open the Information Settings dialog box.

3. Within the Information Settings dialog box, locate the Publishing settings section and use the toggle switch to enable or disable release approval. Upon enabling, configure the approvers and approval policy as follows:

   • Approver: Options include Administrator and Custom. Choosing 'Administrator' selects all administrators of the current project, while 'Custom' allows for up to 10 designated approvers.

   • Approval Policy: The default is Parallel Approval, meaning approval is granted if any approver agrees, and the process is stopped if any approver rejects.

4. To review the approval process, visit the Publishing History page and click the icon next to the publishing entry.

   The approval process dialog box provides details such as the approval status and the list of approvers. To view detailed information about each approval request, click the icon, which redirects to the Task Center.

5. To approve publishing tasks, approvers should click the icon located in the upper right corner of the page within the Task Center. For detailed instructions, refer to view and process tasks.

Modify Jobs

1. Navigate to the Pending Objects List page, click the Actions column next to the desired object, and then select Edit from the icon to proceed to the developer page for the relevant project.

2. Access the module associated with the task to modify jobs accordingly.

Remove Objects

To remove objects is to delete tasks from the list slated for publication. This action does not affect the existing versions of the task in both the production and development environments. To modify tasks in these environments, they must be resubmitted and published anew.

Procedure

1. (Optional) On the Objects To Publish page, click Filter to sort the objects for publication by project, recent submitter, object type, recent submission time, and change type. Quick filters such as My Submissions and Today's Submissions are also available.

2. On the Objects To Publish page, you can remove either a single object or multiple objects slated for publication.

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

   • Batch remove multiple objects: Check the boxes for multiple objects or click Select All On This Page at the bottom, then click Batch Remove at the bottom of the page.

3. Confirm the removal in the pop-up dialog box by clicking OK.

View Publishing History

On the Publishing History page, you can view the list of published tasks, which includes the publishing records for all versions of a task. The page allows you to perform the following actions on the publishing records:

• View Publishing Details: For detailed information, see view publishing details.

• Republish: Republish objects that failed to publish. For more information, see republish.

• View Version Details: To see details about the current version of a published object, click the number in the Version Number column for the desired object.

• Go to maintenance: Objects that are successfully published and whose publish type is not delete support going to maintenance. Click the Actions column icon of the target object to navigate to the corresponding module under the maintenance page.

On the Objects To Publish page, you can view the details of the publishing record for the historical version of an object by clicking the Actions icon in the column of the target object.

View Publishing Details

1. On the Publishing History page, click the icon in the Publishing Details dialog box within the actions column of the desired object.

2. In the Publishing Details dialog box, you can view the Basic Information, Process Verification, and Exception Alerts for the current object.

   Publishing Feature Items	Description
   Publishing Approval	This stage is present if the object requires publishing approval. Objects previously approved but failed to publish will bypass the approval stage upon republishing.
   Control Rule Check	If the object triggers a publishing control policy, this process is initiated. It displays the Control Policy, Control Rule, Exception Description (if any), and Check Result. To view detailed rule checks, click the icon in the actions column.
   Execution Condition Check	Verification conditions vary by object type. Details can be found in the publishing details, including the type, name, exception description (if any), and check result. If verification fails, follow the page prompts and quick operation button to make adjustments and republish. Previously passed publishing approvals do not require re-approval upon republishing.
   Sales Check	This process is necessary for objects that consume data processing units. Only auto triggered nodes are subject to a sales check; one-time tasks are exempt. Integration sync encompasses offline pipeline tasks, sync tasks, and real-time integration tasks. Data processing includes offline and real-time computing tasks. Standard modeling covers logical dimension tables, logical fact tables, derived metrics, and derived indicators. Note Upon successful publication of the overall task, a sales check is mandatory for objects that utilize data processing units. This requirement applies exclusively to auto triggered nodes. For statistical details, refer to view resource usage, statistical caliber. Files (pertaining to ad hoc query files), table management (including metatables, image tables, and offline physical tables), offline and real-time computing templates, and registered hanging indicators do not require a sales check.

3. For objects that are successfully published, click Close to exit the publishing details dialog box. For objects that failed to publish, click Republish to attempt republishing the current object.