Integrations
How external systems connect to and interact with IM
Integration Map
SOAP 1.1 / HTTP Real-time (per order) OM sends work orders to IM when a customer order is created or modified. Uses the EgyptWorkSheetAll endpoint. IM is the consumer.
Proprietary sync Periodic (scheduled) IM synchronizes zone, sector, ADSL exchange, and port data from Matrix. Described in IM-Matrix ISD. IM is the consumer during sync, and can push activation commands via AM.
Proprietary sync Periodic (scheduled) Same as Matrix but for FTTH โ OLTs, ONTs, VLANs, compounds. Described in IM-eMatrix ISD.
LDAPs Per login Optional AD authentication mode. IM queries AD to verify user passwords when AD auth is configured. User accounts must still exist in IM's local DB.
N/A N/A IM does not connect directly to CRM or Self-Care. CRM โ OM โ IM is the required path. Telecom Egypt is responsible for network connectivity between all systems.
Calling IM from OM โ Quick Start
# IM SOAP WebService
Host: http://<IM_SERVER_HOST>:<PORT>/services/EgyptWorkSheetAll
Method: POST
Headers:
Content-Type: text/xml; charset=gb2312
SOAPAction: ""
Key integration points for OM developers
- 1. Wrap all field values in a
<form>...</form>block inside CDATA - 2. Set
encoding="gb2312"in the XML declaration (not UTF-8) - 3. Include
flowIdโ used as idempotency key, duplicate flowIds return errorCode -1003 - 4. OM must send ALL parameters regardless of service type โ empty strings are fine
- 5. Always check
returnCodein the response, not just HTTP status - 6. Implement retrial with exponential backoff on errorCode -9999
Network Requirements
Network connectivity is Telecom Egypt's responsibility
- โข DCN (Data Communication Network) with VPN and firewall policies between all OSS servers
- โข NBI (North Bound Interface) licenses for Matrix and eMatrix
- โข Network path from IM servers to AD/LDAP for authentication
- โข Engineers available on Matrix/eMatrix side during UAT and commercial launch
Retrial Mechanism
IM supports configurable retry logic per integration point:
- โขOne configuration file per interface (OM, Matrix, eMatrix, etc.)
- โขConfigurable: number of retries and interval between each retry
- โขHuawei provides the configuration guide after development and before deployment
- โขDuplicate flowId retries are safe โ IM is idempotent for the same flowId