コンポーネント リリースマネージャ

 

Related articles: Vault ベースのコンポーネント, Vault ベースの領域モデル, コンポーネントライブラリとコンポーネント定義

Component Release Manager は、1 つ、または複数の回路図、PCB、コンポーネントライブラリ内で保存した回路図シンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義 を順番にリリースする主要なリリース 'コンソール' です(ライブラリを vault へバッチ形式でリリースできます)。

設計側で、ソースライブラリ (*.SchLibs, *.PcbLibs, *.CmpLibs) を見つけることができる Windows フォルダを指定します。 

Item を保存する vault の場所や、Item の作成に使用する naming scheme に関して、シンボル、モデル、コンポーネント定義をリリースする方法をコントロールできます。また、Item のレビジョンに名称を付ける方法や、それに従うライフサイクル定義をコントロールできます。 

vault 内の既存のフォルダへリリースし、または新しいトップレベルフォルダを作成します。また、vault (ソースライブラリドキュメントを保存する)内のフォルダ構造を作成したりフォルダ構造へリリースするために選択できます(Windows のサブフォルダから vault フォルダを作成します)。vault 内のフォルダ(リリースしているライブラリファイルを表示)を作成しフォルダへリリースします。その論点は、Component Release Manager でプリファレンスや作業方式に従ってリリースをコントロールできると言うことです。 

Component Release Manager には、既存のモデルライブラリを分割するだけでなく、既存の回路図ライブラリにある情報から自動でコンポーネントライブラリを作成する固有の移行ツールがあります。 

Component Release Manager の設定例!

Component Release Manager は、File»Component Release Manager コマンドを実行して Altium Designer のどのエディタからでもアクセスできます。

設計側のライブラリ

Altium Vault へリリースする前に、リリースしたい content を含むソース設計側のライブラリが必要です! 回路図シンボル (SchLibs)、PCB 2D/3D コンポーネントモデル (PcbLibs)、コンポーネント定義 (CmpLibs) を含む新しいライブラリは、ゼロから作成できます(既存のライブラリへ新しい実体を追加します)。しかし、その開始点は、vault ベースのコンポーネントにするための現在のコンポーネントライブラリ(Altium の初期のコンポーネント管理 methodology を使用して管理した)の移行です。

移行プロセスフロー

Component Release Manager には、回路図コンポーネントライブラリ(PCB モデルライブラリ)に保存したコンポーネントの移行で手助けとなるツールがあります。これらには、ソース SchLib と PcbLib を 1 つの回路図コンポーネント、または PCB モデルがある個別のライブラリへ分割するためのスプリッタと、ソース回路図ライブラリから自動でコンポーネントライブラリを生成するためのツールが含まれています。これらの詳細な情報は、このアーティクルの後半にある Migration Tools の項目を参照してください。

Component Release manager を使用してコンポーネントを最初に vault へ移行する場合、一般的なステップ('移行プロセスフロー')は以下のようになります:

  1. Component Release Manager でソース SchLib を開きます。そして、1 つの回路図コンポーネントがある個々のライブラリを得るために Split Libraries ツールを使用します。それから、新しい回路図シンボル Item を作成するために vault へライブラリをリリースします。 
     
  2. Component Release Manager でソース PcbLib を開きます。そして、1つのPCB 2D/3D コンポーネントモデルがある個々のライブラリを得るために Split Libraries ツールを使用します。それから、新しい PCB コンポーネント Item を作成するために vault へライブラリをリリースします。   
     
  3. Component Release Manager で再度、ソース SchLib 開きます。SchLib と PcbLib がリリースされ、ソース SchLib から直接、ソース CmpLib (やそれらのコンポーネント定義)を作成するために Generate Component Libraries ツールを使用できます。  
     
  4. Component Release Manager で新しく作成したソース CmpLib を開きます。それから、新しいコンポーネント Item を作成するために vault へライブラリをリリースします。  

ソース回路図と PCB ライブラリを分割するのは必須ではありませんが、設計側でバージョンコントロール下のライブラリを容易に保存できるのでこの方法を推奨します。1 つのコンポーネントだけがあるライブラリファイルは、コンポーネントを変更する際、1 つのファイルをチェックアウトして修正するだけで済みます。 

コンポーネントを vault へ移行した後、以降の変更(設計側のソース領域モデル、またはコンポーネント定義)を vault 内の Item の新しいレビジョンへリリースするために、必要に応じてソースライブラリを開くことができます。 

IntLib ライブラリソース

vault へ既存の Integrated Library (*.IntLib) を移行するには、その IntLib を作成する時に使用したソース回路図や PCB ライブラリを入手する必要があります。これらを入手するには以下の 2 つの方法があります:

  • オリジナルのライブラリが保存されている場所へ行きます。 
  • 統合ライブラリからソースライブラリを抽出します。

2 番目のオプションは、統合ライブラリへソースライブラリパッケージをコンパイルすることで、回路図コンポーネントに正しい PCB モデルの情報を割り当て、厳密な確認、検証を行うため、最も高い信頼性があります!

統合ライブラリからソースライブラリを抽出するには、File»Open コマンドを使用して実行します。Extract Sources or Install ダイアログで Extract Sources ボタンをクリックします。ソースライブラリは、IntLib が保存されているフォルダのサブフォルダ下へ抽出されます。 

統合ライブラリからソースライブラリを抽出した例。 

リリースするソースタイプの指定

リリースするソースライブラリドキュメント(SCHLIB, PCBLIB, or CMPLIB)のタイプを選択するには、ダイアログの Library Location - Design Side 領域にある Document Type ボタンのドロップダウンメニューを使用します。  

設計側のライブラリの場所を指定

ダイアログの Library Location - Design-Side 領域では、ライブラリに基づいたリリースデータを保存する場所や方法、リリースするソースライブラリの場所を指定するためにコントロールできます。 

リリースするライブラリを保存する親フォルダを指定するには、Top Level Windows Folder 欄を使用します。直接、フォルダパスを入力するか、または  アイコンをクリックしてフォルダを閲覧できる標準のダイアログを表示します。有効なフォルダは、上部に緑色で表示されます。手動で入力したフォルダパスが間違っている場合、赤色で "Folder Not Found" と表示されます。  

リリースしたいソースライブラリを含む親フォルダを指定。 

ソースライブラリを指定した親フォルダのサブフォルダに保存する場合、Include sub-folders オプションを有効にします。Explore ボタンをクリックすると Windows エクスプローラで指定したトップレベルフォルダが開きます。  

この領域の他のオプションでは、ライブラリソースに基づいて vault 内のサブフォルダ構造を作成できます。vault に Item を保存する方法(希望する方法)に従って、以下のオプションのいずれか、または両方を有効にします:

  • Create vault folders for Windows sub-folders – このオプションは、ソースライブラリ保存構造と似ています。設計側にある新しいサブフォルダごとに vault にフォルダを作成します。 
  • Create vault folder for each library file – このオプションは、リリースに含まれた新しい個別のソースライブラリドキュメントごとに vault に個別のフォルダを作成します。

Vault 側のオプションの指定

ダイアログの右上では、新しく作成した Item を保存する場所やそれらを識別する方法、レビジョンやライフサイクル状態を割り付ける方針を定義できます。以下の項目ではこれらの領域の詳細を説明します。 

新しくリリースしたシンボル/PCB コンポーネント/コンポーネント Item を作成する場所や方法を指定。 

これらのオプションは、シンボル、PCB 2D/3D コンポーネントモデルのリリース、または以前にリリースしなかったコンポーネント定義(新しい Item を vault で作成してマップする必要があります)を適用します。既にリリースしたライブラリについて、vault やフォルダ情報はソースドキュメントと一緒に保存されます。リリースしたシンボル/モデル/コンポーネント定義には、Item へそれらをマップするリンク情報があります。ライブラリ内でシンボル、PCB 2D/3D コンポーネントモデル、またはコンポーネント定義を再リリースしている時、この情報を再度、使用します。  

デフォルト Vault

