Manage WebTrader document attributes templates

As a WebTrader administrator you can create document attributes templates to link specific metadata to the documents that your WebTrader users exchange.

On the WebTrader user side, WebTrader end-users see the metatdata you attach to their exchanges in several ways:

  • When sending documents, the interface displays additional attribute fields that WebTrader users may (or may not depending on your configuration) be required to complete before sending a document.
  • The attributes and their values are listed in the table of the Sent folder.
  • The attributes and their values are listed in the table of the Inbox folder.
  • When using the document search tools, additional filtering criteria are available for locating documents with associated attributes.
  • For example, a WebTrader user may wish to search among received documents for documents that share a common attribute such as "Company Name" or "Priority". You can create a document template that attaches these attributes to transferred documents and then appears as informative and searchable information in the WebTrader user interface.

On the server side, you can use the metadata that is attached to WebTrader documents to determine how documents are routed and processed.

Create a document attributes template

  1. From the Interchange tool bar select WebTrader manager > Manage WebTrader partners.
  2. From the Related tasks list at the bottom of the page, click Manage document attributes template.
  3. From the Related tasks list at the bottom of the page, click Add new attribute field.
  4. In the Add an attribute field page complete the fields:
    • Name – Enter a name for the document attribute. This is the name that displays in the WebTrader user interface.
    • Make this a required attribute – Select this option if the user must choose or enter a value each time a document is sent.
    • Make available for searching – Select this option if you want the WebTrader end user's search tool to include an attribute name and value filter.
    • Make available for message processing – Select this option if you want document processing to depend on the detection (or non-detection) of this attribute or attribute value. For example, you may want to configure a service to run only if a specific attribute/value is detected.
    • This property is a list of values – Select this option if you want to create a list of possible values from which the user can select.
    • Selection style – Indicate if the user can select a single value or multiple values from the list of possible values.
    • Possible values – Enter the possible values that you want to appear in the user's selection list.
  5. Click Add.

Modify a document attributes template

  1. From the Interchange tool bar select WebTrader manager > Manage WebTrader partners.
  2. From the Related tasks list at the bottom of the page, click Manage document attributes template.
  3. From the list of templates, click the name of the template you want to modify, to open the Change an attribute field page.
  4. Change the displayed fields as required. For field descriptions see the previous procedure.
  5. Click Save.

Change document attribute display order

After you create two or more document attributes templates, you can change the display order of the template attribute list on the Manage document attributes template page. This has the effect of changing the order of the display of attributes in the WebTrader user interface.

  1. Select WebTrader manager > Manage WebTrader partners.
  2. In the related tasks list, click Manage document attributes template.
  3. On the Manage document attributes template page, select either the up or the down arrow of any attribute to change its position in the list.
  4. Click Save.

Delete a document template

  1. Select WebTrader manager > Manage WebTrader partners.
  2. In the related tasks list, click Manage document attributes template.
  3. From the list of templates, locate the name of the template you want to remove, and click Delete on that line.
  4. The following message is displayed: Are you sure you want to delete this attribute?
  5. Select OK to delete the template or Cancel if you decide not to delete.

Related topics

Related Links