Reliable for Large-scale Organizational Change! Method for Realizing Automatic Release

Using the API for [Release] an App under development, you can realize automatic release of the group of specified Apps. The mechanism of the automatic release is implemented by automatic processing Step (Add-on XML).

Hi, there!

In Japan, “Workstyle reformation” is advocated by the Prime Minister.

But, it seems difficult somehow. In the industry which I am working for (IT industry), changes do not seem to be making any progress, neither do others.

By using Questetra, I would like to improve work efficiency and contribute to “workstyle reformation”.
However, it is likely to be affected by changes in the organization or business that occur at the end of the quarter or the end of the year, since it is used for business management.
Even if you can improve efficiency for business use, it is meaningless if it takes much effort to operate.
For example,

* You have to change the configurations at 00:00 on April 1st in response to organization change!
(= release Business Process Definitions)

If this happens, it has to be an overnight work.It’s serious! It’s all-night long. It’s tough.
If it could be possible to

* Revise the Business Process Definitions beforehand, then they will be updated automatically when the time to switch comes

, it will help your company’s “workstyle reformation“.

It can now be realized in Ver. 11.6!

v11.6 2018-03-12 Corresponds to HTTP Start which can Receive Request Body as It Is
Changes of Functions for System Engineer

– Added API to acquire App list (/API/Admin/ProcessModel/list)
– Added API to [Release] a version under development App (/API/PMM/ProcessModel/{processModelInfoId}/release)

https://www.questetra.com/info/version-1160/

I will explain an automatic release App using these APIs.

Details of New APIs in Version 11.6

Details of “API for [Release] developing Apps”

The part of URL for the API is (e.g.) “/API/PMM/ProcessModel/4/release”.
(Hereafter, “Release API”) Put your AppID in place of “/4/” section, above.

For details about the API, you can refer to the “API Manual” in the right menu of your environment.
You can also access it as follows if you want to access it easily.

<Easy access to API Reference>
https://foobar-999.questetra.net/s/swagger/index.html?urls.primaryName=Workflow%20API&validatorUrl=#/ProcessModel/releaseProcessModel

Test-execution is also available!
* Please modify the “https://foobar-999.questetra.net” section for your environment.

Details of “API for retrieving App list”

The part of URL for the API is (e.g.) “/API/Admin/ProcessModel/list”.

<Easy accesss to API Reference>
https://foobar-999.questetra.net/s/swagger/index.html?urls.primaryName=Workflow%20API&validatorUrl=#/ProcessModel/listProcessModel

App for Auto-Release at a specified Time

Utilizing the API above, automatic release can be possible by selecting Release date/Target App.

Example of Flow diagram

When approval is obtained at the “Approve Release” Step, Release processing is automatically performed at the specified date and time.

Step of “Request Release approval”

The point of this Step is to specify the Apps to be automatically Released.
It cannot be realized with only the standard features, so it is realized with (client-side) JavaScript.

(This is an animation. Please click on the image if it does not run.)

<Explanation of the behavior of Task operating screen (JavaScript part)>
1. Execute “/API/Admin/ProcessModel/list (Retrieving a List of Process Models)”
2. Generate options for checkbox (HTML) based on the information retrieved at #1
3. Information of the selected Apps is set to String type Data Item (multiple-line) at the time when the “Finish” button on the Task operation screen is clicked. (Execute Release API using this content)

Step of “Auto-Release service (Add-on XML)

At this (auto-)Step, the following processing is performed.

1. Read App ID one by one from the specified App list
2. Execute HttpRequest API using the App ID retrieved #1.
3. Set execution result to log

“Password of the API executing user” is the password for accessing APIs with the Basic Authentication.

Related authorization settings

One of the big points when running this App is authorization.

* To execute /API/Admin/ProcessModel/list (Retrieving a List of Process Models), System Authorization: System Administrator is required.
That means the user who operates this Task must have System Administrator permissions in the System Authorization.
* To execute /API/PMM/ProcessModel/{processModelInfoId}/release (Release process model), App Authorization: App Administrator is required.
That means, the user who is specified in the “Auto-release service” Step must have been authorized as the App Administrator in the App Authorization.

The above are the conditions for execution.

Closing

Implementation of relatively not that complicated.

Download: Auto-release service App
* As the Service Task definition file (add-on XML) is related to App-specific management, please refer to it in
“App details” → “▼ App” → “Manage Add-on”.

As described in the “Related authorization settings” above, you need to pay attention to the authorization settings when executing the API.
The user authorized as “System Authorization: System administrator” is strictly limited, so I suppose that it is quite possible that it is different from the person in charge of business design.
Therefore, another method could be, for example:

1. Request for Release (by a Business designer) * cannot make the selection from Apps list.
2. Check & Select (by System Authorization: System administrator holder) * The Step of “Request Release approval” in above example.
3. Approve (by the Supervisor of the Business designer)

In addition, it is also good to grant “App Administrator authorization” to all App to a group of users who are specified in the “Auto-Release service” step.

If you have any questions, please feel free to contact us.

2018-03-27

About Masato Furukubo

Questetra, Inc. Sales Department
View all posts by Masato Furukubo

Recommendations
Prev article - 50. Questetra Tips Let's Create a Cool(?) Questionnaire Management System! (2)
Next article - 50. Questetra Tips Reliable for Large-scale Organizational Change! Method for Realizing Automatic Release (Revised)
Another article - Masato Furukubo Method of Letting a Robotty(?) Start Processes Every Other Week

Archive

 RSS