This documentation supports the 20.08 and 20.08.01 versions of BMC Helix Business Workflows.

To view the documentation for the previous version, select 20.02 from the Product version menu.



Setting up time zone, and date and time format for PDF files

Requesters can submit requests to generate PDF files, such as a visa letter or reference letter, from different time zones. A case business analyst configures the time zone and format in which date and time are displayed in the generated PDF files.

The time zone of a case is determined in the following order of precedence:

  • Requester primary site
  • Time zone that is defined by the case business analyst
  • Server time zone in UTC

Parameters for time zone, and date and time formats

Use the following parameters to define the time zone, and date and time formats:

  • ZONE_ID—Defines the time zone that is used to display the date and time in PDF files.
  • DATE_FORMAT—Defines the format in which the date is displayed in PDF files.
  • DATE_TIME_FORMAT—Defines the format in which date and time are displayed in PDF files.

The DATE_FORMAT parameter is used for the dynamic date field, and the DATE_TIME_FORMAT parameter is used for the dynamic date and time type field.

When is ZONE_ID considered for displaying the time in PDF files

By default, when a case agent creates a case, the time zone of the primary site is considered as the case time zone. If a case agent changes the primary site, the time zone of the changed site is used for displaying the date and time in PDF files.

When no primary site is defined for a case, the time zone that a case business analyst configures for the ZONE_ID parameter is used for displaying the date and time in PDF files.

If a case business analyst hasn't set a value for the ZONE_ID parameter, the default UTC time zone is used for displaying the date and time in PDF files.

Examples

  • For example, a case business analyst configures Asia/Kolkata as the IST time zone for Calbro Services. The case business analyst also defines dd-MMM-yyyy as the date format to be displayed in the reference letter. A requester from Calbro Services is traveling and raises a request for a reference letter. Although the request is raised from a different time zone, the reference letter displays the time in the IST time zone.
  • A user from Calbro Services from Pune, India requests for a visa letter. The time zone of the primary site of the requester is IST. When the PDF is generated for the Visa letter, the date and time are displayed in the IST time zone. The requester travels to New York, USA, and requests for a reference letter. A case agent changes the primary site from Pune, India to New York, USA. The changed time zone CST is used for the case. When the PDF is generated for the reference letter, the date and time are displayed in the CST time zone.
    While creating the case for a reference letter for the Calbro Services user, if the case agent doesn't define the primary site, and if a case business analyst hasn't set a value for the ZONE_ID parameter, the default UTC time zone is used to display date and time in PDF files.

Daylight saving time not considered for displaying time in PDF files

To enable the conversion of time according to daylight saving time, an administrator edits a time zone in BMC Helix Innovation Studio, and sets the Adjust Clock to Daylight Savings field value to Yes.

When the setting is enabled, and PDF files are generated by using the site timezone, the daylight saving time is not considered while generating PDF files. However, when the ZONE_ID parameters is considered for displaying time in PDF files, daylight savings time is accounted and time is displayed accordingly in PDF files.

For example, when a user creates a case during daylight saving time from Mexico City with CST timezone, the daylight saving time that should be considered is America/Chicago. However, BMC Helix Platform returns the ZONE_ID as UTC -06:00.