リリースされているシンボル、PCB 2D/3D コンポーネントモデル、またはコンポーネント定義についてリリースデータを保存したい vault を指定するには、Default Vault for New Items 欄を使用します。その欄のドロップダウンには、現在、接続している vault が表示されます。vault へ接続しなかった場合、 ボタンをクリックして Preferences ダイアログの Data Management – Vaults ページを表示します。 そこから、vault へ接続できます。 

Vault フォルダ

リリースされているシンボル、PCB 2D/3D コンポーネントモデル、またはコンポーネント定義の Item を作成するフォルダを決めるには、指定した vault の右にある欄を使用します。以下から選択します:

  • Top-Level Folder – トップレベルフォルダが vault (設計側のソースライブラリを所有しているトップレベルフォルダごとに名称が付けられた)に作成されます。
     

    親ソースライブラリフォルダに基づいたトップレベルフォルダを作成。 
  • Existing Folder ボタンをクリックして Choose Folder ダイアログを表示します。このダイアログには vault のフォルダが表示されます。vault 内の既存のフォルダを選択するか、または新しいフォルダを追加します。 
     

    vault 内の既存のフォルダを選択。

フォルダで作成した Item は後でフォルダ間を移動できます。また、vault でフォルダ階層を変更したい場合、フォルダを移動できます。それは、保存場所でなく設計側でソースデータの実体に戻ってそれをリンクする Item の固有の ID です。 

Item に関連した Scheme 

Item を作成するその他の重要な面は、それに使用する naming scheme です。これは、Item の固有の ID のフォーマットを定義します。SCHLIB 内の回路図シンボル、PCBLIB 内の PCB 2D/3D コンポーネントモデル、または CMPLIB 内のコンポーネント定義をリリースしている時に作成した Item の naming scheme を定義するには、Item Naming 欄を使用します。 

回路図シンボル Item で使用する naming scheme の例。

フォルダタイプ、または content タイプのどちらかに短い形式のコードを利用するものを含む、デフォルトのサンプルの scheme を利用できます。デフォルトの naming scheme を使用して、ソフトウェアは自動で次に利用できる固有の ID を割り当てます(その scheme に基づいて vault 全体と Item の識別子をスキャンします)。もちろん、欄内で入力して自身で scheme を作成できます。変化する箇所は大括弧で囲います(例えば、SYMBOL-001-{J000})。 

SCHLIB と PCBLIB について、ソース回路図や PCB ライブラリで指定したコンポーネント名と同じ名称を付けた Item を作成するために選択できます。これを行うには、Item Naming 欄を $COMPONENT_NAME に設定します。 

ベースレベル Item (割り当てた Item ID 領域の開始点)を指定するには、First Index 欄を使用します。vault 内の Item が Item Naming scheme を既に使用している場合、その scheme で利用できる次のインデックスを自動で使用するように、このインデックスを 0 のままにできます。

作成した Item (Schematic Symbol, PCB Component, Component Items)に使用するライフサイクル管理や、レビジョンに使用した naming scheme のタイプを選択するには、Lifecycle Definition と Revision Scheme 欄を使用します。その欄は、適切なデフォルトの scheme を使用するために設定します。vault で利用できる別の scheme を選択するには、各欄のドロップダウンを使用します。

定義した Lifecycle Definition と Revision Scheme の例。 

フォルダ解析

ソフトウェアは、指定したオプション(例えば、新しい Item を作成、または既存の Item の新しいレビジョンへ再リリースするかどうか)に従って、リリースする方法を確認するために、ソースライブラリフォルダと vault 内のフォルダをスキャン、または分析する必要があります。これを行うには、ダイアログの左下で Analyze Folders ボタンを押します。

選択したドキュメンタイプ(ダイアログのメイン領域にリスト表示された)のライブラリを解析します。

ソースライブラリを分析後、その内容をリスト表示した例(Document TypeSCHLIB に設定)。

以下のようにデータをリスト表示するには、リストの下部にある Group by Document と Group by Folder オプションを使用します:

  • Document=Disabled, Folder=Disabled – 検出されたソースライブラリのシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義をフラットにリスト表示します。 
  • Document=Enabled, Folder=Disabled – 検出されたソースライブラリのシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義を、親ドキュメントに従ってグループ化します。 
  • Document=Disabled, Folder=Enabled – 検出されたソースライブラリのシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義を、親ライブラリがあるフォルダでリスト表示します。 
  • Document=Enabled, Folder=Enabled – 検出されたソースライブラリのシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義を、親ドキュメントに従ってグループ化し親ライブラリがあるフォルダでリスト表示します。 

リンク情報とリリース動作をプレビュー

リストには、ソースの実体がリリースプロセスに含まれる場合に扱われる動作や、ソースシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義、vault ベースの Item 間のリンクに関連する情報が表示されます。リスト内のソースシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義の項目には、以下の情報があります:

  • Target – この領域には、既に確立した(既にリリースした場合)、またはこれから確立する(最初のリリースを待っている場合) Item へのリンクに関する情報が表示されます。それは、vault、vault 内のフォルダ、Item 自体の ID から成ります。
  • Current Revision – ソースシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義を以前にリリースしている場合、この領域にはレビジョン ID やライフサイクル状態に関する最新のリリースしたレビジョンについての情報が表示されます。 
  • Next Revision – この領域には、ソースシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義のリリースからデータを受け取るために作成される Item の次のレビジョンについての情報が表示されます。それは、レビジョンのレビジョン ID とライフサイクル状態を反映します。新しいリリースのために常に Planned 状態になります。 
  • Action – この領域には、リリースプロセスとして Release Manager で扱われるシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義に関する動作が表示されます。まだリリースされていない実体については、この項目は Create New Item と表示されます。Status 欄は、プロセスで(例えば、Requires Release Preparation)扱う次のステップを示します。リリースプロセスが完了するとその結果が反映されます。  
  • Enable – このチェックボックスは、シンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義をリリースプロセスに含める(チェックを入れる)、またはプロセスから除外する(チェックを外す)かどうかコントロールします。 

選択したトップレベルフォルダ下にフォルダが無く、ソースライブラリのサブフォルダと/またはライブラリドキュメントごとに vault フォルダを作成するオプションを選択した場合、Action 欄は Create New Folder になります。 

ダイアログの Library Location - Design Side の領域にあるオプションに基づいてフォルダを作成する例。 

リスト上部にある source library and/or target Item オプションへ変更する場合、正しいライブラリソースにするため再分析する必要があります。リンクや動作情報が表示されます。ダイアログの左下にこの警告が表示されます。Analyze Folders ボタンを再度、クリックします。 

リリースのために Item とドキュメントを準備

vault へリリースする前に、リリースする実体のドキュメントと Item について最初にリリースする準備を行う必要があります。これを行うには、Analyze Folders ボタンの右にある Prepare Items and Documents ボタンをクリックします。Prepare Items and Documents ダイアログが表示され、そこにリリースされている item が表示されます。Yes をクリックします。  

vault 側で新しいフォルダが作成され、新しい Item を受け入れる準備ができます。planned 状態の最初のレビジョンで Item が作成されます。既存の Item へ再リリースする場合、次の予定のレビジョンが作成されます。これは重要です。Item や固有の ID はロックされます(vault ヘリリース際、誰も同じ ID の Item を作成したり、リリースプロセスを終了する前に、Item の同じレビジョンへリリースできません)!

ドキュメント側で、ソースライブラリはリンク情報と一緒に保存されます。これにより、Item naming、lifecycle definition、revision naming scheme と一緒に vault やフォルダへリンクします。ライブラリの各実体は、vault (リリースデータを保存する)内の Item のレビジョンへそれをリンクする情報を保存します。

準備段階が完了すると、Action-Status 欄にその結果が反映されます。サブフォルダについては Created、リリースされているソースの実体については Ready To Release と表示されます。 

リリース

リリースのために準備したドキュメントでは、リリースを進めるための Release Items ボタンを利用できます。リリースしないシンボル/モデルがある場合、この時に Enable のチェックボックスのチェックを外せます。   

ドキュメントを準備した後、リリースする前に Component Release Manager を閉じようとした場合、warning ダイアログが表示されます。新しい item レビジョン(準備段階としてソースライブラリドキュメントへ書かれた)へのリンクが無効になると警告されます。この段階でリリースすることを推奨します。  

