English

Installation

Installing Frank is a job for an admin. Frank installs from the Atlassian Marketplace, but it doesn't configure itself. A Jira administrator finishes setup from the Frank admin page.

Frank requires Jira Cloud (Standard, Premium, or Enterprise). Confluence Cloud is optional but highly recommended, and can be connected separately once the Jira setup is complete. Enable Rovo for your site for the best experience.

Prerequisites

Before running setup, a Jira administrator needs to create two Jira groups. Frank can't make these itself (Forge apps aren't allowed to create Jira groups), so they need to exist first. You add them under Jira's user management:

  • Frank-hr-employees: HR staff who manage employee records.

  • Frank-hr-admins: HR administrators who also manage Frank's configuration and can edit secure fields.


Run the setup

Install Frank from the Atlassian Marketplace or go to Jira Settings → Apps → Frank HR → Get Started and click Start setup. You'll see a welcome screen with a setup wizard that guides you through the configuration.

Setup wizard

You don't have to build any of this by hand. Setup puts a complete employee project in place for you: a Jira project where each employee is a work item, the screen and fields that hold their details, the workflow that moves them through their time at the company, and the permissions that keep everything safe. The setup wizard takes about 5 minutes and walks you through three steps.

Required Jira permissions

Frank requests these OAuth scopes during installation:

  • read:jira-user: read user profiles

  • read:jira-work: read issues, workflows, and fields

  • write:jira-work: create and update employee issues

  • manage:jira-configuration: create permission and issue-security schemes

  • manage:jira-project: create and configure projects, screens, and workflows

  • storage:app: store app settings and caches

Step 1: Connecting Frank to Jira

Frank creates the required Jira setup automatically. During this step, Frank will create the employee issue type, configure screens and workflows, set up the Frank project, and apply the right permissions. You don't need to do anything here. Frank handles the details and moves to the next step automatically when done.

Everything setup creates

Resource

Name / details

Project

Frank (FRANK key, business type)

Issue type

[Frank] Employee

Screen

Employee Screen with 5 tabs: General, Personal info, Contact, Emergency contact, Contract data

Custom fields

All optional employee fields (see Field access for the full list)

UI modification

[Frank] Employee UI modifications — controls how the employee issue view looks

Workflow

[Frank] Employee Workflow with statuses: Hired → Onboarding → Active → Offboarding → Departed

Permission scheme

[Frank] Permission Scheme — grants the HR groups the correct Jira permissions on the FRANK project

Screen scheme & issue type screen scheme

Wires the screen to the project and issue type

Issue type scheme

Limits the FRANK project to only the Employee issue type

Step 2: Create Confluence space

Frank uses Confluence to store employee documentation. In this step, Frank creates a dedicated Confluence space where employee folders and onboarding documents will live. HR-safe permissions are applied automatically so sensitive info stays protected. You can skip this step and create the space later from the settings if needed.

Step 3: Connect people policies

Choose the Confluence space where your HR policies live. Frank uses this content to answer employee questions through Rovo. This should be the space containing your employee handbook, leave policies, benefits information, and other HR documentation. You can skip this step and connect a space later, but Frank's Rovo agent won't be able to answer policy-related questions until a space is connected.

After setup

Once the wizard completes, you'll see a "Frank is ready to go" screen with next steps:

  • Customize employee profiles: Configure which fields appear on employee records by editing the Jira screen. The standard template covers basics, but you can add fields for contract details, emergency contacts, or anything else you need.

  • Setup permissions: Add HR staff and managers to the access group so they can view employee records. Regular employees only see their own profile.

  • Convert Jira users to employees: Turn existing Jira users into employee records. Frank pulls in names and emails automatically. You can add details like roles and departments later.

  • Try Frank with sample data: Not ready to import real employees? Add fictional employee records to explore how Frank works. You can remove them later.


Accessing Frank

After installation, access Frank from the Jira app switcher.

Keeping data in sync

After setup, Frank keeps employee data in sync automatically. Whenever a [Frank] Employee issue is created or updated in Jira, Frank syncs the change to its internal database, and a scheduled job runs a full sync every hour.

Change the configuration later

You can adjust Frank at any time from Jira Settings → Apps → Frank HR → Configure Frank, where you can change the HR group names, manage field settings, and more.