CA Calendar Routines® Technical Manual r6 This documentation (the “Documentation”) and related computer software program (the “Software”) (hereinafter collectively referred to as the “Product”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at any time. This Product may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Product is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the Documentation for their own internal use, and may make one copy of the Software as reasonably required for back-up and disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the Software are permitted to have access to such copies. The right to print copies of the Documentation and to make a copy of the Software is limited to the period during which the license for the Product remains in full force and effect. Should the license terminate for any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the Product have been returned to CA or destroyed. EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS PRODUCT “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS PRODUCT, INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE. The use of this Product and any product referenced in the Documentation is governed by the end user’s applicable license agreement. The manufacturer of this Product is CA. This Product is provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7013(c)(1)(ii), as applicable, or their successors. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Copyright © 2008 CA. All rights reserved. Contents Chapter 1: Overview Issues with Calendar Dates............................................................ 1-1 CA Solutions ......................................................................... 1-1 Role of System Administrator.......................................................... 1-2 Installation and Maintenance ...................................................... 1-2 Helping Others Use CA Calendar Routines .......................................... 1-3 Chapter 2: Installation How to Install CA Calendar Routines ................................................... 2-1 Step 1. Create and Load COPYLIB and PROGRAM SOURCE Libraries .................. 2-2 Step 2. Compile and Link the TRCENGIN, TRCENGNC (CICS), TRCSMALL, TRCFSGEN, and TRCHLGEN Programs.............................................................. 2-6 Defining the Holiday Tables ........................................................... 2-7 Components Used to Define a Holiday Table ........................................ 2-7 Creating a Table ................................................................. 2-11 Defining the Special Fiscal Calendar Tables ............................................ 2-13 Components Used to Define a Special Fiscal Calendar Table ........................ 2-13 Defining the Environment ............................................................ 2-19 Global Changes and Invocation Protocol ........................................... 2-19 Null Character Date Mask Validation............................................... 2-20 Set Alphabetic Output Case (TRC-CONVR-CASE) ................................... 2-21 TRCENGIN/TRCSMALL Dynamic Calls - Static Calls ................................. 2-21 Current Date Retrieval ........................................................... 2-23 Holiday Table Retrieval ........................................................... 2-24 Special Fiscal Calendar Table Retrieval ............................................ 2-25 Defining the Business Parameters .................................................... 2-26 How the System Retrieves Parameter Values ...................................... 2-26 Assigning Parameter Values ...................................................... 2-27 Business Parameter Descriptions ..................................................... 2-27 Business Parameter # 1: HOLIDAY-TBL ........................................... 2-28 Business Parameter # 2: FISCYR-START .......................................... 2-28 Business Parameter # 3: FISCMO-START .......................................... 2-28 Business Parameters # 2-3 (Combined): FISCAL-ID................................ 2-28 Business Parameter # 4: END-PNTS-DEF .......................................... 2-29 Business Parameter # 5: DOW-STRING ........................................... 2-31 Business Parameter # 6: TRC-CONVR-PROC-DAY-DEF.............................. 2-31 Contents v Business Parameter # 7: CENTURY-BREAK and SLIDING WINDOW Options .......... 2-32 Business Parameter # 8: FROM-DATE-MASK ....................................... 2-33 Business Parameters # 9,10,11,12 (TO-DATE-MASK, OUT1-DATE-MASK, OUT2-DATE-MASK, OUT3-DATE-MASK) ............................................................... 2-38 Business Parameter # 13: Validate-Null............................................ 2-38 Business Parameter # 14: Set Alphabetic Output Case.............................. 2-38 Chapter 3: Program Logic How TRCHLGEN Generates a Holiday Table ............................................. 3-1 How TRCENGIN Works ................................................................ 3-2 Appendix A: Messages from TRCHLGEN Messages 000 - 006 ................................................................... A-1 000 .............................................................................. A-1 001 .............................................................................. A-1 002 .............................................................................. A-2 003 .............................................................................. A-2 004 .............................................................................. A-3 005 .............................................................................. A-3 006 .............................................................................. A-4 Appendix B: SYSERRS from TRCENGIN Messages 900 - 994 ................................................................... B-1 900 .............................................................................. B-1 901 .............................................................................. B-1 902 .............................................................................. B-1 903 .............................................................................. B-1 904 .............................................................................. B-2 905 .............................................................................. B-2 906 .............................................................................. B-2 907 .............................................................................. B-2 908 .............................................................................. B-2 909 .............................................................................. B-3 910 .............................................................................. B-3 911 .............................................................................. B-3 912 .............................................................................. B-3 913 .............................................................................. B-3 914 .............................................................................. B-3 vi Contents 915 .............................................................................. B-4 916 .............................................................................. B-4 917 .............................................................................. B-4 918 .............................................................................. B-4 919 .............................................................................. B-4 920 .............................................................................. B-4 921 .............................................................................. B-5 922 .............................................................................. B-5 923 .............................................................................. B-5 924 .............................................................................. B-5 925 .............................................................................. B-5 926 .............................................................................. B-6 927 .............................................................................