※この記事は全文機械翻訳されています。
ステータス ワークフローを実装しています。
これは、Catenda がドキュメントとモデル リビジョンを管理する方法を大幅に更新するものです。
この変更により、ワーキング リビジョンと公式リビジョンの区別が導入され、統合に調整が必要になる可能性があります。
この記事では次のトピックについて説明します：
エグゼクティブ サマリー - 変更内容 - 影響を受ける者と方法 - 技術実装ガイド - ドキュメント … (デフォルト) - 移行に関する考慮事項 - 実装のための重要な決定 - 既知の制限と回避策 - サポート リソース - FAQ
1. エグゼクティブ サマリー
Catenda は以下を区別します：
「共有」 リビジョン (ワーキング/ドラフト バージョン)
「公開」 リビジョン (公式/承認済みバージョン)
即座の対応が必要な場合:
アプリケーションが Catenda Hub と統合されている
リビジョン情報をユーザーに表示している
API を通じて新しいリビジョンを作成している
CAD ツール プラグインを使用している
2. 変更内容
このセクションでは次のトピックについて説明します：
2.1 リビジョン タイプ
以前は、すべてのリビジョンが暗黙的に「公式」と見なされていました。現在：
「共有」: アクセス制限のある協働ワーキング リビジョン
「公開」: より広く配布するための公式リビジョン
2.2 API 応答の変更
ドキュメント API は、ライブラリ項目の新しいフィールドを含めます：
{ "document": { "revision": { "extendedVersion": { "major": 1, "minor": null // または 1,2,3（共有の場合） }, "version": 5 // レガシー番号付けを保持 } }}
モデル API の変更は最小限です：
スコープ パラメーター (scope=published または scope=all) を使用してフィルタリング機能を追加します
リビジョン ステータスまたは拡張番号付けを公開しません
基礎となるドキュメントから継承されたアクセス許可を適用します
2.3 デフォルト動作
重要: API は、ユーザーがアクセス権を持つ場所では、デフォルトで「共有」リビジョンと「公開」リビジョンの両方を返します。
これは下位互換性を保ちながらも、返されるデータの性質を根本的に変更します。
3. 影響を受ける者と方法
このセクションでは次のトピックについて説明します：
3.1 影響を受けない
✅ Catenda Hub への依存性がないスタンドアロン API アプリケーション
✅ リビジョンを表示または管理しないアプリケーション
3.2 大きく影響 - CAD ツール プラグイン
⚠️ 重大な問題:
「共有」リビジョンか「公開」リビジョンかを作成しているかを判断できない
正確なリビジョン ステータスをユーザーに表示できない
Hub とは異なる番号付けを表示する可能性がある (順序付けとX.Y 形式)
ユーザーはステータスが表示されていないと、リビジョン コンテキストを理解できません
プラグイン開発者向けの必須アクション:
リビジョン情報を表示しているかどうかを評価します
リビジョン タイプに関するユーザー ガイダンスを追加することを検討します
番号付けの不一致についてのユーザーの混乱の可能性に計画を立てます
3.3 その他影響を受ける
⚠️ 以下を実行するアプリケーション：
ユーザーにリビジョン リストを表示
API 経由で新しいリビジョンを作成
すべてのリビジョンが「公式」であることに依存
Catenda Site 統合を使用
4. 技術実装ガイド
4.1 リビジョンのフィルタリング
新しいスコープ パラメーターを使用して、返されるリビジョンを制御します：
# ドキュメント APIGET /documents?scope=published # 公開のみGET /documents?scope=shared # 共有のみ (アクセス許可が必要)GET /documents # すべて (デフォルト)# モデル API GET /models/revisions?scope=published # 公開のみGET /models/revisions # すべて (デフォルト)
4.2 アクセス許可の変更
新しい ACL 権限が操作に影響します：
「共有」リビジョンの表示: 特定のアクセス許可が必要
「公開」リビジョンの作成: Catenda Hub UI を通じてのみ可能
API リビジョンの作成: デフォルトで「共有」リビジョンを作成
4.3 API 経由で実行できない操作
❌ 「公開」リビジョンを作成 (Hub のみ)
❌ モデル API でリビジョン ステータスにアクセス
❌ モデル API で拡張番号付け (X.Y) を参照
❌ モデル間ドキュメント関係を判断
5. 移行に関する考慮事項
既存プロジェクト:
すべての現在のリビジョンは、移行時に「公開」になります
バージョン番号は主要なリビジョン番号になります (例: v3 → 3)
履歴データに対するアクションは不要です
新しい動作:
API 経由で作成された新しいリビジョン = デフォルトで「共有」
発行には Hub での手動操作が必要です
6. 実装のための重要な決定
質問 1：公式なリビジョンのみが必要ですか？
はい →
scope=publishedフィルタリングを実装しますいいえ → 混合リビジョン タイプを処理するための準備
質問 2：リビジョン情報を表示していますか？
はい → 番号付けの不一致に備える (特にモデル API ユーザーの場合)
いいえ → 最小限の影響が予想されます
質問 3：ユーザーはアプリ経由でリビジョンを作成していますか？
はい → ユーザーに「共有」リビジョンを作成していることを通知します
いいえ → アクションは不要です
7. 既知の制限と回避策
モデル API ユーザーの場合:
制限: リビジョン ステータスまたは拡張番号付けにアクセスできません
回避策: フィルタリングを使用して、希望するリビジョン タイプのみを取得します
ユーザー影響: リビジョン番号付けの違いについての混乱の可能性
コレクション API ユーザーの場合:
現在、「公開」リビジョンのみをコレクションに追加できます
これは顧客のフィードバックに基づいて変更される可能性があります
8. サポート リソース
利用可能なドキュメント更新:
[更新された API リファレンス] - 新しい
scopeパラメーターを含む
9. FAQ
Q: 統合が破損しますか?
A: API レベルで変更を中断はありませんが、ユーザー エクスペリエンスは大幅に変更される可能性があります。
特に CAD プラグインの場合です。
Q: モデル API でリビジョン ステータスが表示されないのはなぜですか?
A: 下位互換性を維持するために、モデル API はステータス ワークフロー機能を最小限に公開します。
フィルタリングを使用して、返されるリビジョンを制御します。
Q: ユーザーはどのタイプのリビジョンを作成しているかをどのように知ることができますか?
A: API 経由の場合、すべての新しいリビジョンは「共有」です。
ユーザーは、「公開」リビジョンを作成するには Catenda Hub を使用する必要があります。
Q: 適応に時間が必要な場合はどうなりますか?
A: すぐにお問い合わせください。
ステータス ワークフローは段階的に有効になり、組織のタイムライン オプションについて説明できます。