To set the time zone for date

  1. As a case business analyst, log in to BMC Helix Business Workflows.

  2. Click My Application Settings .

    The Settings page opens in a new browser tab.

  3. Select Application Configuration > Common Configurations.

  4. Select ZONE_ID, and click Add.

    If you do not define a new time zone, the default UTC time zone is used to display date and time in PDF files.

  5. Specify Configuration Value.

    For example, for the date to appear as 21/08/2020, add the DATE_FORMAT as dd/MM/yyyy.

     Time zone values
    • EST - -05:00
    • HST - -10:00
    • MST - -07:00
    • ACT - Australia/Darwin
    • AET - Australia/Sydney
    • AGT - America/Argentina/Buenos_Aires
    • ART - Africa/Cairo
    • AST - America/Anchorage
    • BET - America/Sao_Paulo
    • BST - Asia/Dhaka
    • CAT - Africa/Harare
    • CNT - America/St_Johns
    • CST - America/Chicago
    • CTT - Asia/Shanghai
    • EAT - Africa/Addis_Ababa
    • ECT - Europe/Paris
    • IET - America/Indiana/Indianapolis
    • IST - Asia/Kolkata
    • JST - Asia/Tokyo
    • MIT - Pacific/Apia
    • NET - Asia/Yerevan
    • NST - Pacific/Auckland
    • PLT - Asia/Karachi
    • PNT - America/Phoenix
    • PRT - America/Puerto_Rico
    • PST - America/Los_Angeles
    • SST - Pacific/Guadalcanal
    • VST - Asia/Ho_Chi_Minh

    You can define multiple date formats. However, for each company, you can define only one format.

  6. To configure the setting at a global or company level, complete one of the following actions:

    1. To configure the setting at a global level, from the Company list, select Global.

    2. To configure the setting at a company level, select the company.

  7. Click Save.

To set the format for date and time

  1. As a case business analyst, log in to BMC Helix Business Workflows.
  2. Click My Application Settings .
    The Settings page opens in a new browser tab.
  3. Select Application Configuration > Common Configurations.
  4. To specify only the date format, select DATE_FORMAT, and click Add.
    If you do not define a new format, the default dd MMM yyy format is used in PDF files.
  5. To specify the date and time format, select DATE_TIME_FORMAT, and click Add.
    If you do not define a new format, the default dd MMM yyy hh:mm:ss a format is used in PDF files.
  6. Specify the Configuration Value.
    For example, Asia/Kolkata or America/Chicago.

     Date and time formats
    FormatterDescriptionExample
    ofLocalizedDate(dateStyle)Formatter with date style from the locale'2011-12-03'
    ofLocalizedTime(timeStyle)Formatter with time style from the locale'10:15:30'
    ofLocalizedDateTime(dateTimeStyle)Formatter with a style for date and time from the locale'3 Jun 2008 11:05:30'
    ofLocalizedDateTime(dateStyle,timeStyle)Formatter with date and time styles from the locale'3 Jun 2008 11:05'
    BASIC_ISO_DATEBasic ISO date'20111203'
    ISO_LOCAL_DATEISO Local Date'2011-12-03'
    ISO_OFFSET_DATEISO Date with offset'2011-12-03+01:00'
    ISO_DATEISO Date with or without offset'2011-12-03+01:00'; '2011-12-03'
    ISO_LOCAL_TIMETime without offset'10:15:30'
    ISO_OFFSET_TIMETime with offset'10:15:30+01:00'
    ISO_TIMETime with or without offset'10:15:30+01:00'; '10:15:30'
    ISO_LOCAL_DATE_TIMEISO Local Date and Time'2011-12-03T10:15:30'
    ISO_OFFSET_DATE_TIMEDate Time with Offset2011-12-03T10:15:30+01:00'
    ISO_ZONED_DATE_TIMEZoned Date Time'2011-12-03T10:15:30+01:00[Europe/Paris]'
    ISO_DATE_TIMEDate and time with ZoneId'2011-12-03T10:15:30+01:00[Europe/Paris]'
    ISO_ORDINAL_DATEYear and day of year'2012-337'
    ISO_WEEK_DATEYear and Week2012-W48-6'
    ISO_INSTANTDate and Time of an Instant'2011-12-03T10:15:30Z'
    RFC_1123_DATE_TIMERFC 1123 / RFC 822'Tue, 3 Jun 2008 11:05:30 GMT'


  7. To configure the setting at a global or company level, complete one of the following actions:
    1. To configure the setting at a global level, from the Company list, select Global.
    2. To configure the setting at a company level, select the company.

  8. Click Save.

Related topics

Defining document templates and generation of PDFs

Automatically generating PDFs for required information

Was this page helpful? Yes No Submitting... Thank you

Comments