How to access Scroll Version workflow using Velocity script

Kin Chan_ocu0z7

Hi there,

We are using Scroll Version on a Confluence space to do space version control. We have activated workflow provided by Scroll Version. We would like to access the workflow, namely the page status (draft, review etc) using a Confluence User Macro (written in Velocity code) to show the revision statuses of all the pages in a table. Can someone suggest a way to do that (i.e. to detect the revision status from workflow) please?

Thanks in advance for your help.

Kin

Dominic Lagger

Hi @Kin Chan 

I once wrote an user macro for getting the page keys. 

I get the API requests from the documentation page:

• Manage workflow states 

The code of my macro is here, feel free to adjust the way you need:

## Macro title: My Macro

## @noparams

#set( $pageId=$content.getContentId().asLong() )
#set( $listOfDescendants = $content.getDescendants() )

#set($listOfDecendantsPageIds = [])
#foreach ($page in $listOfDescendants)
#set($foo = $listOfDecendantsPageIds.add($page.getContentId().asLong()) )
#end

<table class="confluenceTable tablesorter tablesorter-default" >
<thead class="tableFloatingHeaderOriginal">
<tr role="row">
<th class="confluenceTh">Page name</th>
<th class="confluenceTh">Page key</th>
<th class="confluenceTh">Version</th>
</tr>
</thead>
<tbody id="pk-table-output"></tbody>
</table>


<script>
let baseUrl = Confluence.getBaseUrl().concat(Confluence.getContextPath());
let spaceKey = AJS.Meta.get("space-key");
console.log(baseUrl);
function pkArray(pkPages) {
var pkTable = "";
var i=0;
var list = $listOfDecendantsPageIds;
while (i < pkPages.length) {
var page = pkPages[i];
if( list.includes(page.confluencePageId)) {
if (page.scrollPageKey != undefined) {
pkTable = pkTable.concat("<tr role='row' ><td class='confluenceTd'><a href='"+baseUrl+"/pages/viewpage.action?pageId="+page.confluencePageId+"'>"+page.scrollPageTitle+"</a></td><td class='confluenceTd'><a href='"+baseUrl+"/display/_PK/"+spaceKey+"/"+page.scrollPageKey+"'>"+page.scrollPageKey+"</a></td><td class='confluenceTd'>"+page.targetVersion.name+"</td></tr>");
}else{
pkTable = pkTable.concat("<tr role='row' ><td class='confluenceTd'><a href='"+baseUrl+"/pages/viewpage.action?pageId="+page.confluencePageId+"'>"+page.scrollPageTitle+"</a></td><td class='confluenceTd'>---</td><td class='confluenceTd'>---</td></tr>");
}
}
i++; 
}
return pkTable;
}

let pkRequest = new XMLHttpRequest();
pkRequest.open("POST", ""+baseUrl+"/rest/scroll-versions/1.0/page/"+spaceKey);
pkRequest.setRequestHeader("Content-Type", "application/json");
pkRequest.send(JSON.stringify([{"queryArg": "scrollPageTitle", "value": "*"}]));
pkRequest.onload = () => {
if(pkRequest.status === 200) {
document.getElementById("pk-table-output").innerHTML = pkArray(JSON.parse(pkRequest.response));
}
else {
console.log("whoopsie")
}
}
</script>

Regards, Dominic