Common Fields
This section describes all the common fields with examples.
| Field Name | Description |
|---|---|
| Application Name | The name of consumer application that sends log data including Audit logs and Exception events to View log. This field is auto-populated based on the prior registration done with the platform support/services team.
For example, Bulk upload, ClinPhone 4, Calyx EDC, InSights, and other services. |
| Application ID | The consumer applications need to contact platform support/services team to register their application to generate Application ID. Only the registered applications can send their log data to View log.
The consumer application needs to send only the Application ID. The View log will auto-populate the Application Name based on the prior registration done with the platform support/services team for the app name. For example, Bulk upload - BDL, ClinPhone 4 - CP4, Calyx EDC - EDC, InSights - IST and other application IDs. |
| Client Name | This field uniquely identifies the client organization that uses the professional software application support/service for Calyx products and that this transaction is generated by:
For example, Parexel, Novartis, Pfizer, GlaxoSmithKline, Sanofi, Bayer and other client names. |
| Client ID | A unique identifier assigned to the client organization that uses the professional software application support/service for Calyx products and that this transaction is related to
For example, Parexel - PXL, Novartis - NVS, Pfizer - PZR, GlaxoSmithKline - GSK, Sanofi - SNF, Bayer - BYR and other client IDs. |
| Component Name | A Component is an independent deployable part of a distributed/microservices application. It uniquely identifies a specific component inside the software application that had either produced or consumed an event. A software component software package, a web service, a web resource, or a module that encapsulates a set of related functions (or data). Developers and operations teams have code-level visibility or access to telemetry generated by these application components.
For example, Views, Models, Controllers, Data Access Objects, Services, Plugins, APIs and other component names. |
| Component ID | It is a unique ID assigned to the software application Component Name that had either produced or consumed an event. |
| Correlation ID | A Correlation ID is a unique and randomly generated identifier value added to every request and response that allows reference to a particular transaction or event chain. When the data to be conveyed spans several messages, a Sequence Identifier enables the receiver to reconstruct the original data accurately.
In a microservice architecture, the initial Correlation ID is passed to your sub-processes. If a sub-system also makes sub-requests, it will also give the Correlation ID to those systems. |
| Description | This field provides high-level details of an event which user is monitoring. This could be the exception encountered or the purpose of the audit event that occurred. |
| Event ID | It is an application-defined unique ID to identify an event that has triggered the process. |
| Message ID | The message ID is an application-defined value that uniquely identifies the message and its payload. Every message that is passed between the components can be identified using a unique message ID. If any component modifies the message, the component should create a new message ID replacing the original one.
The identifier is a free-form string and can reflect a GUID or an identifier derived from the application context. |
| Product Group |
Represents Calyx product group to which the application belongs to and initiating an event such as Integration, CTMS, IRT, RIM, MI, and EDC. |
| Reference ID | It is an ID that contains unique information about the consumer applications and useful when you search for the job.
For example, Bulk upload uses Job ID as unique identifier assigned to each uploading job and tracks the job status. |
| Study ID | A unique number or unique combination of characters, numbers, and/or symbols is used to identify a clinical study being conducted at the trial site. It represents as part of the application used at the trial site for which an event has occurred.
E.g., 20070782, AS0006, D4191C00001, MI006, PCYC1143CA |
| Timestamp | The time the event is generated is based on the provider's UTC. The preferred format for display is: DD-MMM-YYYY, hh:mm:ss AM/PM based on the 12-hour clock representation.
E.g., 19-Jan-2021, 3:26:18 PM |
| Transaction ID | A transaction is an interaction that got initiated to perform any business operation between two or more systems. e.g., an API that involves a sending party of the transaction and a receiving party that processes the transaction and sends a response back.
The Transaction ID, a GUID format, is a unique identifier used to track the overall transaction used to track transaction across the stack where multiple systems process it. E.g., 1bc934e6-aabc-478c-b6b1-3912d9525088; |
| Type | It is the categorization of an Audit log or an exception type.
E.g., Audit log - log entry, request, response, event, input, output, etc. Exception - Business, Validation, DatabaseException, ParsingException, etc. |
| User ID | Uniquely Identifies the user who had initiated the transaction. |