Customizing columns in the documents list

In the default documents list in Correspondence Reviewer, the following four columns are displayed:

•

Reason

•	Creation Date

•

Type

•

State

Figure 5

Default columns in Correspondence Reviewer

You can re-arrange or remove the default columns, and you can add new columns with user defined metadata.

You customize the columns by editing the reviewer.properties file.

Restrictions

•	The total number of columns must not exceed 30.

•	The minimum width of each column is 150 pixels. If you add more columns than fit in the web browser, the end-user must use the scroll-bar to see all columns.

•	The new columns are not available in the filter area for limiting searches.

Prerequisites

•	If user defined metadata is used, the Message context must be enabled for this metadata in Design Center. See Enabling the Message context for a metadata in the Ad Hoc Correspondence and Correspondence Reviewer User Guide.

•	If the user defined metadata is not shared to all document types in the Design Center Project, you must enable the service gateway to handle non-strict validation. See To enable non-strict validation for the service gateway.

•	The GUIDs for the metadata must be available.

–	The GUIDs for user defined metadata are available in the Design Center resource set (select View > Export GUIDs in the Metadata Group Editor).

–	The GUIDs for predefined system metadata are available in the table below.

 

Predefined system metadata	GUID
ID	6B84E18B-F03C-350C-E040-007F0200026D
TypeID	6B84E18B-F03F-350C-E040-007F0200026D Note: We do not recommend you to add a column for TypeID, since this will display the GUIDs for the document types rather than the names. Document type names are by default displayed using the TypeName metadata below.
TypeName	B818E360-E05F-4230-9113-BD610987337E
Name	6B84E18B-F03D-350C-E040-007F0200026D
Revision	6C8B0907-0646-2843-E040-007F02005164
CreationTime	6B84E18B-F047-350C-E040-007F0200026D
ModifyTime	6B84E18B-F048-350C-E040-007F0200026D
ExpiringTime	6B84E18B-F044-350C-E040-007F0200026D
State	6B84E18B-F042-350C-E040-007F0200026D
ServiceName	6B84E18B-F03E-350C-E040-007F0200026D
RuleName	5DCB3480-CE30-4B68-B26C-47081188FB8B
RuleID	6C8B0907-0647-2843-E040-007F02005164
Comment	6F6EEB26-252D-CCDB-E040-007F02007C09
ErrorCode	8D4625F5-40C5-4914-90FC-A013CC03FAF0
ErrorMessage	BE2F42C9-5D5A-4AEF-A7F3-F5AC8710F94D
Error	5997CABE-3C8F-469B-A32E-AC1EEC9AD622

To enable non-strict validation for the service gateway

Applicable if non-shared metadata is to be displayed in columns.

1	Open the wsconfigurationservice.xml file in a text editor. The file is located in:

<StreamServe installation>\Applications\Service Gateway\
<Version>\webservices

2	Update validateStrict in the following line to false:

<configuration type=... >
   <data>
      <global>
         <parameters>
            <parameter name="returnTotalCount" value=.../>
            <parameter name="lookupAttributeNames" value=.../>
            <parameter name="remoteInvokeTimeOut" value=".../>
            <parameter name="validateStrict" value="false"/> 
            <parameter name="excludedMetaData" value=.../>
         </parameters>
      </global>
      <local>...</local>
   </data>
</configuration>

3	Save and close the file.

4	Restart the service gateway.

To customize columns in the documents list

1	Open the reviewer.properties file in a text editor. The file is located in:

<Portal root>\<Name>_reviewer\WEB-INF\spring\properties

For example, for Apache Tomcat:

<TOMCAT_HOME>\webapps\<Name>_reviewer\WEB-INF\spring\properties

Note:

If you use an external directory (outside the portal root) for the configuration files, you must update the property file in this directory.

2	Go to the following section:

# MetaData to be shown in the columns

#metadata.columns=7C52DDAF-0FA4-4845-88A1-4ECF8B63EABA,0526456B-2F9D-400F-B847-1C7E103B5AE3,938CB835-58C1-4123-90D4-039172D7A325

metadata.columns=6C8B0907-0647-2843-E040-007F02005164,6B84E18B-F047-350C-E040-007F0200026D,6B84E18B-F042-350C-E040-007F0200026D,B818E360-E05F-4230-9113-BD610987337E

3	Edit the uncommented line:

–	Add GUIDs for the metadata to be displayed in columns.

–	Re-arrange the metadata to the appropriate order.

4	Save and close the property file.

5	Refresh the web browser by pressing the F5 key.