Tutorials/Basic-Configuration.md
... ...
@@ -1,11 +1,130 @@
1
-#Basic Configuration Tutorials
1
+#9.0 Misc Tab
2 2
3
-* [[Customizing Izenda Settings|Integration/Tutorials/Customizing-Izenda-Settings]]
3
+[[_TOC_]]
4 4
5
-* [[Views|Integration/Views]]
5
+##About
6 6
7
-* [[Branding|Integration/Appearance]]
7
+The Miscellaneous (Misc) tab allows you to add a title, description, header, and footer to the report. It also allows [[justification|/API/CodeSamples/ShowJustification]] to be used on each of these items. This is also where the sharing and Scheduling controls are located as well as tools to create a drill-down.
8 8
9
+![The Misc Tab]()
9 10
10
----
11
-[[UserGuides]]
... ...
\ No newline at end of file
0
+|**Feature**|**Description**|**Appearance**|
1
+|:---------:|:-------------:|:------------:|
2
+|Report Header Image Justification|Allows you to move the Report Header to the left, middle or right of the page when the report is viewed.||
3
+|Title|Enter the title of the report.|![Title Example]()|
4
+|Description|Enter a description for the report.|![Description Example]()|
5
+|Header|Allows a user to set a report header.|![Header Example]()|
6
+|Footer|Allows a user to set a report footer.|![Footer Example]()|
7
+
8
+_**Note:** In the examples above, "INSERT TEXT" is where you will see the text entered for the corresponding field._
9
+
10
+
11
+##9.1 Share With & Rights
12
+
13
+![Share With & Rights Dropdowns]()
14
+
15
+The **Share With** dropdown allows you to share your report with:
16
+
17
+* Everyone - Share this report with everyone who is listed in the dropdown
18
+* Users with specific roles - Share this report with only users who have specific roles (e.g. marketing)
19
+* Specific users - Share this report with specific users (e.g. bob)
20
+
21
+The **Rights** dropdown allows you to give the users you are choosing to share the report with different levels of access. The levels of access you can grant are as follows:
22
+
23
+* **...** - No rights are applied to this report.
24
+* **None** - The report is unavailable to (hidden from) the users.
25
+* **Full access** - The report is available for users to view, modify, and save changes to.
26
+* Read only - The report is available for users to view, add or remove filters, and modify the existing filters' values. Users may also modify(design) the report but cannot overwrite the existing report. They may, however, save it as a new report.
27
+* **View only** - The report is available to the user to view, but not to modify in any way or save changes to.
28
+* **Locked (v6.4+)** - The report is available to users to view, and users can modify existing filters' values, but users cannot add or remove filters or fields, and they cannot save changes to the report. Users may also not change the column or operator of the filters.
29
+
30
+_**Note:** Access privileges will only apply to the user or group selected in the **Share With** dropdown. All other users will have an access level of None._
31
+
32
+_**Note2:** The owner will not change when a user other than the owner saves the report. Choosing "Save As" will create a new report and its owner will be the user that saved the report._
33
+
34
+_**Note3:** The "Rights" dropdown menu is hard-coded into Izenda and is designed to cover all possible scenarios concerning user access to reports._
35
+
36
+Your system administrator will likely determine the list of groups and users available to share reports with. You may then select who you would like to share your report with. You may also determine the level of access you will give to them for this report using the Rights dropdown. The table below describes the characteristics of each option for selecting the appropriate rights.
37
+
38
+###9.1.1 Setting Sharing Permissions
39
+
40
+The [[SharedWithValues|/API/CodeSamples/SharedWithValues]] and [[CurrentUserRoles|/API/CodeSamples/CurrentUserRoles]] properties allow reports to be easily shared among users and group of users.  Here is an example of what these properties can look like when used in conjunction with each other.
41
+
42
+```csharp
43
+AdHocSettings.CurrentUserIsAdmin = (bool)HttpContext.Current.Session["IsAdmin"];
44
+AdHocSettings.CurrentUserName = HttpContext.Current.Session["UserName"];
45
+AdHocSettings.ShowSettingsButtonForNonAdmins = false;
46
+
47
+if(AdHocSettings.CurrentUserIsAdmin) {
48
+ //Sam is an administrator in the system and has full access to everything
49
+ AdHocSettings.SharedWithValues = new string[] { "Bob", "Sales", "Alice", "Marketing", "Sam", "Mallory" }; //Sam can freely choose who to share with based on department or username
50
+}
51
+else {
52
+ if(AdHocSettings.CurrentUserName == "Bob") {
53
+ AdHocSettings.CurrentUserRoles = new string[] { "Sales" };
54
+ AdHocSettings.SharedWithValues = new string[] { "Bob", "Sales", "Alice", "Marketing", "Sam" }; //Bob can share reports with anyone but Mallory but cannot view reports that are not shared with "Bob" or "Sales"
55
+ }
56
+ else if(AdHocSettings.CurrentUserName == "Alice") {
57
+ AdHocSettings.CurrentUserRoles = new string[] { "Sales", "Marketing" };
58
+ AdHocSettings.SharedWithValues = new string[] { "Sales", "Alice", "Marketing", "Sam" }; //Alice cannot share reports with Bob or Mallory specifically but Bob can still view reports created by Alice if they are shared with "Sales" and Mallory can view reports shared by Alice if they are shared with "Marketing"
59
+ }
60
+ else if(AdHocSettings.CurrentUserName == "Mallory") {
61
+ AdHocSettings.CurrentUserRoles = new string[] { "PR" };
62
+ AdHocSettings.SharedWithValues = new string [] { "Sales", "Marketing", "Mallory", "Sam", "Visitor" }; //Mallory can share reports with the Visitor role.
63
+ }
64
+ else {
65
+ AdHocSettings.CurrentUserRoles = new string[] { "Visitor" }; //visitors cannot share with anyone but can see reports shared with the "Visitor" role
66
+ }
67
+}
68
+```
69
+
70
+This sample represents the basic flow of user roles and the "Shared With" values they will see. If we were to log-in as Sam, we would have full access to everything and the values in Sam's **SharedWithValues** property would fill the dropdown menu. Each user would have different values based on their unique situation.
71
+
72
+_**Note:** If the [[CurrentUserIsAdmin|/API/CodeSamples/CurrentUserIsAdmin]] property is set to true, it will override the SharedWithValues security created by other users, so be careful who you use this property with.
73
+
74
+###9.1.2 Owner Control
75
+
76
+The owner text field is only available to administrators by default. This field is populated with the CurrentUserName of the person creating the report. If no CurrentUserName is available, the application will default to "DefaultAdministrator". This is the default user account for Izenda.
77
+
78
+##9.2 Drill-Downs
79
+
80
+Here is a short video detailing the process involved in creating a drill-down report. If you do not want to watch a video, a full transcript of the process is available below as well.
81
+
82
+![Izenda Drill-down video]()
83
+
84
+The fundamental difference between a main report and a sub-report is the **drill-down key** field. Setting this field will enable a report to become a sub-report. So let's start by creating a report in the Report Designer.
85
+
86
+![Design the sub-report]()
87
+
88
+We have a report with three fields created. Now we will set the **drill-down key**.
89
+
90
+![Set the drill-down key]()
91
+
92
+Once the drill-down key is selected on the sub-report, you will need to design a main report to use it.
93
+
94
+![Design the main report]()
95
+
96
+You will then want to click on the [[Advanced Field Settings|http://wiki.izenda.us/Guides/ReportDesign/4.0-fields-tab#4.8-Advanced-Field-Settings-Button]] button for the field you designated as the drill-down key in your sub-report. I.e. if you made ShipCountry your drill-down key, you will want to apply advanced settings for the ShipCountry field on your main report.
97
+
98
+![Drill-down report view]()
99
+
100
+Congratulations! You have designed a report with a drill-down. You may now click on the link on your main report to view the sub-report.
101
+
102
+###9.2.1 Passing Filters from Master Report to Sub-Report
103
+
104
+The [[InheritFiltersinSubreports|/API/CodeSamples/InheritFiltersInSubreports]] property that your system administrator can set allows the filters applied in the parent report to automatically pass through to the child report (main report to sub-report).
105
+
106
+You can click on the above link for a sample of how this property is applied.
107
+
108
+##9.3 Scheduler
109
+
110
+Your application will need to be properly [[configured|http://wiki.izenda.us/FAQ/Questions/How-do-I-use-the-Izenda-Reports-report-email-scheduler]] before the scheduling controls appear on the page. If you do not see them, please speak with your system administrator.
111
+
112
+There are several different controls here that we will address.
113
+
114
+|Control|Description|
115
+|:-----:|:---------:|
116
+|Schedule|Set the schedule date and time.|
117
+|Repeat Type:|Set the repeat frequency from a list of possibilities. You may also use [[custom time spans|http://wiki.izenda.us/FAQ/Questions/Adding-Custom-Time-Periods]]|
118
+|Send Email As:|Sets the format in which the email is sent. Formats include PDF, Word, Excel, HTML, Link, Embedded, RTF, and CSV.|
119
+|Recipients:|Enter a comma separated list of recipients.|
... ...
\ No newline at end of file