Atlassian App || Customer Group & Organization Sync for JSM Cloud || Documentation
1. Introduction
User synchronization in Jira refers to the process of adding users from groups to organizations. Our enhanced features ensure seamless navigation and intuitive control over user groups and organizations. We've implemented a scheduled run feature that enables users to set up automated processes for adding users from groups to organizations.
2. App Installation
Step 1: Login as a JIRA administrator. Go to Administration -> Add-on -> Find Add-on
Step 2: Find "Customer Group & Organization Sync for JSM Cloud" and click "Install".
3. Customer Group & Organization Sync for JSM Cloud Steps
Step 1: Go to Jira Home → Click on Apps drop-down -> Click on “Customer Group and Organization Sync for JSM Cloud.”
Step 2: After selecting "Customer Group and Organization Sync for JSM Cloud," the application view will be displayed, providing you with the interface to interact with the tool.
Step 3: To validate the authorization, please provide your 'Email ID' and 'API Token' and click on the validate button.
Step 4: If you have entered an incorrect Email ID or API token, an error message will be displayed, indicating the issue in the flag message.
Step 5: Upon clicking the "Validate" button, if both the Email ID and API token are valid, a success flag message will be displayed confirming that the API token is valid.
Step 6: To perform the user synchronization operation, click on the "User Sync" tab.
Step 7: Upon clicking the Jira Groups dropdown, a prompt will appear requesting a 3-character keyword. Subsequently, the system will retrieve groups containing the specified keyword and enable the selection of the desired group.
Step 8: When you click on the organization dropdown, it will retrieve and display a list of organizations. Choose the relevant organization from the list.
Step 9: After selecting a group and organization, clicking the "Add" button will add the names of the group and organization to the table. This table will include options for deleting and synchronizing operations.
Step 10: Clicking "Delete" removes the row containing both group and organization, while clicking the "sync" button adds users from the group to the organization.
Step 11: To execute the selected groups and organizations from the table through scheduling, you should click on the "Schedule" tab and it will start run the job at the scheduled interval with flag message “Scheduler running started”.
Step 12: The default frequency is set to daily, and users have the option to choose weekly or monthly intervals. In the case of a weekly schedule, users will be prompted to select the specific day for execution, while for a monthly schedule, they will be asked to specify the desired date for the operation.
Step 13: Upon selecting the interval and entering the hours and minutes, clicking the "Save" button will store the chosen interval as a cron pattern in the database. Subsequently, this saved schedule interval will be displayed in the table.
Upon click on ‘Delete’ button, it will delete the schedule interval and we can enable and disable the created schedule. By default it will create as enabled.
Step 14: If we click on the “View” button, it will show the 5 recent schedule runs details with “Success” or Failure” status.
4. Audit Log
The primary purpose of an audit log is to provide a detailed trail of activities for security, compliance, troubleshooting, and analysis purposes.
