Component Synchronization with Enterprise Systems

親ページ: Altium 365 Workspace

Workspace は、エンタープライズ システムにあるコンポーネント データの単方向、または双方向の同期を容易にします。Workspace は、XML ベースの configuration ファイルを使用して、同期の方向、含まれるコンポーネント、およびパラメータ データのマッピングを指定できます。Workspace と対象のエンタープライズ システム間のコンポーネント データ同期は、必要に応じて手動で実行する内蔵の同期プロセスが使用されます。

同期プロセスが、最初に対象のエンタープライズ システム内のコンポーネントのデータを追加すると、システムで生成されたアイテム番号が PlmPartNumber パラメータとして Workspace 内のコンポーネントに返されます。これは、Workspace とエンタープライズ システム インスタンス間でデータを同期する時の重要なパラメータとして機能します。更に、エンタープライズ システム側のアイテム パラメータ/属性がWorksapce サーバのプロパティ (欄ごとに構成可能) を更新するように configuration を調整できます。その Component Item の新しいレビジョンを正式にリリースする必要はありません。

外部のエンタープライズ システムへの接続とその configuration は、Workspace のブラウザ インターフェースを介して設定されます。Arena^®、または PTC Windchill^® PLM システムへの同期は、現在、対応しており、これらのシステムの基本の configuration ファイルを使用して開始できます。

エンタープライズ システムへの接続

エンタープライズ システムへの接続は、Workspace のブラウザインターフェースの Admin – Component Sync ページから実行されます。これには、適切な XML ベースの configuration ファイルのアップロードと、エンタープライズ システムと Altium 365 で管理される Workspace 間の接続の設定が含まれます。

会社のエンタープライズ システムへインターフェースを追加して構成します。有効な接続があれば、必要に応じて、そのシステムと Workspace インスタンス間でコンポーネントの同期を開始できます。

新しいインターフェース インスタンスを作成するには、 ボタンをクリックし、インスタンスに名称を付けてから、エンタープライズ システムとコンポーネント データの同期の要求に適用される configuration ファイルをアップロードします。ほとんどの場合、エンタープライズ システム インスタンスを 1 つだけ設定する必要がありますが、必要に応じて、任意の数のインスタンスを Workspace へ追加できます。各インスタンスには固有の名称を付け、configuration ファイルが必要です (以下をご覧ください)。

Configuration ファイル

追加された各エンタープライズ システム インスタンスには、関連付けられた configuration ファイルがあり、定義され、アップロードされている必要があります。これは、コンポーネント タイプごとに、同期の方向、関係するコンポーネント、コンポーネントを作成する場所、およびパラメータ マッピングを指定することにより、Workspace とエンタープライズ システム インスタンス間のコンポーネントの同期を定義する configuration ファイルです。

サンプルの Configuration ファイル

サンプルの PLM システム configuration ファイルは、Configuration file 欄の下にある Download sample configuration リンクをクリックして、新しいインスタンスを追加する時に取得できます。Zip ファイル (ConfigurationSamples.zip) が、ブラウザのデフォルトのダウンロード フォルダにダウンロードされます。このアーカイブには、基本的な dm-Arena-config-basic.xml と dm-Windchill-config-basic.xml の configuration ファイルが含まれています。

Workspace では、ダウンロード可能なサンプルの configuration ファイルを利用できます。

会社のエンタープライズ システム インスタンスと要件に合わせて、configuration ファイルを変更します。XML configuration には、Arena、または Windchill API への URL 参照と、2 つの代表的なコンポーネント エンティティ セクション (Capacitors と Diodes) が含まれ、それぞれに ToPLM と ToAltium 属性/パラメータ マッピング サブセクションも含まれます。

生成された Configuration ファイル

Workspace では、Component Sync サービスの configuration ファイルを作成する代替方法として、configuration ジェネレーター オプションも利用できます。Add new instance ダイアログの Generate configuration リンクから利用できるジェネレーターは、接続情報 (PLMタイプとURL) を要求し、Workspace コンポーネントデータ モデルと照合し、基本の configuration ファイルを作成します。

Workspace に登録されているコンポーネント タイプは、一致する ToPlm と ToAltium 同期セクションと、マップされた属性を持つエンティティ タイプとして configuration に追加されます。また、Workspace、および PLM configuration との互換性のために追加、または変更する領域をハイライト表示する TODO コメントも含まれています。作成されると、configuration ファイル (dm-configuration.xml) がブラウザへ自動でダウンロードされます。

コンポーネント属性の割付方針等、会社のエンタープライズ システムの configuration 要件に合わせてこのファイルを変更し、以下に概説するように、更新されたバージョンを Workspace へアップロードします。

Configuration のアップロード

