Changes between Version 1 and Version 2 of Software/Manual/PostProcessors


Ignore:
Timestamp:
04/19/13 12:30:00 (6 years ago)
Author:
smith@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Software/Manual/PostProcessors

    v1 v2  
    11= Post-Processors = 
     2 
     3== Introduction == 
    24 
    35Post-processors allow you to alter the way information is to be displayed between its retrieval from the Raptor MUA and display in Raptor Web. This can be used to do things such as sort results, etc. This page contains a complete list of current post-processors available in Raptor. 
     
    57It is important to note that you can apply multiple post-processors. When you do have more than one, they act in a sequential fashion - so the order you add them in is important. 
    68 
    7 == Remove Rows from Result == 
     9== Index of all Post-Processors == 
    810 
    9 This allows you to select how many "rows" you would like to retain. For example, if your search returned 30 departments (i.e. you grouped by principalInformation.school), then choosing 10 would chop off the remaining 30. 
     11[[PageOutline(3-100,,inline)]] 
     12 
     13== Details == 
     14 
     15=== Remove Rows from Result === 
     16 
     17[[Image(PostProcessorRemoveRows.png)]] 
     18 
     19Allows you to select how many "rows" you would like to retain. For example, if your search returned 30 departments (i.e. you grouped by principalInformation.school), then choosing 10 would chop off the remaining 20. 
    1020 
    1121This post-processor works by retaining the first N rows (where you choose N) using the order given to it. So if you want the top N according to value (e.g. the top 10 users, you would first need to apply the Sort Y-Axis by Value post-processor) then apply this post-processor. 
    1222 
    13 == Y-Value as percentage == 
     23=== Y-Value as percentage === 
    1424 
    15 == Sort X-Axis Alphabetically == 
     25[[Image(PostProcessorYAxisPercentage.png)]] 
    1626 
    17 == Sort Y-Axis by Value == 
     27Converts the absolute numbers associated with each column into percentages, where the highest value column becomes 100%. 
    1828 
    19 == Format EntityIDs with SAML Org Name == 
     29=== Sort X-Axis Alphabetically === 
     30 
     31[[Image(PostProcessorXAxisAlph.png)]] 
     32 
     33Sorts the columns displayed along the X-Axis alphabetically. For example, if you were grouping your data by department (i.e. principalInformation.school), the columns would display the department names in alphabetical order. 
     34 
     35To sort in alphabetical order choose "Ascending" as "true". For reverse alphabetical order, choose "Asecending" as "false" 
     36 
     37=== Sort Y-Axis by Value === 
     38 
     39[[Image(PostProcessorYAxisValue.png)]] 
     40 
     41Sorts the columns displayed along the value of that column. For example, if you were grouping your data by department (i.e. principalInformation.school) and displaying the number of authentications, the columns would display the department names according to how many authentications were associated with each. 
     42 
     43To sort from low to high choose "Ascending" as "true". For high to low, choose "Ascending" as "false" 
     44 
     45=== Format EntityIDs with SAML Org Name === 
     46 
     47[[Image(PostProcessorSAMLName.png)]] 
     48 
     49Changes the SAML Entity IDs which are displayed by default when graphing Shibboleth IdP or Shibboleth SP event types to the corresponding OrganisationName recorded in that entity's SAML Metadata (see [Software/Productionalisation/AddingExtraInfo this page] for information on how to configure the SAML Metadata as an input to Raptor for this purpose).