Versions Compared

Version Old Version 53 New Version 54
Changes made by

Denise McGettigan

Denise McGettigan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconId2699
panelIcon:gear:
panelIconText⚙️
bgColor#EAE6FF

Administration permission required: Period Types, Databases and Sync

In Phocas, period types define the core increments of time that allow users to analyze their data, forming the basis of defined periods. The default period types are months, days and years but other period types can be added, such as quarters or weeks.

You can decide what set the defined periods (date ranges) are listed that display in the Period menus in Phocas for menus for each database. Users can add their own personal defined periods. However, if a defined period is required by several users, it is better to make it available across the database. That way all users (provided they have permission) can access it from the Period menu. See Set defined periods for a database and Add your own defined period.If you have permission to design databases, you can set the period types that are available for a database in Designer. See Modify a database > Select a period typeIf the period you want is not available in the Defined Periods list, you can add it to your Phocas site using the steps below. After you add a new period type, you need to add it to one or more databases in Designer, so it is available as a defined period option.

View all period types

Click the Phocas menu button > Administration >Period types to open the Period Types screen, which displays a list of all your period types. You can then add, edit and delete periods types.

Image RemovedImage Added

Add a period type

The process of adding a new period type has two key steps. First, you add the period type, then you define each moment in that period, in other words, add the collection of date ranges that make up the period. You can define the moments in three ways; (A) manually enter the moments, (B) import a file containing the moments or (C) base the period type on synced data.

  1. On the Period Types screen, click New.

  2. In the Period Types window, enter a name for the new period type, for example, Quarter.

    Image Added

  3. If you want to base the moments on synced data (option C above), select the Is Sync Period Type checkbox. Additional options display. Skip to the expandable section (C) below.

  4. Click Save. 

    Image Removed

    Proceed to define  The new period type displays in the list on the Period Types screen.

    Image Added

  5. Define each moment in the period type using one of the methods outlined below (expand the applicable section).

    Image Removed
Expand
title(A) Manually add moments

  1. On the Period Types screen, click the new period type to open its Moments screen.

    Image RemovedImage Added

  2. On the Moments screen, click Add.

  3. Enter a name for the moment (such as Quarter 1) and the date range, then click Save.

    Note that you cannot enter dates that overlap with an existing period type. If you try to do this, you will get a warning message and have to adjust your dates. 

  4. Repeat the above two steps to define the other moments (such as Quarter 2, Quarter 3 and Quarter 4) in the period type.

  5. Review all the moments in the period type, then click Close.

  6. Proceed to add the new period type to the database.

Expand
title(B) Import moments

  1. Prepare a file that contains the moments in the new period type.

    • The file must be a .txt file with the columns Name, Start Date, End Date and Year in that order with no headings, as per the image below. 

    • The Name must be unique. Although in reality there might be a Week 1 every year, you need to name your moments individually. For example, Wk1-2016, Wk1-2017 and so on.

    • Data in the Year column must be 4 numbers only. If your moment spans a change in year, it is recommended you use the year that matches the Start Date.

    • You can download and edit the file used in this example here.

  2. On the Period Types screen, select the new period type and click Import.

  3. Upload the file.

  4. Set the date format to match that of the imported file (in this example it is dd/mm/yyyy) and click Upload.

    Image RemovedImage Added

  5. Review all the moments in the period type, then click Close.

  6. Proceed to add the new period type to the database.

Expand
title(C) Add a sync period type

If you have synced data, you can add a period type based on that data.

Notes about the sync period type:

  • When the sync source is updated, the period type is also updated. The moments are purged and then the sync rows are loaded.

  • The moments within a period type linked to a sync item can only be edited by re-syncing the item.

  • You can import moments from such a sync item against any Period Type that is NOT linked to a sync item. The import overwrites any existing moments against the period type.

Prerequisite: Ensure the synced data item contains the moments in the new period type, organized into four columns in this order:

  • Name (text)

  • Start (date time)

  • End (date time)

  • Year (integer)

Continuing from step 3 above, where in wherein the Period Types window you select the Is Sync Period checkbox and additional options display:

  1. Select the source from the Sync Source dropdown list.

  2. Select the data item from the Sync Item dropdown list.

  3. Click Save. The moments are added automatically for you.

    Image Added

  4. Click the new period type to review all the moments.

    Image Removed

    , then click Close.

  5. Proceed to add the new period type to the database.

Add a period type to a database

After you add a period type using the steps above, you need to add that period type to the applicable database(s) in Designer, then save and rebuild the database.    

Edit or delete the moments in a period type

  1. On the Period Types screen, click the period type to open its Moments screen.

  2. Take the applicable action:

    • Edit the moment details: Click the moment (blue link), make your changes and click Save.

    • Delete a moment: Select the moment row and click Delete > Yes.

  3. Click Close.

Delete a period type or moment

On the Period Types screen:

  • To delete a period type, select the period type row and click Delete > Yes.

  • To delete a moment, click the period type to open its Moments screen, then select the moment row and click Delete > Yes.

On this page

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse