ButtonScriptMacro

Note, ButtonScriptMacro is available starting with version 2.0.0. Now, you are able to call any SIL script in your Confluence just with one click or even integrate Confluence and Jira if you have Power Scripts installed for both instances.

Example

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

1. Writing the code in Jira

1. To create a script, go to Jira Administration → Manage apps →  cPrime Tools, and click SIL Manager.

2. Click the silprograms folder and then New → New file. 

3. Create a new SIL file and name it, for example, Create_Issue.sil like in the image below. 
   
   
   

   Open

   

   
   
   
   
   

4. In the Create_Issue.sil file that you created write the script for your future tickets. This script is stable and retrieves data you have to specify in Confluence. This is an example.
   Then click Check and Save.

   string projectKey = ""; string parentIssueKey = ""; string issueType = ""; string issueSummary = ""; string priority = ""; string description = ""; string components = {}; string dueDate = ""; string estimate = ""; string securityLevel = ""; string fieldMappings = {}; if(isNotNull(getElement(argv, 0))) projectKey = getElement(argv, 0); if(isNotNull(getElement(argv, 1))) parentIssueKey = getElement(argv, 1); if(isNotNull(getElement(argv, 2))) issueType = getElement(argv, 2); if(isNotNull(getElement(argv, 3))) issueSummary = getElement(argv, 3); if(isNotNull(getElement(argv, 4))) priority = getElement(argv, 4); if(isNotNull(getElement(argv, 5))) description = getElement(argv, 5); if(isNotNull(getElement(argv, 6))) components = getElement(argv, 6); if(isNotNull(getElement(argv, 7))) dueDate = getElement(argv, 7); if(isNotNull(getElement(argv, 8))) estimate = getElement(argv, 8); if(isNotNull(getElement(argv, 9))) securityLevel = getElement(argv, 9); if(isNotNull(getElement(argv, 10))) fieldMappings = getElement(argv, 10); createIssue( projectKey, parentIssueKey, issueType, issueSummary , priority, description, components, dueDate, estimate, securityLevel, fieldMappings );

   
   
   

5. 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. 

1. To configure it, go to Confluence Administration → Add-ons →  cPrime Tools → Remote Systems and click Add Remote.

2. 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

1. To create a script, go to Confluence Administration → Add-ons → cPrime Tools, and click SIL Manager.

2. Click the silprograms folder → Test → and then New → New file. 

3. Create a new SIL file and name it, for example, Epic_issue.sil like in the image below. 
   
   
   

   Open

   

   
   
   
   
   

4. In the Epic_issue.sil file that you created, you have to specify the necessary parameters and add values for fields of your future issue. Also, it requests to add call routine to push your Sil script in Jira.

   Then click Check and Save.

   string projectKey = "SSTP"; string parentIssueKey = ""; string issueType = "Epic"; string issueSummary = "Development process"; string priority = "Critical"; string description = "This issue was created via SIL button"; string components = {}; string dueDate = currentDate() + "30d"; string estimate = "1h 30m"; string securityLevel = "10000"; string fieldMappings = {}; string [] args; args+=projectKey; args+=parentIssueKey; args+=issueType; args+=issueSummary; args+=priority; args+=description; args+=components; args+=dueDate; args+=estimate; args+=securityLevel; args+=fieldMappings; call("Test_Jira", "examples/mh_test/create_issue.sil", args);

   
   
   

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.

1. To add a ButtonScriptMacro, go to the necessary Confluence page, click Insert more content, and select Other macros →  SIL button.
   
   
   
   
   
   

2. 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 the full path to the program being run (all folders after silprograms if any).

   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.
      
      
      

      
      
      
      
      

3. Click Save to create a ButtonScriptMacro.
   
   
   

   
   
   
   
   

Result

When you click the button, Sil script will be called and an Issue will be created. Depending on settings, the button will stay active or be disabled after use.

What's next?

• ScriptMacro

• ConditionScriptMacro

• InlineScriptMacro

• TableScriptMacro