ボタンをクリックして、現在、定義されているエンタープライズ システム インスタンスに適した configuration ファイルをアップロードします。標準の Windows Open ダイアログが表示されるので、そこで必要な XML 形式の configuration ファイルを指定して開きます。アップロードしたら、 ボタンを使用して、configuration に関連する警告とエラーを確認できます。まだサインインしていない場合、テスト プロセスでは、 ボタンを介して最初にエンタープライズ システムのサインイン クレデンシャルが要求されます。

接続検証レポートが実行されると、Workspace では現在の configuration 設定が解析され、Workspaceと対象のエンタープライズ システム データの両方との互換性を確認します。パスエラー、一致しないコンポーネント タイプの定義とパラメータ、無効なライフサイクル、またはレビジョン設定等の Configuration の問題が検出され、Configuration Validation Report ウィンドウにレポートされます。

会社のエンタープライズ システムへインターフェースを追加、構成し、アップロードされた Configuration ファイルのエラーを確認して修正。

configuration エラーが報告された場合 (全体的なエラー ステータス状態 (Status) が発生した場合)、新しいインスタンスを作成する前に、これらを処理する必要があります。configuration に含まれていない Workspace コンポーネント タイプ等の問題を示す WARNING ステータスにより、構成されたインスタンスを保存して使用できます。

configuration ファイルを編集して新しいインスタンスへ再アップロードしたら、 ボタンを再度、使用して、発生した可能性のある問題を検出できます。

インスタンスが正常に定義されたら、必ず ボタンをクリックしてください。そのインスタンスは、接続されているインスタンスの現在のリストに表示され、インターフェースのメインの Component Sync ページに戻ります。

コンポーネントの同期

Workspace サーバと、接続されたエンタープライズ システム インスタンス (より具体的には、それらのパラメータ データ) 間のコンポーネントの同期には、以下が含まれます:

1. 各コンポーネント タイプの同期を構成します。これには以下が含まれます:
   1. 同期の方向を決定します。
   2. 関係するコンポーネントと、コンポーネントを作成する場所を決定します。
   3. パラメータ マッピングの設定。
2. 該当する場合、Part Choices データ マッピングの同期を構成します。
3. 同期を実行します。

上記の最初の 2 つのアイテムグループは、接続されたエンタープライズ システム インスタンスに使用される configuration ファイルで処理されます。同期自体は、Workspace のブラウザ インターフェースの Component Sync ページから要求に応じて実行されます。

同期の構成

configuration ファイル内で、エンタープライズ システム インスタンスとの接続は、Instance タグ間で定義します。そこには、Arena、または Winchill PLM システムの Driver や URL がプリロードされています。Arena configuration では、この項目は、Arena ユーザアカウントで利用できる特定の Arena workspace の指定にも対応します。オプションの Arena workspace ID は、Context タグセットで定義されています。

<Instance>
    <Driver>Arena</Driver>
    <Url>https://api.arenasolutions.com/v1/</Url>
    <Context>12345678</Context>
</Instance>

configuration ファイルの次の Schema セクションでは、専用 part type ごとに同期マッピングのセクションを定義します。Workspace 側では、これはタイプ altiumType のコンポーネントです (Altium Designerの Component Type ダイアログに表示される名称です)。エンタープライズ システム側では、part は plmType として定義されます。このコンポーネント セクション全体は、ファイル内で Entity として宣言されています。その一例は、capacitor の場合です:

<Entity altiumType="Capacitors" plmType="Capacitor">
.
.
</Entity>

Entity タグ内では、2 つのセクションを使用して、Workspace サーバからエンタープライズ システムへの同期、およびエンタープライズ システムから Workspace サーバへの同期をコントロール、および構成します。これにより、単方向、または双方向の同期が可能になります。詳細については、サンプルの configuration ファイルで利用できるコメントと併せて、次のセクションを使用してください。 最終的に、configuration ファイルで定義される内容は、特定の要求、および接続されたエンタープライズ システム インスタンスで定義されている (PLM) 属性によって異なります。

<ToPlm sync="true">
.
.
</ToPlm>

<CreateInfo>
    <Numbering name="Electrical">
        <Fields>
            <Field name="Code" value="120"/>
        </Fields>
    </Numbering>
</CreateInfo>

<Attributes>

<ns2:Attribute>
    <ns2:Key>Name</ns2:Key>
    <ns2:Value>${parameter.name}</ns2:Value>
</ns2:Attribute>
                    
<ns2:Attribute attributeType="item" primaryKeyOrdinal="1">
    <ns2:Key>Number</ns2:Key>
    <ns2:Value>${parameter.PlmPartNumber}</ns2:Value>
</ns2:Attribute>
                    
<!-- Workspace component description will go to enterprise system field Description. Value will be prefixed with 'Extended' -->
<ns2:Attribute attributeType="revision">
    <ns2:Key>Description</ns2:Key>
    <ns2:Value>Extended ${parameter.Description}</ns2:Value>
</ns2:Attribute>

</Attributes>

<ToAltium sync="true" mode="createAndUpdate">
.
.
</ToAltium>

<CreateInfo>
    <!-- <ComponentTemplate>TODO component template Revision ID</ComponentTemplate> -->
    <RevisionNamingScheme>1-Level Revision Scheme</RevisionNamingScheme>
    <LifecycleDefinition>Component Lifecycle</LifecycleDefinition>
    <Folder>Components/Inbox/Capacitors</Folder>
</CreateInfo>

<SourceCriteria>
    <ns2:Attribute>
        <ns2:Key>Company</ns2:Key>
        <ns2:Value>Acme Inc</ns2:Value>
    </ns2:Attribute>
</SourceCriteria>

<Attributes>
<!-- Name field from enterprise system will be passed to name/comment field in Workspace -->
<ns2:Attribute attributeType="revision">
    <ns2:Key>name</ns2:Key>
    <ns2:Value>${attribute.Name}</ns2:Value>
</ns2:Attribute>
                    
<!-- Description field from enterprise system will be passed to Description field in Workspace on revision level -->
<!-- Revision level attributes will cause new revision to be created when parameter value has changed -->
<ns2:Attribute attributeType="revision">
    <ns2:Key>Description</ns2:Key>
    <ns2:Value>${attribute.Description}</ns2:Value>
</ns2:Attribute>
                    
<!-- Number field from enterprise system will be passed to PlmPartNumber field in Workspace on item level -->
<!-- Item level parameters will not cause revision update when changed -->
<ns2:Attribute attributeType="item" primaryKeyOrdinal="1">
    <ns2:Key>PlmPartNumber</ns2:Key>
    <ns2:Value>${attribute.Number}</ns2:Value>
</ns2:Attribute>
</Attributes>

Part Choice データマッピングを定義するためのセクションは、サンプル (または、生成された) configuration ファイルの最後にあります。また、Part Choice データの同期は、エンタープライズシステムから Workspace へのみの一方向であることに注意してください。

<PartChoices>
    <ToAltium sync="true">
        <MfrMapping>
            <MfrName>MFR1</MfrName>
            <MfrPartNumber>MPN1</MfrPartNumber>
        </MfrMapping>
</PartChoices>

<PartChoices>
    <ToAltium sync="true">
</PartChoices>

<common:Attribute>
	<common:Key>Classification</common:Key>
	<common:Value>102-Capacitor</common:Value>
</common:Attribute>

<common:Attribute>
	<common:ClassificationName>102-Capacitor</common:ClassificationName>
	<common:Key>Capacitance</common:Key>
	<common:Value>${parameter.Value}</common:Value>
</common:Attribute>

<SourceCriteria>
	<common:ClassificationName>102-Capacitor</common:ClassificationName>
</SourceCriteria>

<SourceCriteria>
	<common:Attribute>
		<common:ClassificationName>102-Capacitor</common:ClassificationName>
		<common:Key>Capacitance</common:Key>
		<common:Value>10uF</common:Value>
	</common:Attribute>
</SourceCriteria>

<common:Attribute attributeType="revision">
	<common:ClassificationName>102-Capacitor</common:ClassificationName>
	<common:Key>Value</common:Key>
	<common:Value>${attribute.Capacitance}</common:Value>
</common:Attribute>

コンポーネント同期の実行

同期自体は、Workspace のブラウザ インターフェースの Component Sync ページから実行されます。 同期インスタンスに関連付けられている コントロールをクリックします。同期プロセスは、関連する configuration ファイルで定義した設定に従って続行します。

Workspace と指定されたエンタープライズシステム インスタンス間で進行中のコンポーネントの同期。

コントロールが に変わります。同期プロセスを停止したい場合、このコントロールをクリックします。確認ウィンドウが表示され、 をクリックして同期をキャンセルできます。既に同期されている全てのコンポーネントはそのまま残りますが、それ以降の同期は起こりません。

ブラウザを更新して (F5)、同期プロセスが完了したことを確認できます。完了したプロセスの詳細を表示、またはプロセスの成功等を確認するには、Synchronization status タブを選択し、Closed オプションを選択します。プロセスがまだ実行中の場合は、Active リストに表示されます。選択した同期イベントの詳細が、下の欄に表示されます。そこには、イベントのシステム生成通知ログファイル (PLM <Date Time>.log) へのリンクも含まれています。このリンクをクリックして、詳細なログファイルをブラウザのデフォルトのダウンロードフォルダへダウンロードできます。

6 つのコンポーネントの双方向同期が成功した結果の例。

ボタンをクリックして、同期ステータスの結果を CSV ファイルへエクスポートすることもできます。このファイルには、Synchronization status タブに現在、表示されている結果のみが含まれ、下の欄にある詳細も含まれます。

同期プロセスの具体的な結果は、PLM システムと Altium Designer、または Workspace の Explorer ビューの両方で確認できます。ここに含まれる例では、6 つの LED コンポーネントが Arena と Workspace 間で同期されており、Arena ITEM NUMBER 属性と、インデックスキーとしての Altium PlmPartNumber パラメータによってリンクされています。