Synopsis
Adds an entry to the documentation glossary.
Description
Adds the specified entry to the documentation glossary, which is included in documentation that is subsequently generated by WhereScape RED.
Input
Input | Description |
|---|---|
Object Name | Item that appears in the left column of the glossary, which normally represents the business name of a column in a dimension or fact table (although it can be used for other purposes). |
Glossary Term | Item that appears under the analysis area heading of the glossary, which normally represents a dimension ot fact table name (although it can be used for other purposes). |
Glossary Description | Description of the term being defined. |
Action | Either ADD or DELETE the specified glossary entry. |
Output
Output | Description |
|---|---|
Result Text | A message to indicate whether or not the glossary term was successfully added/deleted. |
SQL Server
SQL Server Parameters: Ws_Api_Glossary
Callable Routine Type: PROCEDURE.
Parameter Name | Datatype | Mode |
|---|---|---|
@p_object_name | VARCHAR(64) | IN |
@p_term | VARCHAR(256) | IN |
@p_comments | VARCHAR(4000) | IN |
@p_option | VARCHAR(12) | IN |
@p_result | VARCHAR(256) | OUT |
SQL Server Examples: Ws_Api_Glossary
DECLARE @v_result_txt varchar(256) EXEC Ws_Api_Glossary 'Data Warehouse' , 'Overview' , 'A repository of business information' , 'ADD' , @v_result_txt OUTPUT
Teradata
Teradata Parameters: Ws_Api_Glossary
Callable Routine Type: PROCEDURE.
Parameter Name | Datatype | Mode |
|---|---|---|
p_object_name | VARCHAR(64) | IN |
p_term | VARCHAR(256) | IN |
p_comments | VARCHAR(4000) | IN |
p_option | VARCHAR(64) | IN |
p_result | VARCHAR(256) | OUT |
Teradata Examples: Ws_Api_Glossary
DECLARE v_result_txt varchar(256); CALL [METABASE].Ws_Api_Glossary ( 'Data Warehouse' , 'Overview' , 'A repository of business information' , 'ADD' , v_result_txt );
Oracle
Oracle Parameters: Ws_Api_Glossary
Callable Routine Type: FUNCTION.
Parameter Name | Datatype | Mode |
|---|---|---|
v_object_name | VARCHAR2 | IN |
v_term | VARCHAR2 | IN |
v_comments | VARCHAR2 | IN |
v_option | VARCHAR2 | IN |
FUNCTION Return Value | VARCHAR2 | OUT-Function |
Oracle Examples: Ws_Api_Glossary
v_result_txt varchar2(256); v_result_txt := Ws_Api_Glossary ( 'Data Warehouse' , 'Overview' , 'A repository of business information' , 'ADD' );
DB2
DB2 Parameters: Ws_Api_Glossary
Callable Routine Type: PROCEDURE.
Parameter Name | Datatype | Mode |
|---|---|---|
p_object_name | VARCHAR(64) | IN |
p_term | VARCHAR(256) | IN |
p_comments | VARCHAR(4000) | IN |
p_option | VARCHAR(64) | IN |
p_result | VARCHAR(256) | OUT |
DB2 Examples: Ws_Api_Glossary
DECLARE v_result_txt varchar(256); CALL [METABASE].Ws_Api_Glossary ( 'Data Warehouse' , 'Overview' , 'A repository of business information' , 'ADD' , v_result_txt );