Skip to main content

Schedule

1. Overview​

The file engagement_schedule.yaml in exported package contains all configuration of Schedules module from exported title region. You can add, delete or update some items in the file and then re-import to the title region.

2. An Example of The File Content​

# AUTO-GENERATED FILE.
#
# Export information
# @export_time: Fri, 17 Nov 2023 09:36:39 GMT
#
# This file was automatically generated by PGOS Portal.
# Copyright 2023 Proxima Beta, Inc. All Rights Reserved.

engagement_schedule:
  snapshot_tag: "20231117173620153"
  title_id: "5"
  title_region_id: d_5_812179_dev
  list:
    - identification:
        id: schedule_xb8r16c5
      name: schedule
      desc: ""
      mail_template_name: mailname
      periods:
        - period_id: period_y6feoo59
          start_time: 2023-05-17 00:00:00
          end_time: 2023-05-18 00:00:00
          goals:
            - goal_i5qcym58
      publish_end_time: 2024-05-16 14:56:40
      publish_start_time: 2023-05-17 14:56:40
      rewards_way: By Mail

3. Field Description​

  • identification: The unique identifier for the current resource, it contains multiple fields:
    • id: the id of schedule. Type: string. Length: 1-100.
  • name: the name of schedule. Type: string. Length: 1-100.
  • desc: the description of schedule. Type: string. Length: 1-1024.
  • mail_template_name: the name of mail template. Type: string.
  • periods: the array of periods relate to schedule. Type: array.
    • period_id: the id of period. Type: string.
    • start_time: the start time of period. Type: string.
    • end_time: the end time of period. Type: string.
    • goals: the array of goal id. Type: array\<string>.
  • publish_end_time: the publish end time of schedule. Type: string.
  • publish_start_time: the publish start time of schedule. Type: string.
  • rewards_way: the type of send reward. Type: string. Mannual/By Mail