Gamification

• active Boolean
  default=True args: 'Active'
• challenge_ids One2many → gamification.challenge
  string='Reward of Challenges' args: 'gamification.challenge', 'reward_id'
• description Html
  sanitize_attributes=False translate=True args: 'Description'
• goal_definition_ids Many2many → gamification.goal.definition
  help='The users that have succeeded these goals will receive automatically the badge.' string='Rewarded by' args: 'gamification.goal.definition', 'badge_unlocked_definition_rel'
• granted_count Integer
  compute='_get_owners_info' help='The number of time this badge has been received.' args: 'Total'
• granted_users_count Integer
  compute='_get_owners_info' help='The number of time this badge has been received by unique users.' args: 'Number of users'
• level Selection
  default='bronze' string='Forum Badge Level' args: [('bronze', 'Bronze'), ('silver', 'Silver'), ('gold', 'Gold')]
• name Char
  required=True translate=True args: 'Badge'
• owner_ids One2many → gamification.badge.user
  help='The list of instances of this badge granted to users' string='Owners' args: 'gamification.badge.user', 'badge_id'
• remaining_sending Integer
  compute='_remaining_sending_calc' help='If a maximum is set' args: 'Remaining Sending Allowed'
• rule_auth Selection
  default='everyone' help='Who can grant this badge' required=True string='Allowance to Grant' args: [('everyone', 'Everyone'), ('users', 'A selected list of users'), ('having', 'People having some badges'), ('nobody', 'No one, assigned through challenges')]
• rule_auth_badge_ids Many2many → gamification.badge
  help='Only the people having these badges can give this badge' string='Required Badges' args: 'gamification.badge', 'gamification_badge_rule_badge_rel', 'badge1_id', 'badge2_id'
• rule_auth_user_ids Many2many → res.users
  help='Only these people can give this badge' string='Authorized Users' args: 'res.users', 'rel_badge_auth_users'
• rule_max Boolean
  help='Check to set a monthly limit per person of sending this badge' args: 'Monthly Limited Sending'
• rule_max_number Integer
  help='The maximum number of time this badge can be sent per month per person.' args: 'Limitation Number'
• stat_my Integer
  compute='_get_badge_user_stats' help='The number of time the current user has received this badge.' args: 'My Total'
• stat_my_monthly_sending Integer
  compute='_get_badge_user_stats' help='The number of time the current user has sent this badge this month.' args: 'My Monthly Sending Total'
• stat_my_this_month Integer
  compute='_get_badge_user_stats' help='The number of time the current user has received this badge this month.' args: 'My Monthly Total'
• stat_this_month Integer
  compute='_get_badge_user_stats' help='The number of time this badge has been received this month.' args: 'Monthly total'
• unique_owner_ids Many2many → res.users
  compute='_get_owners_info' help='The list of unique users having received this badge.' string='Unique Owners' args: 'res.users'

• check_granting(self)
  Check the user 'uid' can grant the badge 'badge_id' and raise the appropriate exception if not Do not check for SUPERUSER_ID

• badge_id Many2one → gamification.badge
  index=True ondelete='cascade' required=True string='Badge' args: 'gamification.badge'
• badge_name Char
  readonly=False related='badge_id.name' string='Badge Name'
• challenge_id Many2one → gamification.challenge
  string='Challenge' args: 'gamification.challenge'
• comment Text
  args: 'Comment'
• level Selection
  readonly=True related='badge_id.level' store=True string='Badge Level'
• sender_id Many2one → res.users
  string='Sender' args: 'res.users'
• user_id Many2one → res.users
  index=True ondelete='cascade' required=True string='User' args: 'res.users'
• user_partner_id Many2one → res.partner
  related='user_id.partner_id' args: 'res.partner'

• create(self, vals_list)
  @api.model_create_multi

• badge_id Many2one → gamification.badge
  required=True string='Badge' args: 'gamification.badge'
• comment Text
  args: 'Comment'
• user_id Many2one → res.users
  required=True string='User' args: 'res.users'

• action_grant_badge(self)
  Wizard action for sending a badge to a chosen user

• challenge_category Selection
  default='hr' help='Define the visibility of the challenge through menus' required=True string='Appears in' args: [('hr', 'Human Resources / Engagement'), ('other', 'Settings / Gamification Tools')]
• description Text
  translate=True args: 'Description'
• end_date Date
  help='The day a new challenge will be automatically closed. If no periodicity is set, will use this date as the goal end date.' args: 'End Date'
• invited_user_ids Many2many → res.users
  string='Suggest to users' args: 'res.users', 'gamification_invited_user_ids_rel'
• last_report_date Date
  default=fields.Date.today args: 'Last Report Date'
• line_ids One2many → gamification.challenge.line
  copy=True help='List of goals that will be set' required=True string='Lines' args: 'gamification.challenge.line', 'challenge_id'
• manager_id Many2one → res.users
  default=<expr> string='Responsible' args: 'res.users'
• name Char
  required=True translate=True args: 'Challenge Name'
• next_report_date Date
  compute='_get_next_report_date' store=True args: 'Next Report Date'
• period Selection
  default='once' help='Period of automatic goal assignment. If none is selected, should be launched manually.' required=True string='Periodicity' args: [('once', 'Non recurring'), ('daily', 'Daily'), ('weekly', 'Weekly'), ('monthly', 'Monthly'), ('yearly', 'Yearly')]
• remind_update_delay Integer
  help='Never reminded if no value or zero is specified.' args: 'Non-updated manual goals will be reminded after'
• report_message_frequency Selection
  default='never' required=True string='Report Frequency' args: [('never', 'Never'), ('onchange', 'On change'), ('daily', 'Daily'), ('weekly', 'Weekly'), ('monthly', 'Monthly'), ('yearly', 'Yearly')]
• report_message_group_id Many2one → discuss.channel
  help='Group that will receive a copy of the report in addition to the user' string='Send a copy to' args: 'discuss.channel'
• report_template_id Many2one → mail.template
  default=<expr> required=True string='Report Template' args: 'mail.template'
• reward_failure Boolean
  args: 'Reward Bests if not Succeeded?'
• reward_first_id Many2one → gamification.badge
  string='For 1st user' args: 'gamification.badge'
• reward_id Many2one → gamification.badge
  index='btree_not_null' string='For Every Succeeding User' args: 'gamification.badge'
• reward_realtime Boolean
  default=True help='With this option enabled, a user can receive a badge only once. The top 3 badges are still rewarded only at the end of the challenge.' args: 'Reward as soon as every goal is reached'
• reward_second_id Many2one → gamification.badge
  string='For 2nd user' args: 'gamification.badge'
• reward_third_id Many2one → gamification.badge
  string='For 3rd user' args: 'gamification.badge'
• start_date Date
  help='The day a new challenge will be automatically started. If no periodicity is set, will use this date as the goal start date.' args: 'Start Date'
• state Selection
  copy=False default='draft' required=True string='State' tracking=True args: [('draft', 'Draft'), ('inprogress', 'In Progress'), ('done', 'Done')]
• user_count Integer
  compute='_compute_user_count' args: '# Users'
• user_domain Char
  args: 'User domain'
• user_ids Many2many → res.users
  string='Participants' args: 'res.users', 'gamification_challenge_users_rel'
• visibility_mode Selection
  default='personal' required=True string='Display Mode' args: [('personal', 'Individual Goals'), ('ranking', 'Leader Board (Group Ranking)')]

• accept_challenge(self)
• action_check(self)
  Check a challenge Create goals that haven't been created yet (eg: if added users) Recompute the current value for each goal related
• action_report_progress(self)
  Manual report of a goal, does not influence automatic report frequency
• action_start(self)
  Start a challenge
• action_view_users(self)
  Redirect to the participants (users) list.
• create(self, vals_list)
  @api.model_create_multi
  Overwrite the create method to add the user of groups
• default_get(self, fields)
  @api.model
• discard_challenge(self)
  The user discard the suggested challenge
• report_progress(self, users=(), subset_goals=False)
  Post report about the progress of the goals :param users: users that are concerned by the report. If False, will send the report to every user concerned (goal users and group that receive a copy). Only used for challenge with a visibility mode set to 'personal'. :param subset_goals: goals to restrict the report
• write(self, vals)

• challenge_id Many2one → gamification.challenge
  index=True ondelete='cascade' required=True string='Challenge' args: 'gamification.challenge'
• condition Selection
  readonly=True related='definition_id.condition' string='Condition'
• definition_full_suffix Char
  readonly=True related='definition_id.full_suffix' args: 'Suffix'
• definition_id Many2one → gamification.goal.definition
  index=True ondelete='cascade' required=True string='Goal Definition' args: 'gamification.goal.definition'
• definition_monetary Boolean
  readonly=True related='definition_id.monetary' args: 'Monetary'
• definition_suffix Char
  readonly=True related='definition_id.suffix' args: 'Unit'
