Versions Compared

Version Old Version 2 New Version Current
Changes made by

Helen Gosper

Denise McGettigan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

 

 

 

 

Status
colourRed
titleUNRELEASED
 This feature is not for general release. It will be part of  StatuscolourGreentitlev6.6.18 as an internal feature.

Administrators with the 'phocas' login can set Period types.

From the administration module choose the 'More...' icon Image Removed  > Period types, as shown below.

Image Removed

The Period types screen, show below, shows period types which have been added by a 'phocas' administrator.

Image Removed

Set period type

Choose New, name the new period type and Save. 
Image Removed
Once you save, you are taken back to the Period types screen. From there you can add moments to the period type, or import from a .txt. file.

Add moment (date range)

Select the period type you just created and choose Add. 
Image Removed In the dialog that opens, enter the required date range and Save. By default this dialog will show today's dates. 
Image Removed
Note that you can not

Periods are a core concept in Phocas. Read the Phocas basics > Periods page to learn more about the Period menu in Phocas and the different types of periods.

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 Year, Month and Day and you cannot edit or delete these. You can, however, edit and delete other period types, known as custom period types, such as Quarters or Weeks. You can also add more custom period types as required. This difference in period types is explained in the following image:

  • On the left, you can see the Periods Types administration page with the list of the custom period types you can manage. You can add more period types to this list.

  • On the right, you can see the corresponding list of period types in the database setup (Date section in Designer), along with the three default period types (in the green box). It is here in the database setup that you determine the period types that are available in the database.

Image Added

After you select the period type(s) for a database, you can use them as a foundation for defined periods in that database. These are the periods that display in the Period menu in the Analytics and Financial Statements modules.

Image Added

In the Budgets & Forecasts module, the selected period types for a database become available for selection in the setup of budgets and forecasts.

image-20241004-021144.pngImage Added

To manage the period types for your Phocas site, you need the following Administration permissions: Period Types, Databases and Sync.

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. Click Administration >Period types.

  2. On the Period Types page, click New.

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

    Image Added

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

  5. Click Save. The new period type displays in the list on the Period Types screen.

    Image Added

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

Expand
title(A) Manually add moments

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

    Image 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.

    Image Added

    Note that you cannot enter dates that overlap with an existing period type. If you try to do this, you will

see

  1. get a warning

, allowing you

  1. message and have to adjust your dates. 

    Image Modified
 

Import moments

To import a period type from a text file select Import rather than Add.

Select a .txt

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

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

  4. 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.

      Image Added

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

  3. Upload the file.

  4. Set the date format to

march

  1. match that

if

  1. of the imported file (in this example it is dd/mm/yyyy) and click Upload

.
Image Removed 

Using period types in Designer tool

 When creating a database, select the period types to appear in that database (standard period types and any you have created will be in the list).

 

Image Removed

To create a new period in Designer, choose New and select a period type from the drop down. Populate as required and save.

Image Removed

Image RemovedImage Removed

  1. .

    Image Added

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

  3. 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, 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 AddedImage Added

  4. Click the new period type to review all the moments, 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 page, 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 page:

  • 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

Related pages