Database Reference
In-Depth Information
SDKs can also include flow charts or visual layouts that demonstrate the structure of a data warehouse,
for example. To keep the documentation professional, some companies choose to set a standard for how the
documentation is recorded that can be kept on the main page and can help developers understand how the SDK
is read. This can include formatting for text or other standardized information. Here are some examples:
Standard fonts
Bold text
Italics
Hyperlinks
Date indicators such as mm/dd/yyyy or yyyy/mm/dd, and so on
<Inserts>
Value type indicators such as Bool vs. Boolean
Separation characters for
either | or choices
The following SDK example is created from a stored procedure we used in Chapter 13. Its purpose is to select
report data.
Omitted portions
an exaMple sDK
Name: pselQuantitiesByTitleAnddate
Title: stored Procedure for sales Quantities by Title and date
Description: Reporting stored procedure that returns total quantity, the overall average quantity, and a
KPI value based on the comparison between the total quantity and the overall average quantity
Links: http://MyCompany/BIWebSite/Dev/pSelQuantitiesByTitleAndDateInfo.aspx
Parameters:
Name
Type
Example
Description
ShowAll
nVarchar(4)
True
Show all rows of data if true
StartDate
DateTime
01/01/1990
Starting date range
EndDate
DateTime
01/01/2100
Ending date range
Prex
nVarchar(3)
A, AB, or ABC
0 to 3 characters used before
wildcard search symbol
 
Search WWH ::




Custom Search