dspCompose

External Request Scenarios that Create ISA Requests

NOTE: Information Steward (IS) is SAP’s software for data profiling and metadata management. The Information Steward Accelerator by Syniti (ISA) extracts data that failed IS rules, then distributes the data to groups of users via reports.

An external request scenario can be configured to remediate failed data from IS reports using dspCompose™. Refer to Create a Request in dspCompose™ From the ISA Report Data Viewer Page for more information.

During the request creation process, the report data is copied to a staging table where dspCompose™ maps the columns and runs any custom rules (registered as template-level events) on the data. The data is then moved to the Data Entry table for the dspCompose™ template, and can be corrected by the first Data Entry role to begin the request posting process.

To use this type of external request scenario:

1. Run rules in IS. Refer to Information Steward documentation for more information.
2. Configure the ISA to distribute failed data to users in project distributions. Refer to Work with Projects for more information.
3. Create an External Request Scenario for an ISA Request in dspCompose™.
4. Map Columns from the Template to Columns from the ISA Report.
5. Create Custom Rules for ISA Requests, if needed.

The request is automatically created and dspCompose™ sends a notification to the user assigned to the first Data Entry role for the template. At this point, the request moves through the request process normally.

Create an External Request Scenario for an ISA Reques

NOTE: An external request scenario cannot be created for an active template.

NOTE: For the template that uses the ISA external request scenario that creates a request from an ISA report, there can only be one Role defined with the lowest Priority.

NOTE: For the template that uses the ISA external request scenario that creates a request from an ISA report, there cannot be an External Data role defined.

To create an external request scenario in dspCompose™ for an Information Steward-initiated request:

1. Click Team in the Navigation pane.
2. Click the Templates icon for a team.
3. Click the ISA External Request Scenarios icon for a template.

   NOTE: This icon does not display if the ISA is not installed and licensed.

   NOTE: If the template is not active and no scenarios have been created for this template, the page displays in add mode. Otherwise, click Add.

   NOTE: The Add button does not display if the template is active.

    View the field descriptions for the Template (ISA External Request Scenario) page

4. Enter a rule name (for exmaple, NoRegion) in the RULE ID field.
5. Enter the name of the ISA rule the scenario applies to (for example, Customers – Region) in the RULE BINDING ID field.
6. Enter a description, if other than the default, in the REQUEST DESCRIPTION FORMAT field.

   NOTE: The text entered in this field displays on the Request page in the DESCRIPTION field for a request created from this external request scenario. The field defaults to Request from ISA - #Date#; the actual Date value will be substituted in the DESCRIPTION field when the request is created.

   NOTE: A value preceded and followed by # is a dynamic substitution value for replacement at run time  A user can add these variables to the description:

    #ISAProjectID# - ISAProjectID (ISA Project ID)

    #ISARuleBindingID# - ISARuleBindingID (ISA Rule Binding ID)

   #ISARuleID# - ISARuleID (ISA Rule ID)

   #RuleID# - ExternalRequestAlias (Rule ID)

   #RuleBindingID# - Scenario (Rule Binding ID)

   #RequestConnectionID# - RequestConnectionID (RequestConnectionID)

7. Click Save; the Vertical View displays.
8. Select the name of the project that contains the rule from the ISA Project ID list box.

   NOTE: All projects that exist in the ISA display.

9. Select the rule binding from the ISA Rule Binding ID list box.

   NOTE: Only rule bindings associated with the project in the ISA Project ID list box display.

10. Select a data source, if other than the default data source, where the staging table will be created in the Staging Data Source ID list box.

    NOTE: The Staging Data Source ID is populated with a default data source, but the value may be changed. This staging data source must be registered in the platform.

11. Enter the table name, if other than the default, for the staging table in the Staging Table Name field.

    NOTE: The staging table name is created automatically using the naming convention st[Template Name] [Scenario]_ISAStaging. This table name can be changed.

    NOTE: Data is moved from the ISA report to this staging table where custom rules can then be run against the data before the data is moved to the Data Entry table of a request.

12. Click Save.

    NOTE: Once the record is saved, the ISA Rule ID field displays the ISA Rule Binding Description. Refer to Edit Rule Binding Descriptions for more information.

13. Click the Connections icon to select a connection to the target system for each process template used in the scenario.

    NOTE: The connection is used to post the data during the posting role. dspCompose™ can post to multiple instances of the target system.

    NOTE: The Process Templates for which a connection can be set are based on:

    • The Integrate template type. Refer to Create a Basic Template in Integrate for more information.
    • The "Allowed Connections" configured at the Integrate Process Template level. Refer to Set Available Connections at the Process Template Level in integrate for more information.
