Technical Specification Interfaces PI

[Former Member]

Hi, first of all, thank you very much for the support I can provide.

I have developed a set of interfaces, but now I need to make the documentation of the technical specification of the interfaces developed. If there is not a standard in the IP documentation I can provide for the technical specification.

thank you very much.

Daniel

[Former Member · Accepted solution]

As many SDN'ers have suggested here. The format of tech spec is different for every project and clients.

Typically, these formats are decided before the build phase starts.

However, following information is most certainly available in most of the formats:

Section I: Initial Information Requirements

General Information

Involved Systems, Message Communication and Interfaces

Involved Systems

Message Communication

Interfaces

Section II: Technical Development Concept

General Information

Overall Process Description

Enterprise Service Repository Objects

Data Types

Message Types

External Definition

Imported Archive

Imported Objects

Service Interfaces

Java Archive

Message Mappings

Function Library

Operation Mappings

Integration Process

Integration Scenario

BPM Processing Details

Container Variables

Integration Directory

Sender Configuration

Receiver Configuration

Receiver Determination

Interface Determination

Sender Agreement

Receiver Agreement

Direct Connections

Integrated Configurations (AAE)

File Archiving Mechanism

Security & Authorization Configurations

IDoc Port Configurations (for IDoc Inbound/Outbound scenarios)

COMMON Services

PI PatTERNS IDENTIFIED

Section III: Operational Support

Monitoring

Other Configurations

Error Handling within PI

Test Cycle u2013 Unit Test

Transport Number(s)

Cutover Activities

Contacts to Solution Owner

Outstanding Issues

**Apart from this make sure you have the PI standards and naming convention guide specific for your project before you start working on build and TD.

Edited by: Puneet Singhal on Oct 5, 2011 8:26 AM

[Former Member · Accepted solution]

Thanks.

[raviteja_satuluri · Accepted solution]

Hi Puneet,

Nice explanation

can u please provide one One Template as for référence

it may greatful to me..

Thanks in advance

regards,

Ravi

[naveen_chichili]

Hello,

This completely depends on your project/client ...better i suggest you to ask if they have any specific template/format and proceed with the same.

Rgds,

Naveen

[Former Member]

Hi,

Technical Spec format will be different from different projects. You can get the sample format form your client or from your senior leads.

Thanks,

Madhu

[prasanthi_chavala]

Hello,

I am not sure if there is such standard technical document is available or not. Normally dev team will follow the project/client specific standards documentation for any development objects. For PI technical specific doc you can cover the below points:

--> overview of the design

--> highlevel description of the interface (include src and tgt system details)

--> components developed for the interfaces (you can specifiy all ur IR & ID objects)

--> Assumptions etc.....

Thanks,

Prasanthi.