OpenProject AdminGuide

Transcription

1 OpenProject AdminGuide

2 I. Contents I. Contents... 1 II. List of figures Administration Manage projects Manage users Manage groups Manage roles and permissions Manage work package types Manage work package statuses Manage workflows Manage custom fields Manage enumerations Manage LDAP authentication Manage colors Manage project types Manage export card formats Manage plugins Manage cost types System settings General settings Display settings Authentication settings User settings Projects settings Work package tracking notification settings Incoming s Repositories Checkout (Plugin)

3 II. List of figures Figure 117: Create a new project... 3 Figure 118: Configure a new project part Figure 119: Configure a new project part Figure 120: Copy an existing project...error! Bookmark not defined. Figure 121: Configure a copied project...error! Bookmark not defined. Figure 122: Select a parent project...error! Bookmark not defined. Figure 123: Project settings in project menu...error! Bookmark not defined. Figure 124: Activate and deactivate modules...error! Bookmark not defined. 1 Administration Granted that you have the necessary privileges you can access the administration panel, through which you can adapt the global settings for all of the projects. To do that open the Modules dropdown menu on top of the page and select Administration. Figure 1: Select administration panel 1.1 Manage projects Note: In order to be able to access the administration panel and create a new project you need to be a system admin. You can find the list of all existing projects under Modules -> Administration -> Projects. 1. Filter and search projects. In general you will automatically see the list of all the active projects. You can find the archived projects by selecting All from the Status dropdown filters list. Type in the search criteria in the search field and click Apply to yield search results. 2

4 2. Edit projects. To edit a project, you can access the project settings by clicking on the project name. 3. Archive projects. 4. Copy projects. See here how to copy a project. Please note that the delayed job must be activated for the project to be copied. 5. Delete projects. Figure 2: Manage projects Create a new project In order to create a new project, open the Modules dropdown menu on top of the page and select Administration. You will be redirected to the administration panel, where you can see the list of existing projects. To create a new project, click the respective link on the right side. Figure 3: Create a new project A configuration dialogue will open where you can name and configure the project. 3

5 1. Project name. This is the field to enter the project name. 2. Subproject. This dropdown menu lists all the projects for you to select from, if you want to set a new project as a subproject for an existing one. 3. Summary. A short summary of the project that will appear. This summary will appear in the overview page where all the projects you are a member of and public projects are listed (Projects -> View all projects). 4. Description. You can describe the project in more detail here. This description will appear on the overview page of this specific project (Project Overview Page). 5. Identifier. A project identifier is used to uniquely identify a project. It needs to be clear and possibly not too long, as it will become a part of the project URL. Project identifiers are unique: They same project identifier can only be used once at the same time. 6. Homepage. If your project has a homepage, you can enter it here. 7. Public. If you check the Public checkbox, the project (including all of the project information) will be visible to some users, even if they are not project members, depending on the roles permissions. The permissions of users who are not logged in are usually determined via the role Anonymous while the permissions of users who are registered but are not project members in the public project are determined by the role "Non member. Figure 4: Configure a new project part 1 8. Project type. Here you can select the project type. Project types are for example relevant for complex project timelines, if you want to create a reporting relationship between projects. 9. Modules. You can select which modules can be activated for the project. You can activate and deactivate all and any of the modules later. 10. Types. The types in question here refer to the work package types. You can select which of the work package types should be activated for this specific project. See here how you can create a new work package type. 11. Custom fields. Custom fields are customized fields you can activate. They will be displayed when, for example creating or editing a work package. You can create any number of custom 4

6 fields and tailor them according to your project needs. See here how you can create or edit a custom field. 12. Don t forget to Save the project Figure 5: Configure a new project part Manage users Note: In order to be able to access the administration panel and manage users you need to be a system admin Search through and filter users You can find the list of all existing users under Modules -> Administration -> Users. You will automatically see the list of the active users. You can sort the users: 1) By status. 2) By group, granted that at least one group has been created. See here how to create a new group. 3) By typing search criteria into the search field. 5

