Home

PDF - Documentation

image

Contents

1. 2010 2015 Exprodo Software Glossary 253 User Project Association A Calpendo concept which contains a list of projects amp the user is associated with User Roles Users may be assigned roles and then Permissions can be configured to use those Rules For example by default users with the Admin role can modify more things than users without the Admin role User Settings Specifies settings that change the way Exprodo DB operates for this user These will override the Global Preferences User Status The current status of the users account This may be one of Requested Normal Password must be reset at next login Blocked or Denied User Type A way of grouping similar users together A user has one type See also User Group 2010 2015 Exprodo Software Index 255 Index sA Admin Role Introduction To 54 Appearance Global Preferences For 144 Approving New User Requests 5 7 Attachment File Creating A Set Of Bisket Def 220 Example Adding Properties For 212 Authentication Methods 140 Basic 141 Editor 142 External 141 IMAP 140 Local 140 SMTP 140 Automatic Email 116 Conditions 120 Dealing With Sensitive Data 125 Details 119 Editor 117 Examples 126 Property Path 121 Recipients 120 Subject Tab 122 Tree 117 URL 124 B Backing Up The Database 235 Use Custom Per Table Settings 236 Bakery 173 Biskit Definitions 175 Biskit Format 178 Biskit Inheritance 1 79 Bi
2. Calpendo new project request Specify the text of the email This can reference properties of the project created and the user who created it Conditions Recipients Email Subject Email Body A new project request has been made by NEW owner givenName NEW owner familyName 2010 2015 Exprodo Software Exprodo DB Configuration Guide 127 Example 2 Send Email To A New User After They Register This example shows how to create an Automatic Email that will be sent to a new user immediately after they register with Exprodo DB We need to make sure it gets sent when a new User is created and that the email gets sent to the new user 1 Create an Automatic Email that is triggered when a User is Created Tell new user to wait after registering 2 Add a condition Status is Requested Value of sttus OOOO O 3 Onthe Recipients tab set Send To User Performing Action to true send To User Performing 4 On the Email Subject tab enter the text you want to be the subject of the email Conditions Recipients Email Subject Email Body USER NEW OLD DATE IF ADDRESS AUDIT LOG URL Mew Calpendo user request for NEV loginName 5 On the Email Body tab enter the text you want to be the main content of the email Conditions Recipients Email Subject Email Body USER MEW OLD DATE IP ADDRESS AUDIT LOG URL DIFF ALL Dear NEW givenName
3. TOES al Change Ade Hew Cut Copy FPasl Delete Type to Biskit Version Number pd hi Name Property use etan sorting z a Label Lower patient inio jLabel Upper Fation inio 2 Lower patient info s iM Required Labets Upper Patent info 25 Y Visibie in Biskit Detail visiti in Biskit Li iul Value Label Read Only Lise default tht LO Visibhe ia Collection Editor Null Value Label Read Write Read write Use default aem Editable Persistent dull Avra c Change Biskit Det to Patent Info Aliows Deletion While Does mot allow detetion Referenced a 14 c Change iPrirnary Key Column Hame to ide kii Property Type stave To a Reference Deaton maak inverse Inverse Property Suitable properties found d Change Biskit Property Type to Slave To Masher 11 Press the Save Button There will be an error Save Despite Errors 2010 2015 Exprodo Software Exprodo Database User Documentation 12 Select the PatientInfo Biskit and press the Edit button to get back into edit mode 13 Select the Slave property a Change Bisket Def to Patientinfo2 b Change Biskit Property Type to Master To Slave c Change Inverse Property to Parent iene de Add New Cut Copy Paste Detete Version Number N E z 7 rf i P Frima Y Ke arion Number ot Pro
4. 7 os A il Vigibee in Biskit Dotai vi Visibie In Baskit Lisi il Visib e in Collection Editor nure 5 Press the Add New button to add a new property 2010 2015 Exprodo Software Exprodo DB Configuration Guide 207 a Choose p oeer ee ae b Give the Properties Add New Cut Copy Paste Delete projectCode description arag drag drag ifinish Sting drag Bool rg rag N TE as w i i e j 3 2 2 fe m 4 5 drag ring drag drag J drag String name String String Date String drag String Visible Editable Persistent Null Allowed Required v i Visible In Biskit Detail Visible In Biskit List Visible In Collection Editor String String Set ag wo T a pn 0 S M 0 a String ele ood Unconstrained 6 Update the meta properties of the property Most of them will not need to be changed but as a minimum a Decide on the Type required b Give the property a name this needs to be unique Exprodo DB will update the Label and Column Name meta properties at the same time Usually these can be left alone but Label may need to be modified as this is what is displayed for this property in reports etc c When a Biskit of type Project is created by a user is the user required to give th
5. Calendar Templates Bookings Projects Usage Search Help d Filet Search for Please select Please select Attachment Audit Log Authentication Method Automatic Email Automatic Email Child Multi Condition Once a Biskit Type is selected additional options will appear Calendar Templates Bookings Projects Usage Search Help 4 File Search for Resource Report type Group Report Conditions Columns Reset Go Autorun There are four report types List Summary Single Item and Group The user can also add conditions to the search not Single Item change the columns that are going to be viewed in the returned search not Summary or Single Item or reset the search conditions to the default not Single Item J his icon will toggle whether the File and Report Type options are available The Go button will run the current search set up Autorun if selected will automatically run new search set ups as they change so changing Columns Conditions Report Type and even what is being searched for will get the search to be re run as each setting is changed If searches are being done on large amounts of data or the user needs to make multiple changes between search runs it is more efficient if Autorun is not selected If at any time having made changes and Autorun is selected but a new search has not run then press the Go button 2010 2015 Exprodo Software
6. E Import project resource settings Notepad File Edit Format View Help project name resource name numberofsessions minutesPersession costPerHour Sun spots dry lab 10 60 400 Name Value Comments SunSpots Needs to match SunSpots Sun Spots name exactly dry lab resource name Physics Needs to match Number of Sessions Project name exactly Minutes per Session numberOfSessi Integer Cost Per Hour ons minutesPerSess a Integer ion 2010 2015 Exprodo Software Exprodo DB Administration Guide Example File For Importing A Time Template A Time Template is a Biskit Type used in Calpendo to store information about when bookings for resources can take place and how they can be automatically approved T uu E import template Notepad File Edit Format View Help temp lateGroup name resource name dateRange start dateRange finish enabled abdicated Free for all dry lab 15 May 2013 10 30 15 May 2013 15 00 true false The Template record that will be created from this file Name Value Comments NearTem TAMGroup Neartem of sd Pod date 15 May Date and Time Range start 2013 10 30 Enabled Fartem TAM Grup ___ d abdicated Date ___ SSSC d fabdicatea By id dateRange finis 15 May Date and Time h 2013 15 00 templateGroup Free for All Not set A A EE To import repeat Time Templates see below for additional information about importing repeat
7. NEW familyName Thank you for registering with Calpendo You will receive another email when the administrator has processed your request Please note that this may take up to 24 hours E 2010 2015 Exprodo Software 128 Exprodo Database User Documentation Example 3 Send Email To A User When New User Request Denied This example shows how to send an email to user who has just registered so the status is set to Requested but had their request denied so the status has changed to Denied 1 Create an Automatic Email that is triggered when a User is Updated equals Specified value Requested 3 Adda condition New Value is Denied Updated value of status equals Specified value Denied 4 Set Send To Subject Of Action to true Lond irons Recipients Email Subpect Email Hody 5 Enter the email s Subject ubject Email Body IP ADDRESS AUDIT LOG Calpendo user account denied 6 Enter the email s main content Conditions Recipients Email Subject En ail Body IP ADDRESS AUDIT LOG URL DIFF ALL Your name and or email address was not recognised by the Calpendo administrator Please contact the administrator if you believe this to be in error 2010 2015 Exprodo Software Exprodo DB Configuration Guide 129 4 5 Menu Editor Using the Menu Editor page the administrator can create modify and delete the menus that exist in Exprodo DB Once menus
8. When a Condition Type of Old Value is specified the property path will show all the properties of the type defined by the context s bisikit type and any properties that can be reached from those properties When the context bisikit type is set to a Resource clicking where it says Select a property shows this collectUsage inProgressChangeOption largeUsageRecorder laterChangeOption laterTermMinutes location name omiectRemured A Resource has a number of properties as shown One of them Location is itself an object that has properties of its own that can be selected As soon as you select a property from the drop down the Relation part of the condition will change from No property path selected to something appropriate for the property selected described further below Condition Type New Value A Condition Type of New Value is only available when a bisikit type has been specified and even then only in some contexts For an Automatic Email Permission or Booking Rule a Condition Type of New Value is only available for the Update action Selecting New Value means that the condition will be placed on the value of the property after the update has occurred The property path will display the same as for a Condition Type of Old Value 2010 2015 Exprodo Software 20 Exprodo Database User Documentation Condition Type Change A Condition Type of Change is available in the same contexts as New V
9. When editing an object if Exprodo applications can determine that Permissions prevent the user from changing a property then that property will be rendered in an unmodifiable form This will prevent the user from making changes that would only be rejected later Delete When deleting an object Delete action and Biskit Type Permissions are checked Run Report Run Report action Permissions are checked whenever a report is run This allows the administrator to prevent some types of report being run for example to stop some people from running summary or group reports or the Biskit Type being reported on for example to restrict reports about system usage or other things To control which reports somebody can run create a Run Report action Permission for the Biskit Type Report Then place conditions on which reports can be run Run Report Permissions for any Biskit Type other than Report will be ignored Dump Database Dump Database action Permissions are checked when trying to using the Database Backup page to generate a copy of all the data in the database Update Database Schema Checked when using the Bakery to modify the database schema for newly added dynamic properties 2010 2015 Exprodo Software 104 Exprodo Database User Documentation 4 3 2 The Permissions Editor The Permissions Editor shows all the Permissions and allows the user to create update and delete them By default it appears on the menu
10. button would insert details about the new user since they instigated the event that generated the email The New Value And Old Value Buttons f a Biskit Type of Any data type has been selected for this Automatic Email then these buttons cannot be used When a specific Biskit Type is selected then these buttons generate a pop up with properties that belong to that Biskit Type This means that they allow the insertion of text from the object that was created updated or deleted In the case of an update triggering the email then the New Value button is linked to the properties on the object after the change has taken place and the Old Value button is linked to the properties on the object before the change took place For date properties extract just the date or just the time to give more control over the content of the subject The example above is a special case since the Automatic Email is triggered by a User changing then this means that the New Value and Old Value buttons show the properties of a User just like the User button When the action triggering the email is either Create or Delete then the text inserted by the New Value and Old Value buttons will generate identical results The Date Button This inserts the text DATE and when the email is generated this inserts the date and time that the email is generated The IP Address Button This inserts the text IP ADDRESS and generates the ne
11. changed so that 2 displays as B and 3 displays as A and there is no mapping for 1 then there won t be a way to display a text value for 1 and there won t be a way to search for it 2010 2015 Exprodo Software 190 Exprodo Database User Documentation 4 9 3 4 1 1 Bit Sets A Bit Set is a BiskitDef integer property that uses a special sort of Mapped Integer To be used as a Bit Set a Mapped Integer must map integer values that are between 0 and 31 It doesn t need to map all 32 possible values but the values mapped must be within that range A Bit Set works by using binary values Each Bit Set has a particular value and when a number of bits have been set the value of the integer is the total of each of the individual bits values added up Bit fo 1 2 3 4 5 lef la 9 ho 41 12 f3 f4 45 i ai le ll e 4 4 8 Therefore if bits 1 5 and 7 are set the value is 162 2 32 128 Bit Sets allow the user to combine up to 32 options in any combination required In Exprodo DB we have one default bit set and that is for User Roles There can be as many Bit Sets as needed in the database Once the Bit Set is created as a Mapped Integer to use it create an integer property on a BiskitDef and set its Integer Type to be Bit Set and chose the Mapped Integer that has been created Integer Type Bit Set Mapped Int Default Value isola CancellationReason 4 9 3 4 1 2 User Roles There is a special Mapped Integ
12. t Creat Any type Create An automatic email that is triggered when data of any type is created It s shown in red because it is currently disabled Something created Delete Something deleted Update Something updated User Create New user request to admin New user request wait Update User accepted reset password User accepted An automatic email called User account blocked that is triqgered when a user is updated User account blocked User request denied System Event Create Exception to email An automatic email that i is triggered when a Project System Event is created Create ji Project requests Update Project accepted Once all the items in the tree are viewable the emails in their Biskit Type Action Automatic Email categorisation will be seen with any that are disabled shown in red The tree shown here shows fourteen Automatic Emails four of which are disabled and so are shown in red The first one shown under User called New user request to admin is an Automatic Email that is triggered when a user is created This doesn t mean that an email will actually be sent because the Automatic Email may have conditions that need to be checked In this case it has a condition that checks 2010 2015 Exprodo Software ons Exprodo Database User Documentation whether the user s status is Requested although you can t tell that without clicking
13. 2 The right pane is split into three areas a Top is the layout menu and the header information for the current layout Top Pane b Bottom left shows the organisation of the Property Groups and properties for this layout in the form of a tree Organisation Pane c Bottom right displays information depending on what is selected in the organisation tree in the bottom left pane Information Pane i fa Property Group is selected then the header information for that Property Group is viewed along with any properties assigned to that Property Group li Ifa Properties branch is selected then the properties are shown in a list lil If a Single property is selected then information about that property will be shown Refresh Open AIl Close AIl Cancel Save Preview TestSubject Test Subject Layout Visit1 Visit 1 Layout Visit2 Visit3 Visit4 eson ft Depayed Nps Enabled Layout Header Unassigned Properties Display Location Show In Main Table 7 Information Created dB Apr 2015 11 09 8 Apr 2015 11 09 A W E soa Add New Add New Child Cut Copy Paste Delete Snow Cell CSS Editors Properties 6 Unassigned Properties 0 ae Depression Tree showing property groups Sleep and properties Heading Properties 0 PSQI Property Table Type Simple Table v PSQI Totals Properties 8 Displayed information of the item selectedin i the tree
14. 4 2 Configuring Types And Groups The Types And Groups Editor is used to configure the types and groups in the system Before reading more about how to configure them please take a look at which describes what a type and a group is and how an item can have exactly one type but may be a member of many groups including zero When it comes to configuring types and groups in Exprodo DB consider first whether there is a good way to categorise the users such that they each fall into precisely one category For example distinguish between students staff and external users using that for the user type Types are used to control Permissions Automatic Emails P and Manual Emails Types And Groups Editor The Types and Groups Editor page consists of three parts 1 The menu tool bar this is the tool bar at the top of the page and all the buttons operate on all types and groups at a time 2 The left pane this allows the selection of a type or group or an item within a type or group 3 The right pane this shows the detail of the currently selected type or group item Refresh Open AIl Close All User Type User Group Booking Type Project Type Project Group Resource Type Resource Group For aco mpete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter 2010 2015 Exprodo Software Exprodo DB Configuration Guide 95 The List View By clicking on one o
15. Exprodo Database EXorodo DB Online Web Database User Manual October 2015 Exprodo Database 7 0 52 2010 2015 Exprodo Software Contents Table of Contents Foreword 0 Part Getting Started 8 Part ll Exprodo DB User Guide 10 24 Getting A USer ACCOUNT acisre nea a Aa aN a AEN aN ESA 10 2 2 Change PassWord aoni a a a Minty A ee N Ea teas mete ua 13 2 3 Ur SENINGS rrii a a a sin siepinntenaamemueudun 14 23A Date amp TIME sete es astsctantecew ase i aa a a a 14 29 p Bnal aen E a E a E ee Ee nO eee eee 14 2939 M n souin a a a a eT ae ee eee eee 14 2 4 Toolbar Button Standard Definitions cccceeeeeee sence eee eee eeeeeeeeeneneeeeaeaeesesesneneneeaeaes 15 2 9 CONGIU ONS ssi adaa a metal E a S a slid a ual aa 17 2 6 SG arching For Normat ssn a ae aa a a acta E 27 PA 3 ie 1 RRR Ro Pa Ro AC ER RA Rea rR 27 2 6TA SINGIOHEI RE BOM eonna naa A sammanamcmacnmeeanetaresdaucensas 28 20 1 2 OSC REDON eu i N A aie Rial N 28 2013 Summa REDO Dee N a E N 31 DB VA GURDO aaa a ah acted State ait ol A AA 34 2 6 1 5 Editing Search nf OF MANO se9 c scar 6 820 2en25cteceacoueguceveunsaceteteteasiagaseustorsee he a a e e 36 2 6 1 6 Saving And Reusing Searches sence aad te a EEEa a REE 38 2 6 2 Report Manager rre e E emer te crt ete rene reece ee 40 PA E a E e a A E E A EN AA E else A A S A E A T A A E 45 DAG A DCA OU OI a E E A te chan A S A EA A E E N E E 46 21 Web Browser Compa tality ccno a a a ab ebewe wees 52 P
16. The particular Mapped String that constrains the value must be specified The value will be the type of a BiskitDef and so will be Biskit Type configured as a drop down listing all the known Biskit Types 4 9 3 7 1 Mapped Strings A Mapped String is similar in concept to a Mapped Integer but instead of storing an integer in the database a text value is stored instead This means that a Mapped String is a mapping from one set of strings to another set of strings When a String property created ona BiskitDef you can indicate that it should be constrained to contain values from a Mapped String Then when a user edits such a property they will see a drop down that lists the labels defined in the Mapped String although the value stored in the database will be the associated text value Mapped Strings are similar to String Enumerations P in that they both store values as text and they both generate a drop down selection list Mapped Strings are the preferred mechanism though because by decoupling the displayed labels from the values stored in the database it makes things very easy it you ever want to change the way values are displayed to users This is why String Enumerations are deprecated and may be removed in a future version of Exprodo DB Here is an example of a Mapped String defined in the database Mapped Int Null Value Label Mapped String BorderStyle T Values DateFormat DateT
17. or Choose File to select the file to import At this point Exprodo DB will attempt to decide which Biskit Type is being imported from the header information If it cannot determine the Biskit Type the user will need to select it can import usertxt Choose new file Biskit type Selectimportbiskittype Update Existing Data lt Preview Impor Once the Import page knows which Biskit Type it is importing it will look like this import usertxt Choose new fle Biskit type User Update Existing Data Preview Import Import At this point decide whether to choose to Update Existing Data or Insert New data If updating data then import needs to know which columns to use as the key fields to find the appropriate records to update Click on the Key option below the column headings of those properties 2 that are keys fields or put Key before the property name in the file In this example for importing User data the key is specified to be the combination of userldentity loginName and userldentity authenticationMethod name as the combination of these two will be unique import user txt Choose new file t t User Update Existing Data v Preview Import a 2010 2015 Exprodo Software Exprodo DB Administration Guide 83 In this example for importing User data Insert New Data has been chosen the Key option
18. projectResource Settings costPerHour durationInMinutes 60 else case when datediff dateRange start cancelled gt 7 then 0 when datediff dateRange start cancelled gt 2 then 0 2 projectResourceSettings costPerHour durationInMinutes 60 else 0 5 projectResource Settings costPerHour durationInMinutes 60 end end status will refer to a property called status found on the Booking Biskit projectResource Settings costPerHour will refer to a property called costPerHour that is found on the Biskit that is referenced by the projectResourceSettings property of the Booking Biskit In this case the type of Biskit referenced is Project Resource Settings durationInMinutes will refer to a property called durationInMinutes found on the Booking Biskit dateRange start will refer to a property called dateRange found on the Booking Biskit dateRange is of type DateRange this type has some sub types one of which is start start holds the date and time of the start of the date range cancelled will refer to a property called cancelled found on the Booking Biskit datediff is a MySQL function that returns the difference between two dates as a whole number of days For more accurate time differences use a combination of time diff and time_to_sec i e time_to_sec timediff date1 date2 returns the number of seconds between the two dates We will be using the costPerHour property that can be set up for each re
19. see Web Browser Compatibilit for the full list The administrator should have told you the address of the Exprodo DB When Exprodo DB is started the opening screen will look something like this Exprodo DB Version 0 12a Username Password Login Register new user Press the Register new user button to see the New User Registration form shown here New User Registration Username Password re Frans UserType Please select a User Type Cancel Register 2010 2015 Exprodo Software Exprodo DB User Guide 11 Enter the desired login name which can consist of letters numbers and other characters such as Enter the password that is required by the user with conformation then enter the given name usually the first name and family name usually the last name Finally enter the required email address It is important that the email address is entered correctly because Exprodo DB will send an email to confirm it has received the registration request and again to inform when or if the request has been approved and the user can log in If User Types have been configured you will need to choose one Depending on how Exprodo DB has been configured other information may need to be selected When all values are entered press the Register button lf the requested login name password and email address are acceptable then a message like this will appear The page at https demo calpend
20. 1 Simple Table i Does the property benefit from any Heading of the following guarantees or Pary Tae Toe A Information in a Simple Table will be displayed with the property label and the property value 2 Radio Button Table Property Grouping Method Captions C Not Appticabiel Yes No CeT Fe ites oven ana gril ited micowave_ JoJo CO o_o gt Fragereeze Jo 1 Freee A I E Ze 7 A wasng machine V S Information in a Radio Button Table is displayed showing the property labels and then a choice of values This type of table is limited to the following a All properties must be of the same type b They must be one of the following types Biskit valued li Mapped Integer lil Mapped String 2010 2015 Exprodo Software Statutory Registers false I Horizontal Tabs Name Hidden Property Grouping Method Multi Column Table v Show Custom Row Labels He i Number of Property Columns 2 Show Column Headings W Centre M Right lz Editable Column Custom editable Local Authority Landfill Sites within Local_Authority_Landfil_Sites_260 Local_Authority_Lanafil_sites 600 E a L Q Column Label Alignment Row Label Alignment yf 9 a a lt Zi a j w o D a E Waste Treatment and Disposa Waste_Treatment_and_Disposal_250 Waste_Treatment_and_Disposal_500 Pollution Sites Pollution_Sites_250 Pollution_S
21. 4 D owner u Choose files to import as attachments irt 7 G finish 7 G finish 8 H Attachment name ey R Normal Normal import Booking txt Done alj Normal Normal ey R ignore Ignore s Import template txt Done re Ignore ignore ose Files No file chosen OK Handling Import File Errors During the import process there are three main types of errors 1 Incorrect property names or labels in the header of the import file Header errors 2 Incorrect data in a record stopping Import from resolving property values Data Errors 3 Failure to import due to internal checking Violation errors a Incorrect data in a record causing Permissions to fail to allow creation of records e g password too short b Permissions failing to allow creation or updating of records 2010 2015 Exprodo Software e Exprodo Database User Documentation Header Errors Header errors are found when the import file is first loaded using the Send button Once Import has decided on the Biskit Type being imported or the user has selected the correct Biskit Type the header information is loaded If any of the headers cannot be resolved to property names or property labels in a case insensitive manner if possible then those headers are marked in red A pop up will inform the user how many column headings have not been recognised Import then updates those columns from Normal to Ignore so the user can proceed with the im
22. Automatic Emails A project may belong to many groups See also Project Type A Calpendo concept creating a list of resources that a project may use with project specific information for that resource A Calpendo concept showing the current status of a Project Type Property Property Path References Relation Repeat Requested Booking Resource Settings Single Item Report Summary Report System Event system Usage Statistics Task Time Template Units User Approval Process User Group 252 Exprodo Database User Documentation project This can be Requested Approved Denied Unbookable or Terminated A Calpendo concept grouping similar projects amp together A project has only one type See also Project Group An individual piece of data attached to a Biskit A property will have a name a type and a label as well as other meta properties defining how it is organised When adding a property to a report or placing a condition ona property z you can choose a property of a prop property This is known as aproperty path For example if you want a Permission to prevent creating reports that are scheduled to run daily you would need a condition on the the report schedule s repeat type This is found in the property path reportSchedule repeat repeatType Biskit properties may have various types such as integer and string One such type is Biskit which
23. DB http localhost 8080 DB The above configuration should be placed inside a VirtualHost declaration If you want to provide both SSL and non SSL access to Exprodo DB then you should place the above configuration in both the SSL and non SSL VirtualHost areas At this point accessing Exprodo DB from https vourServer DB should work possibly unless you are using an operating system that uses SELinux as described below Note that previous versions of this installation guide differed in two ways from the above e Previously it was suggested that you should use mod_jk to connect Apache HT TP server with your servlet container Such as Apache Tomcat This is no longer recommended In particular mod_jk isn t available for recent versions of Red Hat Linux and CentOS That is why the above recommended Apache configuration uses mod_proxy_http 2010 2015 Exprodo Software 246 Exprodo Database User Documentation e t used to be a requirement that http access was required at least from localhost even when you only wanted https access to be remotely accessible This requirement no longer exists so you only need to configure the SSL VirtualHost with the above directives if you only want to provide SSL access SELinux Settings lf you are running a version of Linux that uses SELinux then you may find that your Apache HTTP server is prevented from opening further http connections thereby stopping the above from working You can check
24. Permissions Editor 104 User Role Editing Role Definition 190 Positive and Negative 100 Root Role Precedence Of 99 Introduction To 54 Targeting Users 101 Tree 105 S Preferences Global 143 Search Property Comples Content Types 32 Biskit Property Definitions 185 Editing Search Information 36 BiskitPropertyType 185 193 Exporting Information 39 Boolean Property Definitions 186 General Search 27 Double Property Definitions 187 Group Report 34 Integer Property Definitions 188 List Report 28 Integer Type 188 Saving And Reusing 38 Java Enum 191 Summary Report 31 Java Enum Property Definitions 191 Layout Editor 156 Security NUN Allowed 184 Brutce Force Password Hacking Preference Project 184 Setting For 153 Property Definitions 180 Global Preferences For 152 Searching 27 2010 2015 Exprodo Software 260 Exprodo Database User Documentation Security Time Between Flushes Preference For 154 Password Requirements Preference Setting For Time Per Statistic Preference For 154 152 User Password Allowing Browser To Remember Administration 54 Preference Setting For 152 Approving New Users 57 Single Sign On 140 Approving Or Denying 58 Statistics Changing Group Membership 61 Network Metrics Enabled Preference For 151 Changing More Than The Status 59 Network Metrics Minutes Between Sending Creating An Account 10 Preference For 151 Network Metrics Network Calls Between Sending Preference For 151 Usage Statistics Enab
25. again with no other changes another error would occur this time an invalid email for the third record In order to fix these types of errors go back to the original import document and fix them there before loading it back into the Import page Remember once the file to be imported has been updated save it before reloading the file into Exprodo DB Import 2010 2015 Exprodo Software Exprodo DB Administration Guide 89 3 5 System Events The System Events p Page provides a convenient way to search for and display Exprodo DB s record of events such as people logging in or emails being sent It is recommended that only those who administer Exprodo DB should have this added to their menu To access the Systems Events page it is found on the Admin menu However the administrator may have configured Exprodo DB so that the menu is different The Systems Events page is very similar to the Search page The events returned can be filtered by time type source and category Unlike other Search pages there is no auto run option When the page opens up it looks like the following Type Source B Category Go 2a W Biskit Validation Z Vi trace vi EmailNotifier 02 May 2013 00 00 F 02 May 2013 23 59 Choose the start date Choose the end date 9 had Bice evel F Booi and time for the system and time for the system Fine Pe arie ETA events Beene Minto Wi ExprodoServiceim
26. d Change DOE Biskit Property Somsen soe i a Type to Many To One Default Value 3 i 7 Press the Save button There will be an error Check the error by pressing Show Log If the error is complaining about a no inversePropertyName being set press the OK button and then the Save Despite Errors button 2010 2015 Exprodo Software Exprodo Database User Documentation 8 Select the Project BiskitDef press the Edit button to get back into edit mode 9 In Properties Add New a Change Type to Set b Change Name to attachments c Change Biskit Def to Project Attachment d Change Biskit Property Type to One To Many e Change Inverse Property to Project Properties Add New Cut Copy Paste Delete Name rye type drag staus JavaEnum crag sescrpton fS aragi resourcesettings set liorag stat_ fragrans oae uses fse crag princirannvestgaror sna erag piprone smag iraorfpieman fsm __ ioraa g 3 A g S 3 Ad A A A A g ji New attachments Property c Change Biskit Def to Project Attachment d Change Biskit Property Type to One To Man e Change Inverse Property to Project 10 Press the Save button and this should save without an error a Change Type to Set O Gi J I 23 D lt A 2 z E b Change E ige attachments id fase
27. gt Properties Visible In A Biskit List explains how to change the properties that are displayed in a list of items Change the visibility of each of the properties defined on an item gt Properties Visible In Biskit Detail explains how to change the properties that are displayed when seeing a detailed view of an item In this case it affects both the read only and editable mode detailed view of an item Again change the visibility of each of the properties defined on an item gt Properties Visible In A Collection Editor explains how to change the properties that are displayed in collection editors For example if there is a Project Biskit Type that contains a list of users then the user can change which properties are shown to represent those users in the Project s list of users 2010 2015 Exprodo Software Exprodo Database User Documentation 3 1 7 Changing A User s Settings A user can change their own settings as described in User Settings in the Exprodo DB User Guide Sometimes however the administrator may want to edit another user s settings This can be desirable if some users do not have permission to modify all of their settings For example Exprodo DB may have been configured so that a regular user cannot choose which menu they use whereas an administrator may have permission to do so The menu is one of the properties of a user s Settings 9 Page For Editing Another User s Settings Curre
28. property e g project status Where e css class is the CSS class to be applied to the top level e the initial flags are o flags to indicate the overall behaviour of the search H horizontal button bar vertical panel F Form like container that displays each item with a heading in the line above the search item G Growing form displays like a form but can be hidden or shown by ticking a checkbox 2010 2015 Exprodo Software 136 Exprodo Database User Documentation E Expanding a container showing a checkbox for each item where clicking the checkbox will open up the search item C Captions around each of the items in the container F Form labels above each widget o flags to indicate the default size of items Note that these can be overridden by size flags placed on each item S Small widgets in this container should be small size by default L Large widgets in this container should be full size by default o Sorting flags No flag means items are presented in the order specified and when using the A flag their natural order T sort all items in this container by their text label O sort all items in this container by their bakery assigned order o Miscellaneous flags A automatically add items for all known properties not added elsewhere e item flags define the size o S small minimal widgets in a row o L large widgets taking full size the whole time Exa
29. the Recipients tab looks like this send To User Performing send To Subject Of Action false Indwidual Users Please select a Userto add r Selection empty User Types Please select a User Type to add w Selection empty send To User Performing i Action jilg User Groups cend To Subject Of Action Please select a User Group to add Y selection empty Individual Users This automatic email has no individual users associated with it iea Paes User with all of the selected roles User Types This automatic email has no user types associated with it L Root He C Admin C User User Groups Aa This automatic email has no user groups associated with it m Property Path To User s User Typefs or User Groups rare This automatic email has no user roles associated with it sc BUSS De Property Path Property Path To User s User Type s or User Groupis Delete No recipients to be derived from the object in question Send To Subject Of Action This option is only applicable when the data whose change triggered the Automatic Email is itself a User User Group lt 2 or User Type When setting this option to true and triggered by a change to a User then the changed user will receive an email This means that when a User is modified for example to change their status
30. the default value of a property displayed with a drop down with Null Allowed set to true will be null since that is the first value shown in the drop down However if a property is set to Required then a value must be provided it cannot be saved without a non null value For properties that have Required and Null Allowed both set to true this means that the user is forced to choose one of the values from the drop down as the default value of null cannot be left as the current value A drop down for a property that is Required but for which Null Allowed is false would be built without a value representing null and so the user would not be forced to choose Instead the first value in the drop down would be automatically selected unless a choice is made by the user For string properties an empty string is a non null value and so will satisfy Required In order to make sure the user can not do this set a minimum length for strings where you want to make sure they enter something Large Numbers Of Properties And Tab Layout If you are adding a large number of properties to a Biskit and wish them to be displayed in particular groups under specific tab names then use the Group meta property All properties with the same Group meta property will be displayed under the same tab which will be labelled with the value of the Group meta property unless a layout has been defined for this Biskit in the Layout Editor The Project Biskit will always use
31. tor Targeting Users For each Permission choose which users it will affect However it s sometimes easier to say who a Permission shouldn t affect or to say that it s everybody meeting some criteria apart from those that meet some other criteria So Exprodo applications allows the specification of the users a Permission applies to as well as those it does not apply to The affected users will be everybody the Permission applies to that are not amongst those it does not apply to Within each of the applies to and does not apply to sections identify users by employing one or more of the following methods e Name individual users or user groups e Specify users by the roles they have e Specify a property on the object being controlled that will identify a user or user group This last item specifying a property that identifies a user or user group needs more explanation For example a Calpendo booking has an owner that is the user that owns the booking a booker that is the user that created the booking and a project Each project also has an owner and users Consequently when writing a Permission that affects a booking users can be targeted by using any of the properties owner booker project owner and project users The blue circle shows The black circle shows users specified by the a N users specified by the Apples To parrot amp i Does Mot Apply To the permission 1 y part ofthe permission The
32. 2015 Exprodo Software Exprodo DB User Guide 33 File Search for Booking Report type Summary Report E Conditions Reset Row resource name Scale the result by a Pokaan monina User defined factor Round the Contant Sum x durationinMinutes LC Scaled C Rounded results to integers Go Property to be calculated eect nena maging neri light bumm radiation the final rrontier Total ee S E a o lewens o d e d d d asl a e fe e d ee S S S B T CE ovo a A e E E 21234 Use the Rounded option to round numbers to integers Use the Scaled option to scale the results by the user requested factor i e if the scaling factor is 10 divides all results by 10 Viewing Records Records associated with each cell can be viewed by clicking on the number in the cell This will give a List Report of the records for that cell beneath the table File F Search for Resource Report type Summary Report Conditions Reset Row locaton name Column proectRequired Content Count F Sealed Resources where location name planet earth and projectRequired PFROJECT_ REQUIRED Name Jtocation type Project Required conect Actual Usage a a eI C 2 fperet earnf samel Prjeet nears fre n ES rE Edit Delete As with the List Repornt clicking on an individual record will give an expanded view of that record below the list lf
33. 28 Exprodo Database User Documentation 2 6 1 1 2 6 1 2 Single Item Report Shows the result of the search as a single record 4 File Search for User Report type Single Item Report Timb Tim Bilder x Go Users where id equals 32 Edit Create Create copy Delete References History Type in here to get Drop down to choose single matching rice i fuserte Password Version id SCS created SS dA Feb UIST _ _ 4 Feb 2015 11 17 4 Feb 2015 11 17 Requested Project Code s Either use the drop down to get a full list of possible options to be scrolled through or type in the input box to get a shortened list of possible matching objects lf the user has the correct permissions they may edit the individual records or make changes to multiple records All of this will be covered in the chapter on Editing Search Information List Report Shows the result of the search as a list of records File Search for Resource Report type List Report Conditions Columns Reset Go V Autorun Found amp resources F i Th L i re i Name _ tecation Type _ Project Required g 3 i f t 1 7 i l J planet eann a vetted pienet eartn Scanner Project Required ive scann Scanner Project Requires uve ubject Room r Notices Project Required true ip ajal E ajal E ajaj E i Ed Del
34. A default installation comes with no types and no groups If your installation does use User Types then when a user registers they will be asked what their type is An administrator can override that and change it when they approve the user but the user will always have a single type When users have types then the type can be used for Permissions Automatic Emails and Manual Emails Use User Types if there is some logical separation of users that fits the notion of a user having precisely one type For example it may be that there are multiple departments in your company with everybody belonging to only one department If that were the case then perhaps have as many User Types as there are departments User Groups can also be used for Permissions Automatic Emails and Manual Emails the same as for types However there is greater flexibility due to the way a user can belong to multiple groups or no groups So while a user s type may indicate their department or whatever groups could be created that reflect any sort of grouping that makes sense in your situation Given this apparent flexibility in groups one might ask what the point of types is The answer is that it is sometimes useful to have a taxonomy in which you know every user has a type whereas a user may belong to no groups at all See also Configuring Types And Groups 2010 2015 Exprodo Software 94 Exprodo Database User Documentation
35. Biskits button to check the database Biskits b Press Reload Database Configuration to load the new database into Exprodo DB c Refresh the browser Remember if adding a large number of properties to a Biskit and they need to be displayed in particular groups under specific tab names then use the Group meta property All properties with the same Group meta property will be displayed under the same tab which will be labelled with the value of the Group meta property unless a layout has been defined for this Biskit in the Layout Editor The Project Biskit will always use Group for its layout General es Project Resource Settings Professer Sign Off false Users Accounts Liason n onesmo wae ta Project Groups 2010 2015 Exprodo Software Exprodo DB Configuration Guide 209 4 9 5 1 2 Adding Formulaic Properties An example of adding a formulaic property to the Biskit of type Booking which will be called BookingCost and will calculate the cost of the booking depending on the duration of the booking and whether it was cancelled or not lf a booking was Denied or Cancelled more than 7 days before it was due then no cost If it was Cancelled more than 2 but less than 7 days ago then 20 of cost if it was Cancelled with less than 2 days to go then 50 of the cost otherwise full cost The formula used will be case when status DENIED then 0 when status APPROVED or status REQUESTED then
36. Cpe ienser fien fiese fiereso com eoar froma 2 fuzo 1521 funa _ i Edit Delete Approve Deny Block Force password reset Add To Group Remove From Group Edit Create Create copy Delete References History 2010 2015 Exprodo Software Exprodo DB User Guide How To Edit Multiple Items At Once You can edit many items in one go quite easily using the check boxes and the checked button bar as follows 1 Tick the check boxes next to each item to be changed or tick the box in the header row to tick all boxes Calendar Templates Bookings Proje Tick the check box in ee the top row to tick all p fre fee Nothing selected ne d Root Admin User or untick all users root Guest rok admin Admin User Guest admin Admin User Guest User Guest Tick the check box Sl a a ee C feae frenn Teer sues z S a r Led E hubbie hubble Thiz ts the regular This is the checked a button bar The check m mend mendel bar You can press the boxes do not affect it pal buttons to apply the action to You must select a row all checked items In the table rather thar Ee a check box for most of E Edit Delete the buttons here 3 Once one or more check boxes have been ticked the checked button bar will change so it is no longer greyed out Press the Edit button to edit all the ticked items 4 When you press the Edit button a pop up appears showing most of the properties
37. For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Edit Create Create copy Delete References History Edit Create Create copy Delete Cu References History Paul amp Clare s group eu fesa Romson care ome mamy Booking Type User Group Types and Groups appear slightly differently Types are just a list of the properties 2 that can be changed A group has that list but also a list of all the appropriate items that are in its group For instance a User Group will have a list of all the logins associated with that group Once in edit mode edit any properties with permission to access and add or delete items from group lists Cancel Save Paul amp Clare s group Edit individual properties Add items to Please select a User to add J the group list Lilian nae oven name omer name ramty name lomm Remove selected tems from the group To remove items from the list first select the items to be removed using the check box and click the Remove button To add items to the list use the pull down to get a full list of possible items and select the one required 2010 2015 Exprodo Software Exprodo DB Configuration Guide Permissions are designed to be very flexible so that you have fine grained control over who can per
38. Minutes Between Sending Metrics Setting Description Network Metrics If this is set to true then network metrics will be kept otherwise Enabled they will not Note that by setting this to false statistics that are already in the database will not be affected Only new information will be affected by this setting Enabling Network Metrics will slow down Exprodo DB a little Number Of Indicates how many network calls each web browser much make Network Calls before sending its network metric information to the server The larger Between this number is the fewer network calls will be created as an Sending Metrics overhead However larger numbers increase the greater the memory requirements and also increase the amount of data that will be lost when the user closes their browser This is because outstanding information collected by the browser but not sent to the server is not sent when the browser it closed This is the period of time between sending metrics to the server This Minutes Between is only used during periods of low activity when you have some sending Metrics information to send to the server but you are not active enough to reach the Number Of Network Calls Between Sending Metrics lf Network Metrics are enabled the data will be stored in the database In order to access the data use Search Once in the Search page set the Search Biskit Type to Network Metric as there could be a lot of information to be
39. Normal Normal Normal a Ignore Ignore Ignore ignore ignore Ignore Ignore Ignore Ignore No problems No problems No problems No problems No problems No problems No problems No problems No problems Timb oca Tim Bilder Norma Physicist timb conaptic com timbli Import Result Detail Import Result Error 2__ 1 Could not create user Login name Timb is not available Error 3_ 1 Could not create user Your password must be at least 6 characters long ok lf there are errors a pop up will appear use the Show Log button to show a complete list of the errors Records with an error will have their record number highlighted in red Moving the cursor over a record number with an error will result in a tool tip coming up describing the error The error log just shows the records that failed to import and a reason for that failure If there are two violation reasons that will cause a record to fail only one is found and when fixed the second reason will cause a failure next time around This is because the Permissions are run until one fails and the rest are then ignored In the example above the third record has both a password that is too short and an illegal email address but only the short password has been found the illegal email address has been found for the second record but not the third So after fixing the password for the third record and the email address for the second record if an attempt was made to import the file
40. P the targeted users are those users covered by the Applies To tab that are not also covered by the Does Not Apply To tab Individual Users This allows the specification of particular users that the Permission should apply to User Groups The Permission will apply to any user in the specified groups Property Path A Permission property path works exactly the same as the property path in an Automatic Email and it is described more fully in that section The property path is a property or list of properties that lead from the Biskit Type defined on the Permission to a user or user group and those users will also have the Permission applied to them User Roles Users can have multiple roles Any number of roles can be selected by ticking the check box next to the role and then choose with the drop down whether the Permission is to apply to users that have all of the selected roles or users that have any of the selected roles 2010 2015 Exprodo Software 108 Exprodo Database User Documentation 4 3 3 The Does Not Apply To Tab This tab is almost identical to the Applies To tab The only difference is that the check box at the start is labelled Exclude Nobody instead of Include Everybody When ticked it means that no users are taken away from the Applies To list of users and so the rest of the Does Not Apply To tab will be hidden When unticked the users that should not be targeted are selected Exampl
41. Search Child property groups of the main layout displayed as Vertical T abs 2010 2015 Exprodo Software Property Information Form _ All available guarantees warranties and supporting paperwork should be provided Leasehold Information Form Boundries Disputes Notices Planning Council Tax Environmental Arrangements excha Property group nge of contracte i Child property groups of Guarantees dsplayed as Caption Layout Heading Information STI for Horizontal Tab Guarantees Does the property benefit from any of the following guarantees or warranties If yes Property group Heading Information for Caption 5 1 Properties assigned to 5 1 laid out as a simple table m If yes give details srjajgqsclft Child property groups of Guarantees dsplayed as Caption Layout T 52 a Properties i assigned to 5 1 ANy claims be made under lad alk asa any warranty simple table 160 Exprodo Database User Documentation Organisation Pane El House Buying Layout Ad Layout is ges Hame amp Properties 6 Unassigned Properties 0 Property Details Properties nat assigned E Property Information Form Properties 0 Boundries Disputes Notices amp Planning Child property Guarantees group of House Buying Layout 2 Properties 0 a 57 Child property group of Guarantees 6 Properties 1U Properties branch Ne
42. String The name of the property that should be used to hold the last modified date and time of the Biskit Only those properties of type Datetime with an Automated Property Type of Update or Create amp Update will be used String The name of the property that should be used to hold the creator of the Biskit Only those properties of type Biskit with Biskit Def set to User with an Automated Property Type of Create or Create amp Update will be used String The name of the property that should be used to hold the updator of the Biskit Only those properties of type Biskit with Biskit Def set to User with an Automated Property Type of Update or Create amp Update will be used Lets the user specify a format for representing the Biskit Format String when there isn t a single property that contains the name See below for more details Abstract Boden True if there can be no instances of this Biskit Type only instances of subtypes Paumerble Boden True if there are likely to be a large number of Biskits of this type too many for display in a list 2010 2015 Exprodo Software Exprodo DB Configuration Guide 177 some Biskits represent a hierarchy For example there might be a Location Biskit where the Location Oxford is a child of the Location England which is a child of United Kingdom which is a child of Europe A hierarchy is a Biskit that has a property containing a Biskit of the same typ
43. T Paraisten a Change BisketDef to Organisation sttribute er b Change Biskit Property Type to One F Visible In Biskit Detal To Many Visible In Biskit List Visible In Oolhection Editor c Change Inverse Property to Parent f a O a Change Bisket Sas Def to Organisation oma Tyee comet B Property Type to Soa Une To Many One to Many c Change Inverse Inverse Property Property to Parent 14 Change the Hierarchy Property meta property of the Organisation Biskit to be children 15 Press the Save button 16 If there are no errors the database will need to be updated a Press Update DB Schema to implement changes in the DB and then run the script to apply the changes b Press Validate Biskits button to check the database Biskits c Press Reload Database Configuration to load the new database into Exprodo DB d Refresh the browser 2010 2015 Exprodo Software Exprodo DB Configuration Guide 229 4 9 5 1 9 Creating AMaster Slave Biskit Relationship An example of creating a Master Slave Biskit relationship This type of relationship is needed if there are going to be a large number of pieces of data to be stored in effectively one table MySQL has a limit of about 1000 columns to a table so if more are needed Biskits that are completely linked together will need to be created Where if a record is created in one an equivalent record will be created in the other and they wil
44. any IP Address M Usage Session ID Template Usage id Once in edit mode the changes can be made T Mia Required Project Required jRequire Reason for Cancellations O 3 ae Fousze i l eseeton El B E M Usage Session ID Template Insert Value Usage id 2010 2015 Exprodo Software 38 Exprodo Database User Documentation 2 6 1 6 Saving And Reusing Searches Once a search has been created that is useful the user may wish to save it for later use This can be done using the drop down button from the File option on the toolbar and wea Save As This will save the search as a report accessible from the Search gt Reports page Using the File option the user can also load saved searches to run them edit the properties of any saved searches and export search information to a file called report csv File Search for Resource Load P Resource gt My Report SS Jeeves foe planet earth Harmar ow I L_I Il A LLI F r When a search has been created use the File gt Save As to save the search Give it a Name decide whether the search is accessible to all users System Wide and whether anyone can edit the search Publicly Modifiable Then save the search File Search for Resource File Search for Resource Ri Cancel Save Cancel Apply Save When a search is saved it can be reloaded using File gt Load If a se
45. are created a menu can be assigned to a user either by relying on the gobal preferences for new users see the Menus tab of Global Preferences _or by manually selecting the menu for particular users see Changing A User s Settings allowing menus to be set up by the users role or on a user by user basis There are many different types of pages that can be added to a users menu They include but are not limited to Customised search or data explorer pages Customised calendar pages using bookmarks Pages that open up web pages external to Exprodo DB Running predefined reports Pages normally found only on the Admin menu D ae ww NN a Customised Biskit editor pages The Menu Editor page consists of four parts 1 The menu tool bar this is the tool bar at the top of the page and all the buttons operate on whole menus at a time 2 The menu item tool bar this is the tool bar at the bottom of the page and all the buttons operate on single items within a menu 3 The left pane this shows the content of the currently selected menu 4 The right pane this shows the detail of the currently selected menu item cabria Temples Feo Riess Projects Jesh Search Admin Hepp Manu Edho admin Rage pagseced Satins Signi Saa Relesh Weer menu Open all New Delete Guptecate install Rename Cat Copy ia Delete Up Deven Hew tem 2010 2015 Exprodo Software 130 Exprodo Database User Document
46. are left centre or right justified Alignment Row Label Defines whether the row labels are left centre or right justified Alignment Adds a new empty cell after the current cell Useful for filling out tables which have a variable number of rows Information in a Multi Column Table will be displayed with the property label and the property value If multiple columns are being displayed only the labels of the properties required for the number of rows being used will be displayed 2010 2015 Exprodo Software Exprodo DB Configuration Guide 167 4 Custom HTML Enable building of a table structure using HTML Property Grouping Method Horizontal Tabs Has the property ever sutftered from any of the following 2 Property Table Type Custom HTML lx lt table gt lt TE gt lt th gt lt div id Suffered Flooding 1 label gt lt th gt sata lt th gt lt div id Suffered Rising Damp label gt lt th gt lt tr gt attribute lt td gt lt div id Suffered Flooding 1 value gt lt td gt lt td gt lt div id Suffered Rising Damp value gt lt td gt a lt table gt ae Other Display Options Boolean properties have additional options click on the property to get Property Def Suffered Flooding i Boolean False Text The display type can be either a list box or a check box and the user can define the text to be used for True False and Null Biskit properties have additional options cli
47. as required and they are normally associated with setting up Permissions as required for your facility See User Roles in the Bakery section of the Exprodo DB Configuration Guide for how add new roles Users with the Root role have the following special properties e Permissions are not checked Permission is always granted e They are allowed to log in even while the licence has expired This allows you to recover such situations once you have a new licence e They can change the status of a user to make them active for example by changing the status from Blocked to Normal even if it means there will be more active users than the licence allows However this may not be a good thing to do since only Root would then be able to use the system e Normally a user can only allocate other users with roles that they already have However if a user has the Root role they can add any role to another user 2010 2015 Exprodo Software Exprodo DB Administration Guide 55 Users with the Admin role have the following special properties e By default Permissions are created that allow a user with the Admin role to create update and delete almost all Biskit Types They can also update the database schema when using the Bakery However these Permissions are changeable and may be added removed or modified for any user by a user with Admin privileges e When the Exprodo DB licence has fewer than 30 days remaining users
48. created Once finished use the Install button on the Menu Toolbar to install the menu temporarily into the browser Then check the menu to make sure it is what is required Remember to use the Up Down buttons to change the order of items in the menu When finished use the Save button on the Menu Toolbar to save the menu The menu will still be in the menu drop down box but will no longer have a star next to it as it has been saved Look at the chapter on Changing a Users Settings to see how to apply this menu to a particular user Remember putting this menu as an option in Global Preferences will only change that menu for new users not existing users 2010 2015 Exprodo Software 140 Exprodo Database User Documentation 4 6 User Authentication Methods THis section outlines how an Administrator can set up a number of different methods for user authentication allowing Exprodo DB to be used in a single sign on environment 4 6 1 Authentication Methods There are three main types of authentication 1 Local The current Exprodo DB does the authentication User names and encrypted passwords are stored in the Exprodo DB database 2 Internal These are built in methods that allow Exprodo DB to send your user name and password to another system for authentication Exprodo DB does not store your password in this case but does handle it during login The currently supported internal authentication methods include using an email server SM
49. es familyName Bilderbec String Beya J k E I email blah co String naptic co m userlType name Physics Needs to match name exactly password timbil Depends on system configuration status Normal Requested Normal Blocked Notice the order of the properties does not matter Depending on how the system is configured password may be a compulsory property and may have a minimum number of characters and or a combination of alphanumerics 2010 2015 Exprodo Software Exprodo DB Administration Guide Example File For Importing A Resource A resource is a Biskit Type used in Calpendo to store information about resources that can be booked in a facility Import resource txt Notepad File Edit Format View Help name location name type name projectRequired collectUsage bookingBiskitDef representedBiskitType Ion Poo Harvard Room PROJECT_REQUIRED true Booking The Resource record that will be created from this file Name Value Comments Harvard Needs to match name type name Room Needs to match name exactly projectRequired PROJEC PROJECT REQUIRED me Rom Project Roqured Jany Project Roqured Booking Subtype feon eS Require Reason for Cancellations Allocate Calendar Column li Allow Old Changes Enable pre defined time slots Version PROJECT NOT REQUI RED or PROJECT WITH RES OURCE_ENTRY collectUsage __ true true or false bookingBiskitDe Booki
50. forms is not implemented for dynamic Set properties Many To Many Properties Suppose a user can be associated with any number of projects and a project can have any number of users associated with it This means there will be a collection of projects stored in a property on each user and also a collection of users stored in a property on each project Both sides of this relationship are known as Many To Many properties lf a project is a member of a user s projects then that same user would be a member of that same project s users and vice versa This means it is not necessary to save both sides of this relationship to the database because of this symmetry However there are some occasions when it is necessary to know which side is persisted and so one half is known as a Many To Many Persisted and the other half is known as Many To Many Unpersisted 2010 2015 Exprodo Software 194 Exprodo Database User Documentation 4 9 3 7 String Property Definitions Default Value Multiline URL Email Address HTML Name Meaning gna Property Type Defines the nature of the content of the string i Indicates whether the content of the text value should Sting Type In constrained String Property Type This defines the nature of the content of the string with possible values shown in this table Value Meaning Single Line One line of text A single line content that should be hidden when typed Intended for Passw
51. granting or refusing permission etc will occur Conditions work logically together using information from the database to reach a True False result A page that shows Biskits see Biskit Type 2 Defines the list of users that an operation Rule Permission etc will not affect This list overrules the Applies To list ie If a user is in both lists then the Does Not Apply To is used An Exprodo SDM concept which defines a when a task needs to occur 2010 2015 Exprodo Software Glossary 254 FAQ Global Preferences Group Report History Layout Editor List Report Mapped Integer Mapped String Meta Property Network Metrics Nobody Owner Permission Permission Action Project Project Group Project Resource Settings Project Status 2010 2015 Exprodo Software Frequently Asked Questions this page lists the FAQ s for the facility Specifies settings that change the way Exprodo DB operates A report that lets you break down data by any number of properties The audit log kept by Exprodo DB that shows what has been changed when and by whom The Layout Editor allows the user to define how the properties of a Biskit will be displayed A report that shows a list of Biskits A Mapped Integer relates text labels to integer values An integer property ona Biskit may use a Mapped Integer so that a user would see a drop down with each of the text labels when they edit it T
52. guide should be read in conjunction with the Exprodo DB User Guide User Administration When somebody first registers with Exprodo DB as described by Getting A User Account ua new user is created with a status of Requested While a user has this status they are unable to log in An administrator must then approve the user by changing their status to Approved This and other user related administration is described in this section User Properties This chapter describes the properties of a user and what they are for but not how to change them See Modifying Users for a description of how to change the properties on a user The licence for Exprodo DB counts the users with status Normal whose accounts have not expired and Password must be reset at next login Identity Every user has a combination of authentication method and login name which must be unique The login name may contain letters numbers hyphen underscore or full stop A login name may be changed as long as the new name adheres to these constraints Roles There can be up to 32 roles defined in the system including the predefined and special Root and Admin roles A user with the Root role always has permission to do anything in the system A user with the Admin role is allowed to perform administrative tasks However Exprodo DB can be configured so that the Admin role is not required for administrative tasks The remaining 30 possible roles can be configured
53. has a built in set of data types that it handles the user can add extra data types and modify the predefined data types by adding new properties and change the way existing properties are displayed As well as being able to create definitions of the data in a database so that the user can see and edit the database contents Exprodo provides additional facilities to help with interaction with that data e Automatic Emails to be sent in response to data being changed e Customisable Menus A Permissions system based on very adaptable Conditions e Dynamic reporting tools Each of these facilities makes heavy use of the fact that the data types themselves are defined in the database It lends itself to providing a very flexible system Therefore the very heart of the system is the means by which one can view and modify the definitions of the data types and that is precisely what the Bakery does The data types themselves are called Biskit Types and the definition of the content of a Biskit Type is known as a BiskitDef Each BiskitDef defines certain information such as its name the labels used to display that name the database table that contains the Biskit Type and how to display the name of its Biskits individual occurrences of the Biskit Type i e User is a Bisket Type Joe Bloggs would have a Biskit in the database defining his information as a specific occurrence of the User Bisket Type with the properties of that Bis
54. has disappeared as no longer required import usertxt Choose new file Biskit type User Insert New Data Preview Import ee rn ee Choose the columns to be ignored during the import by clicking the Ignore option below the property name or by putting Ignore before the property name in the file and then press the Preview button to see the data before importing or go straight to importing by pressing the Import button If previewing once the data has been loaded into the top pane select an individual record and see the record to be created updated in the bottom left pane and if doing an update the original record is in the bottom right pane import user txt Choose new file Biski type User Update Existing Data v Preview Import Ed ad O paan od ryeal OT 2 gt Normal gt Normal gt Normal gt Normal Nomal ea o moa oo a E Password id epy E E Login name ____ Timo Authentication Method Authentication Method terrane CE maaa s oi Expiry Date created 12 Mar 2015 09 23 Updated 12 Mar 2015 09 23 Remesa reac O Projects Groups Press the Import button to import the data into Exprodo DB While the import is being run a progress bar will be displayed which will show the time taken amount completed and any errors There is also a Cancel button to cancel the import When the import completes a pop up will appear in the bottom r
55. is Create or Delete For a Permission _ it s a very similar situation The context Bisikit Type is the Bisikit Type that the Permission controls access to and if the Permission applies to any Bisikit Type then the context has no Bisikit Type The New Value is available when the action being controlled is Update and not when the action is anything else For a Search the context Bisikit Type is the Bisikit Type that the Search is on and the only Condition Type available is Value 2010 2015 Exprodo Software Exprodo DB User Guide 19 The Conditions Type When a condition is created or edited the type has four possible values All of the following apply Show advanced Old vaue of No property path selected Old value New value Change Meta property Condition Type Old Value A Condition Type of Old Value means the condition will be placed upon the value of a property before any change has been made to it For a condition within an Automatic Email this means the value of the property in a Create or Delete action and the old value of the property for an Update action Fora Permission this means the value of the property on an object somebody is trying to Create or Delete and the original value they are trying to change from when somebody is trying to Update a Biskit A Condition Type of Old Value is only suitable when the condition context specifies a bisikit type
56. is Expired cannot log in Either their expiry date has passed or the administrator has decided they no longer need to use the system Lurker A user whose status is Lurker cannot login but will receive automatic and booking reminder e mails The reason that both Blocked and Denied statuses exist is so that an Automatic Email can be sent to the affected user with a message that is suitable for the situation Expired Expiry Date This allows the administrator to set an expiry date for the users login When this field is edited a calendar will appear just select the day the login is to expire on Last Login and Last Login From This records the last date and time the user logged in and the IP address of the machine they logged in from Groups A user may belong to any number of User groups 2 and group membership can be used for assignin g Permissions The groups that exist are configured in Configuring Types And 2010 2015 Exprodo Software 3 1 2 3 1 3 Exprodo DB Administration Guide When users first register their status is set to Requested While a user s status is Requested they will not be able to log in Approving new users and thereby allowing them to log in simply means changing their status to Normal Deny the user request by changing their status to Denied or delete the user It is also useful to define the users roles at this point A new user can be assigned any role the pe
57. it is necessary to define the property controlled by the Permission For example to grant or deny the ability to view a particular property ona booking create a Permission that affects just that one property Permissions that apply to individual properties are only relevant to reading and updating things For example when deleting something the whole thing is deleted and not just individual properties So it makes no sense to specify a property ona Permission that controls who can delete data Layering Permissions When defining Permissions specify the action to be controlled and optionally the Biskit Type and property Permissions that specify only the action are known as action Permissions Permissions that specify the action and a Biskit Type are known as Biskit Type Permissions and Permissions that specify action Biskit Type and property are known as property Permissions In a typical system everybody can read most things So it is usually easier to start by giving read Permission to everybody to read everything This can be done with an action Permission for the read action Then layered on top of that create a non authorising Permission that takes away permission for the things that are not allowed to be read 2010 2015 Exprodo Software Exprodo DB Configuration Guide 99 The layering works by using action Permissions only if there isn t a relevant Biskit Type or property Permission Similarly Biskit Type Permissions ar
58. means that a Biskit may reference another Biskit The References for a Biskit is the list of all such referencing Biskits Provides a means of comparing the value of a property amp to another value e g equals less than etc something that occurs at regular time intervals A Calpendo concept of A booking that has been created but not yet approved 22 A Calpendo concept deining a room person instrument or anything else that that must be booked before it can be used See User Settings shows a report of a dnde item of the appropriate Biskit Type A report ik a spreadsheet pivot table that can automatically count or sum data Various things that happen within Exprodo DB are recorded as a System Event For example a system event is recorded each time an email is sent or an error is detected These are statistics that may optionally be kept to track how much each user has been using Exprodo DB An Exprodo SDM concept of an individual action that needs to be performed See also Event A Calpendo concept allowing an administrator to assign an acceptability rating to bookings depending on when they are booked who makes the booking and the project the booking is for A method of displaying different measurement types such as feet and metres The process by which new users become approved A way of grouping similar users together A user may belong to many groups See also User Type
59. of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Tool Bar Item Description nes caver eect en eve ooo the currently selected menu item up Dowm Moves the Moves the currently selected menu item down i ss selected menu item down New item Creates a new menu item at the same level as the currently selected menu item sub ee anew menu item as a child of the currently selected menu item 2010 2015 Exprodo Software Exprodo DB Configuration Guide 131 The Left Pane Calendar This shows a tree with the contents of the currently Templates selected menu If an item is selected then Bookings e that menu item is loaded into the right pane so you Booking Cancellations f j can modify the item My Bookings My Projects Bookings e use the Menu ltem Toolbar to operate on the Booking Search selected menu item Projects Create Project My Projects Project Search Project Association Request Usage Usage Recorder Usage Calendar My Usage My Projects Usage Usage Search Search Reports search Report Running Admin Help About Calpendo FAQ 2010 2015 Exprodo Software 132 Exprodo Database User Documentation The Right Pane This shows the details of the currently selected menu item The first property menu item s type There are five types as described in this table Type Page Page Definition Label Create Project Page Create Project
60. on the Automatic Email to see its details 2010 2015 Exprodo Software Exprodo DB Configuration Guide ono Automatic Email Details Click on an Automatic Email in the tree and see its details appear on the right Calendar Templates Bookings Projects Search Admin Help admin Reset Button bar for actions relating to the selected automatic email Automatic Email Refresh OpenAll Close All Display Edit Create Create copy Delete Reference Create Any type Something created 2 User New user request to admin Main details of this automatic email Tabs to show other details New user request wait 3 System Event Exceptiod Select an automatic Bais email to see its details Project Project requesl 3 Delete Any type Something deleted Update 5 Any type Updated value of status equals Requested The conditions for this automatic email Something updated gt User User accepted reset password User accepted User account blocked User request densed Project Project accepted For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Press the Edit button to make the page editable and the button bar changes Ca ncel save The main details of the Automatic Email contain all the information represented in the tree on the left These two screen shots show the details in read only and in e
61. only additional meta property will be Sorted Sorted Indicates whether the contents of the Set are sorted or not BiskitDef Specifies the type of Biskit the set will contain Component Indicates whether the Biskit value is stored as a reference to a Biskit stored somewhere else or if its properties are stored directly as a component of its owning Biskit Normally only used for static properties Biskit Property One to Many Many to Many Persisted Many To Many Type Unpersisted To Many explained below Inverse This is the property on the Set Biskit which will point back to the Property parent Biskit Sub type 2010 2015 Exprodo Software Exprodo DB Configuration Guide 193 Biskit Property Type Value Meaning One To Many Indicates the set contains child Biskits that will all reference this Biskit as the parent in a Many To One Biskit property With this value of Biskit Property Type we must also specify the Inverse Property Name that is the name of the child s property that reference the parent Many To Many This Set represents the persisted half of a Many To Many Persisted property See Many To Many Properties Many To Many This Set represents the unpersisted half of a Many To Many Unpersisted property See Many To Many Properties To Many This Set is a collection of Biskits but the Biskits we contain do not reference us in any way Currently Many to Many in all its
62. oo Value of dateRange finish later than gt 14 days to the minute oo now seconds P seconds now minus femurs ours specified date wd months monihs years Years 2010 2015 Exprodo Software 24 Exprodo Database User Documentation Date Accuracy Description now The time specified but with a level of accuracy now plus Within now plus a certain amount of time with a level of accuracy now minus Within now minus a certain amount of time with a level of accuracy specified date The specified date exactly No level of accuracy may be set The now option means that the value of the property to be compared against is to be the date and time that the comparison is done The now plus and now minus options indicate that the date to be calculated is relative to the time the comparison is done When selecting either of these options a further item is displayed to input how much time to add or subtract from the time of the comparison to reach the date time that the property is being compared against If the specified date option is selected then a date time entry is displayed to input the exact point in time to compare the property against The Accuracy is only shown for date or date time properties and it specifies how accurately the comparison is to be Then when the Condition is checked and Exprodo DB compares two dates it first rounds both dates down to the year month day hour minute o
63. or whether the body of the email is the report data Sand s Altachmenti false Choose the subject line of the e mail Choose the subject line to appear on the email manual Users Select the Recipients tab to decide who to send the email to Please select a User to dd eosin name ven name rami rare ema accross Select the individual users the mail is to go to User Types Piedse gaie a Weer Type to add Selection empty Select the User Types the mail is to go to The mail will be sent to all users of these types Liger Groups Fitis sail a User Group fo add Selection empty Select the User Groups the mail is to go to The mail will be sent to all users in these groups Usar Fics User yah sE gf ihe seheried nodes Root Admin LAr Guest Select the User Roles the mail is to go to The mail will be sent to all users with these roles Emails will only be sent to an address once So if multiple users have the same email address or with your selections of Individual Type Group or Role you would have accessed a user multiple times they will only get one email Select the When tab to schedule the report Next Send The time and date the mail will next be sent with the current settings Recipients Last Sent The time and date the report was last sent Next Sand 30 Apr 2013 09 03 Last Sent Repo never gent Daily Sel
64. property and Report Schedule has a users property As an example to find all those users that have created Reports set Exprodo User as the BiskitDef to be searched for and Report owner owner is a pointer to an Exprodo User as the property defined in the Property Path returned will be a list of Exprodo Users that currently have Reports in the Report Manager If the Relation Statement and Value are set to greater than 1 times then only those users with two or more reports will be returned See Also e Example Automatic Emails e The examples in Permissions amp 2010 2015 Exprodo Software 2 6 2 6 1 Exprodo DB User Guide Searching For Information There are various ways to search for information in Exprodo DB and several ways to display the information found This section describes the generic search options that apply to any type of data Search The Search page allows searches for any type of data within Exprodo DB By default it appears under the Search menu with a sub menu item also labelled Search However the menu may have been configured so that the Search page is not visible or in a different place When you enter the Search page the following will be seen Calendar Templates Bookings Projects Usage Search Help 3 File Search for Please select Choose which Biskit Type to search for Clicking on Please Select will provide a drop down menu with the complete list of types available to search
65. read and managed easily This is useful if your type has a large number of properties to be displayed Opens up a page based on a URL searchtype Find by URL 2010 2015 Exprodo Software Exprodo DB Configuration Guide 135 Biskit Tree Viewer Create a custom biskit and give ita Name property and a Content property The Content property should be of type String and of subtype HTML Create a number of instances of the new Biskit Type giving each a name and adding content in rich text associated with the name This can include links and images Use the Menu Editor to add a custom page of type Biskit Tree Viewer and specify the type of biskit and which property contains the HTML content to display Users then see the names of the biskits appear in a navigation pane on the left with the associated content on the right Bioimaging This is the Electron Microscopy core facility All bookings for our instruments must be associated with a project You must be associated with a project in order to book against it Electron Microscopy Descriptors for Custom Search Pages The definition of the format of a descriptor e line group group e group initialFlags css class label item item e initialFlags H V G F E C S L A T O e item propPath item Flags e itemFlags SIL e propPath a path this may be the name of a property e g status or a path to the
66. the users are not As many users with the Root role may be created as required Any user with the Root role is not subjected to permissions checks regardless of whether it is the user Root or not only the roles matter 2010 2015 Exprodo Software Exprodo DB Administration Guide 3 2 Using Exprodo DB To Send Emails Exprodo DB can be used to send emails to anybody that is registered with Exprodo DB since all users must provide an email address Emails can also be sent to any email address as required This can be used as a means of general communication so that the administrator doesn t necessarily need to maintain email distribution lists This works because if you want to send emails to people who use your resources then they are probably also Exprodo DB users If you are running Exprodo DB on your own server Exprodo DB can make a secure connection to the mail server for sending email see Global Preferences Email on how to set this up Exprodo DB can also be used to send email to people who have a booking over the next few days or whatever period required This is useful when there s a problem with a resource that needs to be brought to the attention of those that are due to use it Send emails using the Manual Email page which is placed by default onto the menu as Admin gt EMail gt Manual Email The page sets up the email subject and email message and priority as though using any normal email client There are then three t
67. they can receive an Automatic Email Similarly if a User Group or User Type changes then send an email to everybody in that User Group or with that User Type send To User Performing Action An Automatic Email is triggered when some data is changed Normally but not always that 2010 2015 Exprodo Software Exprodo DB Configuration Guide 121 change is triggered by something a particular user did If that user is required to receive the email then select true for Send To User Performing Action Individual Users This lets you specify particular users that should receive the email User Types If you specify one or more User Types then any user with one of those User Types will receive the email User Groups Any user in the specified groups will receive the email User Roles Users can have multiple roles Select any number of ro es by ticking the check box next to the role and then choose with the drop down whether the email is to go to users that have all of the selected roles or users that have any of the selected roles Property Path As an abstract concept the property path may at first appear confusing It is used when the data that is changed contains a reference to a User User Group or User Type or else contains a reference to something that contains a reference to a User User Group or User Type For example a System Event is a record of various things that happen Every time a user logs in a S
68. whether you will need to do this by running this command Getsebool httpd can Network connect lf this returns zero or off then you will need to change this setting by running this command Setsebool P httpd can network connect 1 You can read about the httpd can network connect setting on the httpd_selinux man page If your httpd can network connect setting is zero or off then the result will be an error in your Apache logs similar to this 13 Permission denied proxy HTTP attempt to connect to 127 0 0 1 8080 localhos Rebooting Finally you will need to arrange for MySQL Tomcat and Apache to be started each time your operating system boots You should follow the standard method for your platform For Windows this means they should all have been installed as services Advanced Apache Configuration sometimes you may have an external facing Apache HTTP server through which all of your traffic flows eg on a firewall and then internally you may have another Apache HTTP server that has the mod_jk module installed In this situation with two Apache HTTP servers and one Tomcat server there is some extra configuration to do Without any extra configuration Tomcat will always be given the IP address of the firewall Apache HTTP server as the source of each request instead of that of the user s computer The problem with such a situation is that the login attempts that Exprodo DB will record will all show the firewall as the source of ev
69. 0 2015 Exprodo Software Exprodo DB Installation Guide mn Requirements You should have received a file archive that contains the following files Sle a rA SC DB INSTALL apache ssl www calpendo com INSTALL apache www calpendo com INSTALL apache with mod jk ssl www calpendo com INSTALL apache with mod jk mod_jk conf INSTALL apache with mod jk singleTomcatInstance ssl www calpendo com INSTALL apache with mod jk singleTomcatInstance workers properties INSTALL apache with mod jk singleTomcatInstance www calpendo com INSTALL apache with mod jk workers properties INSTALL apache with mod_jk www calpendo com INSTALL hibernate cfg xml INSTALL README txt INSTALL tomcat6 conf server xml INSTALL tomcat6 conf tomcat users xml The DB directory contains the program itself and db x y z sql contains a blank MySQL database The other files are examples for configuring Apache Tomcat 7 and Apache web server described further below Installation Overview You will need e Adatabase server eg MySQL though many other database servers will work ok e Aserviet engine eg Tomcat 7 Jetty etc Java JDK 7 or possibly just a JRE depending on the version of your serviet engine An Apache HTTP server may be required or else you can serve directly from the serviet engine The config files are use Apache HTTP server as a front end to Tomcat A database If using MySQL then you can load the db x y z sql provided For any other database Exprodo D
70. 000 cccccccec cee cceeccececceeeceesceneseeueseneeseueseneeseneecaeevaneseaeseeussensesaeseaseseresensevaeey 194 7 WL Jane ey dita Mapped 2S 9 0 e nee oe ona Rov aa oe a Re en Se Sea ee NORE eee 195 4 9 3 8 String Enum Property Definitions cc eececccccccceeeeeceeceeeeesenseceeeeeeeeeeseaeaaeaenssseceeeeeeeeeeeeesuaaeaneseeeeeeeess 196 4938 1 Sing EVM AOS asics esis a ea axes scab ect boccara Sec ted taal eae nated deena 197 AOA FO init ae a r nsec a a deauldcuauune vauaues tetiwea sucess vaucalyauhaubabbaed anctenvedserventeters 197 4O05 Bakery Edi IOT s E E E 200 4 9 5 1 Bakery Editor Examples cccccc cc cccccceeccescceseccaeesensceaeeceueseneeseneseaeeseneseasevaueseausesusseaeesaeseaseeesesensevans 206 49 511 Addnd M62 6c 9 ee em os E rt nee eee or ra 206 4 9 5 1 2 Adding Formulaic Properties 00 0ccccccccccecssecceccesseeesecseeeeeseceueeeesceueeeeseuuesesessaueessessneeesseeieeeeeeeees 209 4 9 5 1 3 Adding Properties For File AttaChment cccccccccssssssssssseceeceeeeceeeaeeaeaenssececeeeeeeeeeeeeaeasensseeeeeeees 212 4 9 5 1 4 Adding Properties For Created Updated V eSi0N ecccecceescessscesseeeseseeseeeeseesevesesensseseesesteneeeensens 214 4 9 5 1 5 Adding A New Yes No Mapped Int Property ccceessssseeceeeceeeceeeeeeaeaeessseeeeeeeeeeeeeeeeaeaeassseeeeeeeess 216 4 9 5 1 6 Creating A New Basic BiSkitDef ccccccccccececcecceeesessseseeceeeceeeceeeaeaaeaensessceceeee
71. 2 that are defined for the selected Biskit Type However some may be missing if they are too complex to edit in this pop up for example properties that contain lists of things If these properties are Grouped or have a Layout defined then the pop up will be hierarchical ae Modify checked users A Jert Value ocr Givennamel O Other namel O Family name O Email address O User Type _ password _ LStatusf Od E Requested Project Code s Apply Cancel 2010 2015 Exprodo Software 48 Exprodo Database User Documentation 5 Tick the check boxes of one or more properties shown in the pop up Once done the Apply button changes so it is no longer greyed out and an editor appears in the Value column Modify checked users dif Vaue OO O OS E I L Gwennan OP Othername EP Familyname OJ o Emai address O Cd L UserTyee OP e Apply Cancel 6 Choose a value for each property whose check box you tick When finished press the Apply button Every ticked item will then be modified with only the ticked properties being changed Whatever values selected for each property will be applied to all the ticked items Properties that are not ticked are not affected by the change 2010 2015 Exprodo Software Exprodo DB User Guide 49 How To Edit A Single Item While it is very useful being able to edit multiple items at once the above mechanism doesn t let you e
72. 2010 2015 Exprodo Software Exprodo DB Configuration Guide ter The different property types have different requirements about what information must be stored For example an integer property needs to specify whether it is to have values constrained by being a Mapped Integer or a Bit Set and in both cases in needs to know which particular Mapped Integer should be used But other property types do not need to 251 know anything about Mapped Integers The requirements of the individual property types are shown in the following sections the rest of this section will focus on the properties they have in common Primary Key Type string SC Min MiNone max MiNone S O Wl Visible Editable Persistent W Null Allowed L Required lw Visible In Biskit Detail W Visible In Biskit List Visible In Collection Editor Storage Mechanism fFomulaic J CdS Attributes Column Name Automated Property Type String Property Type SingleLine vl String Type Unconstrained w a 2010 2015 Exprodo Software 182 Exprodo Database User Documentation Name Description Primary Key _ This is the database ID for the PropertyDef This cannot be changed it is er Ferg oeg for information purposes Type tt The type of the property The type of the property integer long date ete long date etc
73. 2013 05 02 10 30 iii TEJ Weekly reo4 create 2013 05 16 08 00 2999 12 31 10 30 lf there are any questions about system events please get in touch with Exprodo DB customer support info calpendo com weekly 2010 2015 Exprodo Software EA Exprodo Database User Documentation 4 Exprodo DB Configuration Guide Exprodo DB was designed from the very beginning to be flexible so that it could meet the requirements of many different types of facilities It s targeted at people who have shared data that needs to be viewed and updated through a web interface The Exprodo DB Configuration Guide describes how to change Exprodo DB so that it works the way you want it to This does not normally need to be read by non administrators nor by anybody who only needs to do the day to day administration This guide should be read in conjunction with the Exprodo DB User Guide 2010 2015 Exprodo Software Exprodo DB Configuration Guide For various reasons it is useful to be able to split users into sets of one sort or another This is done in Exprodo DB using types and groups These are two independent means of segregating users 4 1 Types and Groups P The Difference Between Types and Groups The key thing to understand is that a user has precisely one type but may belong to any number of groups Exprodo DB should be configured with types and groups that make sense for the current installation
74. 3 1 5 Creating Users To add a new user that has not been requested go to the User Search page There will be a list of the current users and underneath a menu bar with Create button enabled File 7 Report type List Report User Type Status Roles Conditions Columns Reset Go 4 Autorun Users where status equals Normal or Requested and roles includes any of No roles Root Admin User or Guest Found 5 users Foes J aentity Given name Otter name Famy name Email adaress User Type Status Expiry Datel Version Created Updated Fo user Admin e root TT noma oT fuser Admin Guest Jlocavagnin Joann __ e vomar _ Jo JJ e fanear oavncr forcon emacs Noma Jo _ ous tecarmantie Jean Prove Juangancom Jews rora Jo jise ficamen oregor s vere _Jangnancem feos rora Jo t Ec it Delete Approve Deny Block Force password reset Edit Create Create copy Delete References History For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter In order to understand more about the properties used for a user read the section on User Properties The login name to be used will be added under identity after choosing the appropriate authentication method Also in order to understand more about setting up projects and groups for a user read the section on The User Requests Pa
75. B Parameters Type Description Page This type of menu item is one that shows a page When menu item is set to Page the following properties need to be set Property Description Label This is the text that should be displayed on the menu Page This is a drop down that allowing selection from all the different types of pages that Exprodo DB supports Parameters Some pages support additional parameters If a page is selected that supports additional parameters then the parameters value will be filled with a template that shows the sort of content expected This type of menu item is one that contains only sub menu items When this type is selected also select the label that should be displayed for the sub menu Menu Separator Creates a horizontal line in the menu that separates the items before and after it Once selected also fill in the label The label is not shown on the menu itself but is used to display the item in the menu editor s left pane Window This represents a menu item that when selected will open another browser window Set the following properties Property Description Label This is the text that should be displayed on the menu URL This is the address of the web page that should be loaded into the newly created browser window 2010 2015 Exprodo Software Exprodo DB Configuration Guide 133 Type Description Custom This type of menu item is one that shows
76. B can be made to generate the necessary tables itself instructions for this are not here Once those things are in place you need to e Copy the DB directory into the servlet engine s webapps directory e Change a configuration file so it knows how to connect to the database Configure the servlet engine and Apache Start the serviet engine and Apache Connect to the server from a browser to make sure it is accepting connections 2010 2015 Exprodo Software 242 Exprodo Database User Documentation Install MySQL Any version that supports InnoDB tables should do but the database dump that s included in this distribution comes from MySQL 5 5 x MySQL documentation should be consulted if loading this into any other version Create The Database And A Mysql User Open a connection to MySQL with my sgl 2O0r p and then at the mysql prompt mysql gt create database db mysql gt grant all privileges on db to exprodo localhost gt identified by somepassword mysql gt exit You may choose a different name for the database and or user if you wish Later on you will configure Exprodo DB so it can locate the database and log in you will just put the connection information into a URL in file hibernate cfg xml Load The Sample Database You should have a file called db x y z sql that you can load mysql db password somepassword db lt db x y Zesql Install A Java JDK Follow the installation instruction
77. Biskit as defined by their Sort Order meta propert drag lower sid Biskit a That Sort Order meta property cannot be edited directly but changed by using the drag area and dragging and dropping selected properties within the property list In the example three properties have been selected using the shift key and are being dragged up the list ee a to be placed higher up drag 2010 2015 Exprodo Software 204 Exprodo Database User Documentation Editing Mapped Int and Mapped String When in edit mode for Mapped Int and Mapped String there are buttons to Add and Remove items When an item is added a new Name Value pair appear at the bottom of the list to put in the new mapping To remove items select a Name Value pair first then press the Remove button Cancel Save Null Value Label Values Add Remove Name Vaue id i Editing String Enum Def When in edit mode for String Enum Def to add a new value use the Enter New Value box and press Enter when finished The new value is added to the bottom of the list To remove items select the check box for the items to be removed and then press the Remove button To move an item to a different position in the list use the drag column Select the item to be dragged and then drag and drop it where required Cancel Save Enter new value ES E Coe calf E fom mewa caf E foi Peyeroogy A calf fors raf eero r
78. DB Add in the Bakery e Does not require table structure to be changed to add a new indirect property e Harder to make mistakes and get confused e Efficient storage and retrieval e The fastest access mechanism Efficient storage and retrieval Not quite as fast as Static properties Advantages Need to be aware of Much less efficient database columns storage and retrieval and their Biskit Types than the other property types Disadvantages Cannot be changed without new version of Exprodo DB Users of Exprodo DB cannot create or delete Static Biskits or properties but can change some of the meta properties of both the Biskit and the properties such as the labels tool tips whether required and default values Users should be using dynamic properties rather than indirect properties unless they really do not wish to change the DB Schema and are happy with the speed of the indirect properties 2010 2015 Exprodo Software Exprodo DB Configuration Guide 175 4 9 2 Biskit Definitions It can be a bit confusing to talk about definitions of properties So let s start by using an example and looking at the definition of the Session Biskit that is used to store information about who is using Exprodo DB A Session has the following properties Name Data Type Description user Biskit The user whose session this is star
79. DB This is useful for checking that Exprodo DB is sending the expected emails particular while Exprodo DB is being configured Email BCC 2010 2015 Exprodo Software Exprodo DB Configuration Guide 147 Setting Description eee Email This is a signature that is included at the end of every outgoing email If Signature left empty then a default signature will be added 2010 2015 Exprodo Software 148 Exprodo Database User Documentation 4 7 4 General The General tab of the Global Preferences page provides the following Past Repeatable Minutes Between g Flushes Minimum Time Between Database 30 Dumps In Minutes Temporary Directory tmp Run Data Definition Validation At Boot false Read Only Mode false Check Reserved Words true Y Submit crash reports tue Y Default Initial Page Token Maximum File Upload Megabytes Setting Description Icon This provides the name of an image file that should be used to display on the Bookings Calendar and using the default settings for the appearance headings on the login page Exprodo DB has some Biskit Types amp that support repeats such as Events Bookings and Time Templates As the time for each instance of the repeat passes a new Booking or Event etc is created to represent the instance of the repeat that happened This is done so that when a repeat Booking or Event etc is changed you do not change the recor
80. Group for its layout General se Professer Project Resource Settings Professer Sign Offl false sers Accounts Sign Ofi false Sign Off 2 I Accounts Liason Project Groups 2010 2015 Exprodo Software Exprodo DB Configuration Guide 185 4 9 3 1 Biskit Property Definitions A property of type Bis kite Reference Deletion Option Name Meaning BiskitDef Specifies the type of Biskit this property will contain Indicates whether the Biskit value is stored as a reference Component Biskit stored somewhere else or if its properties are stored directly as a component of its owning Biskit Only used for static properties Biskit Property To One Many To One Master to Slave or Slave To Master Type explained below Must be provided when this is a Many To One property Master to Slave or Slave to Master in which case this is the name of the property on the parent that points to the child BiskitDef Reference Whether this objects of this Biskit type can be deleted if referenced by Deletion Option other Biskits in the DB Cascade No Action Set null must specify the following information Inverse Property Biskit Property Type Value Meaning T The value of this property will reference a Biskit but that Biskit will not o One l know anything about us referencing them The value of this property will reference a Biskit in a child parent relationship We are the chil
81. IFF and ALL generate a large amount of data When triggered by an update DIFF inserts text that is converted to something that shows what changed ALL generates output that shows every piece of data from the changed Biskit both before and after the change This can be particularly noisy The information it shows is normally everything that can be reached from the New Value and Old Value buttons The exception to this is that if the Automatic Email is triggered by any Biskit Type then the New Value and Old Value buttons cannot display appropriate properties because it doesn t know what Biskit Type will trigger the email You also cannot type in something like NEW name and hope that it will work because it will not In those cases ALL is the only way to get at the details The format this generates is not particularly user friendly and so if you use this you should be careful about who receives such emails In order for any data to be included in an email it needs to have Read and Email Readable Permissions set for the special user nobody By default there are no Email Readable Permissions set up so no data can be sent by email In order to allow data to be sent by email go to Permissions and create an Email Readeable Permission for the user nobody Dealing With Sensitive Data In Emails lf there is data that any user shouldn t be able to put into an email because of confidentiality or sensitivity but the user sti
82. Metrics 151 Network Metrics Enabled Preference For Network Metrics Minutes Between Sending 151 Network Metrics Network Calls Between Sending 151 New User Default Roles Page Banner 144 151 155 258 Exprodo Database User Documentation Global Preferences 143 Integer Type Page Banner In Debug Mode 144 Property 188 Password Content Requirements 152 Passwords Allowing Browser To Remember J 152 Read only Mode 148 Java Repeat Flushing Time Between 148 Enum Definition 191 Request Filtering By User Type 155 Run Data Definition Validation At Boot 148 Security 152 Submit Crash Reports 149 system Usage 154 L Temporary Directory 148 Usage Statistics Enabled 154 Usage Statistics Time Between Flushes 154 Usage Statistics Time Per Statistic 154 User Session Timeout 155 User Type Requirement For 155 Enumerations 191 Java Enum Property 191 Layout Editor CSS Rule Editors 177 Edit Mode 163 Information Pane 161 Moving Properties 164 n Users Notes 168 ossary Organisation Pane 160 Group Report 34 Prevew 159 Groups Property Group Header Information 161 User Groups 93 Property Table Types 165 H 7 Licence Global Preferences For 149 List Report 28 History Login Name History Button 16 History Page 45 Mapped Integers 188 Mapped Strings 195 Menu Default Admin Menu 150 Default Root Menu 150 Default User Menu 150 Global Preferences For 150 Menu Editor 129 Menu Editor 129 Biskit Tree Vi
83. Name The name of the property This must be unique amongst all the property definitions on its Biskit and contain only letters numbers and the underscore In particular this cannot contain spaces Description A description of the content of this property This is only used for display in the Bakery so that anybody using the Bakery will be able to see this text It s not used anywhere else Label This is the text used to display the property name This is used whenever a Biskit s detail is displayed with each property s label show before its value Tooltip This is a tool tip that should be displayed whenever the mouse hovers over this property when it is being displayed or edited in a Biskit sort Order Used to change the order in which properties are displayed This cannot be modified directly Instead property sort order is modified by drag and drop in the Bakery Live Lie Used internally Min The minimum value the property can take This is only used for numeric and string values For numeric properties the minimum should be a number representing the minimum value the property should have For string properties the minimum should be the minimum length of the string lf a minimum is set the string is automatically required Similar to Min this specifies the maximum value the property can take and is T E used for numeric and string values Attributes These are defined in a These are defined in a separate ta
84. Permissions that permit something to be done and non authorising Permissions that deny the right to do something 2010 2015 Exprodo Software 98 Exprodo Database User Documentation Breaking An Activity Into Its Parts Let s start by looking at an example viewing the content of a booking This example is taken from Calpendo an Exprodo application The same principles apply to all Exprodo applications To help with following this example it is useful to know that Calpendo is a booking system with Booking Rules that specify who can make what bookings Each booking may be associated with a project and each project has a number of users Each booking has a resource which is the equipment instrument room or person etc that is being booked This breaks down into the following items 1 Action Start by looking at the underlying action Everything is broken down into an action of some sort and the most common actions are create read update and delete In the example it is view or read 2 Biskit Type Next look at the type of the data the action will affect In the example in order to control viewing of the content of a booking the Biskit Type is booking 3 Property When trying to read or update something as in the example then the action has an impact on individual properties That means the user may have permission to read some of the properties on the booking but not all of them So for some Permissions
85. TP or IMAP any HTTP basic authentication system or another Exprodo DB 3 External The web server that users connect to is configured to provide authentication for example using a single sign on system or perhaps LDAP In this case Exprodo DB never sees users passwords and authentication is solely the responsibility of the web server All systems automatically have Local authentication initialised but the administrator may also set up a number of non local authentications and may switch off Local authentication The administrator cannot switch off the authentication system they are currently logged in with to ensure that they cannot be accidentally locked out Common Options For All Authentication Methods Name Data Description Type Type Tye gt s String The type of authentication method Name String The name assigned to this method Must be unique Login Allowed Boolean Whether users can login using this method Whether new users can register using this method If Boolean True then new users may register for this authentication method even if logins are not allowed New User Registration Allowed Local Authentication Local authentication has no additional options IMAP Authentication and SMTP Authentication Name Data Description Type Host String The mail server s IP address or name Security JavaEnum Choose the type of security to be used None STARTTLS SSL TLS 2010 2015 Exprodo Softw
86. Toolbar Button Standard Definition chapter Edit Mode Description Tool Bar Save Saves all the changes to the Biskit and its properties In order to make these changes_permanent follow the procedure to validate update and reload the DB When saving a changed Biskit an error message may occur Failed to Save BiskitDef BiskitDef is invalid and so cannot be saved OK show Log save Despite Errors Look at the log Show Log button and then depending on the errors decide whether to Save Despite Errors Sometimes Biskits need to be saved with errors due to the need to set up links between Biskits and both Biskits need to be created before that can be done With some errors there is not the choice of whether to Save Despite Errors these errors must be fixed before saving because they can corrupt the database 2010 2015 Exprodo Software Exprodo DB Configuration Guide 203 203 Properties Description Tool Bar Add New _ Adds a new property to the property list The gt By perty is automatically selected and available for its meta properties to be modified Cut Multiple properties may be selected by using ctrl and shift Copy Multiple properties may be selected by using ctrl and shift Paste Pastes the properties held in the buffer into the current property list Delete Multiple properties may be selected by using ctrl and shift Properties are placed in the list of properties for a eo
87. Usage Statistics Minutes Between Flushes 5 Sysytem Usage Statistics Minutes Per 45 Statistic Setting Description Usage Statistics Enabled If this is set to true then usage statistics will be kept otherwise they will not Note that by setting this to false Statistics that are already in the database will not be affected Only new statistics will be affected by this setting Enabling Usage Statistics will slow down Exprodo DB a little Usage Statistics Minutes This specifies how often Exprodo DB should flush statistics Between Flushes out to the database For performance reasons this should not be made too small Usage Statistics Minutes This indicates how long each block of time is during which Per Statistic Statistics are put together The larger this value is then the less space will be taken in the database and the lower the time resolution of the statistics If System Usage Statistics is enabled the data will be stored in the database In order to access the data use Search Once in the Search page set the search Biskit Type to System Usage As there could be a lot of information to be returned make sure you use Conditions to set at least time limits for the information returned For more information read the chapter on using Search 2010 2015 Exprodo Software Exprodo DB Configuration Guide 155 4 7 10 Users The Users tab of the Global Preferences page sets up the following N
88. a custom built page After Page choosing Custom Page then set the following properties Property Description Label This is the text that should be displayed on the menu Token What the configurer wishes to appear in the browsers top address bar when this menu item is selected for example in the case of the Menu Editor menuEditor Custom Page Type The type of custom page to create there are seven possible ee EP 1 Biskit Tree Editor Bookmark Page Customised Search Page Data Explorer Page Frame Page Run Predefined Report y o gt gp e pN Search Results Page Additional This depends on the custom page type chosen Information More information on the different types of Custom Pages Page Description Additional Information Biskit Tree A page which which will display A list of the Biskit Types to be Editor and edit a user defined selection displayed on the page Once created of Biskit Types For example if the order can be adjusted new Biskit Types have been created such as Doctor and Nurse and both a Doctor and a Nurse are associated with bookings then create a menu item that takes the user to a page where they can create the Doctors and Nurses Biskit Tree Provides a way to display a 1 The Biskit Type to be displayed Viewer number of HTML pages with a 2 The property with the information Page navigation panel for users to
89. abase User Documentation Viewing Buttons Button Description Refresh The Refresh button reloads the current page from the database Open All gt Open All button opens up the whole tree so that all the information can be seen Close All The Close All button closes the tree information so only the top of each tree can be seen Printable The Printable View button will reformat the page to make it printer friendly View including removing the list of items and retaining only the selected item Then use the browser s Print option to print the item s details Click anywhere on the page to revert back to the normal view Columns The Columns button allows the user to decide which properties will be displayed The default is always the Name property The References Button This button will show a list of everything that references the currently selected item It will be greyed out if there is nothing referring to the item Once pressed a list of the references will be viewed Fefresh Delete Printable view Edit View History Create Create copy References References to User 36 Type of Referer ID of Referer Referer 20th Centur Project a light bulb flight bulb This shows a table with the Biskit Type of the referrer the unique database identifier of the referrer and its name Either press the References button again or press the Back button on the browser to retur
90. abs named To CC and BCC to specify who the email is sent to copied to and blindly sent to As long as someone is in the CC or BCC list then there doesn t need to be anything in the To list Subject Message Priosity Normal User Statuses User Types User Groups Recipients z a Type an email address and press enter to add it No email addresses selected Send Show Recipients Reset 2010 2015 Exprodo Software Exprodo Database User Documentation Each of the To CC and BCC tabs have the same content with tabs as follows Tab Name Users User Statuses User Types User Groups Description ooo This adds any number of specific email addresses This means emails can be sent to people who are not known by Exprodo DB This chooses individual users to send the email to Use the drop down to select the users Watson Francis Watson required Use the tick Login name Given name Other name Family name box to choose which EHC a users you wish to a Wal Sor Francis f watson remove and then al click the Remove button This chooses the statuses of users that are allowed to received the email Note that the recipients will be those specified by any of the other tabs that are not also prohibited by this User Statuses tab lf Exprodo DB is configured so that users are Classified by their user type then select one or more user types so that all users with th
91. ailable for each of the sides LHe lem ples Bookings Propiecis a ba SrA Pirin hap Conditions Columns Schedule me ae no gandite A report has a number of basic properties Property Descripton The name of the report as assigned by the user The biskit type that will be searched for Enabled lf the report will run if scheduled Publicly Ifa system wide report then anyone can modify it Modifiable system Wide Can everyone see the report or is it a personal one If this is true the report will appear under System Reports rather than Personal Reports Report Type Will the report display as List Summary or Group report Owner The user who created the report and if Publicly Modifiable is false the only person who can edit a report if it is also System Wide and tabs to see other properties Tab Description O o y O Conditions The conditions if any associated with the report see the Setting Search Conditions chapter for more information about conditions and how to edit them The columns that will be displayed in the report Schedule Whether the report is scheduled to run and when it will run who the report will be e mailed to and the format of that e mail 2010 2015 Exprodo Software Exprodo DB User Guide oat The Menu Bars The menu bar has two variations In View mode Edit Create Create copy Delete History Open repot Run report af
92. allow somebody to modify a booking if they created it and the status was set to Requested before they tried to change it and its value would still be Requested after the change 1 Create a Permission that applies when a booking is Updated and give it a name Anybody modify their awn booking request 2 Add a condition Status is Requested Note that for an update to put a condition on the value after the update then use a New Value type of Condition equals Specified value Requested 5 a 3 Add a condition Status was Requested Here we use a Old Value type of Condition to put a condition on the value that the status had before the update Old value of status equals Specified value Requested o amp Oe 4 We now need to limit the Permission to applying to whomever created the booking This is easy because each booking stores a record of who booked it in the booker property To do this go to the Applies To tab untick Include Everybody and then add a property path to booker Thema O O Property Path Doe 5 Save the Permission 2010 2015 Exprodo Software no Exprodo Database User Documentation Example 3 Admins May Create Or Update Anything This example shows how to use User Roles to decide who gets permission to do something as well as showing how to create a Permission that applies to every Biskit Type Use a Permission like this when
93. alue and the property path displays the same as for both Old Value and New Value This Condition Type means that a restriction is placed upon the change of a property For example it can be restricted so that the condition matches when the selected property does not change does change increases or decreases The increase and decrease restrictions are only available for properties for which such a concept makes sense This is described further below Condition Type Meta Property A Condition Type of Meta Property is available in all contexts When this type is selected the property path displays the following l Meta property Eee pro erty dataType date user A Meta Property lets you place restrictions on e the type of the data that was Created Updated or Deleted e the date and time that the action took place e the user that caused the action This is called a Meta Property because it s not a property of whatever was created updated or deleted but rather it s a property of the action itself The Property Path As described above the properties shown in the property path depend upon the Condition Type selected However each property that is shown has it own way of being displayed regardless of how it came to be there For example any date time property that is shown will display with sub properties Conditions x of the following apply Show advanced amp Value of No property path sele
94. ange the name to a Ee Ce W Visible Editable W Persistent Mull Allowed Znan Ao re n dragy ProfessorName String Visible In Biskit Detail M1 Visible In Biskit List drag Tae L_ Visible In Collection Editor ad fdrag Attachment Bst Fomulaic TE Cid 8 unique Cf iina j Na Jira Automated Property Type None Bizkit Def to CP Biskit Def Attachment E Attachment eea d Change ae Type to To Reference Deletion Option 6 Update the meta properties of the property a Change Type to Biskit b Give the property a name in this case Attachment c Change Biskit Def to Attachment d Change Biskit Property Type to To One Press the Save button If there are no errors then update the database a Press Update DB Schema to implement changes in the DB a pop up will appear defining the database changes to be implemented 9 Press the Apply Changes button to update the database There will be a response saying how many rows affected Press OK to finish a Press Validate Biskits button to check the database Biskits b Press Reload Database Configuration to load the new database into Exprodo DB c Refresh the browser CO N 2010 2015 Exprodo Software 214 Exprodo Database User Documentation 4 9 5 1 4 Adding Properties For Created Updated Vesion An example of adding a properties to a Biskit created by a user to record when a Bisk
95. arch is loaded then the properties can be edited using the File gt Properties menu option When edited they can be saved In this case Save and Apply do the same thing that is save the changed information and leave edit mode 2010 2015 Exprodo Software Exprodo DB User Guide 39 Exporting Search Information A user can export any data they have found through a search to a csv a tab separated file or native Excel file either pre 2007 xls or post 2007 xlsx which can then be loaded into such applications as Excel Using File gt Export the current search data will be exported to a file There are three options 1 How the file will be formatted choose between Comma Separated Values Excel xls Excel xlsx and Tab Separated Values 2 What headings will be used these can be Show labels or Show property names Labels are those names that have been assigned by the administrator to a Biskit Type 4 the property name is the name of the property in the database 3 Whether enumerated types have their names shown Show value labels where defined or the value as stored in the database Show underlying data value File Search for Resource R Fomat Comma Separated Values Headings Show labels CS Content Show undertying data value Cancel Export When the format for the export is chosen press Export then choose whether to open the exported information directly into another application or whether t
96. are Exprodo DB Configuration Guide omo Basic Authentication Name Data Description Type UR String The address of the website The address of the website doing the authentication _ the authentication Realm String The name of the system that is doing the authentication External Authentication Name Data Description Type Can Name Header men The name of the HTTP header that will contain the oe ee login name this defaults to X Forwarded User ene Type JavaEnum How to display the frame that will contain the authentication handshake If not hidden then choose its size Choice of Hidden Inline Popup Display Width String The width of the frame within the pop up or on the login page Display Height String The height of the frame within the pop up or on the login page While you can use HTTP basic authentication using an internal authentication method it s also possible to set up HT TP basic authentication using external authentication The following shows an example of an excerpt from an Apache virtual host configuration that sets up HTTP basic authentication and also passes the REMOTE_USER setting that it generates to Exprodo DB by setting the X Forwarded User HTTP header You can use any header for this but you need to tell Exprodo DB which header to examine by setting the Login Name Header property When Apache rewrites URLs you protect private under the rewritten URL lt Location Calpendo com springs
97. art Ill Exprodo DB Administration Guide 94 3 1 USE AGM INI Sta OOM oeni unl a eia a aai 54 3AT User Properties ed er ee oe ee eee 54 3 1 2 The User Approval Proce SS isi ie ee a eee erence dete ee uses ee eine eee 57 31 3 The User REGUCSUS Pag sursson pri cess ea re pease eae ee eee Ea Raana 57 3 dA User Scare haran a 62 31 5 Creating Sers riad e ERE a a 66 3 WO MOGIFYING US CS saa a a a SAE a Ea 67 3 1 7 Changing A User s Settings sesussunnunnnunnunrnurunnnunnunnnnnnuununnnunnunnnnnnunnnunnnnnnnnunnnunnnnnnnnnunnunnnnnnnnnenn nunn nne ennen 70 3 18 Special USET oriresari i a ee 70 3 2 Using EXprodo DB To Send EMallS rsiioiisis ne a a a a E 71 3 3 Repor Manager escicesaecinicenaasedecties cartoassgmndctertupecaratweseaesceuondeccadshenmeceicacwas cues stondacuaewavs 74 SA IMPO e E E A EE A A E EE AE A 75 34 1 IBcaim Die Import Fil Sse a AE E A AEEA 75 34 2 The Import PAG o a a a a a a 82 3 9 SOV SOM EVO MUS cie aS 89 Part IV Exprodo DB Configuration Guide 92 4 1 Typ s and Groups ices cc s retest ates eae al eee oo Air weil aires 93 4 2 Configuring Types And Groups s sssssssssnssnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn nnne 94 43 PC PMUSSI ONS csa a a a ta ewe 97 2010 2015 Exprodo Software 4 Exprodo Database User Documentation 43 1 How Permissions VV OPK eirean a a a a E EEE a AEAN A SE 97 4 3 2 The Permissions Editor ie rootestvnsuvaevianstvernstisinatdencabsevinuiediiteniednedenuadtentinien
98. ase User Documentation 2 1 Web Browser Compatability Exprodo DB supports the most popular web browsers Firefox Safari Google Chrome and Opera Internet Explorer is also supported from version 7 but is much slower than the other browsers Internet Explorer version 6 will mostly work but will be extremely slow and some behaviour will be incorrect The users experience with Exprodo DB will be much better if Internet Explorer versions 6 and 7 are avoided and preferably if Internet Explorer version 8 is avoided as well lf the user has no choice but to use Internet Explorer versions 6 or 7 then it will help if to install Google ChromeFrame This is a plug in for Internet Explorer that allows some web pages to use Google Chrome to render pages Name Ve rsion Comme nts Google Chrome All Supported Firefox 3 0 and Supported later Apple Safari l4 5 6 Supported Opera 9 10 Supported R 6 Not supported Very slow and doesn t always behave properly 17 Supported but very slow Use another browser if possible Peter Ores E Supported but slower than any of the other major browsers E Supported but slightly slower than other major browsers 10 Supported 2010 2015 Exprodo Software EE Exprodo Database User Documentation 3 3 1 Exprodo DB Administration Guide The Exprodo DB Administration Guide covers the day to day administration that is required for an Exprodo DB installation This
99. ate the comparison should be used with dates The Condition Type and Property Path are always present but the others may not be For example if the user hasn t selected a Property Path then the Relation Value and Accuracy do not show If the context does not specify a Biskit Type then when a Condition is first created it will look like this of Mothing available Mo property path selected The above picture shows the default Condition Type of Value with a red border because Value cannot be used without a Biskit Type being available in the context The Property Path also has a red border and shows there are no properties available for the same reason Choosing a Biskit Type of anything other than Any data type changes the Property Path selector to show there are now properties that can be selected of select a property Mo property path selected The Property Path selector still shows in red because a Property Path is required but hasn t been selected yet Clicking where it says Select a property would now generate a drop down menu with a list of all the properties that exist on the Biskit Type selected in the current context 2010 2015 Exprodo Software 18 Exprodo Database User Documentation The Conditions Panel Everywhere that conditions are used they appear in a panel that looks something like this ina writeable context Conditions 3t of the following apply Show advanced BT of location Specifie
100. ation The Menu Toolbar at the top of the page The tool bar at the top of the page contains buttons that operate on whole menus at a time save Refresh User menu Open all New Delete Duplicate Install Rename For aco mete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Tool Bar Item Bar Item Description e Menu drop Shows a list of all the menus Select one of them to load that menu so a ee T it can be edited seen at all i n te curontscecta mon all the menu items in the current selected menu New Creates a new menu ss ss i i OOO a new menu Delete Deletes the currently selected menu Note that this doesn t take effect until the Save button is pressed Duplicate Creates a copy of the currently selected menu This doesn t take effect until the Save button is pressed Install Installs the currently selected menu into the browser This is not a permanent change When the browser is refreshed or when the current user logs out the menu reverts to its previous state This allows the administrator to see exactly what a menu would look like when in use Re name Renames the currently selected menu The Menu Item Toolbar at the bottom of the page The tool bar at the bottom of the page contains buttons that operate on single menu items Cut Copy Paste Delete Up Down New item New subitem For aco mpete description
101. benefit from any Heading of the following guarantees or g Property Table Type Simple Table f Table CSS F Area C55 Editor Coy alter will affect Tse Column C55 Editor New Home Warranty New _Home_Warranty css Damp Proofing Ics Treatment E Fic CSS eam cece yooo Editor Es rss EH Electrical Work css ead CelCSS Lol eae list E Central Heating css Underpinning Iss Other Waranties cs If yes give details EH Other _Waranties Details In the example above the first column has had the text colour set to Blue the font family set to Times New Roman and the font size set to small 2010 2015 Exprodo Software 172 Exprodo Database User Documentation When the CSS Rule Editor is opened up CSS Rule Editor a Positioning Border Misc Class and Other CSS Values Options color Colour Blue direction No value letter spacing No Value Set to Blue a standard text align No Value C55 colour test input by line height No Value the user text transform No Value Set to inherit will text indent inherit Ra inherit from previously white space No Value lz defined CS5 vertical align H text justif No Value vertical align bottom justify z rovided by the editor RIR word spacing No Value P a text wrap No Value text overflow No Value word break No Value B word wrap No Value Font Decoration font family No Value text decoration No Value f
102. ble below table below Rows The number of rows used to display the value Particularly useful for multi line string values Columns The number of columns used to display the value Particularly useful for multi line string values Group This can be any text required In some contexts Biskits are displayed with their properties in separate groups In that case it s the PropertyDef s Group string that defines the group that each property belongs to and the text that should be used to name that group If this is used when viewing a Biskit separate tabs each with the appropriate group name will be used to display the properties This property is used if no layout has been defined in the layout editor for this Biskit Type The Project Biskit will always use this property for its layout General Professer Project Resource Settings Users Sign Off z 2010 2015 Exprodo Software Exprodo DB Configuration Guide 183 Storage Indicates whether the property is static dynamic or indirect See Mechanism Property Storage Mechanisms for more information Formulaic Dynamic only Allows a formula to be entered to calculate the value of this property See the section on Formulae for more details on the formatting Column Name Only required for dynamic properties this is the name of the database column used to hold the property Unique Only required for dynamic properties this indicates whether
103. ble in their Action Biskit Type Permission categorisation with any that are disabled shown in red Create wl aeaing any ype of a any type of data 22 By default S f eager Fa admins may create data J 44 n E may create template approved booking 43 Anybody may create booking requests Bookmark 65 Anybody can create non system bookmarks Config Disabled permissions shown in red Calpendo Config 7 Must be root to create global preferences Equipment Login Attempt 11 Must be root to create login attempts Permission User Exprodo User User l 1 Must be an admin to creat Project cy amthdeAnybody can cr Permission Detail Click on a Permission in the tree and the details for that Permission will appear on the right Calendar Templates Bookings Projects Usage Search Admin Help Refresh Open All Close All Display Edit Create Create copy Delete References Histo Button bar for actions Any toe relating to the selected Eanes Te default only admins may create data permission Main details of B Select a permission i issi Delete to see its details Data Sa applies to whole object sil nico 25 By default only admins may delete a data Priority Dump Database Exists Tabs to show Applies To Does Not Apply Fo targeted users 26 By default everybody can know about the existence of all data Read There are no conditions 23 By default everybod
104. bookings 2010 2015 Exprodo Software Exprodo Database User Documentation Example File For Importing Two Bookings A booking is a Calpendo object that has a status start and finish date and a few other properties Tontor n File Edit Format View Help booker userIdentity loginName owner userIdentity loginName status dateRange start dateRange finish resource name project projectcode admin admin Approved 18 May 2013 08 00 18 May 2013 08 30 dry lab inventions admin admin Approved 18 May 2013 09 00 18 May 2013 09 30 dry lab helper The Booking record that will be created from the first import line in this file is Resource typed Warned Cd Modiieg id alg Cd Description Pd Reminder Trigger Time J Remind Project Users Not set Name Value Comments booker userlde admin Needs to match ntity loginName login name exactly owner userlden admin Needs to match tity loginName login name exactly status Approved Approved Requested Cancelled Denied dateRange star 18 May Date and Time 2013 08 00 dateRange finis 18 May Date and Time 2013 08 30 resource name dry lab Needs to match name exactly inventions Needs to match project code exactly project Project Code 2010 2015 Exprodo Software Exprodo DB Administration Guide oa When importing repeat bookings the repeat sub Biskit Type for the repeat booking needs to be defined as well as all the properties defi
105. ce data Gouwnt Destinct l ignore null values Ma aggregation Mo aggregation No aggregation Mo aggregation Mo anepatia Choose the data J aggregation required for numerical and date properties AAI Maximum Ayer age Silanda Gawiation aggregation chosen ae decide whether to j ignore null values The first column allows the user to add or delete columns from the report the green to add one column green tick to add multiple columns tick all columns required to be added then click OK red to delete the current column See the Group Report chapter for more information on how they work The second column allows the user to change the properties that will be viewed in a column The third column allows the user to change the label at the top of the column in the report The fourth column allows the user to decide whether absolute values_or data aggregation is required See Summary Report chapter Complex Content Types section for more information If aggregation of the data has been chosen then decide whether to ignore null empty or 0 values 2010 2015 Exprodo Software Exprodo DB User Guide 43 Scheduling Reports If box marked Run report on a schedule is ticked options allowing for the setting up of the scheduling of the report appear Conditions Commas Ta gel n L ta Choose whether to attach the report as a file to F Run report on a schedule the email
106. cified value If Specified value is chosen then a further item will appear so that the value can be chosen The item shown for the value entry will be appropriate to the type of the property indicated by the Property Path Conditions x All Of the following apply Show advanced amp walug of inProgressChangeOption quals Specified value Please select a In Progress Change Allowed m Please select a in Progress Change Allowed Do not allow any changes Allow some changes Alk amy changes Date Properties And Accuracy When dealing with dates there are some other options that are available Whenever a property is asked for which stores a date two condition lines will appear one for the start date and one for the finish date the relation can then be set see table earlier in the chapter for the full list available Conditions x Al j of the following apply Fl snow advanced value of dateRange start earlier than now plus 414 days to the minute oo Value of dateRange finish later than fa now minus 14 days to ihe minute o Date relation to be set Then set how accurate the date checking needs to be There are four options against which the comparison can be made and then a level of accuracy to be used Conditions x All of the following apply Show advanced Value of dateRange stan earlier than now plus 14 days a to ihe minute
107. ck on the property to get The details of the Biskit can be displayed either as a simple table of all the properties Show Simple or in a separate Property Group Show in Property Group using the current layout type Horizontal Vertical or Caption Also if a layout has been defined for the Biskit then the layout definition will be used for the properties of the Biskit 2010 2015 Exprodo Software 168 Exprodo Database User Documentation Notes The user can add areas to the layout which enable the storing of notes In order to do this a BiskitDef needs to be created to hold the note information This BiskitDef must have at least two properties Optionally the user can also define a property to hold the Category of note to be stored Property Type Description String This property will hold the Note information If the StringPropertyT ype is HTML then the note will support Rich Text Format Biskit This property will define the parent BiskitDef that the Note is for This property must be an Automated Property Type set to Create and Update the Biskit Def must be set to the parent Biskit Type and the Biskit Property Type must be set to To One Biskit This property will define the Category BiskitDef that the Note is associated with If used the Category is stored with the note and is used to determine which Waterfall the note will be displayed in Other properties may be added to the BiskitDef such as auto
108. clude lt gt as well as AND or OR for example costPerHour gt 1000 OR costPerHour lt 500 AND costPerHour gt 275 When dealing with strings there are a number of functions that can be used here is a subset of the more useful ones Function Description S When dealing with dates there are also many functions some of the more useful are Function Description O datediff date1 date2 Returns the difference in whole days between two dates unix_timestamp date Returns the number of seconds since midnight 1 1 70 timediff date1 date2 Returns the difference between two times as a time string time_to_sec time Returns the conversion of a time string to seconds Using time_to_sec in conjunction with timediff allows a calculation of the time in seconds between two times i e time_to_sec timediff date 1 date2 2010 2015 Exprodo Software Exprodo DB Configuration Guide 199 Here is an example of a formulae using a nested case and datediff In this example the value of a cost property of a booking is determined depending on the status of a booking lf the booking is denied or cancelled with more than seven days to go then do not charge If the booking goes ahead then charge the rate found in the property costPerHour in the Project Resource Settings for that project multiplying by the duration in minutes of the booking divided by 60 to give hours If the booking was cancelled less than two
109. combination of them is required 9 Biskit Format Definition The syntax of the format is rather convoluted and there will soon be an editor that will let you configure it without having to understand the syntax Dynamic Biskits Use the Bakery to create new Biskit definitions These will be dynamic Biskits The user can use Exprodo DB to handle create read update and delete values in any table with the following restrictions e There must be an integer valued primary key e The new dynamic Biskit must contain only dynamic properties This means that if an extra property is added to the dynamic Biskit the database table must contain a column for it If the column doesn t already exist then Exprodo DB can create the column for the user or the user can create it Dynamic Biskits can be used in exactly the same way as static Biskits Creating Biskits Biskits can have links to each other via properties also some meta property values of a Biskit depend on having appropriate properties which means that creating Biskits and their properties is not a linear event i e the user cannot start at the beginning and hope to move step by step to the end saving completed Biskits as they go Sometimes the user will need to create a Biskit with its properties save it with errors create a second Biskit save it with errors go back to the first Biskit set up new information now available in the first Biskit because the second Biskit has been cr
110. cribed above At the same time the user can decide what aggregation to use No aggregation or Count Distinct as well as whether to Ignore null values Columns Count Count of Bookings resource Count Distinct Values o Count Distinct x W ignore null values booker Booker No aggregation ignore null values created Created No aggregation iy VJ ignore null values E Count of Bookings Mid L biskitType W E allDay booker C cancellationReason cancelled created od ae OK Cancel b ca OK Clear columns 2010 2015 Exprodo Software Exprodo DB User Guide 35 Once the columns have been chosen the table will redisplay using the appropriate number of rows to display the records grouping records by the columns chosen giving a count in the first column File Search for Resource Report type Group Report Conditions Columns Reset Ge Autorun Found 4 groups of resources Pro ect Mot Required Project HA R guirsd Project Required planet earth Pro ect Required Once the columns are displayed move the cursor over the name of a column and a pop up will appear with Change in it Click on Change in order to change 1 The column header 2 The column content OK Cancel hits Column Content 2 Iv E Ignore null values C Scaled Column Heading Sum of Hits The co
111. cted item cannot be deleted due to Permissions or it is being referenced by something else If there are many things in the database that reference the item then it may be difficult to delete it because the references must be removed first Press to delete the selected items from the database The Create button will create a new item of the selected type but it will be greyed out if the user does not have permission to create items of that type Once pressed the item will go into edit mode The item will not exist in the database until either Save or Apply are pressed Apply Cancel REL Create Create The Create Copy button will create a copy of the selected type but it will be greyed out if the user does not have permission to create items of that type Once pressed the item will go into edit mode The item will not exist in the database until either Save or Apply are pressed LER Cut The Cut button cuts the currently selected item removing it from its current position and puts it in the edit buffer for later use overwriting the current buffer contents Copy The Copy button takes a copy of the currently selected item and puts it in the edit buffer for later use overwriting the current buffer contents Paste The Paste button pastes the current paste buffer contents to the currently selected position 2010 2015 Exprodo Software Li 16 Exprodo Dat
112. cted G i j afterFinishedChangeOption collectUsage inFrogressChangeOption g largeUsageRecorder laterChangeOption laterTermMinutes location name amieciRennired A Resource has a number of properties as shown One of them Location is itself an object that has properties of its own that can be selected The Relation Value and Accuracy part of the condition will not show unless a property path has been selected Once a property is selected the extra parts of the condition appear and they reflect the type of the property selected and the choice of Condition Type 2010 2015 Exprodo Software Exprodo DB User Guide 21 The Relation The Relation is only shown when there s a bisikit type in the context and a property path has been selected The options displayed in the Relation drop down menu differ depending on the type of property selected by the property path This is the standard choice of relations for an integer or floating not equal to point number property less than less than or equal to greater than or equal to greater than equals A date property displays with semantically identical options but not equal to using different words to match the English you would expect no later than no earlier than later than Not all integer properties display using the above options That s because some integer properties are defined as a bit set of values of named integers see Bit Sets for details A g
113. d and this property references the parent The parent will also have a Set or List property that contains its child Many To One Biskits using a One To Many property With this value of Biskit Property Type we must also specify the Inverse Property that is the name of the parent s property that contains the children ster to Slave When a Biskit is required which has a large number of properties ie in excess of a thousand in SQL the DB cannot cope with this Ma Slave To In order to do this create Slave Biskit s that is Biskits that are created Master deleted and referenced with their Master The Master Biskit would 2010 2015 Exprodo Software need a property of type Biskit which would point to each Slave and be a Master to Slave type the Slave would need a property of type Biskit which would point to the Master and be a Slave to Master type A Master can have many Slaves in order to reference as many properties as needed The only caveat is that the Primary Key Column Name for any Slave Biskit must be different from the Masters defaults to id therefore needs to be changed and different from any other Slave of that Master The Inverse Property also needs to be set up in both BiskitDefs E See Creating a Master Slave Biskit Relationship example 186 Exprodo Database User Documentation 4 9 3 2 Boolean Property Definitions A boolean property as well as the normal settings required by a Prope
114. d when and by whom This page is normally found on the Search menu as Search gt History However the menu may have been configured so that the History page is not visible To use the page first enter the search criteria and then press the Go button to see what matching changes can be found The search criteria can be e Data type choose what type of Biskit has been changed For example if the user is interested in changes to bookings then select Booking If a Biskit Type is not selected then the search will include changes made to any type of Biskit e Search from and Search to to restrict the search to particular periods of time It is highly recommended to put limits on the time period using these options so that the amount of returned results are limited e User choose to see changes made only by one particular user or by anybody e Data ID choose the unique ID number to search for For example if the user is interested ina project and they know its ID is 42 then enter 42 here to restrict results to changes made to project 42 e IP Address search by changes made from a particular internet address ar Search from F Any date time Search to Any date time User Anybody E Data ID IF Address After pressing Go a list of matching changes is displayed Each one will represent a change to something within Exprodo DB When the list appears click on one of them to see all changes to the same Biskit For example if t
115. d of what happened in the past This setting sets up how often Exprodo DB looks for repeats that have just happened and need a new historical entry creating This limits the frequency with which database dumps can be created This is here because database dumps take some time and can Database Dumps degrade system performance so they don t want to be allowed to be In Minutes run too often Temporary This is the name of a directory that is used to store temporary files Directory that are created for downloading Run Data If Biskit definitions are changed using the Bakery then it is Definition possible that the system may be left in an inconsistent state Validation At Boot This setting disables the boot time checks that are done to make sure the Biskit definitions are consistent If there is a problem and boot time checks are enabled then Exprodo DB will not boot properly If there is a problem and boot time checks are disabled then the user may be able to correct the problem in the Bakery but the issue may cause something to work incorrectly in the meantime Read Only Mode ibe indicates whether Exprodo DB should operate in a read only mode Check Reserved Choose whether to enable protection that stops users from using reserved database words for table column and property names Past Repeatable Minutes Between Flushes Minimum Time Between when using the Bakery This is particularly
116. d the new database into Exprodo DB d Refresh the browser 2010 2015 Exprodo Software 224 Exprodo Database User Documentation 4 9 5 1 8 Creating AHierarchy Of BiskitDef An example of creating a hierarchy of BiskitDef similar to Location Where a parent can have many children of the same type of BiskitDef and a child will have only one parent We will create one called Organisation Go to Admin gt Bakery Press the Open All button to open the Biskit Tree Select any Biskit Press the Create button to create a new Biskit and enter edit mode Update the meta properties of the Biskit a Change Type to be the new BiskitDef name in this case Organisation b Change Group to help find all the new BisketDefs using the Filter Biskit Group button c In Properties Add New Change Name to Name d Change Name Property on the BisketDef to point to the new Name property Or KRG DH eS ae ie Label Upper organisation Editable r sistent i Null Allowed Ei fe in B all Net Va abe ees On ven CH FI ae i EHS t Null Value Label Read Write use default gt Visible in Collection Editor E z Shareable Tanie Shareable with sud types Alkas Deletion While olaa Does not allow deletion eE a 2010 2015 Exprodo Software Exprodo DB Configuration Guide 225 Properties Add New Cut Copy Paste Delate a Change New Pa
117. d to determine how the add note area is defined Below you can see an example of an add note area Add Note To This Visit 1 Add Note So far the area to write and add notes has been defined Next the user needs to define an area to display all the notes that have been written to the DB this is called a Notes Waterfall Once the Waterfall is enabled the user can define what heading will appear above the Waterfall in the layout Enabled Finally notes can be stored under a number of Category s In order to set up the Category s a hierarchical BiskitDef needs to be defined this is where a parent can have many children of the same type of BiskitDef and a child will have only one parent The minmum properties would be Property Type Description String This property will hold the Category name Set This property will point to the children s BiskitDef as a Set These will be of the same Biskit Type as the parent Biskit This property will point to the parents BiskitDef This will be of the same Biskit Type as the child 2010 2015 Exprodo Software 170 Exprodo Database User Documentation Please select a Note Category Person Communications and events Facilities Finance Human Resources Damen den 4 Once the Category is enabled the use will need to set the Category property This is the property on the Note BiskitDef that points to the Category BiskitDef Then the
118. d value Harvard Any kcl Lous Not all a f name starts with None VWalu of hype namie ends with When there are no conditions it looks like this in a writeable context File Search fer Resource Report type List Report Conditions Columns Reset Go F Autorun Conditions x There are no conditions Add condiion amp OK Cancel When editing Conditions add a new Condition by pressing the Add Condition button At any time clicking on the green button will add a new condition after the current one clicking the red button will delete the condition the button is associated with Whenever there are multiple Conditions they will appear in the Conditions Panel each in their own row The Conditions Context A Conditions Panel is subject to the context within which it is used There are two parts to the context that affect the way the Conditions Panel behaves the Biskit Type the condition is being placed upon and whether used for an update so that there are two instances of the data available the Old Value and the New Value or whether there is just one instance available the Value For an Automatic Email the context Biskit Type is the type that triggers the email If the email is triggered by any Bisikit Type then it means the context has no Bisikit Type There s a New Value available when the action that triggered the email is an Update and not when the action
119. days ago charge 50 otherwise charge 20 case when status Denied then 0 when status Approved or status Requested then projectResourceSettings costPerHour durationInMinutes 60 else case when datediff start_date cancelled gt 7 then O when datediff start_date cancelled gt 2 then 0 2 projectResourceSettings costPerHour durationInMinutes 60 else 0 5 projectResourceSettings costPerHour durationInMinutes 60 end end Known Formulae Problems There are a number of issues with using formulae in Biskits As the formulae has to be converted from what is written in Exprodo DB to MySql there are currently some functions that will not work 1 Any function that requires a string constant as a parameter These constants do not currently convert from Exprodo DB to MySQL cleanly For example timestampdiff unit datetime_expr1 datetime_expr2 where unit is one of FRAC_SECOND microseconds SECOND MINUTE HOUR DAY WEEK MONTH QUARTER or YEAR Unit does not convert properly 2 The if statement does not work so use the if function instead 3 Use T and F for the value of Boolean properties 2010 2015 Exprodo Software 20 Exprodo Database User Documentation 4 9 5 Bakery Editior The Bakery Editor allows an Admin user to see modify create and delete Biskits and their properties The Bakery Editor also allows access to any Mapped Integers or Strings any String a
120. dit every property If the user wants to change the more complex properties such as lists of things then they need to use a different change mechanism For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter 1 Click anywhere in the row for the item to edit apart from its check box in the first column The item s details are shown below the list of items Calendar Template Bookings Projects Search Admin Help admin Reset password Settings Sign out C selected mme _ ie cked Normal Normal Paul Robinson info calpendo co Clare Mackay clare calpendo co Edwin E Hubble al ah co Normal Normal Groups me Finish a a id Coal Se a 2 Press the Edit button not the one in the checked button bar 2010 2015 Exprodo Software EE Exprodo Database User Documentation 3 The item is now shown with the properties editable Note that depending on how permissions have been set up it is possible that some properties will still show as read only Refresh Delete Save Edit View History Create Create copy References Printable view User 6 passo C Password must be reset at next login v Please select a Project to add v e refses pre one ee e iresgaos DE E E E So inv
121. dit mode Name ew user req Enabled fue Ca rae When changing these details e The Name can be anything you like but must be unique amongst Automatic Emails e The Enabled flag is a way to create an Automatic Email without making it take effect immediately or to turn one off without deleting it These show in red in the tree e The Event Type is where it is specified whether the Automatic Email is triggered by a Create Update or Delete e The Data Type value indicates which Biskit Type triggers the email Choose the Any data type option to make the Automatic Email trigger for every Biskit Type However this does quite severely limit what Conditions you can use and what magic text can be inserted into the email described below 2010 2015 Exprodo Software 120 Exprodo Database User Documentation The Conditions Tab Conditions underpin much of the configuration that can be done in Exprodo DB and they are used in several places most notably in Automatic Emails and Permissions P Consequently they have their own section of this configuration guide See Conditions for the details Please note that the section that describes conditions indicates that the Updated Value condition type is considered an error in some contexts When the Automatic Email is triggered by a Create or Delete action that is an example of Updated Value being inappropriate The Recipients Tab In read only and editable mode
122. ditor The Layout Editor allows the user to define how the properties s displayed This is required because Biskits could have a large number of properties numbering in the hundreds and in order for users to find those properties to update them it is necessary to organise them The Layout Editor allows the user to organise the properties of a Biskit into multiple Property Groups Property Groups may themselves contain child Property Groups Property Groups at the same level may be organised in one of four ways Vertical Tabs Vertical Tabs Sorted by Name Horizontal Tabs and Captions Property Groups may have a heading and may also be hidden The properties contained within a Property Group may also be organised in one of four ways Simple Table Multi Column Table Radio Button Table and Custom HTML For each table row column or cell the standard CSS can be changed allowing the user to set such things as font background colour border size type and colour and many other attributes Finally for any Property Group Notes can be set up to be created and then displayed in a Notes Waterfall 2010 2015 Exprodo Software Exprodo DB Configuration Guide 157 The Layout Editor is split into four sections in two panes 1 The left hand pane shows a list of BiskitDefs that have had layouts created for them when a BiskitDef is expanded all the layouts defined for that Biskit will be shown Any in red are currently not enabled
123. do DB Configuration Guide 117 The Automatic Email Editor shows all the Automatic Emails and allows creating updating and deleting them By default it appears on the menu here Calendar Templates Bookings Projects Search Automatic Email Refresh Open All Close All Display t Create Any type User System Event Project Admin Help admin Reset password Settings Sign out s Booking requests J Project requests Ess F Be a User requests List of users List of projects Email gt Automatic Email FAQ Editor Manual Email Global Preferences Menu Editor Permissions Resource Editor Rule Editor Template Constituents Editor Types and Groups Editor Database Dump Bakery The Tree Of Automatic Emails Automatic Emails are triggered when data of a particular Biskit Type is created updated or deleted Each Automatic Email defines which Biskit Type triggers it and which action created updated or deleted triggers it This means all the Automatic Emails can be categorised by Biskit Type and action The above screen shot shows all the Biskit Types for which there are Automatic Emails Note that an Automatic Email can be defined that will trigger for any Biskit Type For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Calendar Templates Bookings Projects Search Automatic Email r Refresh Open All Close All Display
124. e main URL For example if a Project has been changed then set up a link like this URL ba amp type Project amp action view amp id NEW id In this case URL is replaced by the main URL then ba amp type Project amp action view links to a page that is told to display Projects and not other Biskit types Finally the amp id NEW id specifies the identifier of the particular Project that was changed The easy way to work out how any URL like this should be formatted is to first go to the relevant page and see what URL Exprodo DB uses then replicate that within the Automatic Email replacing parts as appropriate with dynamic text It should be noted that it s not normally useful to insert a URL into an email s subject However the same URL button is also used for the content of an email as discussed in the next section 2010 2015 Exprodo Software Exprodo DB Configuration Guide 125 The Email Body Tab The body of the email works just like the subject does The only differences are that there are extra buttons for additional magic text and the editor allows multi line text instead of single line text In write mode it looks like this USER NEW OLD DATE IP ADDRESS AUDIT LOG URL DIFF ALL Thank you for registering with Calpendo You will receive another email when the administrator has processed your request Please note that this may take up ta 24 hours The extra two buttons D
125. e objects that the user is allowed to know exist will be seen This also means that when generating a report that counts the number of objects matching some criteria then the count will not include objects for which the user does not have Exists permission When sending an email each object property that is to be included in the text is checked for both Read permission and Email Readable permission Also for every property inserted into the email the object the property comes from is checked for Exists permission Emails may be read by anybody and so when Exprodo applications check permissions 2010 2015 Exprodo Software Exprodo DB Configuration Guide 103 for what can be included in an email it checks whether the special user nobody has the relevant permission as well as the user that performed the action that caused an email to be sent Therefore it is necessary to create a Permission that gives Email Readable permissions to_user nobody for any information that is required to go into an email See Special Users for more details on user nobody Update When a user tries to update an object Exprodo applications will check for Update permission on the object and also on each property If permission is denied for any property then Update permission for the whole object is denied This is different from viewing an object where being denied permission to read one property does not stop the user from seeing the other properties
126. e representing the parent in the hierarchy and also a property containing a set of its children So Europe has children United Kingdom France Germany and so on String property name When a user selects a Biskit from a hierarchy they are presented with a tree widget making it easier for them to choose the right item For this to work Exprodo DB needs to Know which property contains the children This must be a OneToMany Biskit property Label Lower Strin Text used to display the Biskit Type when the context calls g for a lower case label Label Upper Strin Text used to display the Biskit Type when the context calls PP g for an upper case label Labels Lower Strin Text used to display the Biskit Type when the context calls g for a plural lower case label Labels Upper Strin Text used to display the Biskit Type when the context calls PP g for a plural upper case label Null Value The label to show for Biskits of the type represented by this Label Read String BiskitDef when that Biskit is null and we re displaying in a Only read only context Null Value The label to show for Biskits of the type represented by this Label Read String BiskitDef when that Biskit is null and we re displaying in a Write read write context Tooltip String Text to display as a tool tip describing this type of Biskit Nobody Root Admins Indicates who can see that this Biskit Type exists Users or Eve
127. e Create button to create a new Mapped Int 5 Update the meta properties a Change Name to Yes No b Change Null Value Label to Not Selected 6 Use the Add button under Values to create a new value a Change Name to Yes b Change Value to 1 Use the Add button under Values to create a new value a Change Name to No b Change Value to 0 5b Change Mull Value Label to Hot Selected Vee bal Change bb Change CS Name to res Value to 1 NametoNo jj valle to 8 Press the Save button 9 Refresh the browser 10 Press the Open All button to open the Biskit Tree 11 Select the Biskit to add properties to in this case Project 12 Press the Edit button to get the Biskit into edit mode 13 Press the Add New buiton to add a new property 2010 2015 Exprodo Software Exprodo DB Configuration Guide 217 14 Update the meta properties of the property a Change Type to Int b Change Name to something relevant in this case SignedOff c Change Integer Type to Mapped Integer d Change Mapped Int to Yes No e Change Default Value to Specified Value and Not Selected Properties Add Maw Cut Copy Paste Delete e A a Change feraglfecyectcoce sting a a olr ales e euli i h EL Name to fdrag fnar Description F None ae a u Sign icragifcescnption Sting segfewerrore dem fo noms S E r me p oooO 7 S i Visible Editable Persistent v Null Allowed E a Er T Required V
128. e HTML that will be shown at the top of every page Show advanced appearance setings 2010 2015 Exprodo Software Exprodo DB Configuration Guide 145 4 7 2 Date And Time The Date And Time tab of the Global Preferences page specifies formats to use for dates and times within Exprodo DB These are used in a number of places 1 In Automatic Emails sent out by the server that contain and dates or times 2 When anew user is registered the_date and time formats of their user settings is copied from the global preference Date Format 08 01 2010 Time Format Date amp Time Format 01 08 2010 13 45 Prefer US Date Format 2010 2015 Exprodo Software 14 Exprodo Database User Documentation 4 7 3 Email The Email tab of the Global Preferences page specifies the following Email Sending Enabled mail calpendo com debug calpendo lt calpendo c onaptic gt Exprodo Support lt support exprodo com gt Connection Security STARTTLS Use authentication http xps Calpendo info exprodo com i om ma separated list of ema mm Signature Setting Description Email Sending Set this to true to allow Exprodo DB to send emails and false to disable Enabled all outgoing emails SMTP Host This is the hostname of the SMTP server to be used for sending outgoing email SMTP From This is the name and possibly email address that outgoing emails
129. e Permissions Example 1 Anybody May Create A Booking Request A booking is a Calpendo object that has a status start and finish date and a few other properties This example will create a Permission that authorises anybody to create a booking when the booking to be created has its status set to Requested Note that by creating a Permission like this it doesn t influence what happens when somebody tries to create a booking whose status is set to something other than Requested 1 Create a Permission that applies when a booking is Created and give it a name Give the permission a name Leave the permission enabled Leave the data aia Tai Set the property set to none BiskitDef to Booking Make this a grant authorisation so targeted users are ranted permissior granted permission Tra priority of zero 2 Add a condition Status is Requested 3 Under Applies To ensure Include Everybody is ticked Conditions Applies To Does Not Apply To A Include Everybody 4 Under Does Not Apply To ensure Exclude Nobody is ticked Exclude Nobody 5 Save the Permission 2010 2015 Exprodo Software Exprodo DB Configuration Guide 109 Example 2 Anybody Can Modify A Booking Request They Created If The Booking Is Still A Request This example shows the difference between using a Old Value condition and an New Value condition We need a Permission that will
130. e _ Type Group None MyCompany Group ta arag nt Primary Key pP O Jmm version Number fo ange 6 Create new the Biskit 3 same as parent Sort Property Use default sorting Y dateRange v Hierarchy Property No suitable properties found Persistent 7 Null Allowed Label Lower scanners i Required 4 Visible In Biskit List Null Value Label Read Only Use default v Null Value Label Read Write Use default v Storage Mechanism Toot C T r Storage Mechanism C J Share Super Type Table Share database table wether new Shareable Table Shareable with sub types v share a table Allows Deletion While Referenced Does not allow deletion Y 6 Press the Save button 7 lf there are no errors the database will need to be updated a Press Update DB Schema to implement changes in the DB and then run the script to apply the changes b Press Validate Biskits button to check the database Biskits c Press Reload Database Configuration to load the new database into Exprodo DB d Refresh the browser 2010 2015 Exprodo Software Exprodo DB Configuration Guide 235 4 10 Backing Up The Database To take a backup of the database use the Database Dump page which is by default on the menu as Admin gt Database Dump Y Include structure Include data Add drop if exists J Compress Include all tables Dump database Before asking for the backup there are the following options Option Descr
131. e location of your modules may vary from that shown below so you may need to alter this sample configuration LoadModule proxy module usr lib apache2 modules mod proxy so LoadModule proxy http module usr lib apache2 modules mod proxy http so LoadModule rewrite module usr lib apache2 modules mod rewrite so LoadModule deflate module usr lib apache2 modules mod_ deflate so LoadModule ssl _ module usr lib apache2 modules mod_ssl so For mod_deflate you will need to add config like this lt TTMooule mod detlate c gt AddOutputFilterByType DEFLATE text html text plain text xml text css text javascript lt IfModule gt This allows Apache to gzip the files it serves This has a marked impact on the size of Exprodo DB javascript files in particular You will now need to configure the Exprodo DB aspects of Apache You will have your own requirements here but here is the configuration you will need to provide access to Exprodo DB from a URL of httos vourServer DB RewriteEngine On RewriteRule DB Service DB com springsolutions exprodo basic Basic ServiceSl RewriteRule DB program html DB com springsolutions exprodo basic Basic prog RewriteRule DB S DB com springsolutions exprodo basic Basic program html RewriteRule DB DB com springsolutions exprodo basic Basic 1 PT L ProxyRequests Off lt PLOXYyY gt Order allow deny Allow from all lt Proxy gt ProxyPass DB http localhost 8080 DB ProxyPassReverse
132. e o un 20a 0 fo fuse ______Jtecaverek rence _Jonex uanenancom maccy Juema_Jo __ Oj Yivcatwatsen rence watson Juanenin com macy Reqvesta a Js von va 10s un 20a oma ous forensen fesen foaroan emacs ema oJ __ Ose aens fromas Java Jessen Juanein com fens frees 1s son ra sale un 20a eg fofuse___Jlocavresia_ wicia ____ resia uanguancom emacs uema Jo __ CE a vex rane anein com emacs rea Jo t_ Eait Delete Approve Deny Block Force password reset The following section goes through the options available after the search has been completed enabling the search to be changed saved or the data exported as well as change the information viewed by the search For more information on any of the features shown read the Search chapter File Report ty Save As Allows saving of the report for later use Export Allows export of the information found in the search to a file This button determines what type of report will be seen Single Item Report Displays a single record that matches the Report type Group Report C search single Item Report List Report Lists each record List Report found that matches the search one under the other Summary Report Summary Report Allows the G Re kaalasi diia Mie lace salen inin i information found to be summarised Group Repot Allows the report to be shown by groupings with a count of the number of records that f
133. e properties The search box can be used to find a property Once the user starts typing a name into the search box a list of possible properties will appear as the user continues typing the possible list will reduce until only one remains The Properties branch containing that property will be expanded in the tree and the property will be highlighted If what has been typed does not match any possible property the search box will be outlined in red and the search text will also go red 2010 2015 Exprodo Software Exprodo DB Configuration Guide ter Information Pane The Information Pane will have information about the item that is currently selected in the Organisation Pane There are three types of items that can be selected 1 AProperty Group 2 AProperties branch 3 A property Copy lf a Property Group is selected then information about that group is displayed Any properties associated with the Property Group are listed under the Property Table tab Property Grouping Method showing their Name and Label pears The Notes tab allows the user to define whether this Property Group contains a Notes field and or a The Copy button allows the user put a copy of this Property Group into the buffer for later pasting Description PSQISLPQUAL psqiSLPQUAL Name of the Property Group F Whether the Property Group should be hidden from view Property How the child Property Groups of this Grouping Pr
134. e used if there isn t a relevant property Permission There is also a numerical priority that can be specified for each Permission and that provides another way to layer Permissions because the highest priority Permissions within each of the three layers action Biskit Type and property are considered first lf a relevant Permission can not be found then permission to perform the action is denied Precedence Of Permissions When sorting through the Permissions to decide which one to apply Exprodo DB will only consider those that match the action Biskit Type properties conditions and that also target the user concerned Also note that those Permissions that do not specify a Biskit Type will also be considered Once that filtering has taken place Exprodo DB will use property Permissions first then Biskit Type Permissions and finally action Permissions Within each of those three Permissions are further sorted by priority and the Permission with the highest numerical value for its priority will be used If there are multiple Permissions with the same priority then it is undefined which one will be used The reason this is required will become apparent after going through the way in which the conditions under which each Permission may be used can be specified High precedence Property Permission Biskit Type Permission Achon Permission Low precedence Precedence of permission types When a BiskitDef has another Bi
135. eaf fewe S raar E frevo Nuffield Dept of ffi f drag al Nuffield Dept o Surgery jerar E fP nove 2010 2015 Exprodo Software Exprodo DB Configuration Guide 25 Editing Units When in edit mode there is a list view once a unit is selected there will be a single record view underneath the list view For more information on How to Edit Multiple Items At Once P in the list view and How to Edit A Single Item in the record view read the appropriate sections of the Data Explorer chapter Cancel Save Dfe p pos p p re aves Im fo OOO mas C CC E cenimares fom fn po fo E Joss_fo_ Je ie Edit Remove Remove Add Apply Edit Cancel Create Create Copy Printable View Unit 29 Sub Units Per Unit 1 Sub unt 2010 2015 Exprodo Software 2 Exprodo Database User Documentation 4 9 5 1 Bakery Editor Examples 4 9 5 1 1 Adding Properties An example of adding a property to the Biskit of type Project called ProfessorSignOff of type boolean which is required to always have a value and starts with the value False 1 Go to Admin gt Bakery 2 Press the Open All button to open the Biskit Tree 3 Select the Biskit to add properties to in this case Project 4 Press the Edit button to get the Biskit into edit mode Properties Add Naw Cut Copy Paste Detete VM jorag status vavaEnum fjcrag fowner d CA E Era el E E arag
136. eated re save the first Biskit go back to the second Biskit update that with information from the first Biskit and save This means when creating your own Biskit s make sure there is a plan on how they are going to connect together 2010 2015 Exprodo Software Exprodo DB Configuration Guide 179 Inheritance Biskits can inherit from other Biskits inheriting all their properties To do this set the Parent meta property to be the Biskit the new Biskit is inheriting from When a Biskit inherits from another Biskit it needs to be specified whether both Biskits will share the same table or whether the new Biskit will have a table of its own for its own properties those it does not share with the parent This is done by setting the Share Super Type Table meta property A Biskit can only share the table of the Biskit it inherits from if that Biskit has the Shareable Table meta property set to allow it This may seem very similar to copying a Biskit but there are certain major differences When editing the child Biskit the parents properties are not seen After adding a property to the parent the child automatically has access to the new property When changing any meta properties of properties in the parent the child Biskit will automatically inherit the changes e g Default Value A property in the child cannot be created using the same name as a property in the parent lf the child Biskit has a sibling same parent Biskit and th
137. ecify how many of each of the properties are being used and the limit defined by the current key 2010 2015 Exprodo Software 150 Exprodo Database User Documentation 4 7 6 Menus When a new user logs in to Exprodo DB for the first time they are assigned a menu This can overridden by specifying a menu as described in Changing A User s Settings However if settings for a new user have not been set up then the menu they are assigned depends on their user roles and this is controlled by the Menus tab of the Global Preferences page Default User Menu User menu Default Admin Menu j Admin menu Default Root Menu Root menu B Description Setting Default User This is the menu to be assigned to users that have neither the Admin Menu nor the Root role Default Admin This is the menu to be assigned to users that have the Admin role but Menu not the Root role Default Root This is the menu to be assigned to users that have the Root role ae 2010 2015 Exprodo Software Exprodo DB Configuration Guide 151 4 7 7 Network Metrics Exprodo DB can keep information that tracks how long each network call took This information can be turned on if you want to investigate network performance but it should normally be left turned off The Network Metrics tab of the Global Preferences page provides the following Network Metrics Enabled Number Of Network Calls Between Sending Metrics
138. ect the frequency of the mail Daily Weekly Monthly by Date Monthly by Day Yearly Starting Ap 2013 09 03 Every 1 day s End om No and data Select when the emails will start every day Ca ReEeat Witten description of the scheduling options chosen for checking Specify the frequency every other day every third week etc Select when the emails will end if required 2010 2015 Exprodo Software 44 Exprodo Database User Documentation Select the Export Settings tab to set up the format of the exported file ee en eee 1 Format How the file will be formatted choose between Comma Separated Values Excel xls Excel xlsx and Tab Separated Values Comma Separated Values fd F Header Show Labels Show labels Content Show Labels Show value labels where defined 1 Header What headings will be used these can be Show labels or Show property names Labels are those names that have been assigned by the administrator to a biskit type the property name is the name of the property in the database 2 Content Whether enumerated types have their names shown Show value labels where defined or the value as stored in the database Show underlying data value 2010 2015 Exprodo Software Exprodo DB User Guide 45 2 6 3 History The History page allows the user to look into the audit log kept by Exprodo DB that shows what has been change
139. ed Created Property Created YF Propet to treated Updated Property Daea CS c Set Updated Propet kalpcoted Al Abstract ee eee Eumee fa oooO O Hierarchy Prope No suitable properties found feo A ShareableTable f Shareable with sub types Allows Deletion While Referenced 9 Set up the meta property information a Set Version Property meta property to Version b Set Created Property meta property to Created c Set Updated Property meta property to Updated 10 Press the Save button 11 If there are no errors then update the database a Press Update DB Schema to implement changes in the DB a pop up will appear defining the database changes to be implemented 12 Press the Apply Changes button to update the database There will be a response saying how many rows affected Press OK to finish a Press Validate Biskits button to check the database Biskits b Press Reload Database Configuration to load the new database into Exprodo DB c Refresh the browser 2010 2015 Exprodo Software 216 Exprodo Database User Documentation 4 9 5 1 5 Adding ANew Yes No Mapped Int Property An example of adding a new Mapped Int to the Database for use in integer properties giving Yes No as the drop down values rather than True False 1 Go to Admin gt Bakery 2 Open up the Mapped Int tree 3 Select one of the Mapped Int s 4 Press th
140. ed for a type when they first register The type is a means of segregating users into non overlapping sets which may be used by the facility for assigning Permissions The possible values for a user type are configured in Configuring Types And Groups 2010 2015 Exprodo Software 56 Exprodo Database User Documentation Password The users password is stored here but will only be shown as a number of dots for security reasons If there is no password the box will be empty Status A user s status indicates whether they can log in It can take the following values Status Description Requested his is the status given to a user when they first register A user whose status is Requested cannot log in Normal This is the normal status for a user who can log in Password A user whose status is Password must be reset at next login can log in must be but they will be forced to change their password as soon as they do so If reset at an administrator needs to reset a user s password then it s useful also to next login set their status to this value at the same time Blocked A user whose status is Blocked cannot log in Typically use this status for a user that needs to be stopped from logging in for some reason Denied A user whose status is Denied cannot log in Typically use this status when not approving a new user request although there is also have the option of deleting the user A user whose status
141. ed out if there is no item selected or if the item s history is already being shown To revert back to showing the item s details press the View button or the History button 2010 2015 Exprodo Software 2 9 Automatic Emails Exprodo DB User Guide Conditions are used in several places within Exprodo DB most notably Searching and Permissions amp Understanding Conditions is essential in order to be able to configure Exprodo DB properly because of their pervasive use Their purpose is to allow you to specify what situations generate an email or to which situations a Permission applies The chapter on Setting Search Conditions goes through basic conditions and how to use the Conditions Panel This chapter will expand on how to use conditions for the more complex tasks required in Automatic Emails and Permissions amp Conditions The Anatomy Of A Condition A Condition extracts one or two properties amp from the context and checks whether a relation holds true If it does the Condition is said to match A Condition consists of the following items in this order Condition Type Property Path Relation Value Accuracy The Condition Type indicates the source of a property The Property Path tells how to reach a property from that source The Relation provides an operator to compare the value of that property to another value The Value provides a value to do the comparison against The Accuracy specifies how accur
142. eeeeeaesueaaasseeeeeeeess 219 4 9 5 1 7 Creating A Set Of BiskitDef Attachments cccccccccesscceesseeccsseeeceseeeeessseecesseaseceeeeessseeseseaserness 220 4 9 5 1 8 Creating A Hierarchy Of BiskitDef cccccccccseeseseseseececeeeeeeeeeaeeaeaensessceceeeeeeeessesaeaeasseeeeeeeess 224 4 9 5 1 9 Creating A Master Slave Biskit Relationship cc ccceecceccceccceeeceeeaeeaeaeesseeeeeeeeeeeeeeeesaeaeesseeseeeeess 229 4 9 5 1 10 Creating An Inheriting BiskitDef BOOKING ccccccccessccccessceceeeeeeesaeecceseececsaeeeessaeecesstesersaneeenneeens 234 4 10 Backing US Th Database irni a A a aa aaa 235 Part V Exprodo DB Installation Guide 240 2010 2015 Exprodo Software Contents 5 Part VI Glossary 250 Index 255 2010 2015 Exprodo Software 8 Exprodo Database User Documentation 1 Getting Started Online Web Database Exprodo Database Exprodo DB is a program based on Exprodo for creating bespoke database applications This documentation was written for version 7 0 52 of Exprodo DB and was last changed on October 29 2015 2010 2015 Exprodo Software 10 Exprodo Database User Documentation 2 2 1 Exprodo DB User Guide This guide explains how to use Exprodo DB to access and search your bespoke database Getting A User Account Local Exprodo DB Account To get a local user account first open a web browser Exprodo DB supports the most popular web browsers
143. en first opened Calendar Templates Bookings Projects Search Admin Help Refresh Edit Create Create copy Local Imap Smtp For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter The only difference from the standard is that when the Create button is clicked a drop down menu appears to allow the administrator to choose which type of Authentication Method to be created Calendar Templates Bookings Projects Search Admin Help Refresh Edit Create Create copy Delete References History Local Basic Authentication Method Imap External Authentication Method smtp imap Authentication Method Local Authentication Method Smtp Authentication Method After pressing Create or the Edit button to make the page editable the button bar changes Cancel Save The detail view for the authentication method will also appear fill in the details and Save the method Imap Authentication Method 2010 2015 Exprodo Software Exprodo DB Configuration Guide 143 4 7 Global Preferences The Global Preferences page appears by default on the menu as Admin gt Global Preferences and provides settings that change the way Exprodo DB operates Once all the required changes are made on each tab the use the Save button to implement them Date amp Time Email General Licence Menus Network Metrics Security System Usage Stat
144. en the Biskit Tree Select any Biskit Press the Create button to create a new Biskit and enter edit mode Update the meta properties of the Biskit a Change Type to be the new BiskitDef name in this case Projectinfo b Change Group to help with finding all the new BisketDefs using the Filter Biskit Group button c In Properties Add New i Change Name to Name d Change Name Property on the BisketDef to point to the new Name property Properties Type a Change WylPrejeetnie i ewe L Paste LJ ee es A graa Projectinfo pei YE C Rii r F a a i i i i bch anged the m version Number fo Group to c Add new Name Property fig L MyCompanies property Set Property f d Change Use detautt soning oBRWND Project info Persistent Null Aliowed Project infos Required a 2 Visible in Biskit Detail Visible in Biskit List Vibe In Collection Editor columns none oo Storage Mechanism Dynamic propect mitg Wise default Null Value Label Read Write Lise default Sitilaty Everybody z S368 8HHHEH HHHHHAE ele e g E 9 garage Klechanisan 1 54 Sharestie with sub types Ajicws Deletion While Reteranced HOG AE HAHI HHE g F a z i 6 Press the Save button 7 lf there are no errors the database will need to be updated a Press Update DB Schema to implement changes in the DB and then run the script to apply the changes b P
145. entions Approved _leonardofinventions 4 Once changing properties has been completed press the Save button The item is then saved and shown read only again 2010 2015 Exprodo Software Exprodo DB User Guide 51 5 To cancel the edit while an item is shown in an editable format either click on the row for a different item or press the View button 9 Configuring The Properties Displayed The user can control which properties are displayed in the list of items in the detailed view of a item This is done in the Bakery gt Properties Visible In A Biskit List explains how to change the properties that are displayed in a list of items Change the visibility of each of the properties defined on an item gt Properties Visible In Biskit Detail explains how to change the properties that are displayed when seeing a detailed view of an item In this case it affects both the read only and editable mode detailed view of an item Again change the visibility of each of the properties defined on an item gt Properties Visible In A Collection Editor explains how to change the properties that are displayed in collection editors For example if there is a Project Biskit Type that contains a list of Users then the user can change which properties are shown to represent those users in the Project s list of users 2010 2015 Exprodo Software 52 Exprodo Datab
146. er definition called Role This is used by the Roles bit set property of a User Since it is used as a Bit Set it may only have values of 0 to 31 Value Zero is special in this Mapped Integer Any user whose roles property has bit O set is a Root user and Permissions do not apply to such a user So using the Bit Set bit table a user that has both Admin and User roles would have a value of 6 the 1 and 2 bits set A Guest user would have the value 8 just the 3 bit set The user may add additional values to this Mapped Integer and may rename any of them including Root 2010 2015 Exprodo Software Exprodo DB Configuration Guide ta 4 9 3 5 Java Enum Property Definitions A Java Enum property as well as the normal settings required by a PropertyDef must also specify its Java Enum This indicates which of the Java Enums to be used None com springsolutions biskit core CRUD com springsolutions biskit core PropertysDynamic Type com springsolutions biskit core Property Type com springsolutions biskit core def_AutomatedProperty Type com _springsolutions biskit core def_BiskitPropertyT ype com springsolutions biskit core def ProperntyDef integerT ype com springsolutions biskit core_def PropertyDef String Type com springsolutions biskit core def_ReferenceDeletionOption com springsolutions biskit core def_StringProperty Type com springsolutions biskit core def UserVisibility com snrinasoalutions his
147. er null is an allowed value for the property See below for a discussion about Null Allowed and Required Required Specifies whether it is mandatory to provide a value for the property See below for a discussion about Required and Null Allowed Visible In Specifies whether this property should be visible when the full detail of a Biskit Detail Biskit is displayed Visible in Specifies whether this property should be visible when a list of Biskits is Biskit List displayed Visible in Specifies whether this property should be visible when displaying a Collection collection of Biskits of this type Normally when editing a collection of Editor Biskits the number of properties displayed would be kept very small Editable 2010 2015 Exprodo Software 184 Exprodo Database User Documentation Required Fields And Null Allowed Required and Null Allowed sound like they are exact opposites and therefore Exprodo DB shouldn t support both of them However there is a subtle difference that means that it is sometimes useful to define a property that is both required and allows null The Null Allowed attribute is checked when building an editor for a property So when displaying a drop down for a Mapped Integer Mapped String Java Enumor String Enum a value representing null will be added if the Null Allowed attribute is set to true When a new Biskit is being created
148. ermission Action Exists Data Type Condition Value of self equals Specified value name of resource Self is property of type Biskit that points to the Biskit owning the property By using the self property rather than the name property the primary key of the Biskit is stored in the Condition and not the name therefore if the name changes the Permission will still work 2010 2015 Exprodo Software ne Exprodo Database User Documentation 4 4 Automatic Emails Exprodo DB can send emails automatically in response to any data being created updated or deleted An Automatic Email is a specification for the conditions that should generate emails to whom they should be sent and what the content of those emails should be So every time any data is created updated or deleted Exprodo DB checks to see if there is an Automatic Email that matches the data that was created updated or deleted The Automatic Email doesn t just specify fixed content that should be sent in the email but rather it specifies a template so that properties from the changed data can be included When creating an Automatic Email these are the elements set e AName to can distinguish it from other Automatic Emails e The Biskit Type of the data that must change for the Automatic Email to trigger e The type of change the data must undergo That is Create Update or Delete e Optionally specify conditions that are tested against the changed data e Speci
149. erties branch the information from the Bakery about the property is displayed for information This information can NOT be edited here even if the layout is in edit mode To edit the details of a property the user will need to go to the Visible In Collection Editor Baker 173 l _ Group Storage Mechanism Au as Pd bo ive o Storage Mechanism mated Property Type ax to 2010 2015 Exprodo Software Exprodo DB Configuration Guide 163 Information Pane Edit Mode On entering edit mode what is viewed in the Information Pane will vary depending on what is selected in the Organisation Pane if a Property Group is selected then the header information for the Property Group will be shown in an editable form See the table in the previous section for a description of the information displayed Add New Add New Child Cut Copy Paste Delete O Show Cell CSS Editors Heading Property Table Type Simple Table v Property Table Notes There will also be an edit toolbar Property Group Description Toolbar Item Add New Adds a new Property Group at the same level as the currently selected Property Group Add New Child Adds a new Property Group as a child of the currently selected Property Group Cuts the currently selected Property Group removing it from its current place in the tree and puts it in the edit buffer overwriting any current contents Copy Takes a co
150. ery attempt For defence against any attack it would be better to change this You can set up forwarding of HTTP requests from the firewall to the inner Apache HTTP server in two ways by configuring a reverse proxy with the ProxyPass directive or with mod_rewrite and the P directive If you use ProxyPass then you can make a configuration change on the firewall Apache HTTP server by adding the directive ProxyPreserveHoset On to the appropriate part of the firewall s Apache HTTP server configuration This situation is described here http tomcat apache org connectors doc generic howto proxy html You may be able to achieve the desired effect with SetEnv or SetEnvlf directives instead of the above but have not tested this 2010 2015 Exprodo Software Exprodo DB Installation Guide 247 Once you have done this you can check whether this is working as expected in one of two ways First you can look at entries that appear in the login_attempts table whenever somebody tries to login to Exprodo DB Secondly you can check from Exprodo DB by using either the Search page or the Data Explorer page Upgrading Exprodo DB Upgrades follow the following path 1 Stop Tomcat 2 Take a backup of your MySQL database mysqldump u root password somepassword db gt db saved sql 3 Apply any database upgrade script provided for your release For a release of version a b c this would mean mysql u root password somepasswo
151. ete Specify which columns are viewed by clicking on the Columns button and get a drop down list of tick box s for all available properties those who have their boxes ticked will be shown 2010 2015 Exprodo Software Exprodo DB User Guide File Search for Resource amp resources name C i J M Location a e Marif Urara Actual Usa ArT ca ooo i project Required oe or a Ee roject Requires pe Jory tab Harvard Room Project Required true NE ak a e N e E f scanner Po ES oe R E e IE A t Edit Delete 2010 2015 Exprodo Software 30 Exprodo Database User Documentation lf an individual record is clicked an expanded view of that record will appear below the list File Search for Resource Report type List Report Conditions Columns Reset Go F Found amp resources Autorun Name Location Type Project Required Collect Actual PE Yisescee raves ocame IS E fret iab ptanct earth Scanner Project Requires true COTE e ro Jorosct toques re ee Edit Delete Creata ese __e peen Usage Recorder Options CE E Access protection Allow any IP Address Usage Session ID Template Usage id lf the user has the correct permissions you may edit the individual records or make changes to multiple records All of this will be covered in the c
152. ew User Request Requires User Type User Session Timeout In Minutes 100000 Minimum Login Name Length a Request Filtering By User Type New User Default Roles Nothing selected Setting Description New User Request lf this is set to true then whenever a new user reqisters with Requires User Type Exprodo DB they must specify their user tyoe See Configuring Types And Groups for more information about types User Session Timeout This indicates how long a user s session will remain valid In Minutes without any activity Once this time has passed without them using Exprodo DB then they will have to log in again This should not be zero or negative If a user is timed out any request they make at the point of the time out will be automatically resubmitted when they log back in This specifies how many characters must be in each user name A user will not be able to register with a login name that is shorter than this setting lf this is set to true then the user requests page will only show user requests from users with the same user type as the currently logged in user Otherwise all user requests will be shown New User Default Roles When a new user is created Specify the roles they can have by default See User Roles for more information Minimum Login Name Length Request Filtering By User Type 2010 2015 Exprodo Software 156 Exprodo Database User Documentation 4 8 Layout E
153. ewer 135 Creating a New Menu 137 Custom Search Descriptors 135 Custom Search Pages 135 Minimum Length 155 Import 75 Attachments 85 Data Errors 8 7 Example Bookings File 80 Example Files 75 Example Project File 78 Example Resource File 77 Example Time Template File 79 Example User File 76 File Attachments 85 Handling Errors 85 Header Errors 86 Import Editor 82 Options 84 The Import Page 82 Violation Errors 88 2010 2015 Exprodo Software Required Fields 184 N Set And List Property Definitions 192 String Enum 196 Network Metrics String Enum Property Definitions 196 Enabled Preference For 151 String Property Definitions 194 Global Preferences For 151 String Property Type 194 Minutes Between Sending Preference For 151 String Type 195 Network Calls Between Sending Preference For Tab Layout 184 151 Visibility When Biskit Detail Viewed 51 183 Visibility When Biskit List Viewed 51 183 P _R Page Banner Global Preferences For 144 Password Read only Mode Allowing Browser To Remember 152 Global Preference For 148 Change 13 References 16 Requirements Preference Setting For 152 Repeat Permissions Time Between Repeat Flushing 148 Actions 102 Reports Applies To 107 Manager 74 Breaking An Activty Into Its Parts 98 Report Editor 40 Conditions 100 106 Scheduling 43 Details 105 Request Does Not Apply To 108 User 5 7 Examples 108 Roles How Permissions Work 97 Admin 54 Layering 98 Description Of 54 Overview 97 Root 54
154. ey all share the same table do not create properties of the same name in both child and sibling Currently there are no checks for this but it will cause problems in the database Automatic emails applied to a super type will automatically apply to any sub type Permissions applied to a super type will automatically apply to any sub type but may be overridden in the sub type 2010 2015 Exprodo Software 180 Exprodo Database User Documentation 4 9 3 Property Definitions A PropertyDef is the definition of a property on a Biskit In the exam ple of a Session described in Biskit Definitions we saw that a Session has 6 properties Therefore the BiskitDef describing a Session contains 6 PropertyDefs A PropertyDef itself has properties For example it needs to record the name and type of the Biskit property it represents There are quite a few different property types Type Description Type Specific Content Biskit Properties of type Biskit contain a reference See Biskit Property to another Biskit Definitions Boolean Contains a true false value see Boolean Propert Definitions Date Contains a date without a time element None paetae Contains a range of date time values None Datetime Datetime Contains a date and time None Double A floating point number Shige Double i TORONY Definitions The property contains a 32 bit signed integer This may be interpreted via a drop Gas ihiagar Panai Int d
155. f the types or groups in the left hand pane in the right hand pane will appear a list of all the entries for that type or group This will include two menus one above and one below the list For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Columns Refresh Open All Close All Refresh User Type User Group Booking Type Biology Frojects Project Type El ETES Project Group Edit Resource Type Edit Cancel Create Printable View Resource Group Delete Save Many items can be edited in one go quite easily in the list view using the check boxes read the section on How To Edit Multiple Items At Once in the Data Explorer chapter To edit an individual item from this list click on it and it will appear below the list and the edit functions allowed will no longer be greyed out Columns Refresh Refresh Open All Close All E User Type E User Group Booking Type Project Group t Edit Resource Type Delete Save Edit Cancel Create Printable View Resource Group Project Type 2 6 Biology Projects E GE amp amp 2010 2015 Exprodo Software 96 Exprodo Database User Documentation The Item View Once a group or type has been opened up in the left hand pane select individual items to work on Once selected these items will appear in the right hand pane
156. f you are going to install Exprodo DB on your own server Hardware and Software Requirements Operating system e Windows e MacOS e Linux Server Software e Java 7 minimum when we add support for HT TP 2 this will require Java 8 e MySQL 5 1 minimum or MariaDB equivalent e Tomcat 7 minimum e Apache HTTP Server tested on 2 2 and 2 4 although any version should work Server Hardware e RAM 4GB minimum 8GB recommended Hard Disk 10GB minimum but requirements depend on usage particularly if you configure the system to store file uploads Recent amp fast CPU recommended Both 32 bit and 64 bit supported e You can use a virtualised server if required Client Software e Chrome any version but recent versions preferred e FireFox any version but recent versions preferred e Safari any version but recent versions preferred e IE 9 or later IE8 mostly works but is extremely slow Expected Future Changes We expect the following changes to occur to our requirements e Tomcat Some time during 2015 or 2016 we expect to drop the requirement for the use of Tomcat We expect to replace Tomcat with Jetty which we will bundle with our software e Java Java 6 and Java 7 are both no longer receiving public updates from Oracle Further when we add support for HT TP 2 which will coincide with dropping the requirement for Tomcat HT TP 2 will only work with Java 8 and so we may require the use of Java 8 at that time 201
157. form what action on what data This can be done by creating multiple Permissions objects Exprodo DB looks at all the Permissions that apply to the action the user is trying to perform and uses them to work out if Permission should be granted or denied 4 3 Permissions 4 3 1 How Permissions Work some systems have a large master list of actions and then for each role there would be a tick against each of the actions that users with that role can do The problem with that kind of approach is that it is best employed when the system has a predefined set of actions that need to be controlled However Exprodo DB is designed to allow for precise control over the detail of what people are allowed to do This means that it is much more flexible for a variety of situations That flexibility also leads to a degree of complexity but this section of the manual will try to make this topic as simple as possible Permissions are not im plemented with an all encompassing list of actions The method that is used is to define a small set of simple actions and then create customised and highly targeted individual Permissions to control what can be done The overall picture is then obtained by aggregating those individual Permissions That aggregation is possible due to a mechanism that allows layering of Permissions where some Permissions can override others The crucial element in allowing this is the concept that Exprodo DB supports both authorising
158. fy the recipients of the email Do so by specifying 1 Individual Users a For occasions when the Biskit Type being changed is a User User Type or User Group then that user or set of users may be required to receive an email For example if an administrator changes a user s status to Blocked then set up an Automatic Email that sends the blocked user an email telling them they ve been blocked b The user that caused the original data change should receive the email For example when a user creates a project send them an email to confirm its creation 2 Individual user types 3 Individual user groups 4 The roles that a user should have for example to send the email to all users with the Admin role 5 A path to a custom property storing users user types user groups or email addresses This gives the ability to send emails to users outside the Exprodo DB e Specify the subject of the email This can contain properties from the changed data e Specify the content of the email This can contain properties from the changed data There is a flag to be set on the Automatic Email to choose whether it is enabled or not This allows the creation of Automatic Emails that are not always in use and therefore can be turned on or off as required See Also Conditions P these are central to the way Exprodo DB works and Automatic Emails in particular 2010 2015 Exprodo Software 4 4 1 The Automatic Email Editor Expro
159. ge e8 and Modifying Users Cancel Save Apply ewm O o o Other name Family name Login Name to be added here 2010 2015 Exprodo Software Exprodo DB Administration Guide 3 1 6 Modifying Users To see change or delete users go to a list of users Either use the dedicated User Search page or use Data Explorer as explained in the User Search chapter to get the list Once the list of users has been returned they can be modified Depending on which page was used to get the list of users either go to the Data Explorer r amp or Search P pages for more details on editing and saving Described below is how to specifically change a user groups Changing A User s Password Once the list of users is displayed click on the user whose password needs to be changed ae ee a N Fe fuser Acmn Guest Roof ocavect for fs _ Tr oser Aamin Guest LocaVaamn _ eT a a FT Fe fuser _____ tocarmupole Jeown fe ruwe pangen com spe ____ ae alee a fues ferea en bahbiat con Other name Email address blah blah com User Type Poss Password Expiry Date D O version SidSSCS CS SCO C C created Cd Requested Project Code s te r Projects Grou pS Local leonardo Click on the Edit button once in edit mode any of the users details may be changed If changing a users password it may be an idea to change the Status to Password must be reset at ne
160. gh I ve added the necessary config so that it supports compression If all access is to be made through Apache then this connector on port 8080 could potentially be turned off Leave it on for now so you can test the installation before we bring Apache into the equation I ve also added a lt Connector gt on port 8009 with protocol AJP 1 3 This is the means by which Apache talks to Tomcat Once done check that you can connect to Tomcat and access its management pages Go to the web page http servername 8080 where servername is the name of the server you installed Tomcat on There should be a link on there to the management pages so you can ask Tomcat to start Exprodo DB after Exprodo DB is installed 2010 2015 Exprodo Software 244 Exprodo Database User Documentation Install Exprodo DB Exprodo DB is delivered as a directory in war file format However there s a file inside the directory WEB INF classes hibernate cfg xml that you will need to modify to tell Exprodo DB how to connect to the database The root directory in the archive is called pp You should put this directory into Tomcat s webapps directory Then edit the file webapps DB WEB INF classes hibernate cfg xml The entries you need to configure are lt property name hibernate connection username gt exprodo aA property lt property name hibernate connection password gt somepassword lt property gt lt property name hibernate connecti
161. grey area depicts j h p i The green areas depict the targeted users a the untargeted users Showing the targeted and untargeted users defined by the Applies To and Does Not Apply To users 2010 2015 Exprodo Software 102 Exprodo Database User Documentation Available Actions The following table shows the available actions and indicates whether each action uses action Biskit Type or property Permissions Action Applies When You Uses Action Uses Biskit Uses Permissions Type Permissions Permissions Create a new object View an object whole database Update Add or remove tables or Database columns in the database Schema Create When a new object is created action and Biskit Type Permissions for the Create action are checked The property Permission is checked to see if the property should be rendered read or read write only by comparing against the default value of the property Read Exists and Email Readable When a user tries to view an object Exprodo applications check whether the user has e Exists permission on the object to check whether the user is allowed to know that the object exists e Read permission on each property which means that property checks are performed on every property on the object The value of any property on which the user does not have Read permission will be hidden from the user When displaying a list of objects Exists permission will be checked so that only thos
162. hapter on Editing Search Information 2010 2015 Exprodo Software Exprodo DB User Guide 31 2 6 1 3 Summary Report Shows the report as a table where the user can define the properties that are used for the rows and the columns of the table and how the content of each cell will be calculated When the Summary Report view appears the user will be asked to select the properties that will be used for the rows and for the columns Calendar Templates Bookings Projects Usage Search Help File Search for Resource Report type Summary Report Conditions Reset Row Salect a property Column Select a property Content Count _ Scaled Go Once the properties have been selected then select how the content is to be displayed Calendar Templates Bookings Projects Usage Search Help File Search for Resource Report type Summary Repot F Conditions Reset Row locaton name Column proyectRequired Content Count E Scaled G Count Count Distinct Sum Minimum i Biaxin Awerage Standard Deviation The default content display is count this will display the content as a simple count of how many records match the row column combination with totals for each row and column Row location name Column projectRequired Contant Count T Scaled 2010 2015 Exprodo Software 32 Exprodo Database User Documentation Complex Content T
163. hat is used to identify the biskit to be updated can itself be updated For example when importing users users could be identified by their email property if it s unique and the import could also modify that email property To do this two email columns in the CSV file are required i e e mail e mail ti conaptic com timb conaptic com The first column would then be the key property to identify the user to be changed and the second column would be the new value of the email property Use the following options Key and Ignore typed before the property name to pre select the properties that will be key fields or fields to be ignored 2010 2015 Exprodo Software Exprodo Database User Documentation Example File For Importing A User import user txt Notepac File Edit Format View Help user Identity loginName userIdentity authenticationmMethod asia tami lyname status roles email password Timb Local Tim 6ilder Blocked USER ben conaptic com timbi The User record that will be created from this file Name Value Comments userldentity login Timb String Name userldentity auth Local Needs to match enticationMethod available authentication method exactly roles 4 Set by bits 1 Root 2 Admin 4 User 8 Guest See User Roles for more information Login name Timb Tim Bilderbeck fothername J SC d Email address blah conaptic com Fassuers exces ie
164. hat system before filling in the new registration form New User Registration Create a local account Local or authenticate using External Imap Smtp Cancel And then complete the New User Registration form to create an account within Exprodo DB Once this account has been accepted by the administrator of Exprodo DB then the user will be able to login This enables administrators to control whom has access to Exprodo DB 2010 2015 Exprodo Software Exprodo DB User Guide 2 2 Change Password lf logged in using a local authentication method in the top right corner of every page of Exprodo DB there is a Change Password link Click on this if the user would like to change their password A pop up will appear that requests the old password and two copies of the new password Press the Apply button to change the password Change Password k Please enter your old password and a new one Old password New password Repeat new password Cancel Apply 2010 2015 Exprodo Software 4 Exprodo Database User Documentation 2 3 2 3 1 2 3 2 2 3 3 User Settings The User Settings page lets the user configure various options that control how Exprodo DB looks Access it by going to the Settings link that is shown in the top right corner of every page in Exprodo DB This will show the users settings with several tabs as described below Once the settings have been changed then press the Save bu
165. he related integer value is_stored in the database rather than the text See also Bit Set Similar in concept to a Mapped Integer but instead of storing an integer in the database a text value is stored instead This means that a Mapped String is an association of one set of strings to another set of strings so that you see a drop down of text values but the value stored in the database does not have to be the same as the displayed value 1 Attributes that define how a Biskit or a Biskit s properties work 2 A type of property used in Conditions when you want to specify a relation about who performs an action or when A record of how long communications between web browsers and the Exprodo DB server take A special user used for Permissions to control what information may be written into emails A Calpendo concept defining who owns a booking bookmark or project How the administrator determines which user may have access to what information and under which circumstances Permissions may have many layers allowing fine grained control over who can perform what action on which Biskit An operation that can be performed on a Biskit The most common actions are Create Read Update and Delete A Calpendo concept a project allows an administrator to link together users resources and costs A Calpendo concept grouping similar projects together for use in Rules Permissions Time Tem plates or
166. he search was for changes to resources made on a particular day returned will be a list of changes that affected all the resources on that day By clicking on one of them the user would then see all changes made to that resource regardless of when that change was made Data type Resource Search tom Any daeina Jun 3912 1 Search bo Any daline J5 Ap 2015 112 Uis Gara iD IP Adds Ge Found 9 changes mee RN GR SE e 2010 2015 Exprodo Software 46 Exprodo Database User Documentation 2 6 4 Data Explorer The Data Explorer page allows examination of the data within Exprodo DB By default it appears on the menu here Calendar Templates Bookings Projects Usage Search Admin Help Data type Please select Data Explorer Search i Refresh Delete Save Edit y Create Create copy History a Renn Select a Biskit Type and a table appears that shows all Biskits of that type Note The Data Explorer page does not yet handle well the situation when there is lots of Biskits of the selected type It is highly recommended that the user does not attempt to use the Data Explorer to view Bookings for example since there may be many of them Apart from being able to choose the type of data to look at the Data Explorer page is identical to several other pages in Exprodo DB such as the list of users shown in Modifying Users Select User as the Biskit Type then a list of users
167. her passwords must include upper case characters characters Require numbers Specifies whether passwords must include numbers Require non Specifies whether passwords must include characters that are alphanumerics not numbers or letters 2010 2015 Exprodo Software Exprodo DB Configuration Guide 153 Brute Force Password Hacking Protection This enables or disables protection against brute force password hacking attempts This should probably always be enabled The only potential problem with this is that the protection involves disabling logging in from the IP address being used by the hacker So if there is a hacker on your own network it s possible that this protection could stop some legitimate users logging in temporarily This is only ever temporary Brute Force Password Hacking Protection Enable brute force password hacking protection 2010 2015 Exprodo Software 154 Exprodo Database User Documentation 4 7 9 System Usage Statistics Exprodo DB can keep statistics that track how much each user has been using it Statistics are kept by collating user activity into periods of time so that Exprodo DB can record how much activity there was in each block of time For each user that has been active in a given block of time a statistic is stored in the database The System Usage Statistics tab of the Global Preferences page lets you provide the following System Usage Statistics Enabled System
168. here Calendar Templates Bookings Projects Usage Search Admin Help Refresh Open All Close All Edit Create Create Booking Requests Create Project Requests Delete User Requests Dump Database User Search Execute Bookmark Manager Exists Email d Read FAQ Editor Run Report Global Preferences Update Import Update Database Schema Layout Editor Menu Editor Permissions Report Manager Resource Editor Rule Editor System Events Template Editor Types and Groups Bakery Database B a E a E T T n l D o a This is what the Permissions Editor looks like first opened es History P Automatic Email 3 Manual Email pes J pr e aimi Calendar Templates Bookings Projects Usage Search Admin Help Refresh Open All Close All Edit Create Create copy Delete References History Z Create Delete wa Dump Database Execute Exists Read Run Report Update Update Database Schema 2010 2015 Exprodo Software Exprodo DB Configuration Guide 105 The Tree Of Permissions Permissions apply to a particular action and Biskit Type The above screen shot shows all the Biskit Types for which there are Permissions Note that a Permission can also be defined that will apply to any Biskit Type For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Once all the items in the tree are viewable the Permissions are viewa
169. hineeiawelaceaudindnenvebienbudeuaneeaeliand 104 4 33 Exam ple Permissions sorsia aa AT E E E T Eaa ENa 108 4A A tomatc EMallS anana a a a a a a a a aa 116 44 1 The Autom atic Ein all Editor cicesssalctvosinsaueaeentaccsdsaciudantnavabcassatacsasarwaucnsvadeasaukituonniuaueed ar tontudupenedstyanunenanaaeuss 117 4 42 Exam ple Automatic Em al siaina a A aA aaa A a aa ea Aaaa ada Aaaa 126 BoD MEn EANO aaia aa a a E a A A GA 129 4 6 User Authentication MethodS nnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnennnnnnnn nnmn 140 461 Authentication Methods cicin E A E AE S A ENE 140 4 6 2 Authentication Methods Editor asassssnnnnnnnnunnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn ennn nenne 142 4 7 Global PreferenceS ici ns ciciceiicccivenveceaevinwwncsen acaccuuuteae te savinaneneaneeawebnneinauubncacigvawianstesieeaaseees 143 ATA Apper ante See ae OS een oP oT Ee 144 7 Wi fi Date And TINE Gee ne or ee oe ere 145 AT S 9 eee eee ee ete A Oe ere eee ee eT eT Cr ae eee ee eee Do repre re 146 ATA General srs aa a aiae aa de a e E aA 148 W ECTO ea a E madviaenvataaiirs couueesee 149 ATO Menus renar a E a 150 MTF NetWork MIG PIGS onran E E E 151 A N o DOCUNALY oei T E e E E 152 4 7 9 System Usage Statistics nnnnnnnnnnnnnnnnnnnnennnnnnnnnnnnnnnnnnnnrernnnnnnnnnnnnnnnnnnnnnonnnnnnnnnnenennnnnnunnnnnn nenen ennnnennnnn nnna 154 A ANO USCIS Miriona a a r T 155 AS LAVOuU
170. icult to change the text that is displayed Biskit Def Mapped Int Mapped String String Enum Def 0 8 Department Permissions Action E Java Enum Def E Unit Type 4 9 4 Formulae lf the Formulaic check box is ticked then the value of this property will be calculated by a formulae Formutlaic Formula The syntax for the formulae is based on MySQL with one major exception MySQL uses the column name in its formulae most users of Exprodo DB would prefer to use the property name In order to do this there is a special syntax if the property name is in such as durationiInMinutes then Exprodo DB will convert the property name to the correct column name This also allows the user to specify biskit property in order to access properties of related Biskits 2010 2015 Exprodo Software 198 Exprodo Database User Documentation When creating formulae use all the standard number calculations as well as setting up logic to determine the correct answer For instance there are two main logical options if and case if expr1 expr2 expr3 lf expr1 is true then expr2 will be returned otherwise expr3 is returned You cannot use the if statement lf expr1 is true do option1 otherwise if expr2 is true do when expr then option1 option2 otherwise do option3 Case statements can be when expr2 then option2 nested one inside the other else option3 end An expression can in
171. ight hand corner of the screen saying Import Completed 2010 2015 Exprodo Software a4 Exprodo Database User Documentation Importing Options Click on the options button to see all the options available for viewing and importing the data file Option Character encoding ISO 8859 4 buthor Select the lines to import Filter How to handle errors Import all or nothing How to handle long lines Wrap long lines Row Hiding Hide nothing show all rows Column Hiding Hide nothing show all columns Option Description While importing Exprodo DB guesses at the character encoding used for the file being imported and allows the administrator the chance to choose the one to use allowing non ASCII files to be imported Character encoding Select the lines to import Use the Filter button to set up conditions to define which rows will be imported Choose Import any that do not fail which will import all records that do not have errors or Import all or nothing which will only import the records if they would all succeed How to handle errors Whether lines should be wrapped making the box deeper Wrap long lines or whether to make the table wider to deal with long lines Do not wrap long lines make the table wider How to handle long lines Whether to hide those rows that are being ignored for import Hide ignored rows or
172. imeFormat DateWithYear ormat n ed TimeFormat 20 Grooved erie groove String Enum Def H Java Enum Def 5 Unit Type 3D E Border pos eave fre 2010 2015 Exprodo Software 196 Exprodo Database User Documentation To add new values press the Edit button and then the Add button the new entry will appear at the bottom set the name of enumeration and the value to store with that name Then press Save Cancel Save Mull Value Label Values Add Remove 3D Grooved Barder fore 3D Inset Border finst 3D Outset Border outst 3D Ridged Border ee 4 9 3 8 String Enum Property Definitions A String Enum property as well as the normal settings required by a PropertyDef must also specify its String Enum This indicates which of the String Enums to be used String Enum Default Value i Department PermissionsAction 2010 2015 Exprodo Software Exprodo DB Configuration Guide 197 4 9 3 8 1 String Enumerations A String Enumeration is like a Mapped String in which the name and value are always the same A property with a type of StringEnum will be editable with a drop down list box showing all the values in the enumeration String Enumerations are deprecated and Mapped Strings should be used instead In some future release String Enumerations may be removed This is because by tightly coupling the displayed text with the text stored in the database it makes it very diff
173. important if exporting the Exprodo DB database to a different type of database 2010 2015 Exprodo Software Exprodo DB Configuration Guide 149 Setting Description Submit Crash Choose whether to allow crash reports to be emailed to Exprodo Reports Software Automatic delivery of crash reports are a very useful tool for helping to find and fix problems and are only used for this purpose Default Initial Choose which page is displayed by default when this program is first Page Token started Enter the text after the in the browser s address bar and before any non alphanumeric characters Maximum File choose the maximum size of a file to be uploaded as an attachment Upload The default is 10 Megabytes Megabytes 4 7 5 Licence This tab lets the administrator enter a licence key as well as see what the current licence key limits are When provided with a new key click the Enter New Licence Key button and copy and paste the new licence into the Enter New Licence Key text box and press OK Once you have been returned back to this view make sure you save the changes using the Global Preferences Save button Program Name Calpendo Licensed to Expires 30 Jun 2014 Multiple Logins Yes Max Number Of Users Unlimited Max Number Of Bookings Unlimited Indicates whether the same user can be logged in concu Max Number Of Templates Enter New Licence Key The table at the bottom of the Licence area will sp
174. info Primary Key aaa ooo Change U lial Version Number fo Gopo L a Change type c New Mame fy Paste Delete to Eikit property jErumerapte Label Lower paleni siio Visible Labi Lipper Patient In s F Edigable i FF parai Labels Lomi parent mgg Teim ae F Nuli Auiowed Labels Lipo Patient Infos l Ll Required visiwe In Biski Detail W Visitie In Biski List El Visible In Collection Editor eI yi iz T E i Null Value Label Read Grily Use araul E Null Valve Label R ad Virita Lise Gefaun Shareable with sub fypes 4 E c Change Bisket Det to Bisket Det Default Value Hull 7 Press the Save button 2010 2015 Exprodo Software Exprodo DB Configuration Guide 231 8 Press the Create button to create a new Biskit and enter edit mode 9 Update the meta properties of the Biskit a Change Type to be the new BiskitDef name in this case Patientinfo2 b Change Group to make it easy fo find all the new BisketDefs using the Filter Biskit Group button c Change Primary Key Column Name to id1 must be different from the Master BiskitDef Primary Key Column Name 10 Create a new property a Change Type to Biskit b Change Name to Parent c Change BiskitDef to Patient Info d Change Biskit Property Type to Slave To Master a Change i Type to Parent tone Paientinfo2 Mone
175. initions An integer a whole number no decimal information property as well as the normal settings required by a PropertyDef must also specify its Integer Type This indicates whether the content of the integer value should be constrained The values allowed are Integer Type Time of Day Unconstrained Mapped Integer Bit Set Time of Day Time of Day with seconds Value Meaning Unconstrained The value can be anything The value will be one of the values specified by a Default Value pes Mapped Integer The particular Mapped Integer g that constrains the value must be specified The value will be a Bit Set containing values Bit Set specified by a Mapped Integer The particular Mapped Integer that constrains the value must be Specified Time of Day Stored in the database as the number of seconds Time of Day Since midnight The only difference is the with seconds formatting on output with or without seconds 4 9 3 4 1 Mapped Integers A Mapped Integer is a mapping between a text display value and an integer value It provides a way for a user to edit an integer property by seeing a drop down list of text values hiding the numerical values from them This provides a means of generating drop down boxes for entering values where there is a fixed set of valid values that can be entered while storing an integer in the database Here is an example of a Mapped Integer defined i
176. ion chapter Found amp resources rs a GLA TEE a eS 7 y clual Usage he e Ti Gz i ch Ach 4 EH Karl E PuL Pan AE ice ete Pee ee ees eile el ation Type Project Re Scanner Project Required tue E feet J planet cari Scanner Project Requres_Jwe id we E fiora Tuscany Room Project Not Requred iwe li E parcie accelerator planet earth Scanner Project Required tue Room Harvard _ Notices Project Required tve a t Edit Delete Usage Session ID Template Usage id For a more complete explanation on how to edit records in the list view read the How to Edit Multiple tems At Once section of the Data Explorer chapter fst 1 Select E records to edit 2 Select properties to edit 3 Charge property values ajajolgjojajojE l Usage Session ID Templa IP Address for usage Usage Recorder Large F Require Reason for Nam eee fT a Eed Actual Usagel _Usage Session ID Template IP Address for usage recorder I In Progress Change Allo After Finished Cha t ajajaja Later Change Allo 4 Apply changes 2010 2015 Exprodo Software Exprodo DB User Guide For a more complete explanation on how to edit records in the record view read the How to Edit A Single tem section of the Data Explorer chapter Edit Create Creme copy Delete Rarere History oo e e Access protection Allow
177. ion result as part of the level above s condition calculation In order to use advanced conditions tick the Show Advanced box Once ticked the Create Advanced Condition icon appears at the top of the condition list and on each of the current conditions Conditions All of the following apply Value of locaton name Value of typ name Value of fequreCancellationReasa Advanced Conditions Selected Create Advanced nested Condition Y Show advanced ES Starts with equals equals Specified value brane Specified value Room Below the conditions have been expanded using a nested condition The nested condition has two parts name and collectUsage and it will be True if both sub conditions are True Conditions Any of the following apply Value of location name i gt of the following apply Value of name Value I of collectUsage Value of typename Value of requiraCancellationReasai Starts with slants With Specified value tue equals equals equals Specified value true Specified value iz Room This creates the following search condition Resources where location name starts with h or name starts with d and collectUsage equals true or type name equals Room or requireCancellationReason equals true In order to test the condition the following steps will be used 1 Check the nested condi
178. iption Include structure lf ticked the backup will contain SQL statements that will create the database tables Include data lf ticked the backup will contain SQL statements containing the data from the database Add drop if exists lf ticked the before each database table is created a statement is added to drop that table if it already exists Compress lf ticked the backup will be compressed before being downloaded Include all tables This drop down allows the choice of one of the following options Option Description Include all Tables Dum ps all tables Include all tables except Dumps all tables except history and statistics history and statistics Select Tables Provides a simple choice of tables to be dumped Use Custom per table See below for complete settings description When all the settings are as required just press the Dump database button to initiate the backup When the backup is complete the browser should download the backup file Exprodo DB limits how often a database backup may be taken by setting Minimum time between database backups on the General tab of the Global Preferences 2010 2015 Exprodo Software 236 Exprodo Database User Documentation Use Custom Per Table Settings lf the Use Custom per table settings option is chosen then Exprodo DB will get a list of all the tables in the database and allow the way each table is backed up to be customised Table Name bookmar
179. is property a value Null Allowed Min and Max also have an impact on data requirements and may be used instead of or in conjunction with Required d Will the property have a default value when a Biskit of type Project is created 2010 2015 Exprodo Software Properties Add New Cut _ Copy Paste Delete oo 7 fiorag status Java num Pomary Key a ees a C ProfessorSignOM 208 Exprodo Database User Documentation etto kase o ll Professor ProfessorSigni tf O drag description jarag ownrerPnone rasouncesatiings Set CC e a rate fcrefisers _ 5e_ i Visible Y Editate Persistent v Null Allowed aan 7 Required Visible in Biskit Detail Visible in Biskit List Visible in Collection Editor m Group Acre Fannulaic aa kal aecountNumber Stim ss Column Mame professor sign_ of aT Default Value Specified value false Set to False 7 Press the Save button 8 If there are no errors then update the database a Press Update DB Schema to implement changes in the DB the following should pop up Update Database Schema Database script alter table projects add column professor _sign_off char 1 default F Cancel Apply Changes 9 Press the Apply Changes button to update the database There will be a response saying how many rows affected Press OK to finish a Press Validate
180. isible In Biski Detail i Visible In Biskit List Visible In Collection Editor ane a om omuiaic JO are c Change Integer Type to Mapped Integer tC d Sa Mapped Int to Maceo integer e Change Default Value to Speched Value and Hot Selected specified value Mot Selected 15 Press the Save button Press Save Despite Errors if required 76 f there are no errors the database needs to be updated a Press Update DB Schema to implement changes in the DB and then run the script to apply the changes b Press Validate Biskits button to check the database Biskits c Press Reload Database Configuration to load the new database into Exprodo DB d Refresh the browser 2010 2015 Exprodo Software 218 Exprodo Database User Documentation Looking at a Project BiskitDef in the Create Project view we see aaa i Project Resource Settings sere Project Groups The Default Value could have been set up as either No or Yes rather than Not Selected also the order the values appear depends on the order of the Mapped Int so if No has a higher value than Yes it will appear below Yes 2010 2015 Exprodo Software Exprodo DB Configuration Guide 219 4 9 5 1 6 Creating ANew Basic BiskitDef An example of creating a BisketDef called Projectinfo which has one property called Name which is of type String Go to Admin gt Bakery Press the Open All button to op
181. istics Users 2010 2015 Exprodo Software 144 Exprodo Database User Documentation 4 7 1 Appearance Appearance controls the look and feel of Exprodo DB It does this by allowing the creation of CSS to overwrite the default values The user can also set the headings for the Host Page and for the Login page as well as a banner to be displayed at the top of each page The Headings debug setting will only be shown when the Show advanced appearance box is ticked Setting Description User CSS To specify Cascading Style Sheets CSS that you would like to be used by Exprodo DB Anything specified here will override the default values so that you can customise the look and feel Headings This sets several properties that control the look of Exprodo DB see the table below for the headers that can be changed Headings To specify the same sort of content as used for Headings above but debug allows alternative values when Exprodo DB is in debug mode An example of User CSS would be the following registerButton display none This would remove the Register New User button from the login page Heading Description options Host Page Title This changes the HTML title of the page used for Exprodo DB so that it will show in the web browser Login Header This lets the user provide alternative HTML for the header that appears on the login page Page Banner If a page banner is required this is th
182. it was created updated and store which version is currently in use 1 Go to Admin gt Bakery 2 Press the Open All button to open the Biskit Tree 3 Select the user created Biskit to add properties to 4 Press the Edit button to get the Biskit into edit mode 5 Press the Add New button to add a new property First create a property called for example Created Properties Add New Cut Copy Paste Delete al Set the Type to Name ___ Type o L_ be DateTime J Created by Give the property 4 name ll Visible W Editable lw Persistent W Null Allowed LI Required Wl Visible In Biskit Detail Wl Visible In Biskit List LI Visible In Collection Editor c Set the Automated Property Type to Create amp Update 6 Update the meta properties of the property a Change Type to DateTime b Give the property a name in this case Created c Change Automated Property Type to Create amp Update 7 Do the same again to create a property for example called Updated 8 And again to create a property for example called Version this time make it of Type Int 2010 2015 Exprodo Software Exprodo DB Configuration Guide 215 Add New Cut Copy Faste E Name Tye _ New properties Created Updated Version i Name Property pame A al Set Version Sort Property Use default sorting Property to P version Version Property version MT b Set Creat
183. it each group 2010 2015 Exprodo Software 64 Exprodo Database User Documentation To change the search parameters Status Roles Conditions W Normal Requested F Blocked Password must be reset at next login E Denied ggn Choose Selected User Type then select a user type from the drop down options Then select the user status required And select the user roles 2010 2015 Exprodo Software Exprodo DB Administration Guide e Set up additional conditions for the search For more information on how to set up conditions read the information in the Search page There are no conditions Add condition LOK Conca t_ cam Chemie And change the columns displayed in the output Family name W Email address User Type i Status Expiry Date Reset Resets the search conditions to the defaults set up on starting the search Go Runs the search with the current conditions Reset Go Fl Autorun Reset Go Wastoun Autorun ff this button is ticked then searches will run aS soon as any conditions change If the user will be changing a number of the conditions of the search or searches will return large amounts of information it is more efficient if this is not ticked 2010 2015 Exprodo Software 66 Exprodo Database User Documentation
184. ites_500 Radioactive Substance Sites Radioactive_Substance_Sites 250 Radioactive_Substance_ Sites 500 Hazardous Substances Storage Hazardous_Substances_Storage_250 Hazardous_Substances_Storage_500 Dangerous Substance Storage Dangerous_Substance_Storage_250 Dangerous_Substance_Storage_500 d Add in new Major Accident Hazard Major_Accident_Haz empty cell after Major_Accident_Hazard_500 the current cell Discharge To Water Discharge_to_water_250 F Discharge_to_water_500 Contaminated Land Contaminated_Land_250 Contaminated_Land_500 166 Exprodo Database User Documentation 3 Multi Column Table Contraventions Contraventions_250 Contraventions_500 Multi Column Description Table Show Custom Row Allows the user to edit the row labels Labels Number of Property The number of columns used to display the properties The first Columns property in the list will have its value displayed at the top of the first column the next property value at the top of the next column and so on until the columns are filled up The next available property value will then be displayed in the second row of the first column property values will then fill in the second row before moving onto the next row and so on until all property values have been displayed Show Column Headings labels Displays column headings into which the user may place their own Column Label Defines whether the column labels
185. k_properties ne For each table there are the following options Option Description Use global settings lf ticked then the other options for this table will be ignored Include structure Allows the global setting of Include structure for this table to be overridden Add drop if exists Allows the global setting of Add drop if exists for this table Include data Used to override the global setting of Include data for this table to be overridden Select by column Min Column Value Max Column Value lf partial data is to be downloaded then the user can nominate a column of the table and specify minimum and or maximum values of that column that should be included in the download lf the user wants to download partial data and specifies Select by column then the Min column value is the minimum value of the selected column that should be included in the download lf the user wants to download partial data and specifies Select by column then the Max column value is the maximum value of the selected column that should be included in the download 2010 2015 Exprodo Software Exprodo DB Configuration Guide 237 2010 2015 Exprodo Software 240 Exprodo Database User Documentation 5 Exprodo DB Installation Guide if your Exprodo DB is to be hosted on exprodo com then you will not need to read these instructions as it will be installed for you You only need to read this installation guide i
186. kit core lawnt Riskitl avwoutl oralbisnlawiyne _ Java Enum z mi 4 9 3 5 1 Java Enum Definitions A Java Enum is a representation of an enumeration defined in the original Java source code End users should not create change or delete any Java Enum defined in Exprodo DB You may create properties of type Java Enum and use any of the existing enumerations but you should do so carefully in case the enumeration changes or is deleted in a future release Properties of type Java Enum are edited with a drop down list box showing the values from the enumeration In special cases such a drop down list box might display only some of the values from the enumeration However it is not possible for a user defined property to behave in this manner com springsolutions biskit core Property Type Double avaEnum List ong Set String StringEnum UserDefined 2010 2015 Exprodo Software 192 Exprodo Database User Documentation 4 9 3 6 Set Property Definitions A property of type Set must specify the Property Type of the elements within the Set If the elements are not Biskits then there are no further settings required If the elements are Biskits then the following must be specified C Biskit Def Com peremen nt Biskit ee Type to non Name Meaning The type of data stored by the property represented by this definition For types other than Biskit the
187. kit filled in with his specific information It also stores a list of property definitions with each property definition defining its Biskit Type how it s stored in the database how to display the label for the property the tool tip text to be displayed when the mouse hovers over each property value and a number of other aspects of the property When saving Biskit Types and properties Exprodo DB does check that reserved words have not been used for column names table names Biskit Types and property names There are currently over eight hundred words such as Select Into From Start Full which are reserved The system administrator can switch this checking off in Global Preferences General section but this is not advisable The Bakery allows these things to be customised as well as adding the users own BiskitDefs so that Exprodo DB can be used to interact with the users own data Property Storage Mechanisms A database has many tables with each table having many columns When_a new Biskit is created a new row is added to the Biskit s table containing its properties When a new property is added to a Biskit in Exprodo DB one would normally also add a new column to the appropriate database table However modifying tables like this is not something that all users would be comfortable doing 2010 2015 Exprodo Software 174 Exprodo Database User Documentation Exprodo DB helps with this by creating table columns auto
188. l be referenced through the same key The Master Slave that will be created will have only one property on the Master Name of type String once this has been created then all the properties needed can be added to each of the Biskits AMaster could have many Slave Biskits as required a property needs to be set up on the Master to point to each Slave Each Slave just needs one property to point to the Master The Primary Key Column Name in the Slave MUST be different to that in the Master If there are multiple Slaves then the Primary Key Column Name in each Slave MUST be different 1 Go to Admin gt Bakery 2 Press the Open All button to open the Biskit Tree 3 Select any Biskit 4 Press the Create button to create a new Biskit and enter edit mode 2010 2015 Exprodo Software 230 Exprodo Database User Documentation 5 Update the meta properties of the Biskit a Change Type to be the new BiskitDef name in this case Patientinfo b Change Group to make it easy fo find all the new BisketDefs using the Filter Biskit Group button c In Properties Add New i Change Name to Name d Change Name Property on the BisketDef to point to the new Name property 6 Create a new property a Change Type to Biskit b Change Name to Slave c Change Biskit Def to Biskit Def The other BisketDef is not know yet because we have not created it so use this as a holder gies 1 _______ Type to Parent Mone Patient
189. l the properties in the dragged branch will then transfer to the new branch In the Information Pane using shift and ctrl a number of properties can be selected from the viewed list and dragged across to a Properties branch in the Organisation Pane 5 House Buying Layout 2 4 Selected properties three in this case can be dragged across to the other pane and dropped in a Property Group or Property branch Properties 6j Unassigned Property Det S Property Info Properties Electrical Work_Warranty In Boundries Disputes drag Central_heating Notices Planning Guarantees drag Other_Waranties Details Properties 0 E 5 1 El Properties 10 3 Properties branch can be dragged to a different Property Group or Property Branch New _Home_Warranty Damp_Prooting Timber_treatment Glazin 2 Property can be 3 dragged to different Electrical_Work_Warra piap ai egee a Properties Branch Roofing Central_heating Underpinning 1 Property can be dragged to a new position Other_waranties in the branch list Other Waranties Detai In all the above cases dropping the properties on a Property Group name will place the properties in the Properties branch for that Property Group 2010 2015 Exprodo Software Exprodo DB Configuration Guide 165 Property Table Types There are four different ways to display a list of properties
190. lbar which enables the user to edit create and delete layouts as well as being able to preview the layout already defined For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Layout Description Toolbar Item Preview This will display a preview of the current layout as defined When in edit mode this preview will be up to date and you do not need to save first The preview will display initially in read write mode but the user can change the mode using a toggle at the top of the view to see what the display would look like in read only mode Some information is only displayed in read only mode The information in the properties in the preview is constructed in a random manner to give the user an idea of what the layout would look like with data and is not read from the database 2010 2015 Exprodo Software Exprodo DB Configuration Guide By pressing the Preview button a view of the current layout showing the different areas will appear Use this preview to walk around the layout checking how it works Preview of House Buying Display Mode Read write Full names of the seller Name of solicitors firm Display mode Read Only or Read Write Main Table Child property groups of Property Information Form displayed as Horizontal T abs Property Details Fittings and Contents Form Additional Questions Environmental Search Drainage
191. le In 51 183 Definitions 175 256 Exprodo Database User Documentation Biskit Type 19 Detail Properties Visible In 51 183 Value 23 Dynamic Biskits 178 Configuring Format 178 Groups 94 Inheritance 1 79 Types 94 Integer Property Definitions 188 Creating Users 66 Integer Type 188 CSS Preference Setting For 144 Java Enum 191 Java Enum Property Definitions 191 m D List Properties Visible In 51 183 Many To Many Properties 193 Data Explorer 46 Master Slave 185 Editing Multiple Items 47 Properties Visible In Biskit Detail 51 183 How To Edit A Single Item 49 Properties Visible In Collection Of 51 183 Properties Visible In List Of 51 183 Run Data Definition Validation At Boot 148 Set And List Property Definitions 192 String Enum 196 String Enum Property Definitions 196 String Property Definitions 194 String Property Type 194 Database Backing Up 235 Mapping Your Own Tables 178 Database Dumps Minimum Time Between 148 Date And Time Format Global Preferences For 145 Double String T 195 iia wa Double Property Definitions 187 Biskit Property Type 185 193 Bit Sets 190 Sa Biskits 178 Booking Sub Type Example Creating An Inheriting Biskit Def 234 m Bookings Example Creating An Inheriting Biskit Def 234 Repeat Flushing Time Between 148 Boolean Boolean Property Definitions 186 Editor Authentication Methods 142 Automatic Email 117 Bakery 200 C a Import 82 Mapped Int 204 Mapped String 204 Conditio
192. led Preference For 154 Usage Statistics Time Between Flushes Password Reset 67 Preference For 154 r l DE Properties Of A User 54 Usage Statistics Time Per Statistic Preference For 154 Requests Page 57 Requirement For User Type 155 Reset Password 67 Roles 190 Search 62 Session Timeout 155 Settings 14 70 Creating Users 66 Global Preferences For 155 Modifying Users 67 New User Default Roles 155 String Enum Property 196 String Enumerations 197 String Property Type 194 String Type 195 Summary Report 31 Special 70 Comples Content Types 32 User Group Membership Changing 68 system Events 89 User Group System Usage User Membership Changing 68 Global Preferences For 154 User Requests Page T Request Filtering By User Type 155 User Settings Date amp Time 14 Text Editing For Another User 70 Pattern Matching in Conditions 21 Editing Your Own Settings 14 Toolbar Button Email 14 Standard Definitions 15 Menu 14 Types User Type User Types 93 Requirement For 155 Types and Groups Configuring 94 V Description 93 Editor 94 Visibility U Of Properties In A Biskit Collection Editor 51 z 183 Of Properties In A Biskit List 51 183 URL Of Properties In Biskit Detail 51 183 Refering To Exprodo DB In Emails 146 Within Automatic Email 124 W m Usage Statistics Enabled Preference For 154 Web Browser Compatability 52 2010 2015 Exprodo Software Exprodo Database is produced by Exprodo Software ww
193. lems for Found a total of 4 problems this column Properties with errors highlighted in red warnings highlighted in blue nort Result Detail inted there are Line Cotumn Message S si petig l 1 1 Foundatotaiof4 problems O OoOO O O Found a total of 4 problems ey will be dasa da in a Se ee z Coud not resolve value of project from Could not resolve value of project from imported values project projectCode inventions values project projectCode inventions blue 7m cai OK Show Log Initial pop up used to show log lf there are problems a pop up will appear use the Show Log button to show a complete list of the problems Records with an error will have their record number highlighted in red as will those property values which are causing an error If a record has only warnings it will highlighted in blue as will those property values which are just warnings Moving the cursor over a property with an error warning will result in a tool tip describing the error warning Also for each column you can see the number of problems If there are any problems in a column clicking on the number of problem text will produce a pop up which will show the problems for just that column Import Result Detail Level Line Cotumn Message m 1 hi ie Found a total of 4 problems Could not resolve value of project from imported values project projectCode inventions Could not resolve value of resou
194. list ie If a user is in both lists then the Does Not Apply To is used A Calpendo booking whose status is approved A user that has been approved for access to the system An editor which allows the user to create delete and update BiskitDefs and their properties The Bakery also allows editing of Mapped Strings Mapped Integers amp and Units A Biskit is an object stored in the database that has a custom type It will have whatever properties are specified by its BiskitDef Defines the properties associated with a particular type of Biskit and how those properties should be stored in the database Each Biskit has a type Biskits with the same t e have the same property definitions See BiskitDef A Bit Set is a type of integer property that results ina drop down that can take multiple values A Calpendo salle defining which user has made a particular booking A Calpendo concept of a reservation of a resource at a particular time A Calpendo page which provides a graphical view of bookings by day week or month A Calpendo concept setting up restrictions relating to which bookings can be made A Calpendo concept that shows the condition of the booking A user defined Booking amp taxonomy A Calpendo concept defining a collection of resources amp to be displayed in the Bookings Calendar Allows the user to specify under what circumstances an action such_as generating an email
195. ll needs to be able to access the information in Exprodo DB then set up specific Permissions for data There is a special user called nobody which is used for this purpose In the Permissions page for a property or Biskit create a Permission with Action set to Read E Mail Readable or Exists Positive to False and Applies To to nobody so that the property or Biskit can still be accessed and read by the user within Exprodo DB but cannot be added to an email Read the Permissions section for more details on setting Permissions 2010 2015 Exprodo Software 126 Exprodo Database User Documentation 4 4 2 Example Automatic Emails Example 1 Send Email To An Administrator When A Project Request Created This first example shows how to send an email to an administrator when somebody creates a Projec t 251 252 whose status is Requested A Project is a Calpendo object the details of which do not matter here except to know that it has a status property 1 First go to the Automatic Emails page and press the Create button to create a new Automatic Email Give it a name like Project request to admin 3 Specify the Biskit Type as Project Specify an action type of Create Project request to admin Add a condition Status is Requested value lof staus equals Add the recipients you require Enter the email s subject Conditions Recipients Email Subject Email Body IP ADDRESS AUDIT LOG
196. lumn content can be changed to 1 Another property 2 A complex content type see Complex Content Type P in the Summary Report section for more details on the types available Whether null values are ignored 4 Whether the result should be scaled see Complex Content Type eB in the Summary Report section for more details on scaling Clicking on a cell will produce a List Report of the records associated with that cell below the table File Search for Resource Repot type Group Report Conditions Columns Reset Go l Autorun Found 4 groups of resources Proba C Project Not oe a SIT 1 planet earth zm NEM 5 Project Required GE Project Required As with the List Report clicking on an individual record will give an expanded view of that record below the list lf the user has the correct permissions they may edit the individual records or make changes to multiple records All of this will be covered in the chapter on Editing Search Information 2010 2015 Exprodo Software 36 Exprodo Database User Documentation 2 6 1 5 Editing Search Information Once the search information is in either a List Report view or as an individual record the information can be edited if the user has the permissions to do so The administrator will have set up the permissions for your Exprodo DB For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definit
197. m BOCCEA l i List of the Biskit s Shareable Table ots i pea Ea ati Table Name projects Primary Key Columa Name id aaan The Selected a Property s automated Property Type Biskit Meta Properties veers ae fee string Property Tyge Singe Ling Definitions String Type Dofaun Valua For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Items that are created will not exist in the database until you press the Save button and then follow the procedure to validate update and reload the DB Properties Description Tool Bar Copy This button will take a copy of the selected properties and place them ina buffer to allow pasting into another Biskit Multiple properties may be selected by using ctrl and shift 2010 2015 Exprodo Software 22 Exprodo Database User Documentation Edit Mode Edit mode allows the user to edit a Biskit and all its oroperties Once changes are saved the DB will need to be validated updated and reloaded in order for them to be permanent Edit fee i Bar wee co de Java nun ganes a Hong RorosectCode Ss enamels L bH Li paces Propect Lobes praeis Propet ee Aaii ere Line dofie qi Vigibie in Bisi Oyisi Drag area for ts ia Gk Ui drag and drop TE visitas in conection Eazor of properties to change ort order For a complete description of the standard toolbar buttons read the
198. mated properties to hold the created and updated time the creator the updater and the version number as required There may be more than one Note BiskitDef if required A single Note BiskitDef can be used to hold notes created in multiple places in the layout or the user may define a different Note BiskitDef for each place notes are going to be added or a combination of both methodologies Once an approprite BiskitDef has been created the Notes tab will change from Property Table Notes Property Table Notes No suitable note biskit types exist Disabled Y to use the drop down to enable Notes Once enabled the user will see the following in the Notes tab Note Biskit Type This needs to be set to the Biskit Property Table Notes Type that will hold the note information TEE Owner Property This needs to be set to the property that points to the owning Biskit Type This is the Biskit Type that the notes can be attached to in the Layout aa Note Property This needs to be set to the property that Add Note Notes Waterfall Category will hold the note information Disabled Y 2010 2015 Exprodo Software Exprodo DB Configuration Guide 169 Add Note Button Label This defines the string to be put Add Note Notes Waterfall Category on the button that will add the note to the database Add Note Heading This defines the string that will be Enabled v used as a heading to the add note area This information is use
199. matically but it will not remove unused columns and it will not change the Biskit Type contained in a column This provides some protection against accidental destruction of data while changing the Biskit definitions but also means that getting the configuration right does have some difficulties This is particularly true if there needs to be a change of the type of data stored by a property which has to be handled by creating a new column for it However there is an alternative that does not involve creating a new table column when adding a new property Exprodo DB supports what are called Indirect properties which are stored in a separate table in such a way that new properties do not require changing the table structure In all there are three property storage mechanisms Static Dynamic and Indirect This table compares them Comparison Static Properties Dynamic Properties Indirect Properties Description Hii to Exprodo Created Created using the Bakery Each property ina column in the Biskit s main table One row added to the Biskit s indirect properties table for each indirect property Each property ina column in the Biskit s main table Structure e Add in the Bakery e Ask the Bakery to update the database schema Tell Exprodo DB server to reload the data definitions when you have finished making all changes Not possible without a new version of Exprodo
200. mission that applies when a booking is Updated give it a name and make it Grant Permission Booking approval requires an A Please select a Biskit Def Data type not set T uthorisation Grant Permission 2 Add a condition Old value Status was not Approved Old value of status not egual to Specified value Approved 3 Add a condition New value Status is Approved New value of status equals Specified value Approved 4 Add a condition New value templateApproved is false The templateApproved property is set automatically when a booking is approved by a Time Template and so we can use it to detect how the status was changed New value e of template pproved equals Specified value false 5 Under Applies To untick Include Everybody select Use Roles and then add Admin 6 Save the Permission 2010 2015 Exprodo Software 114 Exprodo Database User Documentation Example 6 No One Can Email Password Details In this example we are going to create a Permission that stops everybody from putting the value of the password property of the User Biskit Type into an email To do this we will be using the special user nobody 1 Create a Permission that applies when a User is Read give it a name select the property Password make it negative Authorisation is Deny Permission Include Everybody fe Jroveay _noveay Use
201. mission when trying to view the Cost Per Session This Permission says nothing about whether other users can read Cost Per Session If you now wanted to change the Permission so that it says nothing about whether Admin can read Cost Per Session but that it denied permission for all other users follow the following steps 4 Press the Edit button unless you didn t actually save it and so it s still shown in an editable form 5 On the AppliesTo tab tick Include Everybody 6 On the Doesn t Apply To tab untick Exclude Nobody and add Admin to the list of individual users 7 Inthe main Permission details change Authorisation to Deny Permission What we ve now done is to target everybody apart from Admin We ve made the Permission negative so that the targeted users will be denied permission to read Cost Per Session 2010 2015 Exprodo Software Exprodo DB Configuration Guide 113 Example 5 Approval Of A Booking Requires An Admin In this example we are going to create a Permission that allows anybody with the Admin Role to change a booking s status to Approved We will also add a condition to make sure we re matching the situation where an administrator modifies the status themselves rather than where the status is modified indirectly as a result of moving the booking to a period in which a Time Template another Calpendo concept the details of which are not important here has approved the booking 1 Create a Per
202. mplates Bookings Projects Usage Search Admin Help Data type Please select Data Explorer Search Refresh Delete Save Edit View History Create Create copy History 7 2010 2015 Exprodo Software Exprodo DB Administration Guide 63 This is what the User Search page looks like when it is first displayed File Report type List Report User Type Status Roles Conditions Columns Reset Go 4 Autorun Users where status equals Normal or Requested and roles includes any of No roles Root Admin User or Guest Found 18 users foes Jlaentty ven name omer namo Family name Email aaaress User Typo Statue Expiry Datel version Greated Updated fous acm cvest Rooifiocaot fou fT PT ema PoP er vser acm e Jaan A e ema Jo E fo E e rau __ Ronneon uau caendo com _ vema_ _ ___ er Jusec Aan Goes Jlvcaveive owe wacky e S a Ja J Epse fnerat Joa ver uaneuiancom Emacs vee Jo __ CE E e ecun JP autne Janet com emacs Juma Jo J a use _______ tocatmendet oregor__Js ender __ anenan com miacay Juema Jo __ Of Yevcatrontgen wine fie renter ane com emacs fora Jo J ofuse______Jtocatnewen isaac Newer Juangan com e a Jo __ Efsa forare Journ Juangin com feaa Requested 1s von ra ae un 20a eg Epse fone ware fore uangiancom emacs oera o e __ Ope Jeveatganes fewo Joanie Juaneian com fens frees o_o vondova a
203. mples e status service provider service location EAT e CL myCSSclass My Label status service provider F service location 2010 2015 Exprodo Software Exprodo DB Configuration Guide 137 Creating A New Menu Press New on the menu toolbar and type the name of the new menu into the pop up What should the new menu be called My Menu The name of the menu will now appear in the Menu Toolbar Menu drop down it will have a next to it to indicate it is being edited and has not been saved yet save Refresh My Menu Open all Delete Install Rename Duplicate Using the Menu Item Toolbar at the bottom of the page press New Item then in the right pane set up the Type to be Page and for the Page Definition set Label to Calendar and Page to Calendar This will create the first menu item Save Refresh My Menu B Open all New Delete Duplicate Install Rename _Lal ndal Type Page Page Definition Label Calendar Page Calendar l Parameters Cut Copy Paste Delete Up Down New item New subitem 2010 2015 Exprodo Software 138 Exprodo Database User Documentation Using the Menu Item Toolbar at the bottom of the page press on New Item then in the right pane set up the Type to be Menu and for the Submenu Definition set Label to Simple User Menu This creates a simple sub menu Save Refresh My Menu B Open all New Delete Du
204. n the database Biskit Det CancellationReason E Mapped Int Null Value Labell No reason given CancellationReason Role Mapped String String Enum Def Java Enum Def E Unit Type 2010 2015 Exprodo Software Exprodo DB Configuration Guide 189 To add new values press the Edit button and then the Add button the new entry will appear at the bottom set the text string to be viewed and the number to store it as Then press Save Cancel Save CancellatioonReason Values Add Remove Wame wali Subject cancelled F Researcher unavailable F Named There can be as many Mapped Integers as needed in the database Once the Mapped Integer is created to use it create an integer property on a BiskitDef and set its Integer Type to be Mapped Integer and chose the Mapped Integer you have created Integer Type Mapped Integer Default Value CancellationReason Role The database stores the values as integers The definition of the Mapped Integer in the Bakery just maps those numbers to a string for display At a later date new items can be added to the mapping new strings and new integers the mapping can be changed by changing the text associated with a particular integer then everything in the database that has that integer value will be displayed with the new string if there is a mapping where 1 displays as A and 2 displays as B and then this mapping is
205. n to the original view The History Button This will show a change history of the selected item like this Refresh Edit View t Create Create copy References Printable view History of User 6 14 Jul 2009 20 46 0 CREATE __ 192 168 0 198 leonardo Nothing selected Leonardo__ De Vinci_ blah blah comf Normal 14 Jul 2009 21 10 clare UPDATE 192 168 0 198 leonardo Nothing selected Leonardo Davinci blah blahcom Normal 9 Sep 2009 20 34 clare UPDATE 192 168 0 198leonardo Nothing selected Leonardo Da Vinci___ blah blah com Physics Normal 13 Jul 2010 11 56 admin UPDATE __ 192 168 0 198 fleonardo_User__ Leonardo Davinci blah blah com Physics Normal 13 Jul 2010 13 26 admin UPDATE 192 168 0 196 leonardo User__ Leonardo Davinci blah blah com Physics Normal _ 18 Aug 2010 21 22 admin UPDATE __ 192 168 0 198 leonardo__ fUser_ Leonardo Da Vinci__ blah blah com Physics Password must be reset at next login 18 Aug 2010 21 41 admin UPDATE 192 168 0 198 leonardo User Leonardo DaVinci blah blah com Physics Password must be reset at next login This shows who has changed the item and when and also shows some of the item s properties as they changed over time The complex properties are not shown Exprodo DB does not record the history of properties that store lists of items like lists of projects and lists of user groups The History button will be grey
206. nd Java Enumeration definitions as well as the unit definitions To access the Bakery Editor page it can be found at Admin gt Bakery However the administrator may have configured Exprodo DB so that the menu is different When entering the Bakery Editor in the left hand pane will be all the current definitions for Biskits and the additional definitions in an expanding tree structure The right hand pane will hold the information for whatever is selected in the left hand pane Reload DB Configuration Update DB Schema Validate Biskits Filter Biskit Group Refresh Open All Close All E Biskit Def Mapped Int Mapped String E String Enum Def Java Enum Def E3 Unit Type The top menu provides buttons to check and update the database once the user has completed any changes in the DB Reload DB Tells the server to reconfigure according to the current dynamic Configuration property definitions you have Make sure the database schema is up to date before running this Update DB Asks the server to generate a SQL script that can be used to Schema create whatever columns are required for the dynamic property definitions After the script has been generated the user will have the option of applying it Validate Biskits Checks that Biskit definitions are self consistent Filter Biskit Group Display only those Biskits in a particular group By default no groups are set up if your own Bi
207. ned for that Biskit Type and all the properties of the parent Biskit Type Repeat Any property not defined will have its value set to null Biskit Type Property Example Value repeat repeatT ype must match Daily repeat biskitT ype Monthly by date Monthly by day Weekly repeat dayOfMonth repeat monthOfYear lint _ 0 11 with 0 January Daily Repeat None Monthly Repeat By Date repeat dayOfMonth int 1 31 repeat dayOfWeek int 1 Repeat repeat biskitT ype Biskit AnnualRepeat must always be DailyRepeat present MonthlyRepeatByDate MonthlyRepeatByDay WeeklyRepeat repeat start 12 January 2015 13 00 repeat finish Date 12 January 2999 14 00 2999 for never ending repeats int int 3 int with 1 Sunday int 5 Monthly Repeat By Day repeat dayOfW eek repeat weekOfMonth Weekly Repeat repeat sunday repeat monday repeat tuesday Boolean Trueor False Boolean _ True or False 2010 2015 Exprodo Software az Exprodo Database User Documentation 3 4 2 The Import Page When importing data you can specify whether data is imported if there are any errors or that no data is imported from the file if any errors occur errors include Permissions failing to allow creation or updating of records Examples of how different error types are handled can be found in the section on Handling Import File Errors On entering the Import page it will look like _Browse_ No fle selected Press Browse
208. ng The Biskit Type to be f representedBi used for bookings of this skit ype resource Created 19 May 2014 09 26 Updated 21 May 2014 10 12 2010 2015 Exprodo Software Exprodo Database User Documentation Example File For Importing A Project A project is a Biskit Type used in Calpendo to store information about projects File Edit Format View Help projectCode type name status owner userIdentity loginName name start finish sunspots Physics phantoms Approved curie sSun spots 25 May 2013 25 Dec 2014 The Project record that will be created from this file Name Value Comments projectCode SunSpots General ii itype name Physics Needs to match Project Resource Settings Type Physics Projects Project name exactly TE Approved ee mn curie uara si status Approved Approved n p Requested Denied Phone Number Lo Terminated Finish j25Dec2018 Owner userld curie Login name Principal Investigator Ethics Approval Number entity login N ame 25 Dec 2014 Projects have other information attached to them but they are stored in different Biskit apes These are used to store the Project Resource Settings Users and Project Groups properties In order to import this information first import the project information and then import each of the other three Biskit Types one after another Acoount Number For example importing the Project Resource Settings for the above project
209. ns Menu 129 Advanced 17 Anatomy Of A Condition 17 Automatic Email 120 Permissions 104 Property Layout 156 Reports 40 Combination Options 24 String Enum Def 204 Context 18 Types And Groups 94 Date Properties And Accuracy 23 Units 205 Nested Conditions 25 Email Panel 18 Apparent Sender 146 Authentication 146 Automatic Email 116 Connection Security 146 Copy All Outgoing Emails 146 Pattern Matching Text 21 Property Path 20 Referenced By Property Path 26 Relation 271 Text Pattern Matching 21 2010 2015 Exprodo Software Email Global Preferences For 146 Limiting Who Can Be Sent Emails 146 Reply To 146 Sending Enabled Global Preference For 146 Signature On Outgoing Email 147 SMTP Server 146 URLs Refering To Exprodo DB Global Preference For 146 Using Exprodo DB To Send 71 Example Automatic Email Dealing With Sensitive Data 125 Send Email To A User Whenever Thier New User Request Is Denied 128 Send Email To An Adminitrator When A Project Request Created 126 Example Bakery Adding A New Yes No Mapped Int Property Adding Created Updated Version Properties 214 Adding File Attachment Properties Adding Formulaic Properties 209 Adding Properties 206 Booking Cost Formulae 209 Creating A Hierarchy Of Bisket Def 224 Creating A Master Slave Biskit Relationship 229 Creating A New Basic Bisket Def Creating A Set Of Bisket Def 220 Creating An Inheriting Biskit Def Booking Example Permission Admins Ma
210. ntly there is no page dedicated to editing other user s settings To do this use Data Explorer and set the Biskit Type to Exprodo DB User Settings By default Data Explorer appears on the menu here Calendar Templates Bookings Projects Search Admin Help Data type Plaase select Data Exptorer k Search Retes fi igw Lory His tory Prat analysis aw Special User There is only one special user and that is nobody This is a user whose status should be set to Blocked and never used This user is used in the following circumstance sending automated emails with embedded data When an Automatic Email is sent it can include data taken from some Biskits When this happens to make sure that it is safe to include such information make sure that the information is only readable by whomever the email goes to or whomever initiated the action that caused the email to be sent as it is possible that anybody could read the email It is therefore better to ensure that emails only include information that is readable by the special user nobody If the special user nobody can read the data then it s safe to put it into an email Your administrator should have set up which data nobody has Permission to read Please note that while there are users created by default that are called Root and Admin these are not special users They have a user role of Root and Admin respectively and their roles are special but
211. o com says 28 Your request has been successfully received Please wait for an email confirming acceptance before attempting to log in This means that the registration request has been received but the user cannot log in yet They will receive an email to tell them when they can log in using the login name and password selected Note that the administrator will not know any passwords nor have any way to find out what they are However the administrator is able to reset a password if required When a user first logs in to Exprodo DB they will see the Data Explorer page 2010 2015 Exprodo Software 2 Exprodo Database User Documentation Single Sign On Exprodo DB Account some customer environments use a single sign on To access Exprodo DB using a single sign system a user would need to get authenticated by the single sign on system To log in click on the button for your sign in system or the Register new user button to register using a specific authentication method The names on the button s will have been chosen by the administrator when single sign on authentication is set up so may be different Username Password Sign in using one of the following Local Imap Smtp Alternatively sign in using External If you do not already have an account Register new user lf registering a new user choose the system to be registered by If using a non local method the user will need to be authenticated by t
212. o save the file If the file is saved it will be called report csv and found in the users Downloads folder Opening reportcsy You have chosen to open H report csy which is a Microsoft Excel tomma Separates Values File 422 bytes from https xps What should Firefox do with this file Open with Microsoft Excel default Save File E Do this automatically for files like this from now on Cancel 2010 2015 Exprodo Software 40 Exprodo Database User Documentation 2 6 2 Report Manager The Report Manager page allows the management of reports within Exprodo DB By default it appears under the Search menu with a sub menu item labelled Reports However the menu may have been configured so that the Reports page is not visible by the administrator Once useful searches have been created they can be saved for future use as reports See Saving and Reusing Searches The reports page allows you to view manage and schedule your reports as well as creating new ones The page is split into two On the left is a list of the System Reports those that anyone can see and the users Personal Reports On the right is the area where to edit schedule and create reports when the user enters the Re ports page this area is initially empty Select a report in the left hand pane to see the properties of that report in the right hand pane Where the page splits can be moved to change the space av
213. odo Database User Documentation Although we have now changed this user s status it still appears in the table of user requests However the status shown in the table has changed A user will remain in the User Requests page until the Refresh button is pressed or the browser is refreshed Refresh 2010 2015 Exprodo Software Exprodo DB Administration Guide st Changing The User s Group Membership To associate the user with some users groups first select the user s row as shown above in Changing More Than A User s Status and then click the Groups tab Requested Project Code l 5 7 Projects Groups Name m fon ceren fien cern Apply Refresh The check boxes indicate what groups this user is a member of New users will not be a member of any groups so no boxes are checked Tick the check boxes next to the groups this user needs to be a member of BS as 7 K Requested Project Cove s r 20th Century Efer cenn Apply Refresh Me me Once all the required user groups are chosen press the Apply button Once done a pop up showing the number of user groups that have been changed will appear a kequestea Project Code s l ace pa F roj E cts GI i H Ips O Name Updated 1 groups 16th Century Century i App m Fefresh i 4 ty I j Fj The user does not need to save the user information if only the group membe
214. olutions calpendo Calpendo private AuthType basic AuthName your Calpendo Realm Name AuthBasicProvider file AuthuserFile path to htpasswd file Require vali d user When Apache rewrites URLs you A Location gt protect private under the rewritten URL RewriteEngine On prevent the client from setting this header RequestHeader unset X Forwarded User see the Apache documentation on why this has to be lookahead Rewritecond LA U REMOTE_USER this actually doesn t rewrite anything what we do here is to set RU to the match abo NS prevents flooding the error log RewriteRule E RU 1 NS RequestHeader set X Forwarded user RU e strip the REALM of Kerberos Login nae edit X Forwarded User GREALM RewriteRule A ie Ca 5 Cal endo com te nda calpendo Calpendo 1 PT L ProxyPass calpendo http localhost 8080 Calpendo ProxyPassReverse Calpendo http localhost 8080 calpendo 2010 2015 Exprodo Software 142 Exprodo Database User Documentation 46 2 Authentication Methods Editor Setting up different Authentication Methods alternatively known as Single Sign On is done using the Authentication Methods Editor which by default is available on the menu as Admin gt Authentication Methods The Authentication Methods Editor shows all the currently defined authentication methods and allows the administrator to create update and delete them This is what the looks like wh
215. on url gt TObCGimysqis Focal nost db lt property gt lt DLOperey Name MiLberna ve sconnecrLon driver Classe gt org mariadb jdbc Driver lt property gt lt property name hibernate dialect gt com springsolutions exprodo core server persistence ExprodoMySQL5Inno DBDialect lt property gt You need to change the username password and url to match the user and database name you created earlier You should now ask Tomcat to start Exprodo DB in case it isn t done automatically Go to the web management page linked from http servername 8080 and see if Exprodo DB has started and if not ask for it to be started Once this is done then you should test to see whether Exprodo DB is working with Tomcat Open a web browser at this url http servername 8080 DB com springsolutions exprodo basic Basic programs Arms All being well you will see a Exprodo DB login screen If you don t then you ll need to check to see what errors are on screen or in the Tomcat logs If you do see the login screen then try to log in with username root and a blank password 2010 2015 Exprodo Software Exprodo DB Installation Guide 245 Install Apache HTTP Server Follow the Apache documentation as appropriate for your operating system in order to install the Apache HTTP server Once installed you should make sure your Apache configuration loads modules mod_proxy mod_proxy_http mod_rewrite mod_deflate and mod_ssl Th
216. ont size No Value font variant No Value font weight No Value z font style No Value fm km lz Remove All CSS Show AllCSS OK Apply Cancel The possible CSS values are organised into different tabs to help with finding the required CSS value When the drop down button is pressed for a value the user will have a choice of options Some will require the user to input the appropriate CSS string see Colour above The user can also specify inherit which means the CSS will be inherited from previously defined CSS by the user this could be in Global Preferences or elsewhere in Exprodo DB where CSS can be defined For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter CSS Editor Description Toolbar Item Remove All Removes all CSS that the user has applied using the editor to this CSS particular object Show All CSS Shows in a pop up window the CSS that has been defined for this particular object For more information and help on using CSS and HTML a site we recommend is http www w3schools com 2010 2015 Exprodo Software 4 9 4 9 1 Exprodo DB Configuration Guide 173 Bakery Exprodo DB is built on Exprodo a web based system that is designed to be able to display and edit the contents of a database To be able to do this Exprodo allows the building of definitions of the data in the database In other words while Exprodo DB
217. ood example of this is a user s roles There are up to 32 roles defined and a user may be deemed to have any number of these roles For such properties it doesn t make sense to compare two sets of roles using greater than or less than and so the available relations are changed to reflect this not equal to includes all includes any does not include all does not include an A text property displays with options for comparison with the starting ending or interior characters Also available is pattern matching using the following A The beginning of the line The end of the line l Any character _ Zero or more times One or more times pannel Once or not at all Merga X Y Either X or Y n Exactly n times inih n m At least n times but not more than m times does not start with a z Characters a to z does not end with a z Any character other than a to z does not contain does not match Search conditions are not case sensitive while non search Automatic Email Permission or Booking Rule conditions are case sensitive Depending on whether the ab bern matchin ng is going to be done in Java Automatic Email Permission or Booking Rule or SQL Search will depend on which additional matching features are available It is recommended that users only use the options listed above 2010 2015 Exprodo Software 22 Exprodo Database User Documenta
218. operty Group should be grouped displayed Vertical Tabs Vertical Tabs Sorted by Name Horizontal Tabs and Captions To see examples of these layout types look at the Preview image above Heading Any heading to be displayed with this Property Group Property How Properties belonging to this Property Group will be displayed Simple Table Multi Column Table Radio Button Table and Custom HTML Property Table Notes New_Home_Warranty Timber_treatment lf a Properties branch to the tree is selected then the Electrical_Work Warranty int___ properties grouped here will be displayed as a list showing their Name and Type Central_heating Int Other_waranties Other Waranties Details String New Home Warranty lf an individual property is selected then the properties Label will be viewed This is so the user can see what will be written for this property in the layout 2010 2015 Exprodo Software 162 Exprodo Database User Documentation Property Def lf the property selected is of type Biskit then there will also be an option of how to display the Biskit information Either as a Show Simple as a single element in a table or Show in Property Group with a name assigned by the user treating the Biskit as the first Property Group If the Biskit has a layout defined it will be used otherwise all the properties will be displayed as a simple table If a property is selected from the heel ie prop
219. orce password reset to allow the users to log in but force them to change their password Alternatively tick the check box in the table s header and every check box will be ticked or unticked as appropriate as a short cut to ticking all users 2010 2015 Exprodo Software Exprodo DB Administration Guide os Changing More Than A User s Status The User Requests page can be used for more than just changing a user s status First click anywhere in the user s row apart from the check box The user s details will appear at the bottom of the page already in edit mode and the values can be changed as required It is useful to define the users roles at this point A new user can be assigned any role the person doing the assigning has If the assignee has Admin Guest then they can assign Admin and Guest ro es to another user qe e fs e name name name Se e ea Refresh Save History ww a e __ Projects Groups Local vy Watson Choose the status you want the user to have from the drop down There is no difference between selecting a status here and using the buttons in the checked button bar When finished press the Save button A pop up will appear briefly in the bottom right corner to indicate the user was saved NJ Expiry Date Requested Project Code s Identity Projects me fo Boas ere rems Srece pared Apply Refresh 2010 2015 Exprodo Software 60 Expr
220. ord passwords but can be used for any text that should not be seen as it is typed i A text area with multiple lines Typically the PropertyDef would also Multiline specify the number of rows to display A single line of text that is expected to contain the web address of some page When rendered in a read only format it displays with an HTML anchor element so that it will operate as a hyperlink URL The content can contain a prefix of the form http or https or any other valid protocol recognised by all web browsers but the protocol prefix is not required Email Address A single line of text that is expected to contain an email address HTML When rendered in a read only context this is displayed with a mailto HTML link so that it will automatically create an email when clicked A text area that contains HTML When edited this property will use an HTML editor with tools for helping you to create valid HTML VASP SIS Se Tie ESBS ea Background Foreground Y Font Size Colour Three hexadecimal numbers that define the RGB colour to be displayed 2010 2015 Exprodo Software Exprodo DB Configuration Guide 195 String Type This indicates whether the content of the text value should be constrained The values allowed are Value Meaning Unconstrained The text value can be anything The value will be one of the values specified by a Mapped Mapped String String
221. ose users types should receive an email Select any number of user groups to send email to Use the drop down to select the user groups required Use the tick box to choose which user groups to remove and then click the Type an emai address and press enber bo add it hd email Bd0rhsS85 Sohected Mirigi T Requested Bhicet bee Password mus Go reset at miat login Denig Expired E p 3 CC BCC Email Addresses User User Staluses User Types Faul amp Clare s group E Paul amp Clare s group 2010 2015 Exprodo Software Exprodo DB Administration Guide Tab Name Description Remove button User Roles Add any user to the recipient list that has the selected roles Email Addresses Users User Statuses User Types User Groups Lise Rol Rom T Aiii User Gis When the email and its recipients are ready then use the buttons in the button bar at the bottom Button Description Send This sends the email Show Exprodo DB calculates who the email would be sent to and shows a Recipients list of those users without actually sending the email Use this to verify that the email will target the expected users If an email address appears more than once in any of the tabs then only one email is sent with To overriding CC overriding BCC to decide which address line is used Re
222. own selector if the Prop Ery OE indicates Defi this is a Mapped Integer and may alow 7 you to set multiple values if it is a Bit Set jootnn Long PropertyDef also needs to define the type of the data contained in the set constrained by specifying a Mapped Siring in which case the value would be edited string ce The property contains a value that is from an enumeration defined in the source code This is represented by a drop down list see Java Enum Property Definitions Must specif ap the Java Enum Definition The property contains a 64 bit signed integer Javascript does not directly support 64 bit values and so long properties may cause performance problems because Exprodo DB has to emulate the behaviour of a 64 bit integer in the browser None The property contains a set of items The see Set Property Definitions 1928 A text property value The value may be See String Property Definitions using a drop down list Otherwise it will be a free text entry A property that contains a string constrained by a String Enumeration StringEnum Note that these properties are deprecated and may be removed in a future version of Exprodo DB Used when the actual type isn t known in UserDefined See String Enum Property Definitions Must specify the String Enumeration advance Normally used only for indirect None properties
223. perty o ial Ermen O Hierarchy Propart i Lata Lower pate Label Upper Labels Upper ypa ET Sort iri W Visite V Editable J E i kabai upper O J V Parsistent E Nuti Aiya Cl R guirj Z Visible in Biskit Dotai vl Visible in Biskit List al Change Bisket Def tol d i Looe Primary Key Column Mame b Change Biskit Component AO O O Property Type to Master To Reference Deletion Option Cascade c Change Inverse Le Property to Parent 14 Press the Save button There will be an error Save Despite Errors Biskit Property Type Master To Slave 2010 2015 Exprodo Software Exprodo DB Configuration Guide 233 15 Select the PatientInfo2 Biskit and press the Edit button to get back into edit mode 16 Select the Parent property a Change Inverse Property to Slave is Enone MyCompany Primary Key tc Version Number a Nene Fee PE Ceo opaa 4 Ru AJ E vVisibte in Biskit Detail Null Valve Label Aead Cnty Lise default FF visio 5 Riaki Lint Use default I visitis In Collection Editor a Allows Deletion While Referenced Does not allow desetion unigue o E e Component f CCisz kii Pro Primary Key Column Name Biska Property Ty a Change to Slave 17 Press the Save button 18 If there are no errors the database will need to be updated a Press Update DB Schema to implement changes in the DB and then r
224. pl lt l i warn E ExprodoSessionDAG M Error Viemor F ExtemnalServicelmpl Exception m 7 F 4 Choose the ks Fatal x Logging Login accepted type of event a E Reminder Manager Login failure 7 RepeatableHandier Refresh a ig Scheduler E Reload database configuration 7 RANAN nearmissions i Choose the source of Choose the category of the event the event Once the search has run the results will look similar to below clicking on an event will bring up the expanded view for that event below the list view ren _ Source _ a TypelUser ___ Affected Type Affected 1D 7 RepeatableHandler fino e T menne C E E 2 May 2073 02 00 Reminder Manager ores Reminder unsent Eror M E eaa 2 May 201303 17 RepeatableHandier Update m Pi aa 2 May 2013 07 00 a a CS 2 May 2013 07 00 Reminder Manager _ Reminder unsent ca __ Bowi zess 2 May 2013 07 17 RepeatableHandier C n LO o E 2 May 2013 09 10 _ 2 May 2013 09 1 A E C A A 2 May 2013 09 10 29mg een era J Mey 2308 Logpeg TE Ero OO T TT a or as ds a 2 May 2013 09 26 rs a C E 2 Mav 2013 09 261 Loooina 2 May 2013 08 17 Source RepeatableHandier Category __ Update Type Tinto user Affected Type laftected 10_ Message 2 objects affected yielding 4 changes mane a hens Update 2013 05 02 08 00 2013 05 02 13 00 Create 2013 05 09 08 00 2999 12 31 13 00 a 2013 05 02 08 00
225. plicate Install Rename Calendar Type Menu l m Submenu Definition Label Simple User Menu Cut Copy Paste Delete Up Down New tem New sub item Using the Menu Item Toolbar at the bottom of the page press New Sub Item then in the right pane set up the Type to be Page and for the Page Definition set Label to My Bookings and Page to My Bookings This will put an item on the Simple User Menu sub menu Save Refresh My Menu Open all New Delete Duplicate Install Rename Calendar Type Page e Simple User Menu Page Definition Label My Bookings Page My Bookings e Parameters Cut Copy Paste 2010 2015 Exprodo Software Exprodo DB Configuration Guide 139 Click on Simple User Menu then using the Menu Item Toolbar at the bottom of the page press New Item then in the right pane set up the Type to be Separator This creates a simple separator to which is a line across the menu to split the menu into sections Calendar Templates Bookings Projects Usage Search Admin Help Menu Editor Save Refresh My Menu Open all New Delete Duplicate Install Rename Calendar Type Separator Simple User Menu My Bookings Separator Up Down New item New subitem Cut Copy Paste Delete d Continue adding in pages custom pages sub menus and separators until the menu is
226. port without those columns Failed to recognise 2 columns all have been set to ignore These errors can be fixed in the Import page Just click on any red header and you will get a drop down box with a complete lists of this Biskit Types properties Select the correct one and the error will be removed Once done the column will be moved from Ignore to automatically import user txt Choose new file Biskit type User Insert New Data uf Preview Import We 2 8 useridentity authenticationMethod name 3 C givenName 4 D familyName 5 E status 6 F roles ee O Ok oi Ok C Ignore E created email expiryDate familyName givenName otherName 2010 2015 Exprodo Software Exprodo DB Administration Guide Data Errors Data errors are found either during the preview of the data of if a preview is not done during import 6 F resource name 2 7 G p roject_projectCode 2 B owner_useridentity loginName 3 C status 4 D dateRange start 5 E dateRange finish 1 A booker_useridentity_loginName Normal Normal Normal Normal Normal META Normal Normal Ignore Ignore 4 problems Ignore Ignore Ignore No problems No problems No problems No problems No problems Ignore 2 2problems blems 8 May 2013 08 00 18 May 2013 08 Number of problems in Import Result a column Click to get a list of prob
227. py of the currently selected Property Group and puts it in the edit buffer overwriting any current contents Paste Pastes the current buffer contents as a child of the currently selected Property Group When pasting a Property Group care needs to be taken if the Property Group has any properties associated with it Properties can only appear once in a layout and the editor will remove Deletes the selected Property Group Any properties associated with that Property Group will be moved to the Unassigned Properties Show Cell CSS This will display in each cell of the properties a little icon allowing the i user to start up a CSS editor for that cell For more on the CSS editor properties that clash with the pasted properties Delete branch read the section on CSS Editors 156 2010 2015 Exprodo Software 164 Exprodo Database User Documentation Moving Properties f a Properties branch is selected then a list of properties will be shown in the Information Pane There are four ways to move properties within a combination of the Organisation Pane and the Information Pane An individual property can be selected in the Organisation Pane and dragged to a new position in the list An individual property can be selected in the Organisation Pane and dragged and dropped into a different Properties branch A Properties branch can be selected in the Organisation Pane and dragged and dropped into a different Properties branch al
228. r Groups Please select a User Group to add Y Selection empty Property Path to User s or User Group s Individual Users nobody nobody T Login namel Given name Other name Family name Sr ae Roles lt lt Use Roles 2 Under Applies To untick Include Everybody select Individual Users and then nobody 3 Save the Permission Use this mechanism on any information you do not want sent by e mail 2010 2015 Exprodo Software Exprodo DB Configuration Guide 115 Example 7 Hiding Resources And Booking Properties sometimes the administrator may want to create resources that only some people may access or define properties on a booking that some people shouldn t be allowed to see This is achieved by setting up permissions that control who can access what To hide some bookings from some people e Deny them READ permission on the bookings they should not be able to see If you want to hide a booking property from some people then e Create a property level Booking permission that denies them READ rights on that property e Create a separate permission for each property you need to hide if you want to hide a resource from someone here is the list of Permissions that need to be set up e Deny them EXISTS permission on the resource e Deny them READ permission on bookings for that resource e Deny them READ permission on templates for that resource To set up the first p
229. r second After rounding both dates it then compares the dates using the specified relation Combination Option Once all the conditions have been created choose how logically the conditions will work together the combination option Click on the drop down button in the top left corner of the condition box equals Specified value Harvard Stans wath ends with Combination Option Description For the combination to be TRUE All All the individual conditions must be true Logical AND Any At least one of the individual conditions must be true Logical OR As long as not all the individual conditions are true this includes none of the conditions being true Logical NAND None As long as none of the individual conditions are true Logical NOR This creates the following search condition Resources where location name starts with h and type name equals Room and requireCancellationReason equals True At this point use OK to save the condition and Cancel to start again 2010 2015 Exprodo Software Exprodo DB User Guide 25 Nested Conditions Nested conditions allow as many levels of conditions as the user requires Each set of nested conditions also has its own combination option allowing the user to create as complex an overall condition as possible Each nested set of conditions is evaluated separately and the overall result of the nested condition is then used as an individual condit
230. rator being able to view this price This serves to demonstrate how to protect individual properties and how to apply Permissions to individuals This is known as a Property Level Permission There are two ways we can set up Permissions to achieve the result we want depending on what we d like to achieve We can create a Permission for each methodology e Authorise the user Admin to read the the Cost Per Session but say nothing about whether other users can read it e Deny everyone other than the user Admin from being able to read the Cost Per Session but say nothing about whether Admin can read it When a Permission says nothing about whether a user is granted or denied permission then you rely on other Permissions to specify what you want This is the way that multiple Permissions are superimpose to get the result required To show how this works we ll go through each of the options above in turn 1 Create a Permission that applies when a Project Resource Setting is Read and set the Data Property to Cost Per Session 2 On the Applies To tab untick Include Everybody and under Individual Users select one or more users In this example a user called Admin has been added 2010 2015 Exprodo Software 2 Exprodo Database User Documentation 3 Save the Permission as it is and with the default values of Authorisation being Grant Permission it means that the targeted users in this case the user Admin will be granted per
231. rce from imported values resource name dry lab Could not resolve value of project from imported values project projectCode helper Could not resolve value of resource from imported values resource name dry lab Error message Number of property columri with error The problem log will list theproblems showing the line and column the problem occurs on as well as the problem message Clicking on the an errors column will scroll the file to the error and it will be coloured blue to stand out In order to fix these types of problems go back to the original import document and fix them there before loading it back into the Import page Remember once the file to be imported has been updated save it before reloading the file into Exprodo DB Import 2010 2015 Exprodo Software Exprodo Database User Documentation Violation Errors Violation errors are found during the import of the data into the database These are errors that occur when the Exprodo DB is trying to create or update the database During this process all the Permissions are checked 1 A useridentity_loginName 2 B useridentity _authenticationMethod name 3 C givenName 4 D familyName 5 E status 6 F userlype name 7 G roles 8 H email 9 I password EEEE Normal Normal Normal Normal Normal Normal
232. rd db lt update a b c sql 4 Replace the DB directory with the contents of the new DB directory Note that you must ensure that the hibernate cfg xml file that you customised when you followed the above installation instructions is not overwritten by the new release New releases normally do not include a copy of hibernate cfg xml file 5 Restart Tomcat 6 Open a web browser to confirm that Exprodo DB is accepting connections Rolling Back a Failure Database Upgrade If you should want to roll back the database because an upgrade failed in some way then you should not load you back up over the top of the upgraded database That s because there could be tables for the upgrade that remain in place and so it might cause problems with doing the upgrade again since it may assume the new tables do not exist The recommended way to roll back the database after an upgrade is to drop the database recreate it and then load the backup 2010 2015 Exprodo Software 250 Exprodo Database User Documentation 6 Glossary Term Action Applies To Approved Booking Approved User Bakery Biskit BiskitDef Biskit Type Bit Set Booker Booking Bookings Calendar Booking Rule Booking Status Booking Type Bookmark Condition Data Explorer Data Type Does Not Apply To Event Definition See Permission Action Defines the list of users that are will affected This list is overruled by the Does Not Apply To
233. re is a description of what each meta property is for Name Data Description Type Type String This is the internal string that represents the Biskit s type some Biskit s extend others in the programming subclass Parent BiskitDef sense and this indicates the Biskit Type that is the parent of this one Only used by the Bakery itself use any group name Group String required on a BiskitDef Then filter the BiskitDefs that are displayed by setting a filter Biskit group Primary Key Integer This is the unique database identifier for the BiskitDef Version Used internally to manage changes to the BiskitDef Integer i Increased by one every time a change is made The name of a property on the Biskit that can be used to Name String represent that Biskit This is not used if Format is specified Property Important to do this or the Exprodo DB chooses the name for each instance of the Biskit that is created ae Property String name of the property that should be used to sort Biskits of this type String The name of the property that should be used to hold the version number of the Biskit Only those properties of type Int with an Automated Property Type of Create amp Update will be used String The name of the property that should be used to hold the created date and time of the Biskit Only those properties of type Datetime with an Automated Property Type of Create or Create amp Update will be used
234. rent Property 6 Create a new property a Change Type to Biskit b Change Name to Parent 7 Eotabie c Change BiskitDef to BiskitDef alae Organisation is not know yet because ee a we have not saved so use this as a 7 visible in Biskit List holder IO visible In Collection Editor ee he a foownn name poet E d Leave Biskit Property Type as To One c Change Biskit Det to Biskit Det temporary change Biskit Ea Property Type 2010 2015 Exprodo Software 226 Exprodo Database User Documentation Properthes Add New Cut Copy Paste Delete l E Type to Set Mame Type Primary Key jo b Change Mame to Nem Children Property Create a new property a Change Type to Set b Change Name to Children c Change BiskitDef to BiskitDef E Bh acta Organisation is not know yet because ee Required we have not saved so use this as a Fi Visas ae my holder F Visible in Collection Editor d Leave Biskit Property Type as One To Many c Change Biskit Def to Biskit Det temporar d Leave Biskit Property Type as One To Mary ives repery neve Le 8 Press the Save button There will be an error Check the error by pressing Show Log If the error is complaining about a property not having the correct BisketDef press the OK button and then the Save Despite Errors button 9 Pre
235. ress Reload Database Configuration to load the new database into Exprodo DB b Refresh the browser Go and check bookings to see if the Booking Cost is present In this case if when viewing a booking in the Booking Calendar at the bottom of the Booking will appear the Booking Cost 2010 2015 Exprodo Software 212 Exprodo Database User Documentation 4 9 5 1 3 Adding Properties For File Attachments An example of adding a property to the Biskit of type Project to hold an file attachment 1 Go to Admin gt Bakery 2 Press the Open All button to open the Biskit Tree 3 Select the Biskit to add properties to in this case Project 4 Press the Edit button to get the Biskit into edit mode Properties i Ad hh Cui Copy Paste Delete licas type Seskct_ a oc ee R EP a Visible in Biskit Catal Wi Visib e In B skit List iY Visite in Collection Editer 5 Press the Add New button to add a new property 2010 2015 Exprodo Software Exprodo DB Configuration Guide 213 Properties Add New Cut Copy Paste Delete me fe EEE o Wa a aa in in g g ra finish principalinvestigator drag fundingAgency arag Set F W 5 Ta ee 5 Ta a W 5 Ta JavaEnum a le oi a a E E E Lo D a g e Je T T String a ea ii a oy jus al Change Type to Type Name _ fAttachment _ __ _ mti b Ch
236. ress Validate Biskits button to check the database Biskits c Press Reload Database Configuration to load the new database into Exprodo DB d Refresh the browser 2010 2015 Exprodo Software 220 Exprodo Database User Documentation 4 9 5 1 7 Creating A Set Of BiskitDef Attachments An example of creating a Set of BiskitDet for this example we will create a Set of Attachments to store a number of documents Go to Admin gt Bakery Press the Open All button to open the Biskit Tree Select any Biskit Press the Create button to create a new Biskit and enter edit mode First we need to create the BiskitDef to hold the attachments Update the meta properties of the Biskit a Change Type to be the new BiskitDef name in this case ProjectAttachment b Change Group to help find all the new BisketDefs using the Filter Biskit Group button c In Properties Add New i Change Name to FileName li Change Type to Biskit iii Change Biskit Def to Attachment Properties ype ProjectAttachment Add New Cut Copy Paste Delete a Change Type to Parent ProjectAttachment Group GNone Nusey dy Primary Key WG Nb Ql ii Change Type to o Biskt J FileName Z None _ i Change aa Nama Mame to File Namg FileName 4 Visible Y Editable Y Persistent 7i Null Allowed Required Visible In Biskit Detail c Add anew property il Version Number Sort Property Use defa
237. returned make sure Conditions are used to set at least time limits for the information returned For more information read the chapter on using Search 2010 2015 Exprodo Software 52 Exprodo Database User Documentation 4 7 8 Security The Security tab of the Global Preferences page sets up the items below Browser A user can specify that their browser will remember logins and passwords On public systems this may not be a good idea so you can disable this facility Browser Browser Allowed To Remember Passwords Browser can remember passwords Setting Description Browser Allowed To Exprodo DB is configured so that it allows the user s browser to Remember remember their login name and password if this facility is Passwords enabled by each user s browser Disable this facility at a global level by setting this to false Password Content This provides control of the content of passwords that people are allowed to use Password Content Minimum Password Length Require letters Require lower case letters Require upper case letters Require numbers Require non alphanumerics j No Setting Description Minimum Password This specifies how many characters must be in each password Length A user will not be able to set a password that is shorter than this setting Require lower case _ Specifies whether passwords must include lower case characters characters Require upper case Specifies whet
238. rodo DB and they are used in several places most notably in Automatic Emails Consequently they have their own section of this configuration guide See Conditions for the details Please note that the section that describes conditions indicates that the Updated Value and Change condition types are considered an error in some contexts For Permissions they are only usable when the Permission action is Update 2010 2015 Exprodo Software Exprodo DB Configuration Guide 107 The Applies To Tab In read only and editable mode the Applies To tab looks like this include Everybody Individual Users Please select a User to add J Include Everybody Selection empty Individual Users User Groups selection empty Please select a User Group to add selection empty m User Groups selection empty Property Path to User s or User Groupfs Property Path to User s or User Groupis 4 Data type not selected Selection empty selection empty Roles m Roles Use Roles Require all selected roles L Root Admin LJ User LJ Guest Include Everybody lf set to true then this means that the Permission applies to all users and so the rest of the tab is hidden As described in Introduction To Permissions
239. rodo DB supports the import of data using comma separated values csv This is found on the Admin gt Import menu 3 4 Import In order to do this an import file needs to be created Only information for a single Biskit Type can be imported at a time The exception to this is if importing data belonging to a Slave Biskit Type that needs to be imported with the Master Biskit Type data as if the Slave properties actually belonged to the Master rather than the Slave Once the import files have been created they can be used in the Exprodo DB import page to import your information 3 4 1 Example Import Files The file should have a header row which defines the properties that are going to be imported and then one row for each object of the Biskit Type Use the Search P page or the Bakery to find the names for the properties All the fields need to be comma separated To modify the value of a property that is from a component biskit values to all the properties on that component must be provided Any properties not mentioned will be attempted to be set to null If this fails then an error will occur Eg When importing users and setting a new value for userldentity authenticationMethod then a value for userldentity loginName must also be set If a new value for userldentity authenticationMethod is set and anew value for userldentity loginName is not set then the userldentity loginName will be set to null A property t
240. rships have changed That s because group memberships are a property of the User Group and not the User and it s also why there s a separate Apply button to save the group membership changes 2010 2015 Exprodo Software ez Exprodo Database User Documentation 3 1 4 User Search To search for users use the dedicated User Search page which by default appears on the menu here Calendar Templates Bookings Projects Usage Search Admin Help User Search ad File Report type List Report User Type Status Roles Booking Requests mns Reset Go w Users where status equals Normal or Requested and roles includes any of No rc Project Requests uest Found 40 users p User TON PMPA identity fGen fiinn ii m Email identity fGen Ginn m al User CONO canal i Local root be Le fe k a Sn e Admin Local clare Clare Mackay clare ca Oca ee heere ne User Localyhubble Bookmark Manager Email FAQ Editor te Preferences The administrator may have configured your Exprodo DB so that the menu is different The alternative i get a list of users is by using the Data Explorer and choosing User as the Biskit Type It doesn t make any difference which method is chosen these pages behave almost identically apart from User Search being dedicated to users while Data Explorer can handle any Biskit Type By default Data Explorer appears on the menu here Calendar Te
241. rson doing the assigning has User approval can be done in the following places The User Approval Process e The User Requests page shows just the users whose status is Requested It also provides short cuts to approving or denying user requests and allows for user detail modification Modifying Users describes how to use the other options for modifying users That is the User Search page and the Data Explorer By default Exprodo DB has an Automatic Email configured that will tell all administrators when there is a new user request The email received contains links to approve or deny the new user request Just click on the links in the email to approve or deny new users Please note that if a resource requires a project to be entered when a booking is made a user cannot book that resource unless they are assigned to the project being used to make the booking The User Requests Page The User Requests page shows users whose status is Requested By default the User Requests page appears on the menu here Calendar Templates Bookings Projects Usage Search Admin Help Booking Requests User Requests EE bees thy E Manager Global Preferences e user s password pr E o Menu Editor EE nien Permissions Approve Deny Blo Force passw ee PE Refresh save stor Lo J E a u i a a However your administrator may have configured the menus differently This is
242. rtyDef may also specify the text to be displayed instead of True and False 4 Default False Text Default False Text Default No By un ticking the Default option the user can then specify which text is to be used to display the value instead of True False When used in a formula the values are T or F 2010 2015 Exprodo Software 4 9 3 3 Double Property Definitions A double property as well as the normal settings required by a PropertyDef may also specify its Units Doubles are numbers with a decimal point Default Value Length Temperature Time Weight N C Meres sr Te a R Jn fuon fo fo CTO ENN eT Centigrade casus Je Name___ Short Name Muttiptier Sub Units Per Unit Offset Sub Unit fo db j Seconds ee E ae fee fee fof a SSS a a C kesin fk dh oe fers Fahrenheit 0 555555555555556 1 47 7771111111118 Fahrenneit F o ss5s55ss5s5ss56ef10_ arre C a U Exprodo DB Configuration Guide Name __ Short NamelMultiplier__ Sub Units Per unit orfset_ Sub Unit hbo do b mame enor Noro a ee foo unire Par oe Pounds _ f 2010 2015 Exprodo Software 187 There are four types of units Length Temperature Time Weight Users can also add their own units into Exprodo DB Each type of unit has a number of options and these are 188 Exprodo Database User Documentation 4 9 3 4 Int Property Def
243. rybody Indicates whether this BiskitDef is defined statically in the Storage Static or Mechanism Dynamic_ source code for Exprodo DB or dynamically in the Bakery Shareable Posle Shareable with sub types if you want dynamic sub types to Table be able to share this BiskitDefs database table Allows Allows Deletion if you want Biskits of this type to be Deletion deletable even while something references them While Referenced Visibility Boolean The name of the database table for storing instances of this BiskitDef The table name for a static BiskitDef cannot be modified since it is defined in the source code for Exprodo DB Also not all static Biskit Types will have a table associated with them for example if they are abstract or if they are only ever used as components of another BiskitDef Table Name String 2010 2015 Exprodo Software 178 Exprodo Database User Documentation ID Column The name of the column which provides the primary key into Name String the table In a Master Slave combination these must be different in the Master and each Slave Biskit Format Set the Name property meta property of a Biskit to specify the name of the property that should be used to represent the Biskit when something more complex than just the label is required For example a user has a login name a given name and a family name but any one alone can not be used to display the person s name Instead a
244. s equals Requested and Permission B has the condition e resource equals Wet Lab In this case assuming both Permissions apply to the current user then Permission A will apply whenever the user tries to update a requested booking and Permission B will apply whenever the user tries to update a booking for the Wet Lab resource What happens when trying to update a requested booking for the Wet Lab In that case both Permissions could apply This is where the Permission priority comes in If one Permission has a higher priority than the other then the highest priority Permission will be used If they have the same priority then either one could be used Authorising And Non authorising Permissions When thinking about giving permission for something one normally thinks in positive terms That is authorising permission for something However the layering used in Exprodo DB requires that there is also the notion of non authorising permissions as well as authorising ones That means that a Permission can be written that will grant the right to do something at one layer and then have another Permission at another layer that will explicitly deny the right to do something For example there may be an authorising action Permission that allows everybody to read everything and then a non authorising property Permission to deny the ability to read the booking price for some people 2010 2015 Exprodo Software Exprodo DB Configuration Guide
245. s for the JDK for your platform This needs to be at least JDK 7 Note that the JDK is required not just the JRE this is a requirement for Apache Tomcat the servlet server rather than Exprodo DB itself 2010 2015 Exprodo Software Exprodo DB Installation Guide 243 Install A Java Serviet Server This should be Apache Tomcat or Jetty or some other server that supports the Servlet 2 5 specification Exprodo DB has only been tested with Tomcat 7 and so this is the preferred server A future Exprodo DB release is likely to use Jetty instead and also include a much easier installation and upgrade mechanism The rest of this section assumes you are using Tomcat version 7 You should read and follow the standard documentation for Tomcat to install it Once installed you will need to edit two files in Tomcat s conf directory server xml and tomcat users xml You should find samples of each of these with the Exprodo DB distribution The important parts of these are tomcat users This needs to contain a lt user gt line so that somebody can connect to Tomcat s web management pages The user name and password can be anything and will only ever be used by a human You may want more than one entry here depending on who will do the administration server xml The sample provided defines a lt connector gt entry on port 8080 that allows users to connect directly to Tomcat A standard Tomcat server xml would contain this entry althou
246. set After using the Manual Email page press the Reset button to reset the page back to its original content ready to compose a new email 2010 2015 Exprodo Software Exprodo Database User Documentation 3 3 Report Manager The Report Manager allows an Admin user to see reports for all users as well as the system reports To access the Report Manager page it is found on the Admin menu However the administrator may have configured Exprodo DB so that the menu is different The page is split into two On the left is a list of the System Reports those that anyone can see and all the Personal Reports On the right is the area where Reports can edited created and deleted Where the page splits can be moved to change the space available for each of the sides Calendar Templates Bookings Projects Usage Search Admin Help Refresh A System Reports Edit Create Create copy Delete References History Open report Run report My Resource Search 9 Name sid Dana Searchl E Personal Reports iSearcnFor TAEAE amp admin admin enabled rue My User 10 Publicly Modifiable i B curie Mane Curie System Wide iue My Projects 11 repon ype TCE Owner admin aamin There are no conditions In order to understand how to create and edit reports read the the Reports section of the Exprodo DB User Guide 2010 2015 Exprodo Software Exprodo DB Administration Guide Exp
247. should appear to come from For example for a Exprodo DB running at example com choose a value like Example Exprodo DB lt Exprodo DB example com gt The reply to address on any email that is sent out Set so that if users do reply to an email it goes to someone rather than getting an error message Connection Choose the security level that should be used for the connection Security between your SMTP email server and the Exprodo DB server Authentication Select whether to use authentication for the connection between your SMTP email server and the Exprodo DB server and if so select the user name and password that should be used by Exprodo DB to connect Emailed Base This is the URL that should be used to get to Exprodo DB and is used URL by Automatic Emails that reference a URL It is useful when sending an email that includes a direct link to a page within Exprodo DB and the main part of the URL needs to be injected automatically SMTP Reply To EL Limited Recipients During testing anything related to email restrict the email addresses that are allowed to receive email from Exprodo DB Provide a comma separated list of email addresses to restrict outgoing email to go only to those addresses If this field is left empty then email will be allowed to go to anybody This is a comma separated list of email addresses that should receive a copy of all outgoing emails from Exprodo
248. skets are created they should be put into their own group in order to use this filter to find them quickly When changes have been made to the DB via the Bakery Editor the user MUST make sure to update the DB properly by using these buttons in the correct order 1 Press Update DB Schema to generate a script to update the SQL database Then apply the script to make the changes 2 Press Validate Biskit to make sure any Biskits that have been changed have a self consistent definition 3 Press Reload DB Configuration to reconfigure the server so that it is using the new DB schema 2010 2015 Exprodo Software Exprodo DB Configuration Guide 201 Once this is done the Exprodo DB will now be able to use the changes implemented in the DB through the Bakery Editor The bottom menu provides buttons to deal with the expanding tree structure For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Use these in conjunction with the Filter Bisket Group button on the top menu to aid the viewing of the tree information View Mode View mode allows the user to see each of the Biskits and their properties You can also copy properties for later use in a different Biskit Edit Create Create copy Delete References History View Mode Tool Bar Teer es Cop Properties Tool Bar ws 8232 sing al ame I projectode E aniy Sti
249. skit Property Definitions 185 Bit Sets 190 Boolean Property Definitions 186 Check Reserved Words Preference 148 2010 2015 Exprodo Software Double Property Definitions 187 Edit Mode 202 Editor 200 Editor Example 206 Example Adding A New Yes No Mapped Int Property 216 Example Adding Created Updated Version Properties 214 Example Adding File Attachment Properties 212 Example Adding Formulaic Properties 209 Example Adding Properties 206 Example Booking Cost Formulae 209 Example Creating A Hierarchy Of Bisket Def 224 Example Creating A Master Slave Biskit Relationship 229 Example Creating A New Basic Bisket Def 219 Example Creating A Set Of Bisket Def 220 Example Creating An Inheriting Biskit Def Booking 234 Formulae 197 Formulaic Properties 197 Integer Property Definitions 188 Integer Type 188 Java Enum 191 Java Enum Definitions 191 Java Enum Property Definitions 191 Mapped Integers 188 Mapped Strings 195 Master Slave 185 Property Definitions 180 Property Layout Editor 156 Property Storage Mechanisms 173 Run Data Definition Validation At Boot 148 Set And List Property Definitions 192 String Enum 196 String Enum Property Definitions 196 String Enumerations 197 String Property Definitions 194 Updating The DB 200 User Roles 190 View Mode 201 Banner Global Preferences For 144 Biskit Biskit Property Definitions 185 Biskit Property Type 185 193 Collection Editor Properties Visib
250. skitDef as its parent it will have access to the Permissions created for the parent When checking Permissions all the child Permissions will be filtered and acted on If there is not a relevant Permission then the parents Permissions will be filtered and acted on for each type of Permission in order of precedence For the action Update this will be done first using property Permissions and then BiskitDef Permissions and finally the action Update Permissions This means all property Permissions on the parent will be checked before any BiskitDef Permissions on the child will be checked 2010 2015 Exprodo Software 100 Exprodo Database User Documentation Conditions The conditions assigned to a Permission provide a means of very precise control over the situations in which a Permission will apply For example there may be different Permissions that apply depending on e the resource a booking is made for e the status ofa booking for example a booking may be editable while it is a request but not once it has been approved or a particular Permission is to apply when e approving a booking e cancelling a booking All of these things are specified by the conditions Here are some examples Suppose there are two Permissions both of which apply to updating bookings and both of which are Biskit Type Permissions which means they specify the action and Biskit Type but not a property Permission A has the condition e statu
251. some options greyed out Refresh Delete Save Edit View History Create Create copy References Printable view When a toolbar is being described the text will refer to this chapter and describe either those buttons not mentioned here or whose operation is significantly different from the norm Editing Buttons Button Description Edit The Edit button is greyed out if there is no item selected or the user does not have permission to edit the item Pressing the button put the item into Edit mode There will be a warning if another user is already editing the Biskit and if the Biskit has the Version Property meta property then the user will be warned if an older version is being edited The Apply button is active only while an item is in edit mode Press it to save the item and stay in edit mode Save OK The Save OK button is active only while an item is in edit mode Press it to save the item and the item will revert back to a read only view The Cancel button is active only while an item is in edit mode Press it to throw away any changes since the last Apply if there is an Apply option on the menu and move out of edit mode The View button is used to revert back to a view of the item s details in read only mode If there is no item selected or the item s details are already shown in read only mode then the button will be greyed out Delete The Delete button is greyed out if there is no item selected the sele
252. source a project lt 2 can use This way individual projects can be set up to pay different amounts for each resource 1 Go to Admin gt Bakery 2 Press the Open All button to open the Biskit Tree 3 Select the Biskit to add properties to in this case Booking 4 Press the Edit button to get the Bis kit into edit mode 2010 2015 Exprodo Software 210 Exprodo Database User Documentation 5 Press the Add New button to add a new property 6 Update the meta properties of the property Most of them do not need to be changed but as a minimum a Change Type to double b Change Name to BookingCost c Make it not Editable d Make it Formulaic Aaka Newt Cu Copy Paste Delete DERIN is aisa m 5et to not Liae Editable a H Visible In Biskt Detail Visible In B skit List F Visible In Collection Editor 7 Enter the formula required 2010 2015 Exprodo Software Exprodo DB Configuration Guide 211 8 Press the Save button An error box will appear fae error in formula for Booking Booking Cost Property Projecthesource Settings costPerHour is not yet live and so cannot be m anenced in a formula Check the error by pressing Show Log If the error is complaining about a property not being live yet then press the OK button and then the Save Despite Errors button 9 As this is adding a formulaic property we only need to reload the database configuration a P
253. ss the Edit button to get back into edit mode 2010 2015 Exprodo Software Exprodo DB Configuration Guide Properties Add New Cut Copy Paste Delete Erm err fe own fsragy cnicrenfset_ Description Minone Toottip none O Sort Order BO O O OOOO O T ase SS El None OOO O El None SOOO Visible 7 Editable Persistent Mull Aige Peequired lt Visibhe in Biskit Dirai 7 Visible in Biskit List C Visible in Collection Editor Hona a 7 bai 10 Select the Parent property a Change BisketDef to Organisation b Change Biskit Property Type to Many To One c Change Inverse Property to Children Columns 7 hong croup Nons torage Mechanism fi Fonmultaic Def toilrgarnisation Ha b Change Bisket iaki Def Organisation Property Type to Many i To Une Bl kit Property Type Many io Ging c Change Inverse l a Property f Chiidren Property to Children ul Value ull i if B A i 11 Press the Save button there will be an error Save Despite Error This is needed so that when the Children property is set up it finds the completed Parent property to set up Inverse Property 12 Press the Edit button to get back into edit mode 2010 2015 Exprodo Software 28 Exprodo Database User Documentation Properties Add New Cut Copy P Viesibie 13 Select the Children property
254. t EONO scrini aa aa a E A 156 BD BAKEN nsore E a E S EAEE E EE EN E N EERE EE E ede A EAA 173 4 9 1 Property Storage Mechanisms visiiscasicsitecsssisssosdssanciwesdectseuianavevenssenetdvacescecsssniansdnbenndedosesscsuedsnveibenaeangent 173 AO 2 Biski Def ONS E a aaa a eaa e a aa 175 AiG 3 Property De TIMILIOINS enan T OA 180 4 9 3 1 Biskit Property Definitions 0 000ccc ccc cee eceecceeeeceeeceneceaeseeueseneeseneseneesenescaeevauesaeseeuesensesaeseasesenesensesaesy 185 4 9 3 2 Boolean Property Definitions rasnon a a E a a A 186 4 9 3 3 Double Property Definitions 0 cccsssessseseceeeeeeeeceeeaeeeesensnseceeeeeeeseesaeaaeaeasssseeceeeeeeeeseesaaaaaseseeeeeeeess 187 49 3A Ine FYODS y De GIAO S eich a ewe veld a soesevunactie ana a ee cee 188 4 9 3 4 1 Mapped Integers cccccc ccc cccccccceseseeesceneescseeesaeeseneesceesesueseeneeseseeesueeseaeeseeeeseaeeseneeseeeeesseeseneeess 188 A9 SAINI BLS SEa vee WE SS PT mS REP on ne ee eee ee vn ae 190 4 9 3 4 1 2 User Roles citisecectesieaaciatiasptencdideensaaveonievishievadvtaadvideinvidpotennawiadolaviceoswavtsvisteaysentevaartvadetasvanterielis 190 4 9 3 5 Java Enum Property DeTIMONS ieccecisuiececnntnveccssouericebcinndeceel a o E a a 191 4 9 3 5 1 Java Enum Definitions seasnaeenaaeaaennaennnenennrenerennrinnrnnnbtntttnn ttantta nt Aa nran EAER AEEA EEEE EEEE EAEra arnan eeann 191 49 360 Set Property DEMONS sasa E aetna ae an Ae 192 4 9 3 7 String Property Definitions
255. ted Date Time The date time when this session started e Date Time peste re wren Mis sasson wes ae OO date time when this session was last used IPAddress IPAddress String The IP address of the user s com The IP address of the user s computer sits session ID String An ID used to represent the session when the user s web browser sends requests to the server userAgent String The web browser s reported user agent information This tells you which web browser they are using Now the BiskitDef for a Session must contain information about each of the above six properties For each one it has to know the Data Type its name the label used to display it and so on However the Session BiskitDef must also store meta properties of Session itself such as its type Session its database table name and the text used to display the name Session in a number of contexts There are quite a few different types of property that a Biskit can store and these are described in the next section Property Definitions The meta properties of a Biskit are much simpler and here is what they look like in the editor Created Property oooO e 4 S S Creator Property Pd Updator Property lt i SSSSSS id e mm Null Value Label ae o _ my Mechanism Shareable Table Not shareable with sub types Allows Deletion While Referenced 2010 2015 Exprodo Software 176 Exprodo Database User Documentation He
256. ter you press the Edit button and enter edit mode Cancel Create Create Copy Delete Open repor For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Opens the Search page in a state ready to run your report Click Go to run the report This will be greyed out in edit mode Opens the Search page and runs the report This will be greyed out in edit mode Editing Reports Once a report is in edit mode the basic properties can be changed in the top section all have drop down menus for the options available other than the report name which can be overwritten Use the tabs to add or change the conditions see the Setting Search Conditions chapter for more information about conditions and how to edit them 2010 2015 Exprodo Software KA Exprodo Database User Documentation Use the tabs to change the columns that are viewed what is viewed in them and how they are labelled O G loginName O roles D O O orventiare O lctnertiame II amiHame emai useType exprCate Add and delete columns property to be vlewed Change the p Editthe column label Logn mame h nam Cownt Distinct Values of F Email address Expiry Date arent Deetieet No aggregation Decide whether Mo apgnegatien Scaled values No aggregation N aggio On
257. the Admin Role needs to bestow the ability to create or update whatever they like The Permission can still be revoked in some circumstances by using a Permission of a higher level elsewhere that overrides the Permission we re creating here To achieve the ability to let the administrator create or update anything we need to create two separate Permissions one for the Create and one for the Update 1 Create a Permission that applies when Anything is Created and give it a suitable name Leave all the other options at their default values true YT Create T 2 Under Applies To untick Include Everybody select Use Roles and tick the check box next to Admin Roles Use Roles Require all selected rales Cl Root l Admin Cl User C Guest 3 Save the Permission 4 Repeat step 1 but this time set the Action to Update and set the Permission s name accordingly 5 Repeat of steps 2 and 3 above for this Update Permission 2010 2015 Exprodo Software Exprodo DB Configuration Guide 111 Example 4 Only Allow Specified Users To See The Price Being Charged For Use Of A Resource In Calpendo a resource resource represents a real world item that can be booked The price to be charged for its use is project specific and stored in the Cost Per Session property of a Project Resource Setting This example is therefore designed to stop anybody apart from one particular administ
258. the user has the correct permissions they may edit the individual records or make changes to multiple records All of this will be covered in the chapter on Editing Search Information 2010 2015 Exprodo Software 4 Exprodo Database User Documentation 2 6 1 4 Group Report Shows the report as a table with one column showing a Count of Biskit Type The table can then be extended to show other columns for properties 2 available within the Biskit Type chosen File Search for Resource Report type Group Report Conditions Columns Reset Go W Autorun Found one group of resources Count of Resources JO 9 To choose more columns either use the Columns button on the toolbar or the green to add one column red to delete the current column green tick to add multiple columns tick all columns that are required and then click OK or use the green icon on the menu bar to select all the columns or the red icon to deselect all the options Count of Resources ud wi skitTyp z pra ype biskitType amerrmushed Change Option Count of Resources bil ahterFinishedChangeD ption collactUsage i nProgressChangeO pion ee langeUsageRecorder inFrogressChangeCption lmerChange Option largeUsageRecorder later Tenmitenutes laterChangeCplion OK Cancel E JE lf the Columns button is clicked a pop up appears in which the columns can be chosen using the same three buttons as des
259. the value stored in this property should be unique If it is then when Exprodo DB is asked to generate SQL code to update the database schema it will add the necessary commands to tell the database that the column contains unique values This will make it illegal for the same non null value to be present twice Automated This specifies whether the property is automatically assigned a value Property Type jand when The potential values are None Create Update or Create amp Update If a property has a value other than None then the property will not be viewable when a Biskit is being edited Default Value The value the user will see on creation If this value is outside the Min and Max values above then the user will have to update before saving The attributes on a PropertyDef are all boolean values as follows Name Description Visible Indicates whether the property should ever be displayed If you make a property invisible it will always be hidden Specifies whether this property can ever be modified Some static properties are special and cannot be changed but you may sometimes have dynamic properties that are calculated from some other source and inserted into the database You can mark such properties as not being editable to protect them from accidental change Persistent Indicates whether the property is stored in the database Dynamic and indirect properties should always be persistent Null Allowed Specifies wheth
260. tion All the remaining property types don t support any notion of an ordering that could be used to specify a less than relation etc So for these the relations available are All the above relations are used when the Condition Type is Value Updated Value or Meta Property For a Condition Type of Change the re ations are different In this case a comparison between new and an old value are being done The numeric options available are semantically identical to their original values but to make it clear what is meant by less than in this situation the wording changes to this changed decreased decreased or remained the same Increased or remained the same increased All the remaining property types including those that used the set of Mapped Integers like user roles above do not support any notion of comparing the new and the old value except for indicating whether there was a change 2010 2015 Exprodo Software Exprodo DB User Guide 23 The Value A value is not required when the Condition Type is Change That s because the Change relation compares the new and the old values of the property and so does not require a user specified value to compare against When a value is required a drop down menu is shown Any property that is not a date or date time it shows this Mull Specified value This gives a choice between a value that is null a special value meaning there is no value and Spe
261. tion if both conditions are True then the nested condition is True otherwise False All conditions apply 2 Check the top level condition if any of the three top level conditions are True or the nested condition is True then the whole condition is True Any condition applies 2010 2015 Exprodo Software 26 Exprodo Database User Documentation Referenced Ticking Show advanced allows the use of Referenced as a Condition Type Using Referenced it is possible to search for BiskitDefs that are referenced by other BiskitDefs Using the Relation Statement and the Value this can be further refined to find those that are referenced a number of times e g more than once less than three times etc Conditions x 7 of the following apply 7 Show advanced cs Referenced by Select a path greater than 7 0 times Eg CAPIUUU UStl Sety j AIl references td Network Metric Ge CORDES Permission Report owner Report Schedule users System Usage T When using Referenced the application looks for all those BiskitDefs that have a property which points to the BiskitDef that is the object of the search In this case the search BiskitDef is Exprodo User the application will give a drop down that lists all the BiskitDefs that have a property that points to an Exprodo User BiskitDef Expanding a BiskitDef will list the properties that are available For instance Report has an owner
262. to appear Then press the New Value button and select the user s login name from the drop down 1 E a oe ee ere k Conditions s Recipients le E mail Subject Email Body v Data Type email familyMame E F gvenMame login ame otherMarme ka E And this would insert text into subject so that it looks like this USER NEW OLD DATE IP ADDRESS AUDIT LOG URL New Calpendo user request for NEW loginName The text inserted could have been typed in manually if it was known what to type The buttons provide easy ways to enter the right magic text When the Automatic Email is saved the email Subject tab changes its appearance to look like this Once saved the magic text parts are parsed and rendered differently in this case in blue and bold This gives some visual feedback so that it can be seen that the text has been recognised correctly This is particularly useful if magic text has been manually typed in rather than using the buttons 2010 2015 Exprodo Software Exprodo DB Configuration Guide 123 The User Button The User button inserts text that is replaced by the user that performed the action that led to the Automatic Email being triggered If an administrator were to create a new User then the User button would insert details about the administrator and not the newly created User If somebody registers themselves with Exprodo DB then the User
263. to be viewed choose which page to view Bookmark A Calendar page with the The bookmark to be used Page specified bookmark set up Customised A search page customised to your 1 The Biskit Type to be searched for 2010 2015 Exprodo Software 134 Exprodo Database User Documentation Page Description Additional Information Search specific requirements 2 The report type to be used Page 3 A descriptor to define additional search buttons available on the search page See below for a definition of the descriptors allowed 4 Any Conditions to be used in the search Data Explorer Page A customised Data Explorer page 1 The Biskit Type to be displayed 2 The ID of the particular record to be displayed 0 or empty means display all 3 Whether a user viewing the custom page may change the Biskit Type being displayed The URL to be displayed For example url http www exprodo com Frame Page Opens any URL as a frame inside Exprodo DB This will display with the menu at the top of the page and then the content of the URL specified below Run Predefined Report Runs a report either system or personal The report to be run The following page type may be useful when customising menus Page Description Parameters Example Opens up an editor which allows the user to define how to layout properties in a Biskit so that they can be
264. to hide all rows without nomen an error Hide error free rows Press the Preview button to see the results of any changes to this setting Whether to hide those columns that are being ignored for import Hide ignored columns or to hide all Column Hiding columns without an error Hide error free columns Press the Preview button to see the results of any changes to this setting 2010 2015 Exprodo Software Exprodo DB Administration Guide oe Importing File Attachments If any of the properties to be imported include the Attachment BiskitDef then the user is supplied with an additional button to select the list of attachments to be imported This needs to be done before the Preview or Import buttons are pressed Calendar Templates Bookings Projects Search Admin Help import project txt Choose new file Biskit type Project Select attachments Insert New Data v os Preview Import ee Pn Select Normal Normal Normal attachments s om s pen v i a Ignore Ignore Ignore button Once the attachment pop up is present use the Browse or Choose File button to find all the attachments required for the import Once selected click OK and move on to Preview and Import the data import project txt Choose new file Biskit type Project Select attachments Insert New Data vy lt Preview Import 1 A projectCode projectCode 2 2 B type name name 3 C status 3 C status
265. to the left in this case a property psqiDURAT group psqiDISTB PSQIDURAT psqiDURAT PSQIDISTB psqgiDISTB psqiLATEN PSQILATEN psqiLATEN psqiDAYDYS PSQIDAYDYS psqiDAYDYS psqiSLPQUAL PSQISLPQUAL psqiSLPQUAL psqiMEDS e PSQIMEDS __ psqiMEDS psqiHSE PSQIHSE psqgiHSE psqi 2010 2015 Exprodo Software 158 Exprodo Database User Documentation Left Pane The Left Pane shows the Layout Tree see image above Showing for each BiskitDef the layouts that are available It also has a tool bar which allows the user to open and close all the branches to the tree For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Top Pane With Layout Toolbar The Top Pane shows the header information for a layout To create a new layout press the Create button and then choose the BiskitDef the layout is for Property Description Displayed The BiskitDef the layout is for Type Enabled Whether this layout is currently to be used Disabled layouts are shown in the layout tree in the left pane in red Unassigned Specifies how all unassigned properties will be displayed Either Show in Properties Main Table where the properties are shown in a table above the tabs Display section or Shown in Property Group where the properties are shown Location as the first tab in the tabs section with a name for the tab assigned by the user The Top Pane also has the Layout too
266. tton to save all your changes Date amp Time This tab allows selection of the format to use for displaying the day and date at the top of each day in any calendar and also the date and time format used everywhere else Also specify whether US date format is preferred Booking Reminders calendar Day Column Date SEED z Calendar View Format Date amp Time Date Format 8 Jan 2010 T Email Prefer US Date Format Menu Email This tab allows the user to choose whether to opt out of automatic emails not reminders Date amp Time l i matic B m B dl ea No automatic emails Emails Ball No automatic emails Allow automatic emails Menu Menu This tab allows the user to choose how the menu operates Either configure it so that each sub menu opens up just by placing the mouse over a menu or that the user must click on a menu for its sub menu to open Also Exprodo DB can show different menus to different user roles If the user has sufficient permission to change their menu then a drop down that lets you select which menu you should see will be shown Date amp Time automatically Open Menu Menu 2010 2015 Exprodo Software Exprodo DB User Guide 2 4 Toolbar Button Standard Definitions Exprodo DB uses toolbars in a number of places to provide options for editing and displaying information This chapter will define the standard button operations Below is an example of a toolbar with
267. twork IP address of the user that generated the change For changes initiated by the Exprodo DB server rather than a particular person this will show the server s loopback network address The AuditLog Button Whenever data is created updated or deleted there is an AuditLog entry created This button allows the extraction of information from the audit log entry This is not normally useful but is required for a special case When a user registers there is normally an Automatic Email that lets an administrator know that a user has just registered That email contains two URLs one that will automatically approve the user and one that will automatically deny the user For this to work Exprodo DB needs to make sure that when the relevant URLs are accessed nobody else has already changed the user s properties So the Automatic Email uses the audit log information to add the AuditLog s identifier This is a unique identifier for the audit log entry Exprodo DB can then examine the audit log and check to see if there have been any changes to the user since the time the email was generated only if there have been no subsequent changes will the user be approved or denied 2010 2015 Exprodo Software 124 Exprodo Database User Documentation The URL Button This inserts a URL to your Exprodo DB Sometimes it is required to provide a link in an email to a particular page This can be done by putting the relevant page information after th
268. ult sorting oo oo Attributes Visible In Biskit List Visible In Collection Editor Columns Group Storage Mechanism jo Formulaic Use default v Use default v Column Name Everybody Y Shareable with sub types Automated Property Type v v iii Change Allows Deletion While Referenced Does not allow deletion Y Biskit Def to Biskit Def Attachment j Y Attachment Component Reference Deletion Option project_attachment Pia O12 S Sec D 2 a l o Ia Z 2 z B He S nt Z Eis e jz lt a S g z G E 3 A a 3 2010 2015 Exprodo Software Exprodo DB Configuration Guide m Properties Add New Cut Copy Paste Delete Name Type drag FileName J Biskit orao Bist a Change Type to Wer Project Name to E COTE Project z Toortip none Sort Order ive y 3 New Project Property iption Visible Editable Persistent Null Allowed Required Visible In Biskit Detail Visible In Biskit List Visible In Collection Editor K 6 Create a new property a Change Type to Biskit b Change Name to Project c Change Biskit Def to Project d Change Biskit Property Type to Many To One ssi S amp S amp Group Formulaic Unique c Change Biskit Def to Project z wy 7 g 3 g 3 Biskit Def Component
269. un the script to apply the changes b Press Validate Biskits button to check the database Biskits c Press Reload Database Configuration to load the new database into Exprodo DB d Refresh the browser 2010 2015 Exprodo Software 234 Exprodo Database User Documentation 4 9 5 1 10 Creating An Inheriting BiskitDef Booking An example of creating a Biskit that inherits from another Biskit In this case Resource Please note that when editing the new Biskit the user cannot see the properties that it inherits from the parent Biskit 1 Go to Admin gt Bakery 2 Press the Open All button to open the Biskit Tree 3 Select any Biskit 4 Press the Create button to create a new Biskit and enter edit mode 5 Update the meta properties of the Biskit a Change Type to be the new BiskitDef name in this case ExtendedResource b Change Parent to Resource c Change Group to make it easy fo find all the new BisketDefs using the Filter Biskit Group button d Decide whether new BiskitDef will share a table with its parent by changing Share Super Type Table it is best if they do share a table e In Properties Add New i Change Name to LastBreakdown li Change Type to Date f Change Name property on the BiskitDef to point to the Name property of the parent Properties Type Scanners 8 Change J b Change Type to Add New Cut Copy Paste Delete Parent Parentto 5 Scanners Bookin Nam g c Change Nam
270. user will need to define which of the Category s the current Notes section will save Notes as Any Waterfall enabled in this Notes section will only display Notes of this Category If no Category is enabled then the Waterfall section will display all Notes no matter what their Category An Add Note can define a Category to create a Note under in one place in the Layout and a Notes Waterfall can be enabled with that Category defined somewhere else in the Layout if required Permissions may be assigned to Category s to stop allow viewing editing of notes A Permission assigned to a Category in a hierarchy will be inherited by all its children 2010 2015 Exprodo Software Exprodo DB Configuration Guide 171 CSS Rule Editors The user can define their own CSS information for each Table Row Column or Cell using the CSS Editors These editors are displayed as small icons with CSS written on them In order to bring up the icons 1 For a row move the cursor to just to the left of the start of the row 2 For a column move the cursor to be just above the column 3 For a table move the cursor to be just outside the top left hand corner of the table 4 For a cell check the Show Cell CSS Editors box in the Property Group Toolbar When selecting a CSS Rule Editor the area to be affected will have a green border Add New Add New Child Cut Copy Paste Delete show Cell CSS Editors Cell CS5 rs Does the property
271. v Visible Editable v Persistent 7 Null Allowed Required Visible In Biskit Detail Visible In Biskit List Visible In Collection Editor Y None Label Tooltip Sort Order Attributes Y None Y None Dynamic attachments Te Tels Te ele gt 2 S TERE 5 2 g S S 3 5 gt p E celu 3 O sis a Z 5 AE g e E Biskit Def Project Attachment Biskit Property Type One to Many Y 2010 2015 Exprodo Software Exprodo DB Configuration Guide 11 Select the Project Attachment BiskitDef press the Edit button to get back into edit mode Properties Add New Cut Copy Paste Delete Name Type min None Visible Y Editable Y Persistent 12 Select the Project property TENE 4 Null Allowed Required a Change Inverse Prope rty to 4 Visible In Biskit Detail Visible In Biskit List Attach me nts Visible In Collection Editor None Columns 4 None Group None Dynamic Formulaic Column Name project Project Storage Mechanism a a Component Many to One v a Change Inverse Property Inverse Property Attachments to Attachments Default Value Null 13 Press the Save button 14 If there are no errors the database will need to be updated a Press Update DB Schema to implement changes in the DB and then run the script to apply the changes b Press Validate Biskits button to check the database Biskits c Press Reload Database Configuration to loa
272. w _Horne_Warranty Damp_Proofing Wi Timber treatment Properties o assigned lazing eH Electrical Work _Wanrra Roofing Central_heating Underpinning Other_waranties Other_Waranties_Detai 5 2 Council Tax Environmental Arrangements Other Charges H Occupie at Fi F Search This pane shows how the properties of a Biskit have been organised into Property Groups and child Property Groups as a tree structure The layout is defined at the top of the pane the layout will have a Properties and Unassigned Properties branch Property Groups are then created When a Property Group is created it will automatically have a Properties branch which will initially be empty Property Groups can be reordered by dragging and dropping the group elsewhere within its parent To move a Property Group from its current parent to another parent they can be dragged and dropped or by using cut and paste Cut the Property Group select the new parent paste the Property Group Then reorder as above The user in edit mode can move properties from one Properties branch to another by dragging and dropping All the properties in a Properties branch can be moved by dragging the branch to a different Properties branch Also properties can be dragged from a property list in the Information Pane and dropped into a Properties branch in the Organisation Pane Properties can be reordered within a Property Group by dragging and dropping th
273. w exprodo com Email support exprodo com UK Telephone 01235 813458 International Telephone 44 1235 813458
274. what the User Requests page looks like when some users are awaiting approval Calendar Templates Bookings Projects Usage Search Admin Help User Requests admin Change Password Settings Sign ouii Lea Other Family Email Identity Password Roles Version Created Updated name name address pa ae ee E ocavsarsin foranes o hangman con blah com Reaves Biology eae ei eee e p Jun 5 sun 2014 18 29 14 33 5 Jun 5 sun 2014 18 29 14 of oo Galileo Watson Francis Local Watson Francis Watson blah blah com Requested Biology User Watson sun 2014 14 88 Jun 2014 14 33 5 sun 2014 14 38 Jun 2014 14 33 Edison Thomas Local Edison Thomas Alva Edison blah blah com Requested Physics User Edison 1 5 Jun 2014 14 33 5 Jun 2014 14 33 2010 2015 Exprodo Software 58 Exprodo Database User Documentation Approving Or Denying Users As described in The User Approval Process amp approving or denying new users means changing their status The top part of the User Requests page provides a quick way to do just this Tick the check box next to each user whose status to be changed r bef F a i Approve Deny Block Force password reset Delete Note that as soon as there are any users checked then the checked button bar changes so that it is no longer greyed out Now press any of these buttons to Approve Deny Block or Delete the ticked users Press F
275. will appear and the user will be able to examine or modify them permissions permitting s J e een nae Fanny rame En aaaess User Type Staus expry Oat veson O fopa roae Fo ovest root user Aamin iccarot fro Normal O e ps sepzore rasafassepana vasa O C eues user ramin Localaanin feom rnaen frora Jo r2wayaora sao separa zsa Ee O foam faut frorn uaus exgrodacom Normal fr 28 Sep 2012 1006 a8 Sep 2014 1226 fuser e E e e E A E Tne ceeendtime when tnter was ceted fose O ioamve eom frome fuaneoaneon fens ora p OO OOOO fose ioamense foreo meroa Joanon feo fora e JJ a fuse ioaromgen winem fronoen anguian com fens roma Jo a ofuser_Yeatewton_fisaae__ rewon fonenn frora fe onoare asep sors 106 a ange fose tcalarwin_ onanes foom nanguancon ease noma e ___ _ ous farne Jae foore uen exedacom fens frora Ja reana ona UUS fo fuse______Jlcagatieo_ oaveo fome forcon fems ora e OOOO ooo r fse iarna ernes fore aanauancom frora O e oa annn UUS E e Jaton e a e E C __ Ofe o faensen aon Jensen ongexrodacom frora fe pronen annan UO e_ _ i ii I O oe ficarenson nomas Jeasen bangnancam fene frora a C e E E Nomall_Jo_ Cpe earna va feon lan alancam Norval 1 peoe eonan a fuser __ locameer fre fose beneoencom fena frora j femos a fanon OOOO C fuser an oar __ ncom oary exorodacom fcay froma f2 fez uzos 1512 fz uns
276. with the Admin role will receive a warning each time they log in Regular users only receive a warning in the 7 days prior to expiration Note that 30 days grace period is allowed so that there is always time after expiration before the licence must be renewed e When a user with the Admin role logs in for the very first time they are assigned the menu that has been configured for Admin users in Global Preferences gt Menus gt Default Admin Menu A user that has neither the Root nor the Admin role will be assigned the menu specified in Menus gt Default User Menu when they first log in The final difference that users with the Root or Admin role may notice is that each Biskit Type can be configured in the Bakery to be visible to users with the Root role users with the Admin role everybody or nobody For example this provides a way to reduce the number of bisikit types that users may search for for example Names And Email A user s name is split into three parts their given name usually their first name the family name usually their last name and their other name for any middle names Exprodo DB uses these names for display and in reports but not for anything else For example it is not a requirement that a user s name is unique A user s email address is important because Exprodo DB sends emails for various reasons Automatic Emails and Manual Emails Type Exprodo DB may be configured so that users are ask
277. xt login in order that the user must change their password again when they log in Once the details are changed click Save this will have replaced the Edit button 2010 2015 Exprodo Software 68 Exprodo Database User Documentation Changing A User s User Groups To see which user groups a user is amember of select the user from the list of users as described by How To Edit A Single User above The tab panel at the bottom of the page shows the user s projects and group memberships Select the Groups tab and a list of all user groups is seen with a check box next to each group the user is a member of L E Apply Refresh Note the user s details do not need to be in edit mode in order to change the user group membership That s because the user group membership is not a property of the user itself but of the user groups To modify the group membership for the selected user 1 Tick or untick the groups The groups ticked are the ones the user is a member of Tick the check box in the header row if all the check boxes are to be ticked or unticked Press the Apply button when finished Updated 1 groups 2010 2015 Exprodo Software Exprodo DB Administration Guide 69 9 Configuring The Properties Displayed The user can control which properties 2 are displayed in the list of items in the detailed view of a item This is done in the Bakery
278. y Create Or Update Anything 110 Anbody Can Modify A Booking Request They Created If The Booking Is Still A Request 109 Anybody May Create A Booking Request 108 Approval Of A Booking Requires An Admin 113 Hiding Resources And Booking Properties 115 No One Can Email Password Details 114 Only Allow Specified Users To See The Price Being Charged For A Resource 111 Explorer Data 46 Exprodo 173 Exprodo Database Configuration Guide Exprodo Database User Guide 10 _F File Attachment 216 212 219 234 92 2010 2015 Exprodo Software Index 257 Creating A Set Of Bisket Def Example Adding Properties For Formulae Known Problems 220 212 199 a General Global Preferences For Getting Started 8 Global Preferences 143 Appearance 144 Check Reserved Words Copy All Outgoing Emails CSS 144 Database Dumps Minimum Time Between Date And Time Format 145 Default Initial Page 149 Email 146 Email Authentication 146 Email Connection Security Email Signature 147 Email SMTP Server 146 Email Apparent Sender 146 Email Limiting Who Emails Can Be Sent To 146 Email Reply To 146 Email Sending Enabled 146 Email URLs Refering To Exprodo DB General 148 Hacking Protection Host Page Title Icon 148 Licence 149 Login Header 148 148 146 148 146 146 153 144 144 Login Name Length Minimum 155 Menu 150 Menu Default Admin 150 Menu Default Root 150 Menu Default User 150 Network
279. y can read everything The conditions for this permission 2 Update Se ee hee TAT n a ante val ie i E ee all 2010 2015 Exprodo Software 106 Exprodo Database User Documentation Now that a Permission is selected the button bar is no longer greyed out Edit Create Create copy Delete References For a complete description of the standard toolbar buttons read the Toolbar Button Standard Definition chapter Press the Edit button to make the page to be editable and the button bar changes Cancel Save The main details of the Permission contain all the information represented in the tree on the left These two screen shots show the details in read only and in edit mode By default only admins may c By default only admins may create data Data Property None permission applies to whole object Authorisation nee Permission When changing these details e The Name can be as required but should not be the same as any other Permission e The Comments can also contain anything and is only there to record whatever notes there are about the Permission e The Enabled flag is a way to create a Permission without making it take effect immediately or to turn one off without deleting it A disabled Permission shows in red in the tree The other properties amp are described in How Permissions Work amp The Conditions Tab Conditions underpin much of the configuration that can be done in Exp
280. ypes All the other content types require a numerical or date property as an additional parameter the exception is Count Distinct which will work with any type The value of this parameter will be used to determine the value stored in each cell Cal nedal Templates Bookings Projects Usage Search Hlp File Search for Resource Report type Summary Repoti Conditions Reset Row locaton nane Column proctRequired Content Sum hort enmdinutes I Scaled _ Founded Go later TermMmutes Loading shontTernnMinutes LEa a Content Tye Description Count Distinct How many different values to the property are there for this cell Sum The total of this property for this cell numerical only Minimum The smallest value for this property for this cell Maximum The largest value of this property for this cell Standard Deviation The standard deviation of the values of this property for this cell Value At Minimum Of Choose a property to find the minimum of and the value shown in this column will be the value of the current property when the property being compared with is ata minimum Value At Maximum Of Choose a property to find the maximum of and the value shown in this column will be the value of the current property when the property being compared with is ata maximum Below is an example of a table showing the total booking duration in minutes for each project for each resource 2010
281. ystem Event is created System Event has a property called user that records who caused the event If you were to create an Automatic Email that was triggered by a System Event then direct the email to the user that caused that event by choosing a property path of user Custom properties can also be used which hold email addresses this allows Exprodo DB to send emails to users outside Exprodo DB by choosing such a property the Automatic Email would extract the email address Once the Biskit Type is selected that the Automatic Email is triggered by then clicking in the Property Path selector will show a drop down panel with all the possible paths that lead to a User User Group UserType or Email property 2010 2015 Exprodo Software 122 Exprodo Database User Documentation The Email Subject Tab In write mode the email Subject tab looks like this USER NEW OLD DATE IP ADDRESS AUDIT LOG URL Mew Calpendo user request In the case shown the email would have a subject of New Exprodo DB user request The buttons that appear in the tab enable dynamic text to be inserted that will be replaced when the email is generated For example suppose the email subject is required to be New Exprodo DB user request for X where X should be replaced by the login name of the new user To do this first append the text for to the subject making sure to leave the cursor at the point where the dynamic text is required

Download Pdf Manuals

image

Related Search

Related Contents

ServView 17 Enterprise KVM Drawer Range  Workflow - Topaz Labs  パーソナルコンピュータの製造等の事業を行う者の使用済物品等の発生  Pioneer DVJ-X1 User's Manual  取扱説明書  Emerson MR98 Data Sheet  SRS-D101  L`APA : mode d`emploi - Athis-Mons  KitchenAid KSB550 User's Manual  Introdução à Computação - Página para produção de livros do  

Copyright © All rights reserved.
Failed to retrieve file