DataMiner Ranking Definition

Ranking Definition Options

Ranking can be defined in scripts by referencing an existing system, using a single formula, or defining the entire system in the script.

Below are the parameters for each option. For options (3) & (4) a ranking system called APIRankingSystem will be created in your account. This ranking system will be reused by the API and will always contain the version specified by the last iteration of the API operation.

Option 1: Use an existing Ranking System
Ranking:	"System Name" or numerical id	Can be one of our pre-defined systems or yours. Use quotes if name has ':'

Option 2: Single formula ranking
Ranking:
→Formula:	"Fomula"
→Lower is Better:	true, false

Option 3: Defining entire Ranking System in YAML
Ranking:
→Rank:	[Higher] , Lower , Summation
→Method:	[NAsNegative] , NAsNeutral
→Nodes:	List of nodes. See Nodes Specification below

Option 4: Defining entire Ranking System in XML copied from the website
Ranking:
→Nodes:	in xml format	See xml format on the website
→Method:	[NAsNegative] , NAsNeutral

Nodes Specifications

Composite Node
Type:	Composite
Name:	"Node name"
Weight:	[0]-100	0 indicates equal weight
Rank:	[Higher], Lower, Summation
Nodes:	List of nodes follows below

Formula Node
Type:	StockFormula, IndFormula, SecFormula
Name:	"Node name"
Weight:	[0]-100	0 indicates equal weight
Rank:	[Higher], Lower, Boolean
Formula:	"Enter formula"
Scope:	[Universe], Industry, Sector	Only for StockFormula

Conditional Node
Type:	Conditional
Name:	"Node name"
Weight:	[0]-100	0 indicates equal weight
Rank:	[Higher], Lower
Formula:	"Boolean condition"
True Nodes:	List of nodes follows below
False Nodes:	List of nodes follows below

Example of an inline ranking system

Ranking:                                           
    Rank: Higher # ( [Higher] | Lower | Summation )       
    Method: NAsNegative #( [NAsNegative] | NAsNeutral )   
    Nodes:                                                
    -                                                     
        Type: Composite                                   
        Name: Value Composite                             
        Weight: 70                                        
        Rank: Higher                                      
        Nodes:                                            
        -                                                 
            Type: StockFormula                            
            Name: EarnYield                               
            Weight: 50                                    
            Rank: Higher                                  
            Formula: EarnYield                            
            Scope: Universe                               
        -                                                 
            Type: StockFormula                            
            Name: Pr2SalesTTMvsInd                        
            Weight: 50                                    
            Rank: Lower                                   
            Formula: Pr2SalesTTM                          
            Scope: Industry                               
    -                                                     
        Type: Composite                                   
        Name: Growth Composite                            
        Weight: 30                                        
        Rank: Higher                                      
        Nodes:                                            
        -                                                 
            Type: StockFormula                            
            Name: EarnYield                               
            Weight: 100                                   
            Rank: Higher                                  
            Formula: SalesGr%TTM                          
            Scope: Industry                               

This creates the following ranking system in your account