- 4 Minutes to read
- Print
- DarkLight
- PDF
October 19 Release Notes
- 4 Minutes to read
- Print
- DarkLight
- PDF
Modeling: Add-Ins for SpotlightXL and SpotlightXL/Spotlight for Office Available
Please access the Install (SpotlightXL and Spotlight for Office Installation) guide for information to upgrade your existing client software.
Modeling: Enhanced Workflow and External Source Model Flexibility
We’ve made External Source Model (ESM) functionality more flexible by providing the ability to update an ESM by adding new fields, and deleting unwanted fields AFTER the data is loaded and the map(s) and view(s) are defined. This functionality is already available for Master and Analytics models but was not available for ESM models until this release.
Prior to this release, the workflow process to modify fields in an ESM required you to recreate the model.
In Practice: Adding a Field to an ESM
Let’s say you set up an ESM definition (on the Source Model page accessed by navigating to Model > External Source Model > Source Model).
Now, let’s say you want to add a field called Status to the ESM Source definition as shown below.
Navigate to Model > External Source Model > Source Model and select the ESM you want to add the field to.
Enter the new field and select the Type as well as whether or not it will be included in the data load. There is no need to delete maps and views to perform this step. The map and views associated remain unchanged.
Save and navigate to the Source Map page (Model > External Source Model > Source Map).
Select the additional field and complete the Maps To, Target Dimension and Target Member fields. Then, Save.
Navigate to the Model > External Source Model > Source Data page, the field will be available to load data against.
In Practice: Deleting an ESM Field
To delete a field from an ESM:
Navigate to the Source Map page (Model > External Source Model > Source Map) and delete the field from the map.
Navigate to the Source Model page (Model > External Source Model > Source Model) and delete the field from the source model definition and save.
Modeling: Support for the Value() Function in ESMs
You can now use this Value() function both in SpotlightXL and Spotlight (web interface) when creating an External Source Model (ESM). On the Source Model setup page (accessed by navigating to Model > External Source Model > Source Model) , you can use the Value function to convert a text string (a number, date, or time format) that represents a number to a numeric value.
An example of the Value function is shown below.
On the ESM Source Data - data load page (accessed by navigating to Model > External Source Model > Source Data) the Review_data field from the Source Model setup page is displayed with the result of the Value () function. The data is not a text value, but rather a numeric value.
Modeling: Support for the Loading of Display Label in the Append Dimension Members API
You now have the ability to load Code and Display Label (as an optional parameter) using the Append Dimension Members API.
Append Dimension Members (Master and Analytic Models)
POST /modeling/model/member/append HTTP/1.1
Content-Type: application/xml
Accept: application/xml
X-ACCESS-TOKEN:
<?xml version="1.0" encoding="UTF-8"?>
<append-member-payload>
<model-name>$ModelName</model-name>
<dimension-name>$DimensionName</dimension-name>
<delimiter>$Delimiter</delimiter>
<hierarchy>$ParentChildHierarchyPlusOperatorLabel</hierarchy>
<dimension-member>$DimensionMemberPlusOperatorLabel</dimension-member>
… add more dimension members if needed
</append-member-payload>
Parameters
@@ - Delimiter
$ModelName: (type: string) Name of the model. If the model specified does not exist, the operation is canceled.
$DimensionName: (type: string) Name of the Dimension that is associated with this model. If the dimension specified does not exist, the operation is canceled.
$Parent@@Child@@Operator@@label: Specify the location of the child member, parent member , rollup operator and label delimited by delimiter string(@@)
DimensionMemberPlusOperatorlabel: Specify the new dimension member, its parent , rollup operator land label delimited by delimiter string in the same order as specified in the hierarchy tag. Add multiple dimension members using different dimension-member tags.
Sample Payload
<?xml version="1.0" encoding="UTF-8"?>
<append-member-payload>
<model-name>Operating Expense</model-name>
<dimension-name>Account</dimension-name>
<delimiter>@@</delimiter>
<hierarchy>parent@@child@@operator@@label</hierarchy>
<dimension-member>Account@@Income Statement@@~@@Jan2010
Income</dimension-member>
<dimension-member>Income Statement@@Income Statement 100@@+@@Feb2019
Income</dimension-member>
</append-member-payload>
Response
Success Response
HTTP/1.1 204 OK
Error Responses
Service Not Available (Possibly due to maintenance)
HTTP/1.1 404 Not Found
One or more HTTP headers were missing
HTTP/1.1 412 Precondition Failed
Model/Dimension not found
HTTP/1.1 412 Precondition Failed
Unauthorized Access (Access key lookup failed)
HTTP/1.1 401 Unauthorized
Invalid XML (Bad Request)
HTTP/1.1 400 Bad Request
Modeling: ClearExternalSource Model Type Available in a Calculation
This Calculation Type clears all the data in an External Source Model (ESM) when included in a Calculation. This adds convenience and eliminates the need for additional steps.
In Practice:
Select the Model task and the Calculation subtask.
Select the ESM model from the Model list box.
Enter a name for the calculation.
For Type, select ClearExternalSourceModel (as shown in the image below).
Add additional Types based on actions you want performed on the model when the Calculation is executed and Run, then Save the Calculation.