XOG Error: Valid Fiscal Period does not exist for start and end dates for plan detail

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

We have created a XOG write file to create some cost plans.  It seems random, but sometimes the XOG will fail for some projects and not for other projects with an error message indicating we do not have valid fiscal time periods.  What could cause this error message?

Steps to Reproduce:

1. Create a XOG write file to XOG in Cost Plan Detail data for more than one project
2. Perform the XOG write action
3. Examine the XOG output file for error messages

Expected Result: All Cost Plan Details are successfully imported.

Actual Result: XOG output file shows the following error message

<ErrorInformation>

   <Severity>ERROR</Severity>

   <Description>Valid Fiscal Period does not exist for start and end dates for plan detail.</Description>

 

</ErrorInformation>

 

Environment

Release: PPM Clarity 15.8 and lower releases

Cause

This is working as designed and caused by the date values entered in the <segment> element not matching the exact start and finish dates of the Fiscal Period defined for the associated Entity.  The <segment> element has 'start' and 'finish' attributes that have to match the dates of the fiscal time period with a zero time stamp format (yyyy-mm-ddT00:00:00)

Resolution

To correct the XOG write file, examine the dates and compare to the dates defined for the associated Entity for that project.  If the dates match, check to ensure the fiscal time period is activated for all periods in the date range for the cost plan details.

1. Navigate to the Project general properties page and look at the Department OBS Unit to identify the associated Entity
2. Go to Administration, Finance: Setup, Entities
3. Open the associated Entity and go to Fiscal Time Periods tab
4. Examine the Fiscal Time Periods for the specific Period Type used in the XOG file
   • Check to ensure all periods are activated in between the start and finish dates used for the Cost Plan
   • Check the exact Start Date and Finish Date of each Fiscal Time Period
   • These dates are stored with a zero time stamp and when you XOG out the Entity and include GL Periods, you will see output without any time stamp
5. Go to the Cost Plan XOG write (input) file and examine the <segment> elements to compare the start date and finish date values
   • The start date must match the Fiscal Time Period Start Date and the format for the Cost Plan Detail segment must have a zero time stamp
   • The finish date must match the Fiscal Time Period Finish Date and the format for the segment must has a zero time stamp
   • The Fiscal Time Period that matches the Cost Plan Detail segment dates must also be active 
   • All Fiscal Time Periods used in populating the cost plan must be active 

Example:

When you XOG out the Entity to show the Fiscal Time Periods - you will see the output generated with dates (no timestamp)

<GLPeriod entityId="Default DWH Entity" isActive="true" periodName="Sep 1, 2015-Sep 30, 2015"

periodType="MONTHLY" startDate="2015-09-01" endDate="2015-09-30" year="2015">

<GLPeriod entityId="Default DWH Entity" isActive="true" periodName="Oct 1, 2015-Oct 31, 2015"

periodType="MONTHLY" startDate="2015-10-01" endDate="2015-10-31" year="2015">

<GLPeriod entityId="Default DWH Entity" isActive="true" periodName="Nov 1, 2015-Nov 30, 2015"

periodType="MONTHLY" startDate="2015-11-01" endDate="2015-11-30" year="2015">

 

When you prepare your Cost Plan Write XOG file, the <segment> data should look like this

<Cost>

  <segment finish="2015-09-30T00:00:00" start="2015-09-01T00:00:00" value="2400.0"/>

  <segment finish="2015-10-31T00:00:00" start="2015-10-01T00:00:00" value="17600.0"/>

  <segment finish="2015-11-30T00:00:00" start="2015-11-01T00:00:00" value="16800.0"/>

</Cost>

<Units>

  <segment finish="2015-09-30T00:00:00" start="2015-09-01T00:00:00" value="24.0"/>

  <segment finish="2015-10-31T00:00:00" start="2015-10-01T00:00:00" value="176.0"/>

  <segment finish="2015-11-30T00:00:00" start="2015-11-01T00:00:00" value="168.0"/>

</Units>

<Revenue>

  <segment finish="2015-09-30T00:00:00" start="2015-09-01T00:00:00" value="24.0"/>

  <segment finish="2015-10-31T00:00:00" start="2015-10-01T00:00:00" value="176.0"/>

  <segment finish="2015-11-30T00:00:00" start="2015-11-01T00:00:00" value="168.0"/>

</Revenue>

 

Therefore, if your <segment> dates are off, and do not match the Fiscal Period Date, then you will get the error message:

For example if your segment has a different finish date such as : Sept. 15, 2015, the XOG output will generate the error message. 

<segment finish="2015-09-15T00:00:00" start="2015-09-01T00:00:00" value="2400.0"/> 

If your <segment> dates are correct, but the Fiscal Period is inactive, the XOG output will generate the same error message.