Integration/SecurityVariables.md
... ...
@@ -0,0 +1,53 @@
1
+#Common Security Variables
2
+
3
+[[_TOC_]]
4
+
5
+##Report Restriction
6
+
7
+The Izenda [AdHocSettings class](http://wiki.izenda.us/API/AdHocSettings) is the heart of setting up security. Within it, there are a number of variables which will prove useful in creating dynamic security. Below is a list of the commonly used variables.
8
+
9
+###[CurrentUserIsAdmin](http://wiki.izenda.us/API/CodeSamples/CurrentUserIsAdmin)
10
+
11
+This determines if the user is an admin and is true by default. Note that admins ignore [share-with rights](http://wiki.izenda.us/FAQ/Questions/Using-Share-with-rights-roles-properties-in-Izenda-Reports-6#Shared-roles).
12
+
13
+###[CurrentUserName](http://wiki.izenda.us/API/CodeSamples/CurrentUserName)
14
+
15
+This sets the current user's name which is used as the report author during report creation. Authors always have full rights to reports they create.
16
+
17
+###[CurrentUserRoles](http://wiki.izenda.us/API/CodeSamples/CurrentUserRoles)
18
+
19
+This is a string array that allows you to define a list of roles/groups the current user belongs to.
20
+
21
+###[NumSharedDropdowns](http://wiki.izenda.us/API/CodeSamples/NumSharedDropdowns)
22
+
23
+This tells Izenda how many rows should be displayed in the Shared-With drop down on in the [Misc. tab](http://wiki.izenda.us/FAQ/Questions/Using-Share-with-rights-roles-properties-in-Izenda-Reports-6#Shared-roles) of the Report Designer.
24
+
25
+###[SharedWithValues](http://wiki.izenda.us/API/CodeSamples/SharedWithValues)
26
+
27
+This tells Izenda which shared with roles to show in the Shared-With drop down on in the Misc. tab of the Report Designer.
28
+
29
+###[CurrentUserTenantId](http://wiki.izenda.us/API/CodeSamples/CurrentUserTenantId)
30
+
31
+This sets the current user's tenant ID. A user can only belong to one tenant.
32
+
33
+###[HiddenCategories](http://wiki.izenda.us/API/CodeSamples/HiddenCategories)
34
+
35
+This will hide an entire category of reports from a user
36
+
37
+###[HiddenColumns](http://wiki.izenda.us/FAQ/Izenda-API-Tip-Hidden-Columns)
38
+
39
+This will hide any column with the given name. Be sure to fully qualify column names so only the appropriate tables are impacted.
40
+
41
+###[HiddenFilters](http://wiki.izenda.us/API/CodeSamples/HiddenFilters)
42
+
43
+This will append an equals condition to any report that has the given column name with the value specified.
44
+
45
+##Feature Restriction
46
+
47
+###ShowNewButton
48
+
49
+This will show or hide the expandable New button on the Izenda navigation bar. It will also remove the save and save as Icons.
50
+
51
+###[ShowSettingsButton](http://wiki.izenda.us/API/CodeSamples/ShowSettingsButton)
52
+
53
+This will show or hide the settings button on the report list page. A [redirect](http://wiki.izenda.us/Best-Practices/Security-Best-Practices) can be used to ensure that users can't reach this location by typing into the address bar.
... ...
\ No newline at end of file