7 Figure 6: Sort, filter and search users Add a new user To add a new user navigate to Modules -> Administration -> Users and click on the + New User link. Figure 7: Add a new user A form will open, where you will be able to create a new user. You need to fill out the following fields: 1) User s login 2) User s first name 3) User s last name 4) User s 5) Select the default language. Note: the language can be changed at any point. See here (LINK) how to change the language settings 6) By selecting the Administrator field, you will grant the new user system administrator rights 7) By selecting the check box you will activate the accessibility mode. It can be de-activated at any time. Read here (LINK) how to de-activate the accessibility mode. 8) By selecting the Assign random password box, a random password will be automatically generated and sent to the user. If you select this option, the user will be automatically required to change the password after the first login. 9) Alternatively you can assign a password on your won, 10) You will need to confirm the password manually if you assign it yourself 11) If you assign the password manually, you can still force the user to change the password after the first login by selecting this box. 6

8 12) Here you can adapt the notification settings. These can be changed later. See here (LINK) how to adapt the notification settings. You can also choose not to be notified of the changes that you make yourself. 13) The Preferences block allows adapting further preferences: 14) The option Hide my address removes the address from the user s profile page. Note: This option can be changed later (LINK). 15) Select the time zone. Note: This option can be changed later (LINK). 16) Specify whether the comments should be displayed in chronological order or in reverse chronological order. Note: This option can be changed later (LINK). 17) Specify if you want to be warned when leaving a page. Note: This option can be changed later (LINK). 18) Select the theme. Note: This option can be changed later (LINK). 7

9 19) By checking this box you ensure that the account information is sent to the user via . If the box is left unchecked, the user will not be notified about the account creation. 20) If you click Create, the user will be created and you will be able to adapt further settings for the newly created user. 21) If you click Create and continue, you will be directed to the new dialog and will be able to create another user Edit users In order to edit settings for a specific user navigate to the user overview list via Modules -> Administration -> Users. Click on the user login to enter the editing mode. You will see the first tab General, where you can edit all of the information you adapted when creating a new user (LINK). 8

10 Figure 8: Edit user general tab Under the Groups tab you can assign the member to a different group, granted at least one group exists. See here how to manage groups (LINKS). Select the respective check box and click on save. You can alternatively add a user to a group under group settings (link to manage groups). Figure 9: User settings groups tab Under the Projects tab you can get an overview of the projects that the user is a member of. 1) You can edit the role of the user in each specific project. To do that click on edit, adapt the role by selecting the respective box and click Save. 2) By clicking Delete you will remove the user from a specific project. 3) You can add a user to any existing project. Select a project from the dropdown menu, select at least one role and save your changes by clicking Add. 9

11 Figure 10: Edit user projects tab Under the tab Global Roles (Plugin) you can assign a global role to the user. A global role can grant specific permissions to a user in addition to already assigned roles. Read here (Link to roles and permissions) about managing roles and permissions. If you are using the Cost Plugin (link), you can adapt the rate for the user by project under Rate History tab. The rates will be used to calculate the costs when costs are logged by a user in a project. You will see the all the projects that a user is a member of, as well as of all the public projects. To adapt a rate click on the Update button. In addition, you can assign a default rate, which will be used if no project rate is specified. To adapt the default rate click Update for the Default rates. Figure 11: Edit user rates You will see the current rate, which you can adapt. You can create multiple rates per user per project and activate them for different periods of time Lock users Users can be locked permanently. To accomplish this navigate to the user overview list through Modules -> Administration -> Users and click Lock permanently. Note: you can unlock a locked user anytime. You will find the list of all the locked users under the appropriate status filter. 10

