CF_GETDESCR

The CF_GETDESCR is a function that can be used to insert object value descriptions in the generated document. Instead of retrieving these columns from the database, it is faster to use CF_GETDESCR to insert descriptive values. In addition, the designer avoids problems with receiving duplicate rows for the same value due to different descriptions in different data sources. For example, if the document is generated with account rows, then this function can be used to insert the account descriptions.

The function refers to data table worksheets which the CF_GETTABLE function has created. In other words, to use the CF_GETDESCR, the function CF_GETTABLE needs to be defined first.

CF_GETDESCR refers to a named range in a data table worksheet (created by the CF_GETTABLE).

CF_GETDESCR Function

Default:  

=CF_GETDESCR(<named range>)

For example, =CF_GETDESCR(ACCOUNT)

Additional parameters (from Bizview 7.2):    

=CF_GETDESCR(<named range>,<column from which the ID should be retrieved in the template>,<column that should be returned from the GETTABLE sheet>) (-1 and 2 is default values for the two additional parameters)

For example, =CF_GETDESCR(ACCOUNT,-2,3)  

The above example states that the second column to the left of the CF_GETDESCR in the template will be retrieved and the third column to the right in the GETTABLE sheet (ACCOUNT in this example) will be returned.

The named range should be the name that is created by the CF_GETTABLE function (the third parameter in that function).

By default, the CF_GETDESCR functions works like this:

In order for the CF_GETDESCR function to work, the object value needs to be located in the cell to the left of the actual function. In the above example, the account number will be inserted in the cell outlined in red and the CF_GETDESCR function is defined in the cell directly to the right.

CF_GETDESCR will match the object value in the cell to the left of the function with the values in the first column in the ACCOUNT worksheet. When a match is found, the function returns the value in the second column in the ACCOUNT worksheet. In other words, the function returns the description for the account.

Important: From Bizview 7.2, two additional parameters have been added in which the location of the object value ID column can be other than directly to the left and the column returned can be another column than the second one in GETTABLE.

If no match is found, the function returns blank.

Below is an example of the generated document: