Tập lệnh tùy chỉnh

Scripts are the lightest-weight entry point into Behavior Extensibility – Python code that runs on the platform server and can be triggered, scheduled, or called from within larger automation flows.

Trong khuôn khổ Behavior Extensibility, script là các tệp Python phía máy chủ chạy trong ngữ cảnh của nền tảng Altium 365. Không giống như các extension đã biên dịch hoặc tự động hóa workflow đầy đủ, script được cố ý giữ ở mức gọn nhẹ: một tệp duy nhất, một hợp đồng input/output được xác định rõ, và một mục đích tập trung. Chúng có thể được kích hoạt thủ công, được gọi từ hook, nhúng vào workflow như các bước, hoặc được lên lịch để chạy định kỳ.

Script dùng chung hạ tầng mở rộng với check, hook và workflow block – chúng có quyền truy cập dữ liệu Workspace, có thể gọi các hệ thống bên ngoài, và kết quả của chúng có thể được đưa vào các phần khác của pipeline tự động hóa. Điểm khác biệt nằm ở phạm vi: một script làm một việc, làm gọn gàng, và có thể lặp lại, cải tiến rất nhanh.

Script được dùng để làm gì trong ngữ cảnh này

• Targeted automation – một script chạy một lần khi được kích hoạt – chuẩn hóa giá trị tham số linh kiện trong toàn bộ thư viện, tạo báo cáo tùy chỉnh từ dữ liệu Workspace, đẩy một tập dữ liệu sang hệ thống bên ngoài sau khi phát hành. Đây là các tác vụ tập trung, không cần phải nối vào toàn bộ framework check hoặc workflow.

• Data transformation – script là công cụ phù hợp khi dữ liệu cần được định hình lại giữa các hệ thống – chuyển đổi cấu trúc dữ liệu Altium sang định dạng mà một API bên ngoài yêu cầu, hoặc biến đổi dữ liệu đầu vào trước khi ghi vào Workspace. Logic chuyển đổi rõ ràng trong một script sẽ dễ kiểm thử và bảo trì hơn so với việc chôn logic chuyển đổi bên trong một workflow lớn hơn.

• Policy enforcement, lightweight – dành cho các quy tắc thực thi không cần chạy tại các checkpoint tự động – các quy tắc mà trưởng nhóm chạy trước một đợt rà soát cột mốc, các kiểm tra được gọi theo yêu cầu thay vì trên mỗi lần commit – script sẽ phù hợp hơn một check đầy đủ được đăng ký với một sự kiện nền tảng. Phần overhead của hạ tầng check đầy đủ là không cần thiết khi việc kích hoạt mang tính chủ đích và thủ công.

• Building blocks for larger automation – script có thể được gọi từ hook và workflow block, khiến chúng trở thành các đơn vị tái sử dụng trong tự động hóa quy mô lớn hơn. Ví dụ, một script truy vấn danh sách nhà cung cấp được phê duyệt từ hệ thống bên ngoài có thể được gọi từ nhiều check và hook khác nhau mà không cần sao chép logic. Script chịu trách nhiệm cho tương tác với hệ thống bên ngoài; check hoặc hook chịu trách nhiệm cho quyết định chính sách.

Script so với các primitive khác của Behavior Extensibility

Script không phải là sự thay thế cho check, hook hoặc workflow block – chúng là một primitive bổ sung với vai trò khác:

Check được gắn với các sự kiện xác thực của nền tảng và chạy tự động tại các checkpoint đã xác định. Script chạy khi được gọi một cách tường minh.

Hook phản hồi với các sự kiện vòng đời của nền tảng và tự động kích hoạt. Script được gọi có chủ đích – bởi người dùng, theo lịch, hoặc từ bên trong một primitive tự động hóa khác.

Workflow block là các bước tái sử dụng được bên trong định nghĩa workflow. Script có thể triển khai logic mà một workflow block gọi đến, nhưng bản thân một script không phải là một bước workflow.

Hãy bắt đầu với script khi yêu cầu là một tác vụ tập trung, theo nhu cầu hoặc theo lịch. Chuyển logic đó vào check hoặc hook khi nó cần chạy tự động theo các sự kiện của nền tảng. Gói nó trong workflow block khi nó cần được kết hợp vào các quy trình nhiều bước có cấu trúc.

Bảo trì và lặp cải tiến

Script là các tệp Python – chúng được quản lý phiên bản như mọi loại mã khác. Vì chúng được thông dịch và không cần bước build, việc lặp cải tiến rất nhanh: sửa script, triển khai, kiểm thử. Điều này khiến script trở thành điểm khởi đầu phù hợp khi yêu cầu chính xác vẫn chưa được xác định đầy đủ, hoặc khi logic cần thay đổi nhanh để đáp ứng cách sử dụng thực tế.

Một script khởi đầu như một tiện ích cho một người thường sẽ phát triển thành hạ tầng dùng chung cho cả nhóm. Khi script đạt đến điểm đó – được nhiều người sử dụng, bao phủ một quy trình quan trọng, được kỳ vọng phải đáng tin cậy – thì đáng để đầu tư vào cấu trúc bài bản: xác thực đầu vào, xử lý lỗi, ghi log, và có thể chuyển sang một check hoặc hook chính thức hơn nếu cần kích hoạt tự động.