• name Char
  readonly=False related='definition_id.name' args: 'Name'
• sequence Integer
  default=1 args: 'Sequence'
• target_goal Float
  required=True args: 'Target Value to Reach'

No public methods.

• challenge_id Many2one
  help='Challenge that generated the goal, assign challenge to users to generate goals with a value in this field.' index=True readonly=True related='line_id.challenge_id' store=True
• closed Boolean
  args: 'Closed goal'
• color Integer
  compute='_compute_color' args: 'Color Index'
• completeness Float
  compute='_get_completion' args: 'Completeness'
• computation_mode Selection
  readonly=False related='definition_id.computation_mode'
• current Float
  default=0 required=True args: 'Current Value'
• definition_condition Selection
  readonly=True related='definition_id.condition' string='Definition Condition'
• definition_description Text
  readonly=True related='definition_id.description' args: 'Definition Description'
• definition_display Selection
  readonly=True related='definition_id.display_mode' string='Display Mode'
• definition_id Many2one → gamification.goal.definition
  index=True ondelete='cascade' required=True string='Goal Definition' args: 'gamification.goal.definition'
• definition_suffix Char
  readonly=True related='definition_id.full_suffix' args: 'Suffix'
• end_date Date
  args: 'End Date'
• last_update Date
  help='In case of manual goal, reminders are sent if the goal as not been updated for a while (defined in challenge). Ignored in case of non-manual goal or goal not linked to a challenge.' args: 'Last Update'
• line_id Many2one → gamification.challenge.line
  index=True ondelete='cascade' string='Challenge Line' args: 'gamification.challenge.line'
• remind_update_delay Integer
  help='The number of days after which the user assigned to a manual goal will be reminded. Never reminded if no value is specified.' args: 'Remind delay'
• start_date Date
  default=fields.Date.today args: 'Start Date'
• state Selection
  default='draft' required=True string='State' args: [('draft', 'Draft'), ('inprogress', 'In progress'), ('reached', 'Reached'), ('failed', 'Failed'), ('canceled', 'Cancelled')]
• target_goal Float
  required=True args: 'To Reach'
• to_update Boolean
  args: 'To update'
• user_id Many2one → res.users
  bypass_search_access=True index=True ondelete='cascade' required=True string='User' args: 'res.users'
• user_partner_id Many2one → res.partner
  related='user_id.partner_id' args: 'res.partner'

• action_cancel(self)
  Reset the completion after setting a goal as reached or failed. This is only the current state, if the date and/or target criteria match the conditions for a change of state, this will be applied at the next goal update.
• action_fail(self)
  Set the state of the goal to failed. A failed goal will be ignored in future checks.
• action_reach(self)
  Mark a goal as reached. If the target goal condition is not met, the state will be reset to In Progress at the next goal update until the end date.
• action_start(self)
  Mark a goal as started. This should only be used when creating goals manually (in draft state)
• create(self, vals_list)
  @api.model_create_multi
• get_action(self)
  Get the ir.action related to update the goal In case of a manual goal, should return a wizard to update the value :return: action description in a dictionary
• update_goal(self)
  Update the goals to recomputes values and change of states If a manual goal is not updated for enough time, the user will be reminded to do so (done only once, in 'inprogress' state). If a goal reaches the target value, the status is set to reached If the end date is passed (at least +1 day, time not considered) without the target value being reached, the goal is set as failed.
• write(self, vals)
  Overwrite the write method to update the last_update field to today If the current value is changed and the report frequency is set to On change, a report is generated

• action_id Many2one → ir.actions.act_window
  help='The action that will be called to update the goal value.' string='Action' args: 'ir.actions.act_window'
• batch_distinctive_field Many2one → ir.model.fields
  help='In batch mode, this indicates which field distinguishes one user from the other, e.g. user_id, partner_id...' string='Distinctive field for batch user' args: 'ir.model.fields'
• batch_mode Boolean
  help='Evaluate the expression in batch instead of once for each user' args: 'Batch Mode'
• batch_user_expression Char
  help="The value to compare with the distinctive field. The expression can contain reference to 'user' which is a browse record of the current user, e.g. user.id, user.partner_id.id..." args: 'Evaluated expression for batch mode'
• computation_mode Selection
  default='manually' help="Define how the goals will be computed. The result of the operation will be stored in the field 'Current'." required=True string='Computation Mode' args: [('manually', 'Recorded manually'), ('count', 'Automatic: number of records'), ('sum', 'Automatic: sum on a field'), ('python', 'Automatic: execute a specific Python code')]
