Document Builder: what is regulation set, reference, guidance and prescription

106 阅读1分钟

Created by Jerry Wang, last modified on Jul 13, 2014

For some customer if their business scenario is really complex, sometimes it is important for the end user to understand how to fill the variable name according to their business case, so Document builder provides the function to attach each variable with an additional document with type reference, guidance and prescription.

The following example just shows that for the variable "Name", there is a reference document attached for it.

clipboard1

 

Once we click the small icon, we can save the reference document locally or directly open it. Such reference document would not be rendered as a building part of the final document, just for pure reference purpose.

clipboard2

 

 

How to create reference document for a given variable

  

1. Launch the following activity:

clipboard3

 

Create a new reference with technical name REF_NAME with type "Reference", and put it to regulation set "ZCR_TRAVEL". Click button "Edit/Show Text" to edit the layout of the reference document.

clipboard4

 

2. Assign reference document REF_NAME to your variable, and that's all.

clipboard5

 

clipboard6

 

 

For the usage of guidance, the usage is a little different.

  

1. Create a new guidance in the same customizing activity as reference creation:

clipboard7

 

Click new text button to start development of your element layout part.

clipboard8

 

2. instead of assign a reference document to a variable, you should assign a guidance document to an element instead.

clipboard9

 

 

Then in the runtime, select the element ZCR_NAME, and you could see the Guidance tab in the UI and could see the guidance text. 

 

The guidance document would not be rendered as one part of final document, either.

clipboard10