Release Items ボタンをクリックします。ダイアログの左下に Releasing n Items と表示されます。n は、リリースとして有効なソースデータの数です。リスト内の Action-Status 欄は Release Running... と表示されます。プロセスが終了すると 、Action-Status 欄は Release Succeeded (リリースが成功した場合)に変わります。リリースした Item を閲覧するには、Vaults パネルを使用します。    

Vaults パネルを使用して、vault にリリースした Item を直接、閲覧。

ソースドキュメントレベルで、リンク情報は回路図ライブラリ (Tools»Document Options) の Library Editor Workspace ダイアログや PCB ライブラリ (Tools»Library Options) の Board Options ダイアログにあります。 

ドキュメントレベルで保存したリンク情報。

ライブラリパネルで、シンボルや PCB 2D/3D コンポーネントモデルのアイコンが vault への接続を示すアイコン(シンボルは  、PCB 2D/3D コンポーネントは  )に変化します。リンク情報は、properties ダイアログの Vault Links、または Footprint Link 領域に表示されます。 

ソースシンボルと PCB 2D/3D コンポーネントモデルレベルのリンク情報。 

Component Release Manager に戻って、再度、Analyze Folders ボタンを押すと更新したリンクやステータス情報が表示されます。ライブラリやデータの実体を再リリースする準備を行います。再リリースされているシンボル、PCB 2D/3D コンポーネントモデル、コンポーネント定義の action は、To New Revision と表示されます。  

リンク情報を更新するフォルダを再分析し、選択したシンボル/モデルを再リリースするためにマネージャを準備。 

リスト内の全ての項目は、デフォルトでリリースが無効になっていることに注意してください。必要に応じて、再リリースのために選択した、または全ての項目を有効にするには、複数の選択機能を使用して右クリックメニューを使用します。それから、2 クリック(Prepare Items and Documents と Release Items)で再リリースできます。  

Vault リンクを削除

ソースドキュメント(やシンボル/モデル/コンポーネント定義)と vault フォルダ(やマップした Item)間の既存のリンクを削除する必要がある場合、ドキュメントを選択してから Component Release Manager のリスト内を右クリックします。そして、Clear Vault Links In Documents コマンドを選択します。リンクは切断され、関連するドキュメントは保存されます。既にシンボル、モデル、コンポーネント定義をリリースしている場合、この方法はソースシンボル/モデル/コンポーネント定義や、リリースした回路図シンボル/PCB コンポーネント/コンポーネント Item の互いの情報を削除します。ドキュメントが一度もリリースされなかったように情報が Component Release Manager に表示されます(新しいItem ID を割り当てた実体を含む、新しく作成した Item の最初のレビジョンへリリースする準備を行います)。 

PCB ライブラリドキュメントの vault のリンクを削除する例。 

ソースの実体と vault Item 間のリンクを作成する時、ソースの実体は事前にリリースされていないと分類される(そのため新しい Item が作成されます)ので、マネージャの右上にあるデフォルトオプションは適用されます。必要に応じて、これらのオプション(特に target folder と Item Naming scheme)を定義します。 

移行ツール

以下の項目では、Component Release Manager から利用できる様々な移行ツールを説明します。これらのツールは、既存のライブラリコンポーネントを Altium Vault へ素早く移行するために使用できます(vault ベースのコンポーネントの領域で Design Data Management System の利点を利用できるように)。 

SchLib と PcbLib を分割

選択した回路図、または PCB ライブラリを個々のライブラリファイル(ファイルごとに 1 つのコンポーネント)へ分割するには、Migration Tools のドロップダウンメニューで Split Libraries コマンドを使用します。Split Libraries ダイアログが表示され、そこで新しいライブラリの保存先を指定します。回路図ライブラリのモデルやパラメータを削除するオプションがあります(シンボル情報だけでライブラリを作成します)。 

ソース回路図ライブラリからコンポーネントライブラリを作成する予定があるが、まだそれを行わない場合、分割プロセスで、モデルやパラメータ情報は、回路図コンポーネントから削除してはいけません。この場合、コンポーネントライブラリを作成した後にライブラリを分割するのがより安全です。vault へリリースすることでモデルやパラメータ情報が削除(または、無視)されるので、回路図ソースコンポーネントにこの情報が含まれているかどうか問題ではありません。これにより、他のコンポーネント管理 methodology のソースコンポーネントを使用できます。