12 A user will be locked temporarily after a certain amount of invalid login attempts. Both the number of the login attempts and the duration of the lockout can be adapted to your needs under Modules -> Administration -> Settings -> Authentication Delete users To delete a user navigate to the user overview list through Modules -> Administration -> Users. Select the user you want to delete by clicking on the login name and click on Delete icon. Figure 12: Delete a user Note: in order for the Delete a user option to be available you may need to adjust certain settings. You will find the settings in questions under Modules -> Administration -> Settings -> Users. Read here (LINK) for more information. 1.3 Manage groups OpenProject allows creating tailored project member groups, which grants additional rights to individual users within specific projects in addition to role permissions. You can edit the existing groups and create new ones in the administration panel. To do that select Modules -> Administration -> Groups. Note: In order to be able to access the administration panel and manage groups you need to be a system admin Add a new group After selecting the Groups from the administration panel menu, you will see the list of all the existing groups. If no groups have been created yet, the list will be empty. 11

13 1.3.2 Edit or remove groups You can edit a group by clicking on the name of the group (1) and remove the group by clicking on delete icon in the respective line (2). Figure 13: Edit or remove a group After selecting the editing mode, you will be able to adapt the group name, group members and assignment of groups to projects. Figure 14: Edit a group 12

14 1.4 Manage roles and permissions Note: In order to be able to access the administration panel and manage roles and permissions you need to be a system admin. A role is a set of permissions that can be assigned to any project member. Multiple roles can be assigned to the same project member. In contrast to normal project roles, Global roles are project-overarching roles that allow certain actions (for example, creating projects) Create a new role To create a new role navigate into administration panel (Modules -> Administration) and select Roles and permissions from the menu on the left. You will see the list of all the roles that have been created so far. After clicking + New Role a form will open and you will be able to specify the role. Figure 15: Create a new role You will then be able to specify the following: 1) Role name 2) Define whether the role is a global one 3) Define whether work packages can be assigned to the role 4) Copy the workflow from an existing role. In case you select a role from the dropdown list, the respective permissions will be copied 5) You can specify the permissions per OpenProject module. Don t forget to save the new role at the bottom of the page. 13

15 Figure 16: Specify new role Edit and remove roles To edit a role navigate to the roles overview list and click on the role name (1). To remove an existing role click on the delete button (2). Figure 17: edit or remove roles 1.5 Manage work package types 14

16 Note: In order to be able to access the administration panel and manage work package types you need to be a system admin. Work package types can be administered under Modules Administration Types. You will see the list of all the existing work package types Create a new work package type To create a new work package type click the + New Type icon. A new dialogue will open, where you will be able to specify the following: 1) Specify the name 2) Specify if the work packages with the new type should be displayed in the roadmap 3) Specify the color of the work package to be displayed in the timeline 4) Specify if the work packages should be displayed in the aggregated view in the timeline (when the aggregation level is chosen) 5) If you select the Default value checkbox, the type will be pre-selected when creating a new project, facilitating the creation of projects with standard types. 6) Specify if the work package should be displayed as a milestone in the timeline view 7) Select which custom fields should appear if this work package type is selected. See here (link) how to create or edit a custom field 8) You can copy an existing workflow from an already existing work package type 9) Specify in which projects this work package type should be available 10) Don t forget to save the changes 15

17 Figure 18: Specify a new work package type Edit or remove a work package type To edit an existing work package type click on the work package name (1). To delete the work package type click on the delete icon (2). Figure 19: Edit or delete a work package type 16

18 1.6 Manage work package statuses Note: In order to be able to access the administration panel and manage work package statuses you need to be a system admin. Work package types can be administered under Modules Administration Work package statuses. You will see the list of all the existing work package statuses Create a new work package status To create a new work package type click the + New Status icon. A new dialogue will open, where you will be able to specify the following: 1) Name the new work package status 2) Define if the new work package status closes a work package (e.g. relevant when filtering for closed for packages) 3) Define if this is the default value when creating new work packages 4) Save the new status by clicking Create Figure 20: Specify a new work package status Edit or remove a work package status To edit an existing work package type click on the work package name (1). To delete the work package type click on the delete icon (2). 17

19 Figure 21: Edit or delete a work package status 1.7 Manage workflows A workflow in OpenProject is defined as the allowed transitions between status for a role and a type, i.e. which status changes can a certain role implement depending on the work package type. Note: In order to be able to access the administration panel and manage workflows you need to be a system admin Edit workflows To edit a workflow: 1) Select the role from the dropdown menu 2) Select the work package type from the dropdown menu 3) Specify if you only want the statuses that are used by this type to be displayed (this option is selected automatically, but you can always uncheck it) 4) Click edit Figure 22: Select the workflow to edit 18

20 You will see be able to adapt the following: 1) Adapt which status changes are allowed by the selected role for the selected work package type 2) In addition, you can specify if this role is allowed to make specific status changes if the user who has been assigned this role also is the author of the work package 3) Or an assignee of the work package 4) Don t forget to save your changes Figure 23: Edit a workflow Copy an existing workflow You can copy an existing workflow by clicking Copy in the workflow overview. Figure 24: Copy a workflow You will then be able to determine which existing workflow should be copied to which other workflow View the workflows summary You can copy an existing workflow by clicking Summary in the workflow overview. 19

21 Figure 25: Workflow summary view You will then view a summary of all the workflows. The number of possible status transitions for each type and role are shown in a matrix. Figure 26: Workflow summary view 1.8 Manage custom fields Custom fields are additional value fields which can be added to existing value fields. The different sections that can use custom fields are work packages, spent time, projects, versions, users, groups, activities (time tracking), work package priorities and document categories (if you are using the Documents Plugin). Note: In order to be able to access the administration panel and manage custom fields you need to be a system admin Add a new custom field To create a new role, navigate to the administration panel (Modules -> Administration) and select Custom fields from the menu on the left. You will see the list of all the custom fields that have been created so far, divided by the module, for which they were created, e.g. Work packages, spent time, etc. Select the module by creating the proper tab. After clicking + New custom field a form will open and you will be able to specify the new custom field. 20

22 Figure 27: Create a new custom field Depending on the module, for which the new custom field is being created, slightly different options may be offered for adaptation. This is an example of a new custom field for a work package: 1) Custom field name, which can be adapted in different languages. 2) Format of the custom field, e.g. text, list, date, Boolean, etc. 3) Specify the minimal and maximal length. If a 0 is chosen, no restriction will be imposed on the length of the custom field 4) Regular expression specifying which values are allowed for the value set for the custom field. 5) Default value which is selected for the custom field. 6) Specify for which work package types the new custom field should be used 7) Set if the new custom field should be a required field 8) Specify if the new custom field should be used for all projects 9) Specify if the new custom field should be used as a filter for work packages. See here (LINK) how to filter work packages 10) Specify if the new custom field should be searchable via the global search 11) Save the new custom field. 21

23 Figure 28: Specify a new custom field Edit or remove a custom field To edit an existing custom field select the appropriate tab and click on the custom field name. Figure 29: Edit or remove a custom field 1.9 Manage enumerations Note: In order to be able to access the administration panel and manage enumerations you need to be a system admin. 22

24 The Enumerations settings allow adapting of Activities (for time tracking), project status, work package priority levels and document types (if you are using the documents plugin). To get an overview of existing enumeration values for all of these categories, navigate to the administration panel (via Modules -> Administration) and select Enumerations from the menu on the left. You will see the enumerations overview, divided into respective sections Create new enumeration value To create a new enumeration value, select the New enumeration value in the respective category. Figure 30: Create a new enumeration value You will then be able to name the value, activate it and choose if it should be the default one. Figure 31: Configure a new enumeration 23

25 1.9.2 Edit or remove enumeration value To edit an existing configuration simply click on it (1). To remove an enumeration click on the respective delete icon (2). If the enumeration is activated, it will have the check mark in the column Active, the default value is identified by the check mark in the Default value column. Figure 32: Edit or remove an enumeration 1.10 Manage LDAP authentication Note: In order to be able to access the administration panel and manage LDAP authentication you need to be a system admin. To see the list of all available LDAP (Lightweight Directory Access Protocol) authentications navigate to Modules -> Administration and select LDAP authentication from the menu on the left. You will see the list of all available authentications already created Add new LDAP authentication To create a new LDAP authentication click on the respective icon. Figure 33: Create a new LDAP authentication You will then be able to specify the LDAP configuration. The configuration depends on the specific database/applications, through which the authentication with OpenProject is intended. 24

26 1.11 Manage colors Note: In order to be able to access the administration panel and manage colors you need to be a system admin. In OpenProject you can define the colors for different work package types or individual task colors in the task board. The spectrum of the color available can be managed through the administration panel. To do that navigate through Modules -> Administration and select Colors from the menu on the left side. You will see the list of all already defined colors. If no color has been defined yet, the list will be empty Create a new color To create a new color, click the respective link in the top right corner. Figure 34: Create a new color You will then be able to define the color name and the Hex Code. Figure 35: Specify a new color 25

27 Edit or remove colors To edit an existing color click on the name (1). To remove a color, click on the delete icon (2) for the respective color Manage project types Note: In order to be able to access the administration panel and manage project types you need to be a system admin. In OpenProject you can different project types. Project type allow the categorization of projects and are shown in the project settings. They are also used in timelines for the second grouping criterion (LINK to TIMELINES user guide). The project types can be managed through the administration panel. To do that, navigate through Modules -> Administration and select Project types from the menu on the left side. You will see the list of all already defined project types. If no project type has been created yet, the list will be empty Add a new project type To create a new project type, click the respective link in the top right corner. You will then be able to the following: 1) Project type name 26

28 2) Set if this type allows association. This option allows creating reporting relations between different project types and consequently creating project-overarching timeline reports (LINK to USER GUIDE). 3) Select the reported project statuses. If a project was assigned to a specific project type and then a project relation was created to another project, a status can be selected to illustrate the reporting status between the projects. Figure 36: Specify a new project type Edit or remove a project type To edit an existing project type click on the name (1). To remove a project type click on the delete icon (2) for the respective project type. Figure 37: Edit or remove a project type 1.13 Manage export card formats Note: In order to be able to access the administration panel and manage export card formats you need to be a system admin. You can configure the formats for the export cards (link to Backlogs section) under administration panel. To do that navigate through Modules -> Administration and select Export card configs from the 27

29 menu on the left side. You will see the list of all already defined export card configurations. If no format has been configured yet, the list will be empty Create a new export card config To create a new export card config click the respective link in the top right corner. Figure 38: Create a new export card config You will then be able to the following: 1) Export card config name. 2) Export card config description. 3) Number of tasks per page. 4) Page size. Note: page size can be adjusted via YAML in Rows. 5) Page orientation. 6) Specify rows. Rows are formatted through YAML. Ideally you could you standard GitHub formatting (link 7) If you have questions about row formatting, click on the question sign icon and see the configuration examples. 8) Click Create to save your changes. 28

30 Figure 39: Specify a new export card config Edit, remove or de-activate an export card config To edit an existing export card click on the name (1). To remove a story card format, click on the delete icon (2) for the respective project type. To de-activate a story card format, click the de-activate icon (3). Figure 40: Edit, remove or de-activate export card configs. 29

31 1.14 Manage plugins Note: In order to be able to access the administration panel and manage plugins you need to be a system admin. OpenProject offers several plugins (link to Install Plugins page) to extend its functionality. To manage plugins, navigate via Modules -> Administration and select Plugins from the menu on the left. You will see the list of all the installed plugins, including a short description. Some of the plugins may be further configured, others can only be installed and used as they are. To configure a specific plugin click the Configure icon in the respective row. Figure 41: Configure plugins 1.15 Manage cost types Note: In order to be able to manage cost types you need to have certain privileges or to have a certain role, for example a system admin. Cost types are the cost categories that will be used for logging costs (Link to the logging costs page). To manage cost types navigate to Modules-> Cost Types. You will see a list of all the existing cost types. If no cost types have been created yet, the list will be empty Create a new cost type To create a new cost type click on the respective icon in the cost type overview view. 30

32 Figure 42: Create a new cost type You will then be able to adapt the following: 1) New cost type name. 2) The unit name for the cost type. 3) The plural form of the unit name. 4) Define if this cost type should be set to the default value. 5) Define the rate history. You can add multiple rates and separate them chronologically. 6) Don t forget to save your changes. Figure 43: Define a new cost type 31

33 Edit or deactivate a cost type To edit an existing cost type, click on the cost type name (1). You can adapt the current rate directly in the overview mode (2). You can lock a cost type (3), in which case it will only be visible if you select the Show locked types option. You can always re-activate a locked cost type. 2 System settings There are certain project overarching settings that are referred to as system settings. To adapt these system settings, select Modules -> Administration and choose Settings from the left side menu. Note: In order to be able to access the administration panel and manage global settings you need to be a system admin. 2.1 General settings Under the General settings tab you can adapt the following: 1) Application title. 2) Welcome text, which will appear on the overview page. 3) The maximum size of an attachment (for example in a work package). 4) Object per page defines the options of how many objects (for example work packages or news entries) you can have displayed on one page. This is used for the pagination. You can enter several values, separated by coma. 5) Days displayed on project activity determines how far back the project activities will be traced and displayed under Activities. 6) Host name. 7) Protocol. 32

34 8) Text formatting. OpenProject supports textile syntax. 9) Select if the formatted text is saved in cache, which will help load Wiki Pages faster. 10) Wiki history compression. 11) Enable feeds enables the export options for the feeds. 12) Feed content limit. 13) Max size of text files displayed inline. 14) Max number of different lines displayed. 15) Don t forget to save your changes Figure 44: Global settings: general 2.2 Display settings You can adapt the following under display tab: 1) Select a theme. 33

35 2) Allow users to choose their own themes. Activating this option adds the theme selection to the My Account settings. 3) Enable accessibility mode for anonymous users. 4) Activate available languages. Note: at the moment OpenProject supports English and German languages. If you want to contribute to the translation project, please join us on Crowdin (link). 5) Select the default language. 6) Select on which day the calendar week should start. 7) Define the date display format. 8) Define the time display format. 9) Define the username display format. 10) Enforce gravatar use by the users. 11) Select the default gravatar image. 12) Set language of users having a non allowed language to default. This option is useful in case a system administrator deactivates a language, which was already activated by a user. It allows the forced language change from the previously activated language to the default language. 13) Don t forget to save your changes. Figure 45: Global settings - display 2.3 Authentication settings You can adapt the following settings under Authentication tab: 1) Select if the authentication is required. 2) Select an option for self-registration. 3) Define the minimum password length. 4) Select what character classes should be part of the password. 34

36 5) Define the minimum number of required character classes. 6) Define the number of days, after which a password change should be enforced. 7) Define the number of the most recently used passwords that a user should not be allowed to reuse. 8) Activate the Forgot your password option. 9) Define the number of failed login attempts, after which a user will be temporarily blocked. 10) Define the duration of the time, for which the user will be blocked after failed login attempts. 11) Enable or disable the autologin option. This allows a user to remain logged in, even if he/she leaves the site. Is this option is activated, the Stay signed in option will appear on the login screen. 12) Activate the session expiration option. If you select this option, an additional field will open, where you will be able to define the inactivity time duration before the session expiry. 13) Log user login, name, and mail address for all requests. 14) Enable REST web service. This activates an API-Interface, which allows communication between external services (for example MS Office) and the instance. 15) Don t forget to save your changes. 35

37 Figure 46: Global settings Authentication 2.4 User settings Under user settings you can define: 1) Whether user accounts can be deleted by admins, and 2) Whether users can delete own accounts. 36

38 Figure 47: Global Settings Users 2.5 Projects settings Under the Projects tab you can define: 1) If the new projects are public by default, 2) Which modules should be activated for newly created projects, 3) Whether sequential project identifiers should be created. If this option is activated, a project identifier for the next project will be offered automatically, based on the existing project name. For example, if a project Myproject1 was created, Myproject2 will be offered as identifier for the next project. 4) The role given to a user in a new project when the user created a new project but is not an admin. This makes sense when a user receives the permission to create a new project via global role (LINK). Figure 48: Global settings: Projects 37

