Request format templates

This section describes format templates for requests, and substitution variables that can be included in request format templates.

About request format templates

A request format template is a user-defined text file that specifies the content and layout of a OpenText Dimensions CM request when it is browsed or printed. Format templates are required for every request type.

The format template contains substitution variables that are dynamically expanded when you browse a request. Variables can represent both system-defined (OpenText Dimensions CM) and user-defined attributes that are single or multivalued.

A template may include:

  • The OpenText Dimensions CM identity of the request, including the product ID, request type, and serial number.

  • The status of the request.

  • The values for one or more user-defined attributes.

  • The date of the last update.

Guidelines:

  • You create request templates outside of OpenText Dimensions CM, usually using a standard text editor.

  • You can use the same template for multiple types, but we recommend that you create a template for each request type so you can manage each template independently.

  • After creating a format template, you associate it to a request type. At this point, the format template is placed under revision control by OpenText Dimensions CM and is stored in a manner similar to items.

  • You can use either lower-case or upper-case text when you define variables in a request format template.

  • When using RTF as a request format, any backslash (\) characters included in attributes are removed because the backslash is treated as a qualifier.

    Any word immediately following a backslash without a space is completely removed.

Back to top

Request template example

Here is an example of a Change Request (CR) request template, followed by an example of an expanded request.

Change request (CR) template

CHANGE REQUEST
CR No:%ch_doc_id%
Originator:%originator%		 Create Date:%create_date%
Severity:%severity%		 Status:%current_status%
Customer Name:%customers%
Reported by:%cust_contact%
Title:%title%    
Affected Product Details
Platform:%platform%
Main Description:
%description%
%description_end%
Operating System:%op_sys%
Affected Item:
%affected_item%
Affected Parts:
%affected_part%		    
Solution Details:
%solution%
Target Release Id:
%target_release% 
Expected effort:%exp_effort%
Actual effort:%actual_effort%
Reason for Deferral
%reason_deferral%
Reason for Rejection:
%rejection%		    
Action Message
%action%
Action:%action_number% by %user_name% on %date% %time%
%action_text%
%action_end%
Related Requests
%related_doc%		    
Action History
%action_history%		    

Expanded change request

 CHANGE REQUEST


	    CR No:PAYROLL_CR_1
	    Originator:DMSYS
	    Reported by:Mike Corelli
	    Create Date:02-APR-2023
	    Severity:1_critical
	    Status:CLOSED
	    Customer Name:Acme Inc


     Title:New field for staff form

	    Affected Product Details
	    Release:2.0.0
	    Platform:Solaris

	    Operating System:Solaris 11.4


     Main Description:
 Staff commented that they were unable to state if they
 were ill during a holiday


Affected Item:
Affected

2	PAYROLL:SICK PAY REPORT.A-SRC;1 (Affected)	DMSYS
	(reports/src/rep_sick.c)
	Report Sick Pay details
Response
4	PAYROLL:SICK PAY REPORT.A-SRC;2 (Response)	DMSYS
	(reports/src/rep_sick.c)
	Report Sick Pay details

Affected Parts:
0	PAYROLL:PAYROLL.A;1				DMSYS
	(PRODUCT)
Payroll Product
2	PAYROLL:REPORTS.A;1				DMSYS
	(SUB-SYSTEM)
	Offline statistics reports



Solution Details:

Target Release Id:Expected effort:Actual effort:

Reason for Deferral

Reason for Rejection:
	
	 Action Message

      Related Requests

Action History

1	02-APR-2023 14:15:32					DMSYS 010
	DMSYS				DEPT
	Document created
2	02-APR-2023 14:33:37					DMSYS 010
	DMSYS 				DEPT
	Actioned document from RAISED to ANALYSED	
3	02-APR-2023 14:33:41					DMSYS 010
	DMSYS				DEPT
	Actioned document from ANALYSED to VERIFIED&CLOSED
4	02-APR-2023 14:42:59					DMSYS 010
	DMSYS				DEPT
	Actioned document from VERIFIED&CLOSED to IMPLEMENTED
5	02-APR-2023 14:44:17					DMSYS 010
	DMSYS				DEPT
	Actioned document from IMPLEMENTED to VERIFIED&CLOSED
6	02-APR-2023 14:47:20					DMSYS 010
	DMSYS				DEPT
	Actioned document from VERIFIED&CLOSED to IMPLEMENTED
7	02-APR-2023 14:48:13					DMSYS 010
	DMSYS				DEPT
	Actioned document from IMPLEMENTED to CLOSED

Back to top

See also: