Voci con l'etichetta :
Chiudi
Changelog
Chiudi
Provalo nel cloud
Centro assistenza
integrazione

About the ONLYOFFICE and Jira integration

ONLYOFFICE offers an official connector to integrate ONLYOFFICE Docs with Jira Software to collaborate on office documents attached to your Jira issues. You can download it from the official Atlassian Marketplace or GitHub. The application is distributed under the Apache license.

To learn more about how it works, please visit our API documentation.

Main features

  • Viewing and editing text documents, spreadsheets, presentations, and forms using the Edit in ONLYOFFICE option.
    To learn more about forms please read the corresponding articles for creating and filling out forms.
  • Co-editing documents in real-time: two co-editing modes (Fast and Strict), Track Changes, comments, and a built-in chat.
  • JWT support to secure your traffic so that no one can have access to your documents with the exception of the users with proper rights.

Supported formats

  • For creating, editing and viewing: DOCX, PPTX, XLSX, DOCXF.
  • For filling forms: OFORM.
  • For viewing only: DOC, DOCM, DOC, DOTX, DOTM, ODT, FODT, OTT, RTF, TXT, HTML, HTM, MHT, PDF, DJVU, FB2, EPUB, XPS, XLS, XLSM, XLTZ , XLTX, XLTM, ODS, FODS, OTS, CSV, PPS, PPSX, PPSM, PPT, PPTM, POT, POTX, POTM, ODP, FODP, OTP.

Connecting ONLYOFFICE Docs to Jira

Requirements

  • ONLYOFFICE Docs 6.4.0 or higher

    You need an instance of ONLYOFFICE Docs that is resolvable and connectable both from Jira and any end clients. It must be able to POST to Jira directly.

    Please refer to the official ONLYOFFICE Docs documentation page to learn more about installing ONLYOFFICE Docs.
  • Jira Software (Server or Data Center) v. 7.13.0 - 8.19.0

    Please refer to the official Atlassian documentation to learn more about installing Jira Software.

Installing the ONLYOFFICE connector for Jira

You can download the connector from the official Atlassian Marketplace or compile it from source codes available on GitHub.

Adding the connector from the Atlassian marketplace
  1. Log into your Jira Software instance as an administrator.
  2. Click the ONLYOFFICE_connector Administration icon in the upper right corner and choose the Manage apps option from the menu.
    ONLYOFFICE_connector ONLYOFFICE_connector
  3. The Find new apps section will open. Click the Search the Marketplace field and find the Jira ONLYOFFICE integration app.
  4. Click the Install button to download and install the application.
Adding the connector compiled from the source code

First of all, you need to install the following prerequisites to be able to compile the ONLYOFFICE connector for Jira:

To compile the ONLYOFFICE connector for Jira, follow these steps:

  1. Clone the onlyoffice-jira repository.
    git clone https://github.com/ONLYOFFICE/onlyoffice-jira.git
  2. Go to the onlyoffice-jira directory.
    cd onlyoffice-jira
  3. Run the following command:
    atlas-package

    Wait while the connector is being compiled. After it’'s done, the connector can be found in the target folder

You can upload the compiled connector on your Jira Software Administration -> Manage Apps page.

  1. Log into your Jira Software instance as an administrator.
  2. Click the ONLYOFFICE_connector Administration icon in the upper right corner and choose the Manage apps option from the menu.
  3. Select the Manage apps section on the left-hand side of the page.
  4. Click the Upload app link.
  5. Click the Choose File button, browse for the compiled target/onlyoffice-jira-app.jar file and click Upload. Wait while the application is being installed.
    ONLYOFFICE_connector ONLYOFFICE_connector

Configuring the ONLYOFFICE connector for Jira

Click the Configure button below the installed Jira ONLYOFFICE integration app on the Manage apps page or find the app in the OTHER section of the Manage apps page.

ONLYOFFICE_connector ONLYOFFICE_connector

In the Document Editing Service address field, specify the IP address or hostname of the server with ONLYOFFICE Docs installed.

ONLYOFFICE_connector ONLYOFFICE_connector

You can also specify a Secret key - the secret to validate the JSON web token upon the request to ONLYOFFICE Docs. For more details, see the Enabling JWT for the ONLYOFFICE and Jira integration section of this article.

The Advanced server settings section can be used if your network configuration does not allow for requests between the installed Jira Software and ONLYOFFICE Docs using the public addresses. In this case, specify addresses for internal requests in the corresponding fields:

  • Jira Software server address for internal requests from ONLYOFFICE Docs.
  • ONLYOFFICE Docs address for internal requests from the Jira Software server.

Click Save to save the settings.

Enabling JWT for the ONLYOFFICE and Jira integration

To protects documents from unauthorized access, ONLYOFFICE editors use the JSON Web Token (JWT). The token is added in the configuration when the Document Editor is initialized and during the exchange of commands between inner ONLYOFFICE Docs services. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.

To protect your documents, you need to enable the token validation and specify your own secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings.

Step 1: Configure ONLYOFFICE Docs

  1. Open the local.json file with any available text editor.
    • For Linux - /etc/onlyoffice/documentserver/local.json
    • For Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
    • For Docker – enter the ONLYOFFICE Docs container using the docker exec -it <containerID> bash command and open /etc/onlyoffice/documentserver/local.json
  2. Enable token validation by changing the false value to true in three sections:
    • services.CoAuthoring.token.enable.browser
    • services.CoAuthoring.token.enable.request.inbox
    • services.CoAuthoring.token.enable.request.outbox
  3. Specify your own secret key by replacing the secret value with your own text string in three sections. The secret key must be the same.
    • services.CoAuthoring.secret.inbox.string
    • services.CoAuthoring.secret.outbox.string
    • services.CoAuthoring.secret.session.string
    {
      "services": {
        "CoAuthoring": {
          "token": {
            "enable": {
              "request": {
                "inbox": true,
                "outbox": true
              },
              "browser": true
            }
          },
          "secret": {
            "inbox": {
              "string": "yoursecret"
            },
            "outbox": {
              "string": "yoursecret"
            },
            "session": {
              "string": "yoursecret"
            }
          }
        }
      }
    }
    
  4. Save your changes.
  5. Restart the services for the config changes to take effect.
    supervisorctl restart all

Step2: Specify the same secret key in the connector settings

In the connector settings, specify the same secret in the Secret key field and save the settings.

Start using ONLYOFFICE Docs within Jira

Viewing and editing files

You can open the ONLYOFFICE editors from any Attachments block of an issue. This option is available for issues from any module where an issue can be opened, e.g., issue list, backlog, issues, etc.

Attachments must be enabled by the administrator.

A new attachment can be added on the issue page using the More -> Attach files option. To learn more, see the official documentation.

To open a text document, spreadsheet, presentation, or form, move the mouse pointer over the necessary file and click the ONLYOFFICE_connector Edit in ONLYOFFICE icon.

ONLYOFFICE_connector ONLYOFFICE_connector

The file will be opened in a new browser tab in the corresponding ONLYOFFICE editor.

Access permissions

Access permissions for files depend on a user's access rights to the corresponding issue.

Editing files. To be able to edit files, a user must have permissions for creating attachments (Create attachments).

Viewing files. File preview in the ONLYOFFICE viewers is available for all users who can view an issue, but do not have permissions for editing the issue or permissions for creating attachments. If the file format is not supported for editing, the file will be opened for viewing.

Saving changes

The changes made to a file are saved to a new file with the same name as the original file, with a postfix added at the end of the file name, e.g. Sample-1.docx.

ONLYOFFICE_connector ONLYOFFICE_connector

The changes made to a file during the co-editing process are only saved to the first version of the file. If the document is being edited by several users simultaneously, the changes will be displayed only in the first file. Until the last user closes the editor, a new version of the file is not added to the issue.

Download Best editors on your website Let your site users view, edit and collaborate
on all types of text, spreadsheet and presentation files
Ti potrebbe essere d'aiuto anche...
Chiudi