Add-ContentItems
Add-ContentItems Webject は、wt.content.ContentHolder を実装する Windchill オブジェクト (別名コンテンツホルダー) にコンテンツを追加します。たとえば、この Webject は、wt.doc.WTDocument タイプまたは wt.part.WTPart タイプを持つオブジェクトにコンテンツを追加します。
使用するパラメータに応じて、Webject は 3 つの異なるシナリオで使用できます。
• Info*Engine BLOB ストリームからコンテンツホルダーに直接コンテンツを追加する (OBJECT_REF または TYPE および WHERE)。
• 後で追加するために Info*Engine BLOB ストリームから保存場所にコンテンツを保存する (STAGING_AREA)。
• 以前に保存されたデータからコンテンツホルダーにコンテンツを追加する (STAGING_AREA および STAGED_FILE_ID および OBJECT_REF、または TYPE および WHERE)。
(OBJECT_REF または TYPE および WHERE パラメータを使用して) 複数のオブジェクトを選択した場合、例外が発生します。
アダプタ Webject での BLOB_COUNT パラメータの使用方法の詳細については、
BLOB のアップロードおよびダウンロードを参照してください。
構文
<ie:webject name="Add-ContentItems" type="ACT">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTION" data="description" />
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PRIMARY" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="ROLE" data="PRIMARY" />
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="STAGED_FILE_ID" data="file_id"/>
<ie:param name="STAGING_AREA" data="pathname"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATED" data="dataType"/>
<ie:param name="UPLOADED_FROM_PATH" data="uploaded_from_path" />
<ie:param name="URL" data="url"/>
<ie:param name="USE_CONTENT_CACHE" data="[TRUE | FALSE]"/>
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
必須
|
必須
|
相互依存
|
オプション
|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
CONTAINER_REF
|
ATTRIBUTE
|
|
DBUSER
|
CONNECTION_ATTEMPTS
|
|
DESCRIPTOR
|
CONNECTION_ATTEMPT_INTERVAL
|
|
GROUP_FILTER
|
DESCRIPTION
|
|
INCLUDE_ARGS
|
FORMAT
|
|
INCLUDE_CONSTRAINTS
|
GROUP_OUT
|
|
INCLUDE_DESCRIPTORS
|
REFERENCE_DELIMITER
|
|
NEXT_OP
|
REFERENCE_OUTPUT_DELIMITER
|
|
OBJECT_REF
|
ROLE
|
|
PASSWD
|
SESSION_ID
|
|
PRIMARY
|
UNFORMATTED
|
|
REFERENCE_EXCEPTIONS
|
USE_CONTENT_CACHE
|
|
STAGED_FILE_ID
|
|
|
STAGING_AREA
|
|
|
TYPE
|
|
|
UPLOADED_FROM_PATH
|
|
|
URL
|
|
|
WHERE
|
|
|
WHERE_CASE_SENSITIVITY
|
|
|
|
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、 アダプタ Webject の概要のセクション「一般 Webject パラメータ」を参照してください。 |
CONTAINER_REF
Webject を適用する対象の Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーであるコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE および WHERE パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
DESCRIPTION
対応するコンテンツアイテムの説明を指定します。DESCRIPTION パラメータの各インスタンスは、コンテンツアイテムに対応しており、コンテンツアイテムの説明を指定します。
DESCRIPTION パラメータが指定されていない場合、コンテンツアイテムの説明は、デフォルトで空の文字列になります。同様に、コンテンツアイテムよりも DESCRIPTION パラメータのほうが少ない場合、空の文字列が DESCRIPTION パラメータのリストに暗黙的に追加されます。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。
Webject を使用し、サーバーのファイルシステムにコンテンツアイテムを保存する場合 (つまり、STAGING_AREA を指定して、OBJECT_REF または WHERE のいずれも指定しない場合)、出力グループには保存されたコンテンツアイテムの識別子が含まれます。
このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
Windchill オブジェクトの Unique Federation Identifier (UFID)。これはコンテンツの追加先となるコンテンツホルダーです。このパラメータには 1 つの値を指定する必要があります。そうしないと、例外が発生します。このパラメータと TYPE および WHERE は相互に排他的です。詳細については、
TYPE および WHERE パラメータの指定を参照してください。
PRIMARY
このパラメータは ROLE パラメータに置換されています。ROLE パラメータを指定すると、このパラメータは無視されます。
このパラメータは、下位互換性を維持するためにそのまま残されています。このパラメータを使用してコンテンツ役割を指定する場合、TRUE は最初のコンテンツをプライマリコンテンツとして指定することを示し、FALSE は最初のコンテンツアイテムをセカンダリコンテンツとして指定することを示します。複数のコンテンツアイテムがある場合、ほかのコンテンツアイテムはこのパラメータにかかわらずセカンダリコンテンツとして指定されます。デフォルトは FALSE です。
ROLE
対応するコンテンツアイテムのカテゴリを指定します。ROLE パラメータの各インスタンスは、コンテンツアイテムに対応しており、1 つのコンテンツホルダー内のコンテンツ内のコンテンツを区別するためのカテゴリを指定します。
使用可能なカテゴリのリストは、Windchill リソースバンドル wt.content.ContentRoleTypeRB.rbInfo で定義されます。
ROLE パラメータを指定しない場合、カテゴリはデフォルトで SECONDARY になります。同様に、コンテンツアイテムよりも ROLE パラメータのほうが少ない場合、SECONDARY が ROLE パラメータのリストに暗黙的に追加されます。このパラメータはオプションです。
STAGED_FILE_ID
以前に保存されたコンテンツアイテムの識別子。複数の値をこのパラメータに指定して、複数の以前に保存されたコンテンツアイテムを識別できます。このパラメータを指定する場合、STAGING_AREA パラメータも指定する必要があります。これらのパラメータが結合してデータベースに保存される以前に保存されたコンテンツアイテムを識別します。
STAGING_AREA
サーバーに置かれている既存のファイルディレクトリの相対パスを指定します。このパラメータは 2 つの用途に使用できます。
• コンテンツアイテムを一時的に保管します。
TYPE および WHERE を指定しない場合、STAGING_AREA を使用して、コンテンツアイテムのアップロード用に Windchill データベース外のディレクトリを識別できます。これによって、大きなコンテンツアイテムを Windchill にコミットする前に一時的にサーバーのファイルシステムに保存できます。この場合、Webject は保存されたコンテンツアイテムの識別子を提供する要素を含んだ出力グループを返します。
各要素には、ソースファイルの名前を指定する source 属性と、保存コンテンツアイテムの識別子を示す staged_file_id 属性が含まれます。後でこの識別子を STAGED_FILE_ID パラメータに使用して、データベースに転送する保存アイテムを選択できます。
• 以前に保存されたコンテンツアイテムを転送します。
TYPE または WHERE を指定する場合、STAGING_AREA および STAGED_FILE_ID パラメータを使用して、以前に保存したコンテンツアイテムを識別して転送できます。この場合、Webject はコンテンツアイテムをデータベースに転送し、TYPE と WHERE (または OBJECT_REF パラメータ) によって識別されたコンテンツホルダーオブジェクトに関連付けます。すべての指定された保存コンテンツアイテムが転送されると、それらのアイテムは保存領域から削除されます。
STAGING_AREA パラメータは、ステージング領域のルートのファイルディレクトリパスを指定する wt.adapter.stagingAreaRoot プロパティを管理者が定義している場合にのみ有効になっています。STAGING_AREA パラメータで指定した値はこのプロパティに付加され、保存コンテンツアイテムが保存されているディレクトリへの絶対パスが生成されます。wt.adapter.stagingAreaRoot プロパティは、wt.properties ファイルで設定できます。
保存されたファイルの絶対パスは次のとおりです。
stagingAreaRoot/STAGING_AREA/ユーザー名
• stagingAreaRoot は wt.adapter.stagingAreaRoot プロパティに定義された値です。
• STAGING_AREA はこのパラメータに指定された値です。
• username は現在のユーザーの名前です。
現在のユーザーが別のユーザー名を 1 つ以上持っている場合、ステージング領域のディレクトリパスを生成する際に使用されるのがどのユーザー名になるか予測またはコントロールすることはできません。
TYPE
オブジェクトタイプの名前。WHERE を指定した場合、TYPE も指定する必要があります。詳細については、
TYPE および WHERE パラメータの指定を参照してください。
UPLOADED_FROM_PATH
対応するコンテンツアイテムのアップロード元のパス。UPLOADED_FROM_PATH パラメータの各インスタンスは、コンテンツアイテムに対応しており、コンテンツアイテムがアップロードされる場所を指定します。このパラメータは URL コンテンツアイテムには使用できません。
UPLOADED_FROM_PATH パラメータが指定されない場合や、コンテンツアイテムよりも UPLOADED_FROM_PATH パラメータのほうが少ない場合、この Webject を使用して保存済みのコンテンツアイテムをアップロードすると、コンテンツアイテムのパスはデフォルトで Null になるか、ステージング領域ディレクトリの絶対ファイルシステムパスになります。このパラメータはオプションです。
URL
コンテンツアイテムとして追加される URL。URL の指定には、OBJECT_REF または TYPE と WHERE も指定されている必要があります。
USE_CONTENT_CACHE
アップロードサービスコンテンツキャッシュが使用されるかどうかを指定します。パラメータが TRUE に設定されていると、コンテンツキャッシュが使用されます。
コンテンツキャッシュを使用すると、アップロードサービスが HTTP 接続を開いてコンテンツをキャッシュにアップロードするので、複数のアイテムのアップロードが一度に行われた場合、パフォーマンスが低下します。このパラメータのデフォルトは FALSE です。このパラメータはオプションです。
WHERE
新規コンテンツを追加するコンテンツホルダーを選択する照会定義式。このパラメータと OBJECT_REF は相互に排他的です。WHERE を指定した場合、TYPE も指定される必要があります。詳細については、
TYPE および WHERE パラメータの指定を参照してください。
