| Status | |
|---|---|
| Owner | |
| Stakeholders | The business stakeholders involved in making, reviewing, and endorsing this decision. Type @ to mention people by name |
Purpose
The purpose of this document is to define the conversion approach to create Permit to Work - Work Permit Template in S/4 HANA.
Permit to Work in Work Clearance Management (WCM) provides a systematic approach in controlling and executing the operational and maintenance activities safely and efficiently in a worksite. The Permit to Work solution helps to manage the risks inherent to hazardous tasks and ensure that the necessary precautions are put in place to improve the safety of personnel, plant, and the environment.
To provide authorization for jobs that require high-risk activities, Permit to Work provides Work Permit, a formal printed document with the description of the work, the requirements to be fulfilled, and the safety measures to be followed. A work permit authorizes the receiver to carry out the specified work at the specified time and acts as an agreement between the issuer and the receiver about the conditions, risks, and precautions involved.
A Work Permit Template provides a predesigned structure that can be used to create work permits in a consistent format. Creating work permits using a template allows you to simplify and streamline the work permit generation process.
Conversion Scope
The scope of this document covers the approach for creating Work Permit Template into S/4HANA following the Permit to Work Template Master Data Design Standard.
List of source systems and approximate number of records
| Source | Scope | Source Approx No. of Records | Target System | Target Approx No. of Records |
|---|---|---|---|---|
DCT | This object is collection, so no relevancy criteria is applicable. For all sites implementing Work Permit solution in SyWay, Work Permit Template will be collected directly in DCT | N/A | S/4 HANA | <to be updated based on confirmation from functional team> |
Additional Information
Multi-language Requirement
Summarize Multi-language Requirement/s, if any
Document Management
Summarize Document Management requirement, if any
Legal Requirement
Summarize Legal Requirement/s, if any
Special Requirements
Specify any special requirements or considerations that may impact the data conversion process based on specific locations, regulatory compliance or system limitations. Clearly outline any regional or localization requirements such as country-specific data formats, legal reporting obligations or industry standards that must be adhered to (e.g., localization rules for countries like China).
If the data conversion involves third-party systems or external data sources, such as Icertis, describe any additional requirements related to data mapping, transformation logic, validation rules or security measures that must be followed.
Target Design
Work Permit Template Data strictly adheres to the Master Data Standard. The complete information of the key fields that hold the Permit to Work Template information follows the Master Data Standard document <include hyperlink>.
Work Permit Template is managed using Fiori Application and the data sits within CDS views. The technical design of the target for this conversion approach.
- General Information (View - IWRKPMTTEMPLATE)
- Nature of Work (View- IWRKPERMITNOW)
- Object List (View - ITECHOBJLIST)
- Safety Requirements
- Safety Precautions (View - IWRKPERMITSPR)
- Personal Protective Equipment (View - IWRKPERMITPPE)
- Partners - (View - IPERMITPARTNER)
- Approvals (View - IWPMAPPROVAL)
| Table | Field | Data Element | Field Description | Data Type | Length | Requirement |
|---|---|---|---|---|---|---|
| MARA | MATNR | MATNR | Material Number | CHAR | 18 | Mandatory |
Data Cleansing
Work Permit Template doesn't exist in legacy and therefore data cleansing is not applicable.
Data for Work Permit Template will be populated directly in the Data Collection Template (DCT) and any data refinement required will be performed as part of the construction activity.
If data cleansing is managed outside of the source system (e.g. Syniti Migrate, 3rd Party Vendor, DCT), the necessary documentation must be produced and appended to this deliverable for sign-off.
| ID | Criticality | Error Message/Report Description | Rule | Output | Source System |
|---|---|---|---|---|---|
| NA |
Conversion Process
The high-level process for DCT is represented by the diagram below:
Data Privacy and Sensitivity
Collection will be done manually in the Data Collection Template for A2D In-scope Planning Plants
Extraction
Data extraction not applicable as data doesn't exist in legacy.
Extraction Run Sheet
| Req # | Requirement Description | Team Responsible |
|---|---|---|
| NA |
Selection Screen
If applicable, this section will give the details on any selection screen parameters, including the parameter type, that are required to be entered to ensure consistent data extracts.| Selection Ref Screen | Parameter Name | Selection Type | Requirement | Value to be entered/set |
|---|---|---|---|---|
| NA |
Data Collection Template (DCT)
Target Ready Data Collection Template will be created for Permit to Work Template data with exception of some fields which require transformation as mentioned in the transformation rule.Permit to Work Template DCT Rules <To add more info below later>
| Field Name | Field Description | Rule |
|---|---|---|
Extraction Dependencies
List the steps that need to occur before extraction can commence
| Item # | Step Description | Team Responsible |
|---|---|---|
| NA |
Transformation
The Target fields are mapped to the applicable Legacy field that will be its source, this is a 3-way activity involving the Business, Functional team and Data team. This identifies the transformation activity required to allow Syniti Migrate to make the data Target ready:
- Perform value mapping and data transformation rules.
- Legacy values are mapped to the to-be values (this could include a default value)
- Values are transformed according to the rules defined in Syniti Migrate
- Prepare target-ready data in the structure and format that is required for loading via prescribed Load Tool. This step also produces the load data ready for business to perform Pre-load Data Validation
Transformation Run Sheet
| Item # | Step Description | Team Responsible |
|---|---|---|
1 | Obtain DCT Sign-off from Business. | SyWay Data Team |
2 | In dspMigrate, select the wave –R3 S4/HANA – Plant Maintenance | Syniti |
3 | Go to Process Area Launch and Process the Object – Work Permit Template | Syniti |
4 | Review and Validate Error and Preload Reports | Syniti |
5 | Execute the transformation to prepare the target tables | Syniti |
6 | Validate data from pre-load and error reports | Business/Data owner |
7 | Generate load files | SyWay Data Team |
Transformation Rules
| Rule # | Source system | Source Table | Source Field | Source Description | Target System | Target Table | Target Field | Target Description | Transformation Logic |
|---|---|---|---|---|---|---|---|---|---|
List of Custom Target Reports for this object is maintained here: Conversion Specification - Custom Reports Register.
Transformation Mapping
Use the exact name and reference this section in the “Transformation rules” above| Mapping Table Name | Mapping Table Description |
|---|---|
Transformation Dependencies
List the steps that need to occur before transformation can commence| Item # | Step Description | Team Responsible |
|---|---|---|
| 1 | Ensure DCT tables completeness | Syniti |
| 2 | Ensure all Transformation mappings are up to date. | Syniti |
Pre-Load Validation
Project Team
The following pre-load validations will be performed by the Project Team.Completeness
| Task | Action |
|---|---|
| Verify Record Count | Data team to verify that the total number of relevant records from the source systems is equal to the total number of records in the Preload and Load Sheets. |
Accuracy
| Task | Action |
|---|---|
| Conversion Accuracy | Data team to verify that all fields below meet pass the checks: 1. Mandatory Fields 2. Field and Value Mapping Correctness 3. Null Checks 4. Text Length Checks |
| Review Error Reports | Review and correct the errors. Achieve a zero-error record count as much as possible. Raise defects for data remediated and requiring a correction in the source data. |
Business
The following pre-load validations will be performed by the business.Completeness
| Task | Action |
|---|---|
| Verify Record Count | Business team to verify that the total number of relevant records from the source systems is equal to the total number of records in the Preload and Load Sheets. |
Accuracy
| Task | Action |
|---|---|
| Conversion Accuracy | Business to verify that all the data in the load table/file is accurate as per endorsed transformation/mapping rules (and signed-off data) |
Load
Custom Load tool will be used to upload the Work Permit Template. The load tool should replicate data creation method under class CL_WCM_PTW_HELPER_ROOT to accommodate upload of all the necessary data sets.
Load Run Sheet
| Item # | Step Description | Team Responsible |
|---|---|---|
1 | Ensure Pre-load sign-offs are obtained. | SyWay Data team |
2 | Go to the load tool and select the correct load Program. | SyWay Data team |
3 | Proceed with Data load. | SyWay Data team |
4 | Validate few records loaded by accessing standard transactions. | SyWay Data team |
5 | Generate the post load reports in the tool. | SyWay Data team |
6 | Log errors as defects, if any and address resolutions. Close defects. | SyWay Data team |
7 | Resolve defects by re-upload and re-generate post load reports if necessary. | SyWay Data team |
8 | Business to validate the post load files as part of post-load validation, raise data defects or provide the post-load sign-off. | Business |
9 | Repeat steps 5 to 7 if necessary. | SyWay Data team |
Load Phase and Dependencies
Pre-Cutover
Configuration
List the Configurations required before loading can commence
| Item # | Configuration Item |
|---|---|
| 1 | Authorisation Groups |
| 2 | Nature of Work |
| 3 | Personal Protective Equipment |
| 4 | Safety Precautions |
| 5 | Approval Categories |
| 6 | Approval Types |
| 7 | Work Permit Type |
| 8 | Work Permit Template Types |
Conversion Objects
| Object # | Preceding Object Conversion Approach |
|---|---|
| 1002 | Equipment |
| 1003 | Functional Location |
| 1006 | Work Center |
| 3001 | Business Partner - Employee (BUP003) |
Error Handling
The table below depicts some possible system errors for this data object during data load. All data load error is to be logged as defect and managed within the Defect Management
| Error Type | Error Description | Action Taken |
|---|---|---|
Post-Load Validation
Project Team
The following post-load validations will be performed by the Project Team.Completeness
| Task | Action |
|---|---|
Verify Count | Data team to verify the record count created in target S/4 HANA by accessing post load reports in dspMigrate or standard reports from S/4 HANA. |
Verify Logs | Check if there is data that failed to load and perform the necessary actions (e.g. register as post load issue, or attempt to load the record again, etc.). |
Accuracy
| Task | Action |
|---|---|
Conversion Accuracy | Data team to verify that the Work Permit Template data in target S/4 HANA were loaded correctly via dspMigrate post load reports or standard reports from S/4 HANA. |
Business
The following post-load validations will be performed by the business.Completeness
| Task | Action |
|---|---|
Verify Count | Download Post Load Reports from dspMigrate and verify that the record count loaded in the target S/4 HANA is the same count as of the endorsed load file. |
Accuracy
| Task | Action |
|---|---|
Conversion Accuracy | Verify that the Work Permit Template data in target S/4 HANA were loaded correctly via dspMigrate post load reports or standard reports from S/4 HANA. |
Key Assumptions
- Master Data Standard is up to date as on the date of documenting this conversion approach and data load.
- Permit to Work Template is in scope based on data design and any exception requested by business.
Any additional key assumptions.
See also
Insert links and references to other documents which are relevant when trying to understand this decision and its implications. Other decisions are often impacted, so it's good to list them here with links. Attachments are also possible but dangerous as they are static documents and not updated by their authors.