2 つの PCB ライブラリドキュメントを分割した例。この場合に、ライブラリファイルは中間フォルダに作成されます。それから、Component Release Manager 内で指定したソースフォルダにオリジナルのライブラリファイルを置き換えるために移動されます。新しい分割したソースライブラリで、フォルダは再分析されます。

分割は、ソースライブラリをリリースする前、またはリリースした後で行うことができます(リンク情報は新しく作成したライブラリファイルに保存されます。そして、ソースシンボル/モデルと vault Item 間のリンク情報はシンボル/モデルと一緒に維持されます)。 

自動化された CmpLib の生成

選択した回路図ライブラリからコンポーネントライブラリを素早く作成するには、Migration Tools ドロップダウンメニューにある Generate Component Libraries コマンドを使用します。各コンポーネント定義は、回路図コンポーネント(パラメータデータや、回路図シンボル、PCB コンポーネント Item を含む)に基づいて作成されます。 

PCB ライブラリで PCB 2D/3D コンポーネントモデルを参照するのと同様に、ソース回路図コンポーネント(そこから、コンポーネント定義を作成します)を vault へリリースしている必要があります。これは、生成したコンポーネント定義によって追加、参照するためのリリースした Item (回路図シンボル、PCBコンポーネント Item)へリンクするために必要です。 

Generate Component Libraries ダイアログが表示され、そこで、必要に応じてソースコンポーネントライブラリを入手する方法をコントロールできます。 

1 つ、または複数の回路図ライブラリを選択した後、Generate Component Libraries コマンドを使用して表示した Generate Component Libraries ダイアログ。

ダイアログの Library Options の領域で、最初にドキュメントを指定します。ソース回路図ライブラリの各回路図コンポーネントについて、1 つのコンポーネントライブラリ(1 つのコンポーネント定義を含む)を生成することを推奨します。バージョンコントロール下でソースライブラリを保存している時、SCHLIB ごとにシンボルを、PCBLIB ごとにモデルを、CMPLIB ごとにコンポーネント定義を容易に管理できます。 

次にモデル(コンポーネントライブラリ内でコンポーネント定義が参照する)を見つける場所を指定します。これは、ソース回路図や PCB ライブラリを見つけることができるソースフォルダです。 

最後に、生成したコンポーネントライブラリファイルを保存する場所を指定します。

ダイアログの Vault Options の領域で、新しい Item (コンポーネント定義(コンポーネント Item)からリリースデータを受け取るために vault で作成される)のデフォルト設定を指定します。適用する Item Naming、Lifecycle Definition、Revision Naming scheme、vault を選択します。 

最後に、新しいコンポーネント Item を作成する vault で最初のフォルダを選択します。これは、領域モデルを保存する別のフォルダですが、vault 内の各 Item に固有のIDがあり、保存場所は重要ではありません。フォルダ階層により、vault 内の Item を閲覧し、リリース後、いつでもフォルダ(や Item)を移動できます。  

必要に応じてオプションを定義した後、OK をクリックします。生成が行われ、プロセスが完了すると確認ダイアログが表示されます。それから、Document Type を CMPLIB へ切り換える場合、Component Release Manager でコンポーネントライブラリ(リリースするために)をロードします。ソース回路図や PCB ライブラリに使用したフォルダと異なる場合、ソースフォルダを指定し、Analyze Folders ボタンをクリックします。  

ソースコンポーネントライブラリが表示された Component Release Manager。コンポーネント定義をリリースすることで、vault(vault ベースのコンポーネント)にコンポーネント Item を作成します。

Prepare Items and Documents ボタンをクリックして準備が完了したら、Release Items ボタンをクリックしてライブラリソースごとにリリースします。リリースしたら、Vaults パネルで結果を確認します。 

vault にリリースしたコンポーネント Item(vault ベースのコンポーネント)。
You are reporting an issue with the following selected text and/or image within the active document: