From 0499ac7d75812369fadc115806c2ebc32fa15d31 Mon Sep 17 00:00:00 2001 From: Nicole Engard Date: Tue, 22 Sep 2009 10:09:35 -0400 Subject: [PATCH] Updated help files Signed-off-by: Galen Charlton --- .../en/modules/help/members/mancredit.tmpl | 6 +- .../en/modules/help/members/maninvoice.tmpl | 2 + .../en/modules/help/members/member-flags.tmpl | 6 +- .../en/modules/help/reports/dictionary.tmpl | 83 ++++++++----- .../modules/help/reports/guided_reports.tmpl | 111 +++++++++--------- .../prog/en/modules/help/tools/holidays.tmpl | 86 +++++++------- 6 files changed, 161 insertions(+), 133 deletions(-) diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl index 6436b493cc..1d2ecd441c 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl @@ -5,5 +5,7 @@
  • To create a manual credit, click the 'Create manual credit' tab
  • Enter in the information related to the credit you're adding
  • The new credit will appear on the 'Account' tab
    • - TIP: Use manual credits to pay partial fines. - \ No newline at end of file + + +

    TIP: Use manual credits to pay partial fines.

    + \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl index d8dc9ab3e4..97d6ebdbe7 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl @@ -5,6 +5,8 @@
  • Click the 'Create manual invoice' tab
  • Enter in the information related to the charge you're adding
  • The new charge will appear on the 'Account' tab
    • +
  • If you would like to define additional categories for manual invoices you can do so by adding authorized values in the MANUAL_INV categories.
    • +
  • Manual invoices can be paid the same way as automatic fines, by clicking on 'Pay fines'
    • diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl index b501d66070..6caa51762b 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl @@ -37,6 +37,10 @@ TIP: If this preference is turned OFF after being ON, the system reverts to the
  • circulate
    • Ability for logged in user to check books out and back in
      • +
    • With GranularPermissions on this section will be expanded to allow access to specific ciculation functions. +
        +
      • Get there: More > Administration > Global System Preferences > Admin > GranularPermissions
        • +
  • catalog
      @@ -84,7 +88,7 @@ TIP: If this preference is turned OFF after being ON, the system reverts to the
    • Use tools (export, import, barcodes)
    • With GranularPermissions on this section will be expanded to allow access only to specific tools
        -
      • Get there: More > Administration > General preferences > Admin > GranularPermissions
        • +
      • Get there: More > Administration > Global System Preferences > Admin > GranularPermissions
  • editauthorities diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl index 1382cbf7d1..351c9679d5 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl @@ -2,40 +2,63 @@

    Reports Dictionary Help

    -

    What is the Reports Dictionary

    -

    The dictionary provides a way that you can define custom criteria for reporting by combining existing criteria.

    +The dictionary provides a way that you can define custom criteria for reporting by combining existing criteria.

    Adding A New Definition

    -

    Step 1 of 4 Name

    + +

    Step 1: Name

    +

    At this step you will need to fill out the following details:

    -
      -
    1. -

      Definition Name: Short name that is used for display and selection

      2. -
    2. -

      Definition Description: Used within the dictionary only to provide further detail about the definition

      3. -
    - -

    Step 2 of 4 Area

    -

    Now you will need to select the area that you are binding the definition to. Definitions can only be bound to one area. If you wish to use a similar definition in say, Circulation and Patrons, you will need to create two definitions - one for each area

    - -

    Step 3 of 4 Columns

    -

    Now select the criteria that you wish to use to build your definition. Click on the database column name and then press the add button. Once you have selected all your desired columns, press Next.

    -

    Note: Definitions can be deleted easily, and if you are still learning the structure of the Koha data, it may take a little while to sort out which fields you require. Some trial and error may be required.

    - -

    Step 4 of 4 Values

    + +
      +
    • Definition Name: Short name that is used for display and selection
      • +
    • Definition Description: Used within the dictionary only to provide further detail about the definition
      • +
    + +

    Step 2: Area

    + +

    Now you will need to select the area that you are binding the definition to.

    + +

    IMPORTANT: Definitions can only be bound to one area.

    + +

    TIP: If you wish to use a similar definition in say, Circulation and Patrons, you will need to create two definitions - one for each area

    + +

    Step 3: Columns

    + +

    Now select the criteria that you wish to use to build your definition.

    + +
      +
    • Click on the database column name and then press the 'add' button.
      • +
    • Once you have selected all your desired columns, press Next.
      • +
    + +

    TIP: Definitions can be deleted easily, and if you are still learning the structure of the Koha data, it may take a little while to sort out which fields you require. Some trial and error may be required

    + +

    Step 4: Values

    +

    Now you need to select the values for each column that will make up your new criteria. There are different ways to define the values, based on the type of data in the column you have selected

    -
      -
    • Search String Matches For free text fields in that database, enter a string/phrase for the criteria to match on
      • -
    • Date For date fields you can either select: -
        -
      1. Date Range: enter values in both date fields
        2. -
      2. All Data Before A Given Date: enter a value in the field only
        3. -
      3. All Data After A Given Date: enter a value in the field only
        4. -
      • -
    • Select From Database Value For data that is given an authorized value in the Koha database, you the drop down list to select one value
      • -
    - + +
      +
    • Search String Matches For free text fields in that database, enter a string/phrase for the criteria to match on
      • +
    • Date For date fields you can either select:
      • +
      1. Date Range: enter values in both date fields
        2. +
      2. All Data Before A Given Date: enter a value in the XXX field only
        3. +
      3. All Data After A Given Date: enter a value in the XXX field only
        4. +
      +
    • Select From Database Value For data that is given an authorized value in the Koha database, you the drop down list to select one value
      • +
    + +

    Step 5: Confirmation

    + +

    You will be presented with a confirmation once you have finished step 4

    + +

    Click 'Save'

    +

    Using A Definition

    -

    Once you have created your new definition and it shows on in the Dictionary, you can use the definition for reporting. When you go to create a new report, the criteria for the area you are reporting on will automatically show as limits in the Guided Reports wizard

    +

    Once you have created your new definition and it shows on in the Dictionary, you can use the definition for reporting.

    + +
      +
    • When you go to create a new report, the criteria for the area you are reporting on will automatically show as limits in the Guided Reports wizard
      • +
    \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl index b1c61f3cbe..55dc4982a2 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl @@ -1,56 +1,57 @@ - -

    Guided Reports Help

    -
      -
    • Building A New Report
      • -
    • Saving A Report
      • -
    • Generating A New Report From SQL
      • -
    • Scheduling A Report
      • -
    • -
        -
      • -
          -
        • Tabular:Simple report of columns only.
          • -
        • Matrix:Not finished
          • -
        • Summary:Not finished
          • -
        -
          -
        • System Generated Criteria These criteria are known to the system and are drawn from your system preferences
          • -
        • Dictionary Criteria These are custom defined criteria defined for your Koha in the Reports Dictionary
          • -
        -
          -
        • Count : Returns a count of each value
          • -
        • Sum : Returns the sum of all values
          • -
        • Average : Returns the average value
          • -
        • Min : Returns the lowest value
          • -
        • Max : Returns the highest value
          • -
        • -

        For help with the Reports Dictionary - see online help within the Dictionary Pages

        -

        Building A New Report

        Step 1 of 6: Choose a Module to Report on

        -

        Select one of the module areas to report on. Guided reports can only generate reports from within one module. For reports across modules, you will need to use either a compound report, or build a custom report using SQL statements.

        Step 2 of 6: Pick a Report Type

        -

        There are 3 types of reports that can be generated:

        Step 3 of 6: Select Columns for Display

        -

        Select the columns to draw the report data from. Click the column to add in the left hand box and then click the "Add" button. Your column will now show up in the right hand box. To remove a selected column, click the column name on the right hand side and then click the delete button. Once you are happy with the columns, select the "Choose Columns" button to proceed to the next step.

        -

        Be careful selecting columns. The guided reports feature expects that you have some knowledge of the Koha database structure and what each field is used for. Be careful selecting columns as a poor choice may lead to a report that is so large that it either times out before it can be generated, or it will require a large amount of system resources to generate and slow down the operation of Koha.

        -

        There is no sanity checker in the reports engine

        Step 4 of 6: Select Criteria to Limit on

        -

        Criteria allow you to limit your report to display results to a given criteria.Criteria are bound to a specific reporting area.

        Step 5 of 6: Pick which columns to total

        -

        Now choose operations that you want to preform on each column. The operations that can be selected are:

        .

        Step 6 of 6: Select how you want the report ordered

        -

        Select how you wish to order the report. You can select multiple criteria to order against and the hierarchy that the are applied. For example order alphabetically by Surname, and then alphabetically by First Name


        -Back To Top - -
        -

        Saving A Report

        -

        Once you have generated a report, you can now choose to save the report definition so that you can run it again when required, or setup the Task Scheduler to run the report for you.


        -Back To Top - -
        -

        Generating A New Report From SQL

        -

        A report can be generated directly using from an SQL statement. On the "Create from SQL" page, give the report a Title and Description (using the notes field) and then paste your SQL statement into the text area.


        -Back To Top - -
        -

        Scheduling A Report

        -

        Reports can be scheduled to run either at a one off time, or repeatedly at a defined period using the task scheduler. The task scheduler is found under Tools >Task Scheduler


        -Back To Top - -
      • -
    \ No newline at end of file + +

    Add a Custom Report

    + +

    If the report you need is not already available, the 'Guided Reports' Wizard will walk anyone through creating a custom report.

    + +

    There are three elements of a standard 'guided' report: columns, rows and filters. For issues and acquisitions, desired data is placed in each cell (count or amount, or loan length).

    + +
      +
    • Go to the 'Reports' module (usually under 'More' in your Global Nav)
      • +
    • Choose 'Guided Reports' under 'Guided Reports Wizard'
      • +
    + +

    Now, you can build a report in 6 easy steps!

    + +

    Step 1: Choose a Module to Report on

    +
      +
    • Choose a module to build a report on
      • +
    • Click 'Next'
      • +
    + +

    Step 2: Pick a Report Type

    +
  • IMPORTANT: Only Tabular should be chosen with this option

    +

    Step 3: Select Columns for Display

    +

    Step 4: Select Criteria to Limit

    +

    This is optional, if you don't want to limit results by any one field, just leave this section blank.

    +

    Step 5: Pick which columns to total

    +

    This is optional, if you don't want to do any math on the results, just leave this section blank.

    +

    Step 6: Choose how you want the report ordered

    +

    This is optional, if you want the results to come out as they are in the table, just leave this section blank.

    + +

    Edit Reports

    + +

    Custom reports can be edited in their entirety from the Saved Guided Reports page.

    + +
    • Get there: More > Reports > Guided Reports > Use Saved
    + +To edit a report click 'Edit SQL' beside the report
    • +
  • A page with editable fields will open so that you can change the title, notes and SQL related to the report
    • + + +

    Questions

    + +

    Can I have reports run on a schedule?

    + +

    Yes, you can use the Task Scheduler tool.

    + + + +

    Is there a repository for reports?

    + +

    There is a page on the Koha Wiki: http://wiki.koha.org/doku.php?id=sql_library with reports written by Koha libraries around the world.

    + +

    NEKLS also has a great page (http://www.nexpresslibrary.org/training/reports-training/) with a list of reports they have written.

    + + + \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl index f3d3e46fa2..3f13158e4e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl @@ -1,47 +1,43 @@ -

    Holidays Calendar Help

    What is the Holidays Calendar?

    -

    The Holidays Calendar allows the library to define days where the library is closed. Circulation rules are then recalculated to taken in to account that library is closed and there will be no one present to return items.

    -

    There are 2 types of holiday:

    -
      -
    1. Unique Holiday:One off events or closeures.
      2. -
    2. Repeatable Holidays:Holidays that either repeat the same day of every week or repeated yearly on the same date.
      3. -
    Holidays are set per library and the same holiday will need to be set for all libraries in a system. -

    Updating the Calendar:

    -

    Why do I want to add holidays for my library?

    After holidays are entered on the calendar, circulation rules are then recalculated to taken in to account that library is closed and there will be no one present to return items. -

    How do I enable the Holiday Calendar?

    -

    You can make use of the Holidays Calendar by turning on the proper system preferences

    - -

    \ No newline at end of file +

    Holidays Calendar

    + +The calendar is used to define days when the library is closed for circulation rules. + + + + +

    Questions

    + +

    Why do I want to add holidays for my branch?

    + +After holidays are entered on the calendar, circulation rules are then recalculated to taken in to account that library is closed and there will be no one present to return items. + + +

    How do I enable the Holiday Calendar?

    + +You can make use of the Holidays Calendar by turning on the proper system preferences + + +

    How is the dropbox date is determined?

    + +

    Is it the last open date for the checkout branch? Is it today's date minus one? Can the dropbox checkin date be set? If the library is closed for four days for repairs, for example, there would be more than one day needed for the dropbox date.

    + +

    You will only have one dropbox date and that will be the last day that the library open (determined by the holiday calendar) because there is no real way to know what day the books were dropped into the box during the 4 closed days. The only way to change the effective checkin date in dropbox mode is to modify the calendar.

    + + \ No newline at end of file -- 2.39.5