39 2.6 Work package tracking You can adapt the following under Work package tracking tab: 1) Allow cross-project work package relations, i.e. that work packages created in one project can have relations to work packages in another project, for example parent-children work packages. 2) Allow assignment of work packages to groups. See here (LINK) how to manage groups. 3) Display subprojects work packages in main projects by default. 4) Enable using current date as the starting date for a newly created work package. 5) Calculate the work package done ratio with defines how 5 done will be shown. If disable is chosen, % done will not be shown. If Use the work package field is chosen, % done can be set in 10% steps directly by the attribute. If the Use the work package status is chosen, the % done will be chosen based on the status. In this case every status can be assigned a % done value (for example, tested would be assigned 80%), which will then be adapted if the status is changed. 6) Work package export limit. This setting defines how many work packages can be exported at the same time, for example for the work package lists. 7) Customize which work package properties will be displayed in the work package lists by default and for which properties sums will be displayed. Figure 49: Global settings - work package tracking 38

40 2.7 notification settings You can adjust the notifications under the corresponding tab. The following can be defined: 1) Emission address. This Address will be shown as the sender for the notifications sent by OpenProject (for example, when a work package is changed). 2) Blind carbon copy recipients (bcc). 3) Define if the should be formatted in plain text (no HTML). 4) Select the default notification options. 5) Select for which actions notification should be sent. 6) Formulate header and/or footer for the notifications. These are used for all the notifications from OpenProject (e.g. when creating a work package). 7) Send a test . 8) Don t forget to save your changes. Figure 50: Global settings: notifications 39

41 2.8 Incoming s You can define the following under Incoming s tab: 1) Define after which lines an should be truncated. This setting allows shortening after the entered lines. 2) Enable WS (web service) for incoming s. 3) Define an API key, necessary for the incoming s communication. This field is activated, when the web service above is activated. 4) Don t forget to save the changes. Figure 51: Global settings - incoming s 2.9 Repositories You can define the following for the repositories: 1) Autofetch commits. This option allows automatically showing commits in an OpenProject Repository. 2) Enable WS for repository management. This option allows communication with SVN-Clients. If it is deactivated, a repository cannot be created. 3) Define an API key. This API key is created once and used for communication with an SVN or Git client. 4) Select which SCM should be enabled. 5) Define repositories encodings. 6) Define the maximum number of revisions to be displayed on file log. 7) Enable caching for authentication request of version control software. This option allows saving the authentication so that a user doesn t have to authenticate every time a repository is accessed (for example during commits). 40

42 8) Define referencing keywords for work packages in commit messages. (LINK to the user guide on work packages and repositories) 9) Define fixing keywords for work packages in commit messages (LINK to the user guide on work packages and repositories). 10) Define which status will be applied to a work package if a fixing word is used in a commit message for that work package. 11) Define which percentage of done will be applied to a work package if a fixing word is used in a commit message for that work package. 12) Enable time logging. Activating this option enables logging time to a work package via commit message (link to user guide logging time to a work package). 13) Define activity for logged time. This activity will be used for time logging via a commit. 14) Don t forget to save your changes. Figure 52: Global settings - repositories 2.10 Checkout (Plugin) The Checkout plugin determines how the repository is displayed. You can adapt the following checkout rules for the SCM systems you defined under Repositories tab: 41

43 1) Specify where the checkout information should be displayed. You can define whether the information (formulated in the field below) is displayed on all pages or only on directory browsing pages. 2) Formulate the checkout description. 3) Overwrite default description. This option allows overwriting the standard description for SVN repositories. If both SVN and Git are used in an instance, this allows selecting a different description for the respective methods. 4) Display checkout command. Determines whether SVN Checkout is displayed on the repository start page. 5) Protocols. 6) Protocol. This field shows which protocol is displayed on the repository start page. 7) Checkout command determines which commands will be displayed. 8) Regular expression. 9) Replacement text. 10) Permissions determines which permissions will be displayed. 11) Append path shows the SVN path. 12) Display login. 13) Default standard value in case multiple checkouts exist. 14) Add protocol. 15) Don t forget to save your changes. Figure 53: Global settings - checkout 42

44 43