This section contains information and procedures relating to the use of CentraSite with ARIS.
The asset type Process contains a profile named ARIS Properties which includes attributes that are of use when CentraSite is integrated with the ARIS products. The contained attributes are:
The ARIS Properties profile includes the following attributes:
Attribute | Description |
---|---|
ARIS GUID | The Global Unique Identifier (GUID) that is assigned to the asset and uniquely identifies it once imported into ARIS. |
ARIS Client | Download URL for ARIS Web client. |
ARIS Publisher URL | URL for assets published through ARIS Publisher. |
ARIS Connect URL | URL to establish connection to the ARIS Connect. |
The asset type Process contains the ARIS Properties profile by default. An administrator can optionally choose to disable this profile in the asset type definition. For example, if ARIS is not jointly used with CentraSite, an administrator might want to disable this profile for all assets on type Process.
ARIS uses CentraSite to retrieve/publish services and processes for process execution. When users define business processes with ARIS Architect, they can optionally publish the resulting processes and related services to CentraSite.
CentraSite includes predefined lifecycle models and predefined design/change-time policies to facilitate the governance of the business processes that ARIS publishes. To use CentraSite with ARIS, you must first configure and activate these features as described in the following sections.
Note:
When users working on the same ARIS database are created as users in
different CentraSite organizations, by default they will not have visibility
to each others' assets. It is recommended to either have all users of an ARIS
database in the same CentraSite organization, or if this is not possible, to
create a group in CentraSite containing all those users, and assign
"Read" or "Modify" permissions to the group.
When ARIS publishes a business process to CentraSite, the business process is represented in the registry by a Process object. ARIS requires business processes (Process objects) to be governed by a lifecycle model. CentraSite includes a predefined lifecycle model called "BPM Process Lifecycle" for this purpose.
The "BPM Process Lifecycle" model defines the following states and transitions:
State | Has valid transitions to... |
---|---|
Requested | Implementing, Rejected |
Implementing | Implemented |
Implemented | Testing |
Testing | Tested |
Tested | Available |
Available | Retired |
Retired | This is an end state. It has no outgoing transitions. |
Rejected | This is an end state. It has no outgoing transitions. |
Certain operations performed in ARIS trigger policies in CentraSite, and these policies change the lifecycle state of a given Process object. When a user deletes a business process in ARIS, a policy in CentraSite automatically switches that process to the Retired state in the registry.
When you install CentraSite, this predefined lifecycle model is disabled (i.e., inactive). To use CentraSite with ARIS, you must activate the lifecycle model as described in Activating the Lifecycle Model and Design/Change-Time Policies that ARIS Uses.
The "Service Lifecycle" model defines the following states and transitions:
State | Has valid transitions to... |
---|---|
Proposed | In Design, Rejected, Retired |
In Design | In Development, Rejected |
In Development | Implemented |
Implemented | In Test |
In Test | Tested, In Development |
Tested | In Production |
In Production | Under Maintenance, Deprecated |
Under Maintenance | In Production |
Deprecated | In Production, Retired |
Retired | This is an end state. It has no outgoing transitions. |
Rejected | This is an end state. It has no outgoing transitions. |
Certain operations performed in ARIS trigger policies in CentraSite, and these policies change the lifecycle state of a given Service object. When a user deletes a service in ARIS, a policy in CentraSite automatically switches that process to the Retired state in the registry.
When you install CentraSite, this predefined lifecycle model is disabled (i.e., inactive). To use CentraSite with ARIS, you must activate the lifecycle model as described in Activating the Lifecycle Model and Design/Change-Time Policies that ARIS Uses.
If the predefined lifecycle models that CentraSite provides does not suit your needs, you can customize them or create a new model for Process objects or Service objects. If you do this, however, you must also update the predefined policies that switch the lifecycle state of objects in the registry. For more information about which policies change the state of an object, see The Design/Change-Time Policies that ARIS Uses.
Note:
The CentraSite Community Edition does not support
the use of customized lifecycle models for Process objects or Service objects.
If you are using the Community Edition, you must use the predefined lifecycle
model that CentraSite provides.
CentraSite includes the following predefined policies.
Policy Name | Purpose |
---|---|
ARIS Delete Processes |
Switches a specified Process object to the Retired lifecycle state. This policy executes when a process model is deleted by a Delete Process call from ARIS. Note that if the Process object in CentraSite is not in a state that permits a transition to the Retired state (i.e, if a transition to the Retired state is not permitted by the Process object's lifecycle model) the policy will fail. Important: |
ARIS Delete Services |
Switches a specified Service (native or virtual) to the Retired lifecycle state. This policy executes when a service is deleted by a Delete Service call from ARIS. Note that if the Service in CentraSite is not in a state that permits a transition to the Retired state (i.e, if a transition to the Retired state is not permitted by the Service's lifecycle model) the policy will fail. Important: |
ARIS Release Processes |
Switches a specified Process object to the Available lifecycle state. This policy executes when a process model is released by a Release Process call from ARIS. Note that if the Process object in CentraSite is not in a state that permits a transition to the Available state (i.e, the transition to the Available state is not permitted by the Process object's lifecycle model), the policy will fail. Important: |
ARIS webMethods Integration | Sets instance-level permission and profile-level
permissions to specified users/group for a Process object in CentraSite .
|
Enforce Unique Name | Ensures that the names of Application Server
objects, IS Server objects and IS Connection objects that are created in
CentraSite are unique.
|
Notify ARIS on Service Changes | Notifies the ARIS APG service endpoint when a
Service object (native or virtual) in CentraSite is updated.
|
Notify ARIS on Service Completion | Notifies the ARIS APG service endpoint when a
Service object (native or virtual) in CentraSite when a user changes the
state of the service to a "completed" lifecycle state (e.g, the
Productive state).
|
Notify ARIS on Service Deletion | Notifies the ARIS APG service endpoint when a
Service object (native or virtual) in CentraSite is deleted.
|
Reset Lifecycle State to Initial State | Resets the lifecycle state of a Process object if
it is republished from ARIS.
|
You use the following procedures to activate the predefined lifecycle models (LCM) and design/change-time policies used by ARIS.
When you install CentraSite, the lifecycle models and design/change-time policies are in the inactive state. To use CentraSite with ARIS, you must first activate the lifecycle models and policies using the procedures provided in this section.
Note:
The activation of the predefined lifecycle models (LCM) and
design/change-time policies used by ARIS is not supported if you are using a
CentraSite Community Edition license.
Use the following procedure to activate the lifecycle models and design/change-time policies for ARIS.
To activate the ARIS-related LCM and policies
Open CentraSite Control.
Activate the ARIS lifecycle models using the following steps:
Go to Administration > Lifecycles > Models.
Locate the lifecycle model called "BPM Process Lifecycle" and activate it using the procedure described in the section Activating a Lifecycle Model in the document Customizing Lifecycle Management.
Locate the lifecycle model called "Service Lifecycle" and activate it using the procedure described in the section Activating a Lifecycle Model in the document Customizing Lifecycle Management.
Activate the state-change policies using the following steps:
Go to Policies > Design/Change Time to display the policy list.
Enable the Show Predefined Policies option to display the predefined policies that CentraSite provides.
Activate each of the following policies using the procedure described in the topic Activating a Design/Change-Time Policy in the section Functional Scope of the document Working with Design/Change-Time Policies.
ARIS Release Processes
ARIS Delete Processes
ARIS Delete Services
ARIS webMethods Integration
Reset Lifecycle State to Initial State
For information about these policies, see The Design/Change-Time Policies that ARIS Uses.
Configure and activate each of the following policies using the procedure described in Configuring the ARIS Change-Notification Policies.
Notify ARIS on Service Changes
Notify ARIS on Service Completion
Notify ARIS on Service Deletion
For information about these policies, see The Design/Change-Time Policies that ARIS Uses.
Configure and activate the "Enforce Unique Name" using the procedure described in Configuring the Enforce Unique Name Policy.
For information about this policy, see The Design/Change-Time Policies that ARIS Uses.
Configure and activate the "Reset Lifecycle State to Initial State" using the procedure described in Configuring the Reset Lifecycle State to Initial State Policy.
For information about this policy, see The Design/Change-Time Policies that ARIS Uses.
Use the following procedure to configure the "Notify ARIS Service" action in the ARIS change-notification policies (i.e., the "Notify ARIS on Service Changes", "Notify ARIS on Service Completion" and "Notify ARIS on Service Deletion" policies). The change-notification policies inform the ARIS server of changes that have been made to objects in the registry that belong to ARIS.
To configure a change-notification policy
Go to Policies > Design/Change Time to display the policy list.
Enable the Show Predefined Policies option to display the predefined policies that CentraSite provides.
Click the policy that you want to configure.
Click the "Notify ARIS Service" action on the Actions tab to open the Edit Action Parameters page, and then do the following.
Set the following parameters:
HTTP Basic Auth
Enabled |
Boolean
Specifies whether the service is secured by Basic HTTP authentication.
If you enable this option, you can optionally specify the user ID and password that CentraSite is to submit when it invokes the service in the following parameters. If you leave these parameters empty, CentraSite will submit the credentials belonging to the user who triggered this policy action. |
|
HTTP Basic Auth
Username |
The user ID that you want CentraSite to submit for HTTP basic authentication (if you do not want CentraSite to submit the user ID of the user who triggered the policy). | |
HTTP Basic Auth
Password |
The password associated with the
user ID specified in HTTP Basic Auth Username .
|
|
SOAP Request
Message |
String The SOAP message that CentraSite is to submit to the ARIS service. The default message (shown below) includes substitution tokens that insert run-time data into the message. The substitution tokens are described in the documentation for the "Send Email Notification" action (see the section Built-In Actions for Design/Change-Time Policies in the document Built-In Design/Change-Time Actions Reference for details). You can use these substitution tokens to customize this message.
|
|
SOAP Action |
String The SOAP action that CentraSite will set in the message. If you do not set this parameter, CentraSite will set the SOAP action to the empty string. |
|
Connection Timeout (in
milliseconds) |
Number The length of time in milliseconds that CentraSite will wait for a response from the remote machine. If the timeout limit is exceeded, the policy action fails. | |
Content
Type |
String The value that CentraSite is to assign to the
Content-Type header in the SOAP request that it submits to the service.
Default: text/xml .
|
Click Save to save the parameter settings.
Click Save to save the updated policy.
Activate the policy using the procedure described in the topic Activating a Design/Change-Time Policy in the section Functional Scope of the document Working with Design/Change-Time Policies.
Use the following procedure to configure the "Enforce Unique Name" action in the "Enforce Unique Name" policy. This policy ensures that the names of the Application Server type objects that are created in CentraSite are unique.
To configure the Enforce Unique Name policy
Go to Policies > Design/Change Time to display the policy list.
Enable the Show Predefined Policies option to display the predefined policies that CentraSite provides.
Click the "Enforce Unique Name" policy.
Click the "Enforce Unique Name" action on the Actions tab to open the Edit Action Parameters page, and then do the following.
Set the following parameters:
Enforce Across
Organizations |
Boolean If this parameter is set to True, then the unique name requirement for Application Server type objects is enforced in all organizations defined in CentraSite. |
Allow Different
Versions |
Boolean If this parameter is set to True, then different versions of an Application Server type object can exist in CentraSite with same the name. |
The event scope of this action is:
PreCreate
PreUpdate
Click Save to save the parameter settings.
Click Save to save the updated policy.
Activate the policy using the procedure described in the topic Activating a Design/Change-Time Policy in the section Functional Scope of the document Working with Design/Change-Time Policies.
Use the following procedure to configure the "Set State" action in the "Reset Lifecycle State to Initial State" policy. This policy resets the lifecycle state of a Process object if it is republished from ARIS.
To configure the Reset Lifecycle State to Initial State policy
Go to Policies > Design/Change Time to display the policy list.
Enable the Show Predefined Policies option to display the predefined policies that CentraSite provides.
Click the "Reset Lifecycle State to Initial State" policy.
Click the "Set State" action on the Actions tab to open the Edit Action Parameters page, and then do the following.
Set the following parameter:
Change State
To |
String Set the parameter to any state of the "BPM Process Lifecycle" model. |
The event scope of this action is:
OnTrigger
Click Save to save the parameter setting.
Click Save to save the updated policy.
Activate the policy using the procedure described in the topic Activating a Design/Change-Time Policy in the section Functional Scope of the document Working with Design/Change-Time Policies.
InCentraSite, the ActivatePoliciesForARIS command-line utility can be used for:
Activate the lifecycle models and design/change-time policies that ARIS requires.
Configure the "Notify ARIS Service" action in the ARIS change-notification policies (i.e., the "Notify ARIS on Service Changes", "Notify ARIS on Service Completion" and "Notify ARIS on Service Deletion" policies). The change-notification policies inform the ARIS server of changes that have been made to objects in the registry that belong to ARIS.
Configure the "Enforce Unique Name" action in the "Enforce Unique Name" policy. This policy ensures that the names of the Application Server type objects that are created in CentraSite are unique.
Configure the "Set State" action in the "Reset Lifecycle State to Initial State" policy. This policy resets the lifecycle state of a Process object if it is republished from ARIS.
This is of a great usage for the Community edition of CentraSite as policies cannot be manipulated via its user interface.
Note:
To run the ActivatePoliciesForARIS utility, you must either have
access to the command line on the machine where the Software AG Runtime is installed or that system must be accessible
via HTTP.
Additionally, you must belong to the CentraSite Administrator role or a role
that has permission to manage system-wide lifecycle models and system-wide
design/change-time policies.
Use the following procedure to activate ARIS-related LCMs and Policies from a Java class:
To run the ActivatePoliciesForARIS command-line utility
Create a script file as described in Creating a Script File for Activating the ARIS LCM and Policies.
Execute the script file with the following parameters:
yourScriptFile -user yourCSUserID -password yourPassword [-url yourCSURL | [-h yourHostname -p yourPort]]
myScript -user jcallen -password j45Hk19a [-url
http://myserver:53305/CentraSite/CentraSite | [- h myserver -p
53305]]
Note:
If the registry/repository component is not running on the same
machine as the Software AG Runtime, or is running on a port
other than 53305, you must also include the -url parameter on the command line,
followed by the URL for the CentraSite registry/repository (e.g., -url
http://myserver:53305/CentraSite/CentraSite).
To activate ARIS-related LCMs and Policies, run the utility with the following input parameters:
Use the following procedure to ActivatePoliciesForARIS under Windows:
Open EnableARISIntegration.cmd in a text editor.
Add the following property statement:
<CentraSiteInstallDir>\utilities\ EnableARISIntegration.cmd -user <USERNAME> -password <PASSWORD> [-dburl <CENTRASITE-URL> | [-h <HOSTNAME> -p <PORT>]]
where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.
Use the following procedure to ActivatePoliciesForARIS under Windows:
Open EnableARISIntegration.sh in a text editor.
Add the following property statement:
<CentraSiteInstallDir>/utilities/ EnableARISIntegration.sh -user <USERNAME> -password <PASSWORD> [-dburl <CENTRASITE-URL> | -h <HOSTNAME> -p <PORT>]
where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.
The following table describes the complete set of input parameters that you can use with the ActivatePoliciesForARIS utility:
Parameter | Description |
---|---|
USERNAME | Required. Your CentraSite user ID. |
PASSWORD | Required. The password for your CentraSite user account. |
CENTRASITE-URL | The fully qualified URL for the CentraSite
registry/repository.
If you omit this parameter, the importer assumes that the
registry/repository resides at Note: |
HOSTNAME | The host name or IP address of the computer
where the CentraSite registry/repository component is running.
If you omit this parameter, the importer assumes that the
registry/repository is running on |
PORT | The port number on which the CentraSite
registry/repository is configured to listen for incoming requests.
If you omit this parameter, the importer assumes that the
registry/repository is listening on the default port, Note: |
The ActivatePoliciesForARIS utility is a Java class whose main() method executes when you execute ActivatePoliciesForARIS from the command line. To ensure that the CLASSPATH and other environment variables are set properly when you execute this utility, you must create a script file that calls ActivatePoliciesForARIS as described below.
Create a script file that looks as follows, if CentraSite is running under Windows.
@echo off
set JAVAEXE=
fullPathToJava.exeset REDIST=
CentraSiteHomeDirectory\redist
set ARISPATH=
CentraSiteHomeDirectory\rts\aris
set BASEDIR=%~dp0
cd /d %REDIST%
REM build CLASSPATH with all files from jar directory
set LOCAL_CLASSPATH=
for %%I in (".\*.jar") do call "
CentraSiteHomeDirectory\bin\cfg\lcp.cmd" %%I
set BASEDIR=%~dp0
cd /d %ARISPATH%
set ARIS_CLASSPATH=
for %%I in ("%ARISPATH%\*.jar") do call "
CentraSiteHomeDirectory\bin\cfg\lcp.cmd" %%I
set LOCAL_CLASSPATH=%LOCAL_CLASSPATH%;%ARIS_CLASSPATH%
cd /d %REDIST%
%JAVAEXE% -cp %LOCAL_CLASSPATH% com.centrasite.aris.util.ActivatePoliciesForARIS %*
cd /d %BASEDIR%
Example
@echo off
REM
REM Run ARIS LCM and Policy Activator
REM
set JAVAEXE=D:\Fix7\CentraSiteGE7\jdk1.5.0_12\bin\java
set REDIST=C:\SoftwareAG\CentraSite\redist
set ARISPATH=C:\SoftwareAG\CentraSite\rts\aris
set BASEDIR=%~dp0
cd /d %REDIST%
REM build CLASSPATH with all files from jar directory
set LOCAL_CLASSPATH=
for %%I in (".\*.jar") do call "C:\SoftwareAG\CentraSite\bin\cfg\lcp.cmd" %%I
set BASEDIR=%~dp0
cd /d %ARISPATH%
set ARIS_CLASSPATH=
for %%I in ("%ARISPATH%\*.jar") do call "C:\SoftwareAG\CentraSite\bin\cfg\lcp.cmd" %%I
set LOCAL_CLASSPATH=%LOCAL_CLASSPATH%;%ARIS_CLASSPATH%
cd /d %REDIST%
%JAVAEXE% -cp %LOCAL_CLASSPATH% com.centrasite.aris.util.ActivatePoliciesForARIS %*
cd /d %BASEDIR%
Create a script file that looks as follows if CentraSite is running under Unix.
set javaexe="fullPathToJava.exe"
set redist="CentraSiteHomeDirectory/redist"
set arispath="CentraSiteHomeDirectory/aris"
set mainjar="CentraSiteARISIntegration.jar" set delim='\:' cd "$redist" set cl="" foreach j ( `ls *.jar` ) if ($cl != "") set cl=${cl}${delim} set cl=${cl}${j} end set delim='\:' cd "$arispath" set acl="" foreach j ( `ls *.jar` ) if ($acl != "") set acl=${acl}${delim} set acl=${acl}${j} end setenv CLASSPATH ${mainjar}${delim}${cl}${acl} cd "$redist" $javaexe com.centrasite.aris.util.ActivatePoliciesForARIS $*
Example
#!/bin/csh
#
# Run ARIS LCM and Policy Activator
#
set javaexe="/.../softwareag/cjp/v16/bin/java"
set redist="/.../softwareag/CentraSite/redist"
set arispath="/.../softwareag/CentraSite/rts/aris"
set mainjar="CentraSiteARISIntegration.jar"
set delim='\:'
# build CLASSPATH with all files from jar directory
cd "$redist"
set cl=""
foreach j ( `ls *.jar` )
if ($cl != "") set cl=${cl}${delim}
set cl=${cl}${j}
end
set delim='\:'
cd "$arispath"
set acl=""
foreach j ( `ls *.jar` )
if ($acl != "") set acl=${acl}${delim}
set acl=${acl}${j}
end
setenv CLASSPATH ${mainjar}${delim}${cl}${acl}
cd "$redist"
$javaexe com.centrasite.aris.util.ActivatePoliciesForARIS $*
CentraSite provides Web service operations for provisioning the Integration Server (IS) services and Web services into ARIS Architect.
The Web service operations filter Integration Server (IS) Services that are classified under the concept called “WMAssetType ->ReusableAsset". An Integration Server service is classified under this concept, when the Reuse property value is set to public in Designer. This helps in filtering the default Integration Server services (example wMPublic), if they are published to CentraSite.
Following are the list of Web service operations that help in provisioning CentraSite services into ARIS:
findAllServices
getAllAssociatedServices
getAllServiceDetails
These operations are part of SearchService (Web service).
Each of these operations have their object types differentiated using a property element that comes as part of the response payload as below.
<ns5:property>
<name>ServiceType</name>
<value>IS
Service</value>
</ns5:property>
<ns5:property>
<name>ServiceType</name>
<value>Service</value>
</ns5:property>