ButtonScriptMacro

Enables you to add a button to the page when clicked on which the SIL script is called. This is a great way for Jira and Confluence integration.

Note, ButtonScriptMacro is available starting with version 1.1.15

Example

Let’s say, you want to create an Issue in your Jira Project by clicking on the button on the Confluence page.

If you have Power Script installed for both Jira and Confluence you can use Remote systems to call the createIssue() routine on Jira itself. If not, you need to write a script that uses the REST api.

1. Writing the code in Jira

To create a script, go to Jira Administration → Manage apps → cPrime Tools, and click SIL Manager.
Click the silprograms folder and then New → New file.
Create a new SIL file and name it, for example, Create_Issue.sil like in the image below.

In the Create_Issue.sil file that you created write the script for your future tickets. This is an example.
Then click Check and Save.

string issue_priority;//Possible values: "Major", "Critical" etc.
string issue_description;
string issue_security_level;
string project = "SSTP";
issue_priority = "Critical";
issue_description = "Reproducing the issue";
issue_security_level = "Administrator";

string k = createIssue(
					project,
					"", // passing in empty to create a regular issue rather than subtask
					"Bug",
					"PS-Summary is here" ,
					issue_priority,
					issue_description,
					{}, // no components
					currentDate() + "30d",
					"1h 30m",
					issue_security_level,
					{} // and no custom field mappings
					);

print ("On the project " + project + ", issue " + k + "is created.");

You can find more information about managing your SIL Scripts on the SIL Manager page.

2. Configuring Remote Systems in Confluence

In this case, the Remote Systems option lets you connect Jira with Confluence and call sil scripts from Confluence page.

To configure it, go to Confluence Administration → Add-ons → cPrime Tools → Remote Systems and click Add Remote.
You are required to enter the following information:

Where:
Name - is the name of the remote system, unique within other remote systems.
URL - represents the URL (just the base URL, as shown above).
Username & Password - to care about authentication.
The timeout is optional, as well as the check result parameters. They control the underlying library responsible for performing REST calls. More information is here.

3. Writing the code in Confluence

To create a script, go to Confluence Administration → Add-ons → cPrime Tools, and click SIL Manager.
Click the silprograms folder and then New → New file.
Create a new SIL file and name it, for example, silButton.sil like in the image below.
In the silButton.sil file that you created write the following script. It calls your Sil script in Jira.
- The first parameter is the name of our connection.
- The second parameter is the name of the script which will be executed on the remote. You have to specify all folders after silprograms (if any) as a path to the file.
  Then click Check and Save.
```
call("Test_Jira", "examples/mh_test/create_issue.sil", "");
```

4. Creating a ButtonScriptMacro

So, you have created the scripts, but before using them, you need to create a ButtonScriptMacro and associate the script with it.

To add a ButtonScriptMacro, go to the necessary Confluence page, click Insert more content, and select Other macros → SIL button.
In the displayed dialog, fill out the necessary fields:
1. Enter the name for the button.
2. Enter the script name that you created in Confluence. You have to specify all folders after silprograms (if any) as a path to the file.
3. Enter the input - space key and the page name where you want to display the button (optional).
4. Check Reuse if you want the button to remain active after execution.
Click Save to create a ButtonScriptMacro.

Result

When you click the button, Sil script will be called and an Issue will be created. After that, the button will be disabled and the comment will be added to the page.

If you check the Reuse option in the macro configuration, the button will be active and can be reused.

Note, it is possible to bind one button to one script per page. In other words, you are not able to have several ButtonScriptMacros are connected to the same script on the page.