Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Button handy
blankfalse
color#0052CC
nameCloud
linkhttps://appfire.atlassian.net/wiki/spaces/EIFJC/pages/10125437/Installation
width84
Button handy
blankfalse
color#EBECF0
nameOn-Prem
linkhttps://appfire.atlassian.net/wiki/spaces/EI4J/pages/11206868/Installation
width85

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

This page is about Easy Integrations for Jira Cloud. Using Jira On-Prem? Click the On-Prem button above.

The Create or Update a Confluence Page action allows you to create or update Confluence pages with Jira or other action data. It is a powerful tool for enhancing collaboration and information sharing between your teams. This documentation provides details on how to configure the Create or Update a Confluence Page action.

🎯 Index

Table of Contents
minLevel3
maxLevel6
outlinefalse
typelist
printablefalse

Prerequisites

Before using this you start configuring the action, ensure you have the following prerequisites are metin place:

  1. Only Jira administrators have the necessary permissions to access and configure the Create or Update a Confluence Page action within Easy Integration.

  2. Confluence Integration must be enabled for your Jira instance.

Options of action

Field Name

Description

Action name

Give a name for the action, it's just a reminder for you!

Condition

Enable or Disable

How to Configure the Create or Update a Confluence Page Action

The Create or Update a Confluence Page action in Listeners can be accessed within Easy Integration's admin UI. Follow these steps to configure:

  1. Navigate to Jira's top menu, and click Apps.

  2. Select Manage your apps.

  3. In the sidebar, locate and click Easy Integrations configuration.

  4. Select Listeners from the app’s top menu.

  5. Configure the listener according to your requirements. For more information on that, refer to this documentation.

  6. In the Actions section of the listener configuration, click Configure the Create or Update a Confluence Page.

  7. Here's how to configure the Create or Update a Confluence Page action:

    Image Added
    • Action name – Give a descriptive name for the action. This is a reminder for you to easily identify this action.

    • Condition – Enable or disable the condition.

      When enabled,

write the
    • provide a JavaScript condition

of
    • for the listener.

When enabled, Listener actions will work
    • The action will execute only if the script returns true.

See
Example
    • For example:

      return startsWith(data.event.issue.fields.summary, 'Sultans of Swing');

    • Space

    • Select the Confluence Space

that
    • in which the content is

being
    • to be created

in
    • .

    • Parent page

The
    • Specify the parent content

of
    • for the new content. If you are creating a top-level page,

this can be left
    • you can leave this field blank.

    • Template space

    • Choose a space for space templates or leave it blank for global templates.

    • Template

Choose
    • Select a user-defined global or space template.

    • Action parameters (variables)

    • Write

the
    • JavaScript code to return objects of variables.

In the following example parameters variable is a JavaScript object and has 4 attributes.:
    • For instance, you can define variables such as "issue key,"

,
    • "issue summary,"

,
    • "issue status,"

.
    • and "project name."

.
    • These

4
    • variables can be used in the

page title and page body.
    • URL, headers, and request body. Here's an example:

      var parameters = {};
      parameters['issue key'] = data.event.issue.key;
      parameters['issue summary'] = data.event.issue.fields.summary;
      parameters['issue status'] = data.event.issue.fields.status.name;
      parameters['project name'] = data.event.issue.fields.customfield_10500.name;
      return parameters;

    • Page title – Specify the title

Title
    • of the page.

    • You can use parameters in the title

with
    • by enclosing them in double curly braces.

Example
    • For example: "New issue is created with key {{issueKey}}."

    • Update existing

Update if
    • Check this option if you want to update a page with the same title

is
    • found

on
    • in the directory. Page names

have to
    • must be unique within a space

and if
    • . If you

will
    • do not check this option,

this
    • the action may fail. When checked, an additional option is required:

FieldDescription
      • Append template

      • If checked, the action appends the template body to the end of the current page; otherwise,

otherwise
      • it overrides the existing content.

    • Add page link to issue

If enabled, the
    • Enable this option to add a page link

will be added
    • to the issue. When this field is enabled, additional fields are required:

FieldDescription
      • Issue ID or Key script

      • Write a JavaScript script

which
      • that returns an Issue ID or key. Event data or data from previous actions

data
      • can be used in the script.

      • Confluence application link ID

Application
      • The application links information

can not
      • cannot be accessed by the apps.

Please login
      • To obtain the "id" value of the Confluence object, please log in to Jira, navigate to https://

ttunca
      • [domain name].atlassian.net/rest/applinks/latest/applicationlink, and copy the "id" value

of the Confluence object. Example:
      • . For example: "7d4bz3tu-fy2m-26p1-1g3m-

3857972z9252

Example Screen

The following example creates an Azure DevOps ticket with the newly created Jira Bug data.

Image Removed

Template Example

Templates are used to create/update
      • 3857972<9252."

That’s it! You have successfully configured the Create or Update a Confluence Page action in Easy Integrations. For further insights, please refer to the following example:

Example 1: Create/Edit Wiki Page

Note: This is a sample use case and can be customized to suit your integration needs.

Expand
titleExample:
Image Added

Example 2: Templates

Templates are employed for the creation or modification of Confluence pages. All action parameters are available accessible as variables. Space templates are under can be found within the "Look and Feel" space settings.