Enterprise Services allows you to use existing TM1 processes or create custom processes to be published as web services.  These web services can then be used by applications to execute batch processing functions in the foreground, background depending on your application needs.   Processes can even be executed as an administrative user so that sensitive processes are not visible to users in the TM1 Perspectives or TM1Web environments.

 

With Enterprise Services, you can even create multiple web methods using the same TI process.  This allows you to create fewer and more generic TI processes that can be published to be used in applications in different ways.   For example, you can write a generic process that performs a data copy between scenarios, but expose the same process as CopyForecast, CopyBudget and CopyActuals web methods; each accepting different parameters.  This reduces maintenance and support of having three different, but similar TI processes defined in TM1.

Creating a Process

To create (publish) a process in Enterprise Services, simply click on the Processes section, and select an existing process.  

 

Processes Selection

 

This will open a new tab with the name of the view in the content section of the Manager and display the properties of the process similar to the image shown below.  

 

Process Properties

 

At this point, you can set the options required for this process and press the Save or Save As button at the bottom of the screen.   This will create a reference to the TM1 process  and store it in the Enterprise Services.  A published process will be reflected in the Object Navigation Section, denoted by a green world icon in the lower right corner.  

 

Note_200

NOTE:  Enterprise Services only creates a reference to the TI process; such that if the TI process is updated in TM1, it will be reflected immediately in Enterprise Services.

 

Views, subsets, processes, and chores must be named in accordance with XML web service naming conventions:

 

Names can contain letters, numbers, and other characters

Names cannot start with a number or punctuation character

Names cannot start with the letters XML (or XML, or XML, etc)

Names cannot contain spaces

 

Any name can be used, no words are reserved.  See http://www.w3schools.com/xml/xml_elements.asp for more details.

 

Deleting a Process

Deleting a process in Enterprise Services only removes the process definition it does not delete the process in TM1.    To delete a process in Enterprise Services, click on the process to be deleted.  When the properties are displayed in the content section,  simply click the Delete button.

 

Creating Custom Processes

Enterprise Services allows you take an existing process and customize it to open a whole new level of capability for that process.  Some of the flexibility of using custom processes include:

 

Assigning user-friendly parameter names.

Setting default parameter values.

Selecting only the parameters that you want to expose.

 

The simplest way to create a custom process is to start with an existing process in TM1 as the foundation for the custom process.  In this way, you only need to add options required for your specific applications.

hmtoggle_arrow1        Selecting a process.

Select a process by simply clicking on the name of the process that closely resembles the results you want to produce.

Processes Selection

hmtoggle_arrow1        Customizing default process parameters.

After a process has been selected, the Content section changes to display the Parameters as shown in the following example.

Process Properties

This process has three parameters: pEmployee, pDepartment and pTransferDate.

hmtoggle_arrow1        Use In Web Method

By placing a check in the box in the Use In Web Method column will indicate that the parameter will be available as a parameter in the web method.  When the parameter is exposed, the value can be supplied by the application.  

 

In the above example, all three parameters will be included in the web method.

hmtoggle_arrow1        Web Method Parameter Name

The Web Method Parameter Name column allows you to supply a name to be used as a web method parameter name different than what the TI process was created with.    This allows you to expose the web method with more friendly and more intelligible parameter names than what may be required in the TM1 system.

 

Process Change Parameter Name

 

In this example, the real TM1 process parameter is called pEmployee, but when this process is published to a web method, it will be created using the name EmployeeID.

 

You can enter default values for each parameter so that value will be used when a published web method is called and no other value is supplied for the related parameter.

In our example, if no value is specified for the pDimName parameter, "Employee" will be used as the value; if no value is specified for the pParentElem parameter, "Hourly Employees" will be used.

hmtoggle_arrow1        TI Parameter Name

This column displays the value defined in TI for the parameter.   This value is read-only and cannot be changed.

 

hmtoggle_arrow1        Parameter Type

The Parameter Type column displays the string or numeric variable type used to create the process in TM1.  This value is read-only and cannot be changed.

 

hmtoggle_arrow1        Default Value

The Default Value column is where you can specify what value is to be provided if the parameter has not been supplied by the application.   This is especially useful when the parameter is not exposed in the published process.

 

Process Default Value

 

In this example, if a department is not supplied, the value 'Unassigned' will be used as the dimension element to assign the employee to.

hmtoggle_arrow1        Running a process as administrator.

Sometimes you might want to execute a process that requires administrative privileges, such as when you do not want to expose sensitive processes to users, but the application needs to be able to perform the operation, CreateUser process, for example.

If you only want the process to be executed by a user with administrative privileges, simply click on the Run As Administrator check box, as shown below.  When this web method is used, Enterprise Services will log in as the user defined in the TM1 Administrative Credentials setting in the configuration screen during installation:

Process Administrative Credentials

 

hmtoggle_arrow1        Saving the process.

When you are ready to save the process as a custom process, simply click on Save As.   The name you save the process as will be the name of the published web method.