14. Click Edit.
15. Select the connection from the CONNECTION ID list box.

    NOTE: If a user adds a request based on this template and does not select a connection ID, the default connection assigned to the Integrate Template is used for the request. Refer to Establish a Connection to a Target System for more information.

16. Click Save.
17. Return to the Template (External Request Scenario) page’s Vertical View.
18. Click the Build Staging Area icon.

    NOTE: If this template has not been generated, this icon is disabled.

    NOTE: A report for the chosen ISA Rule Binding ID must have been run in ISA before that staging table can be built.

19. Click OK.

NOTE: dspCompose™ creates a staging table in the Staging Data Source database. The column names in the table match the column names listed on the Report Data Viewer page for the associated ISA report.

NOTE: In some cases, the staging table may need to be rebuilt. Clear the staging table by clicking Clear Staging Area, then click Build Staging Area.

Refer to Map Columns from the Template to Columns from the ISA Report to continue configuring the external request scenario.

Map Columns from the Template to Columns from the ISA Report

NOTE: During the request creation process, columns from the ISA report are mapped to columns in the staging table. The template must have already been recorded and generated to map columns. Generate a template on the Vertical View of the Templates page on the General tab.

Once an external request scenario for an Information Steward-initiated request has been created and the staging table has been built, the columns in the template must be mapped to columns in the staging table; staging table columns are the same columns as in the ISA report.

As a result of the mapping, when the ISA report is processed and the request data is moved from the staging table to the table used for the Data Entry role for the request, it is either:

• Copied from the staging table to the table used for the Data Entry role for the request or
• Replaced by a fixed value

NOTE: If a template uses an external request scenario that creates Information Steward-initiated requests, that template cannot be activated until at least one of the columns in the staging table has been mapped to a template column on the Template (External Request Scenario Column) page.

To map columns in the staging table to template columns:

1. Select Team in the Navigation pane.
2. Click Templates for a team.
3. Click ISA External Request Scenarios for a template.
4. Click Vertical View for the scenario.

5. Click Map Columns.

   NOTE: The Map Columns icon is only active after the template has been generated. Generate a template on the Templates page’s Vertical View on the General tab.

   NOTE: See the following two sets of steps for instructions to map a column from the staging table to a column in the template or to map a fixed value to the template column.

To map a column from the staging table to a column in the template:

1. From the Template (External Request Scenario Column) page, click Edit for a COLUMN NAME

   View the field descriptions for the Template (External Request Scenario Column) page

   NOTE: The COLUMN NAME is the name of the table’s column in the template.

2. Select a column from the STAGING COLUMN NAME list box.

   NOTE: The options in the STAGING COLUMN NAME list box are the column names from the ISA report.

3. Click Save.

To map a column from the staging table to a fixed value:

1. From the Template (External Request Scenario Column) page, click Edit for a COLUMN NAME.

   View the field descriptions for the Template (External Request Scenario Column) page

   NOTE: The COLUMN NAME is the name of the table’s column in the template.

2. Click the STAGING COLUMN NAME list box.

3. Enter the fixed value in the filter field that displays above the options.

   NOTE: A fixed value must be surrounded by single quotation marks (e.g., ‘10’).

4. Press the Enter key.
5. Click Save.

When processing data from an ISA report for an Information Steward-initiated request, the request uses the fixed value for this column in the table used for the first Data Entry role for the request.

Refer to Create a Request in dspCompose™ from the ISA Report Data Viewer Page for more information.

Create Custom Rules for ISA Requests

Rules are stored procedures that have been written and saved in a data source that is registered in the DSP®. A rule runs during a process to manipulate data, perform an extra step in the process, or finish a task the process starts. For example, a rule could dictate that once table A has been populated with 1000 rows of data, that data is archived in table B and removed from table A.

dspCompose™ allows a Template Administrator to register custom rules that will run when a template-level event occurs. A rule is set to run when a request is canceled, created, deleted, or posted based on how that request’s template is configured.

A rule can also be registered to the Request ISA Create event for requests that are initiated by an Information Steward report. Once an event occurs in Information Steward to create a dspCompose™ request, the request data is loaded into a staging table. Rules can then be run on the data before it is moved to the table used for the Data Entry role for the request.

These custom rules must exist in a data source that is registered in the platform (often in the cMass_Data database), and be registered to the template-level event on the Template (Event Rule) page.

Refer to Register Rules to Template-level Events for details on how to create custom rules for Information Steward-initiated requests.