• compute_code Text
  help="Python code to be executed for each user. 'result' should contains the new current value. Evaluated user can be access through object.user_id." args: 'Python Code'
• condition Selection
  default='higher' help='A goal is considered as completed when the current value is compared to the value to reach' required=True string='Goal Performance' args: [('higher', 'The higher the better'), ('lower', 'The lower the better')]
• description Text
  args: 'Goal Description'
• display_mode Selection
  default='progress' required=True string='Displayed as' args: [('progress', 'Progressive (using numerical values)'), ('boolean', 'Exclusive (done or not-done)')]
• domain Char
  default='[]' help="Domain for filtering records. General rule, not user depending, e.g. [('state', '=', 'done')]. The expression can contain reference to 'user' which is a browse record of the current user if not in batch mode." required=True args: 'Filter Domain'
• field_date_id Many2one → ir.model.fields
  domain=<expr> help='The date to use for the time period evaluated' string='Date Field' args: 'ir.model.fields'
• field_id Many2one → ir.model.fields
  domain=<expr> string='Field to Sum' args: 'ir.model.fields'
• full_suffix Char
  compute='_compute_full_suffix' help='The currency and suffix field' args: 'Full Suffix'
• model_id Many2one → ir.model
  index='btree_not_null' ondelete='cascade' string='Model' args: 'ir.model'
• model_inherited_ids Many2many → ir.model
  related='model_id.inherited_model_ids' args: 'ir.model'
• monetary Boolean
  default=False help='The target and current value are defined in the company currency.' args: 'Monetary Value'
• name Char
  required=True translate=True args: 'Goal Definition'
• res_id_field Char
  help='The field name on the user profile (res.users) containing the value for res_id for action.' args: 'ID Field of user'
• suffix Char
  help='The unit of the target and current values' translate=True args: 'Suffix'

• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• current Float
  args: 'Current'
• goal_id Many2one → gamification.goal
  required=True string='Goal' args: 'gamification.goal'

• action_update_current(self)
  Wizard action for updating the current value

• description Html
  sanitize_attributes=False string='Description' translate=html_translate
• description_motivational Html
  help='Motivational phrase to reach this rank on your profile page' sanitize_attributes=False sanitize_overridable=True string='Motivational' translate=html_translate
• karma_min Integer
  default=1 required=True string='Required Karma'
• name Text
  required=True string='Rank Name' translate=True
• rank_users_count Integer
  compute='_compute_rank_users_count' args: '# Users'
• user_ids One2many → res.users
  string='Users' args: 'res.users', 'rank_id'

• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• consolidated Boolean
  args: 'Consolidated'
• gain Integer
  compute='_compute_gain' readonly=False args: 'Gain'
• new_value Integer
  required=True args: 'New Karma Value'
• old_value Integer
  readonly=True args: 'Old Karma Value'
• origin_ref Reference
  default=<expr> selection=<expr> string='Source'
• origin_ref_model_name Selection
  compute='_compute_origin_ref_model_name' selection=<expr> store=True string='Source Type'
• reason Text
  default=<expr> string='Description'
• tracking_date Datetime
  default=fields.Datetime.now index=True readonly=True
• user_id Many2one → res.users
  index=True ondelete='cascade' required=True args: 'res.users', 'User'

• create(self, vals_list)
  @api.model_create_multi

• badge_ids One2many → gamification.badge.user
  copy=False string='Badges' args: 'gamification.badge.user', 'user_id'
• bronze_badge Integer
  compute='_get_user_badge_level' args: 'Bronze badges count'
• gold_badge Integer
  compute='_get_user_badge_level' args: 'Gold badges count'
• karma Integer
  compute='_compute_karma' readonly=False store=True args: 'Karma'
• karma_tracking_ids One2many → gamification.karma.tracking
  groups='base.group_system' string='Karma Changes' args: 'gamification.karma.tracking', 'user_id'
• next_rank_id Many2one → gamification.karma.rank
  args: 'gamification.karma.rank', 'Next Rank'
• rank_id Many2one → gamification.karma.rank
  index='btree_not_null' args: 'gamification.karma.rank', 'Rank'
• silver_badge Integer
  compute='_get_user_badge_level' args: 'Silver badges count'

• action_karma_report(self)
• create(self, vals_list)
  @api.model_create_multi
• get_gamification_redirection_data(self)
  Hook for other modules to add redirect button(s) in new rank reached mail Must return a list of dictionnary including url and label. E.g. return [{'url': '/forum', label: 'Go to Forum'}]
• write(self, vals)