您的合同管理数据模板

DocuSign CLM

← 返回改进指南

合同管理属性(19) 合同管理活动(15) 提取指南(1)

您的合同管理数据模板

此模板概述了分析合同管理流程所需的关键数据，列出应收集的核心属性、应跟踪的主要活动，并提供实用的数据提取指南。使用此模板可确保收集流程发现与优化所需的数据。

建议收集的属性
需要跟踪的关键活动
数据提取指南

刚接触事件日志？了解如何创建流程挖掘事件日志.

下载模板

合同管理属性

为全面分析合同管理流程，建议在事件日志中纳入以下数据字段。

5 必填 7 建议填写 7 选填

	名称	说明
	合同ID ContractId	系统中每份合同的唯一标识符。
说明合同ID是确定案例身份的唯一标识符，可将合同从创建到结束的所有相关事件和活动关联起来。在DocuSign CLM中，它可能对应信封ID或自定义合同标识字段。此属性对于流程挖掘至关重要，因为它可以还原每份合同的端到端历程。将所有相关活动归入同一个合同ID后，分析人员便能查看完整流程、衡量周期时间，并分析不同合同之间的差异。重要性这是关联所有相关流程事件的主键，可用于追踪和分析单份合同的完整生命周期。获取途径这通常是DocuSign CLM中合同或信封对象的主要标识符。它可能标记为信封ID，也可能是用于识别合同的自定义字段。示例 CON-2023-03-112MSA-4815162342NDA-CORP-9981
	开始时间 EventTime	表示某项活动或事件开始时间的时间戳。
说明此属性记录活动发生的准确日期和时间，是流程挖掘进行时间维度分析的基础。按开始时间排列事件后，即可为每个案例生成按时间顺序排列的日志，从而计算活动间的周期时间、各步骤的持续时间以及端到端流程的总时长。此属性对于识别瓶颈、衡量等待时间以及根据SLA评估流程效率至关重要。重要性此时间戳对于按时间顺序排列事件，以及计算周期时间和持续时间等所有基于时间的指标至关重要。获取途径此信息是DocuSign CLM中事件日志或审计跟踪的标准组成部分，与每条已记录的操作相关联。示例 2023-04-15T09:00:00Z2023-05-20T14:35:10Z2023-06-01T11:21:05Z
	活动 ActivityName	合同生命周期中发生的具体任务或事件名称。
说明此属性表示合同管理流程中的一个步骤或里程碑，例如“合同起草完成”“法务审核开始”或“合同签署完成”。这些活动构成流程图的基本要素。分析这些活动的顺序和频率是流程挖掘的基础，有助于识别实际流程路径、发现偏离标准过程的情况，并找出耗时最长或重复最频繁的活动。重要性此属性定义流程中的各个步骤，便于可视化和分析合同工作流、瓶颈及流程差异。获取途径此属性通常取自DocuSign CLM中的事件日志或审计跟踪数据，用于记录对合同文档或工作流执行的操作。示例起草合同开始内部审查发送给合同对方合同已执行
	最近数据更新时间 LastDataUpdate	源系统最近一次刷新或提取数据的时间戳。
说明此属性用于标明数据集最近一次更新的时间，帮助了解分析所用数据的新旧程度和时效性。在仪表板和报告中，这项信息对于数据治理和建立用户信任至关重要。它能帮助分析人员判断当前查看的是实时信息，还是某个特定时间点的数据快照，从而及时做出有依据的决策。重要性提供数据时效性的重要背景信息，让用户了解流程分析所依据的数据有多新。获取途径这是一个元数据属性，通常由ETL（提取、转换、加载）工具或数据管道在数据导入过程中生成并存储。示例 2023-10-26T08:00:00Z2023-10-27T08:00:00Z
	源系统 SourceSystem	标识数据提取自哪个系统。
说明此属性用于标明流程数据的来源。在此视图中，其值通常为“DocuSign CLM”或类似标识。在单一系统分析中，这一字段看似多余，但仍建议保留。合并多个系统的数据时，例如将CRM中的合同数据与DocuSign中的工作流数据结合，此字段对于确保数据来源清晰、可追溯至关重要。重要性确保数据可追溯，对于整合多个企业系统数据的分析至关重要。获取途径此属性通常是在数据提取和转换过程中添加的静态值，用于标记数据集的来源。示例 DocuSign CLMDocuSign CLM v24.1
	到期日期 ExpirationDate	合同约定的到期日期。
说明此属性记录合同到期日，是主动管理合同组合的重要元数据，尤其适用于经常性收入或长期服务协议。此日期是“合同续约与到期展望”仪表板的主要依据。通过监控即将到期的合同，组织可以及时启动续约工作流。此属性也是计算“按时续约率”KPI的重要数据来源，有助于避免收入流失和服务中断。重要性对于主动管理合同至关重要，有助于及时续约，避免合同意外失效。获取途径这是标准元数据字段，在DocuSign CLM中应为所有有明确期限的合同记录此信息。示例 2024-12-312025-06-302026-01-15
	合同状态 ContractStatus	合同在其生命周期中的当前状态。
说明此属性表示合同在某个时间点的整体状态，例如“草稿”“审核中”“等待签署”或“已签署”。它概括了合同当前所处的流程阶段。在流程挖掘中，分析合同状态有助于筛选案例，并创建跟踪各阶段合同数量的仪表板。“合同实时状态跟踪”仪表板直接使用此属性，展示当前合同组合的情况，并识别工作积压的位置。重要性概览合同进度，对于状态跟踪、工作量管理和识别瓶颈至关重要。获取途径此信息通常作为主要属性，保存在DocuSign CLM的合同对象或工作流对象中。示例草稿内部审查中等待签署已签署已终止
	合同相对方 Counterparty	参与合同的外部方，例如客户或供应商。
说明此属性用于标识参与协议的另一方组织。不同合同相对方的谈判方式、法律要求和响应时间可能不同，进而显著影响合同生命周期。按合同相对方分析流程绩效，有助于识别哪些合作伙伴易于协作，哪些经常造成延误。这些信息可用于改善关系管理，并为未来谈判设定合理预期。此属性也是“合同返工与修订频率”分析的重要维度。重要性帮助分析与不同外部方的协作如何影响谈判时间、修订次数和整体周期时间。获取途径此信息是合同记录的基本组成部分，通常存储在专门的“合同相对方名称”或“公司”字段中。示例 Acme CorporationGlobex Inc.Stark Industries
	合同类型 ContractType	合同的分类，例如NDA、MSA或SOW。
说明此属性根据合同的法律或业务用途对合同进行分类。不同类型的合同通常遵循不同的工作流，审批要求和复杂程度也各不相同。按合同类型细分流程分析，是了解绩效差异的基础。分析人员可以比较不同协议的周期时间、合规率和谈判情况。例如，NDA的周期时间应远短于复杂的主服务协议，而此属性可支持这类比较。重要性支持比较不同类别合同的流程绩效，因为各类合同通常有各自的工作流和复杂程度。获取途径这是一个重要的元数据字段，通常在DocuSign CLM中创建合同时从下拉列表中选择。示例保密协议（NDA）主服务协议（MSA）工作说明书（SOW）
	合同负责人 ContractOwner	负责在合同生命周期内管理合同的用户或员工。
说明合同负责人是合同推进过程中的主要联系人和责任人，通常是发起合同申请的人，或负责业务关系的人。按合同负责人分析绩效，可以发现效率、返工率和周期时间方面的规律。这有助于识别表现出色的个人或团队，以及可能需要额外培训或支持的人员。此属性也是“合同周期时间分析”等仪表板的重要分析维度。重要性支持按个人或团队分析绩效，帮助识别用户执行的活动中可借鉴的做法和改进空间。获取途径此属性通常是合同对象上的用户字段，常填写创建合同或拥有该工作流的用户姓名。示例 Alice SmithBob JohnsonCharlie Brown
	合同金额 ContractValue	合同的总金额。
说明此属性表示协议的财务价值，可以是一次性金额，也可以是周期性金额。合同金额往往决定所需的审查级别和审批路径的复杂程度。按合同金额分析流程，有助于优先处理高价值交易，并识别是否存在不必要的延误。此属性还可用于检查合规情况，例如确认金额超过特定门槛的合同是否已获得CFO批准。借助此属性，优化工作可以聚焦于财务影响最大的合同。重要性支持确定处理优先级和评估风险，因为高价值合同通常需要更严格的审查，业务影响也更大。获取途径此属性通常是DocuSign CLM合同元数据中的数值或货币字段。示例 500002500001200000
	结束时间 EndTime	表示某项活动或事件完成时间的时间戳。
说明此属性记录活动完成的准确日期和时间。开始时间标记活动的起点，结束时间则标记其完成时间，二者可用于准确计算单项活动的持续时间。分析结束时间对于计算活动的处理时间至关重要，也就是执行某项任务所花费的实际工作时间。这有助于区分实际工作时间和等待时间，深入了解资源效率以及延误的实际成本。例如，可据此计算“法务审核”活动的准确时长。重要性可准确计算单项活动的持续时间，帮助区分实际处理时间和空闲等待时间。获取途径在DocuSign CLM等系统中，此时间可能会明确记录在审计跟踪中，也可能需要根据后续事件的开始时间推算。示例 2023-04-15T17:30:00Z2023-05-21T10:00:15Z2023-06-01T11:55:00Z
	审批状态 ApprovalStatus	审批步骤的状态，例如“待处理”“已批准”或“已拒绝”。
说明此属性用于细化合同生命周期中审批阶段的状态。合同状态表示案例的整体状态，而审批状态则跟踪各项审批活动的结果。此属性对于“合同审批瓶颈报告”和“合同实时状态跟踪”至关重要。它清晰展示哪些合同正在等待审批、哪些已被拒绝并需要返工，以及哪些已顺利通过审批。分析这些状态之间的转换，有助于找出审批链中的具体故障点或延误环节。重要性详细呈现审批阶段的情况，帮助识别哪些合同陷入停滞及其原因。获取途径此属性表示DocuSign CLM中审批任务或工作流步骤的结果。示例等待法务审批财务已批准销售副总裁已拒绝
	审批阶段持续时间 ApprovalPhaseDuration	所有审批相关活动耗费的总时间。
说明此指标用于计算合同在审批阶段的总耗时，从首次提交内部审批开始，直到获得最后一项必要批准为止。可通过汇总所有审批相关活动的持续时间计算，也可计算首次审批活动开始至最后一项审批活动结束之间的时间。此属性是“平均审批阶段持续时间”KPI的核心指标。它有助于单独识别审批流程造成的延误，而非起草或谈判环节造成的延误。跟踪此时长可以帮助组织更好地了解审批矩阵的影响，并发现简化审批流程的机会。重要性单独衡量审批耗时，便于精准识别和解决审批链中的瓶颈。获取途径在流程挖掘工具中识别所有审批相关事件（例如“已发送内部审批”“已收到内部审批”），并计算每个案例中首个和最后一个此类事件之间的时间。示例 5天2小时10天1小时2天6小时
	文档版本 DocumentVersion	合同文档的版本号。
说明此属性用于跟踪合同文档在修订和红线修改过程中的版本。每次上传或保存新版本时，版本号都应递增。跟踪文档版本是衡量返工情况和谈判复杂程度的直接方式。合同版本较多，通常意味着双方进行了大量反复沟通。此属性是计算“文档平均修订次数”KPI和分析“合同返工与修订频率”仪表板的主要数据来源。重要性通过跟踪文档的修订次数，直接衡量返工量和谈判投入。获取途径 DocuSign CLM内置文档版本控制功能。此属性可从文档的版本历史中提取。示例 1234
	是否发生返工 IsRework	用于标记合同是否经历过重大修订循环的布尔值。
说明此计算属性用于识别发生过返工的合同，例如合同已获内部批准后，又被退回进行红线修改。通常可通过查找特定的不理想活动顺序来推导此属性。此标记简化了流程低效情况的分析，可直接用于计算“合同返工率”KPI，也便于筛选和分析需要额外投入的合同。借此可以找出返工的根本原因，例如初始需求不明确或谈判难点较多。重要性帮助量化和分析返工频率，这是衡量流程低效和隐性成本的重要指标。获取途径可在流程挖掘工具中定义规则来计算此属性，以识别返工循环，例如“合同已红线修改”事件发生在“已收到内部批准”事件之后。示例 truefalse
	是否已电子签署 IsESigned	用于标记合同是否通过电子签名完成签署的布尔值。
说明此属性用于跟踪合同是通过DocuSign eSignature等集成电子签名工具签署，还是通过线下方式完成签署（例如手写签名后扫描）。此属性直接支持“电子签名采用率”KPI。通过分析电子签署合同的比例，企业可以衡量数字化转型举措的成效。采用率较高通常与更快的签署速度、更低的管理成本，以及更完善的合规和文档跟踪相关。重要性衡量数字化流程的采用情况，并帮助量化使用集成电子签名功能带来的效率提升。获取途径可通过检查“合同签署完成”事件是否来自集成的DocuSign eSignature服务来确定。示例 truefalse
	法务顾问 LegalCounsel	受指派审核合同的法律专业人员或团队成员。
说明此属性用于标识负责审核和批准合同的法务部门具体人员，与通常来自业务部门的合同负责人不同。将审核任务分配给具体法务顾问后，即可详细分析法务审核环节的绩效。借助此属性，可以创建“法务审核绩效”仪表板，衡量并比较不同法务团队成员的处理量和周期时间，为平衡工作量、发现法务部门的效率机会提供依据。重要性支持深入分析法务审核环节，帮助平衡工作量并衡量法务团队的绩效。获取途径此属性取自DocuSign CLM工作流中的任务分配数据，用于标明“法务审核”任务的受派人。示例 Jennifer WaltersMatt MurdockHarvey Specter
	部门 Department	拥有该合同的内部业务单元或部门。
说明此属性用于标明发起合同或负责合同的内部部门，例如销售、市场或IT。不同部门的流程和需求各异，因此合同管理方式也可能不同。按部门细分分析，对于了解业务各部门如何使用合同管理流程至关重要。此属性有助于创建有针对性的报告，例如“合同审批瓶颈报告”，以识别延误是否集中在特定业务单元，并据此制定符合部门需求的流程改进措施。重要性支持比较不同业务单元的绩效，揭示效率、合规和工作量方面的差异。获取途径此属性可能是合同上的元数据字段，也可能根据合同负责人的所属部门推导得出。示例销售法务采购市场

必填建议填写选填

合同管理活动

为准确发现合同管理流程，建议在事件日志中记录以下关键步骤和里程碑。

6 建议填写 9 选填

	活动	说明
	发起合同申请	此活动标志着合同生命周期正式开始。通常在用户提交合同申请表或在DocuSign CLM中创建新的合同记录并触发相关工作流时记录。
重要性这是流程的主要开始事件。分析此活动对于衡量合同整体处理量和端到端周期时间的起点至关重要。获取途径此事件取自审计日志或工作流历史记录，对应合同记录的创建时间戳或申请表的提交时间戳。采集记录合同发起表单的提交或新合同对象的创建。事件类型 explicit
	发送合同以供签署	此活动标志着最终批准合同的电子签名流程启动。这是DocuSign的核心功能，用户通过DocuSign eSignature信封发送文件时即可记录。
重要性这是合同执行前的重要里程碑。分析从此时到合同执行的耗时，有助于了解签名收集效率，并支持“电子签名采用率”关键绩效指标。获取途径这是文件详细历史记录或审计轨迹中明确记录的核心事件，通常称为“信封历史记录”。采集创建并发送eSignature信封时，系统会直接记录此事件。事件类型 explicit
	合同已执行	表示合同已成功完成，即最后一位必需签署人签署文件。DocuSign eSignature平台会明确记录此事件。
重要性这是合同创建流程的主要成功终点。计算“平均合同周期时间”和衡量整体流程处理量都离不开此事件。获取途径 eSignature工作流全部完成时，完成证书和文件审计日志会记录此事件的时间戳。采集最后一个签名完成时，eSignature组件会自动记录。事件类型 explicit
	合同终止	此活动表示合同生命周期正式结束，原因可能是到期、取消或双方协商一致。通常通过系统中的手动状态变更记录。
重要性这是流程的另一种结束方式。跟踪合同终止和到期情况，对于了解完整合同生命周期和开展续约分析至关重要。获取途径用户将合同状态更新为“已终止”“已到期”或“已取消”时记录此事件，并使用状态变更的时间戳。采集合同的主要状态字段变更为终止状态时，可据此推断。事件类型 inferred
	开始法律审查	标志着合同正式提交法务部门审查并征求意见。合同进入工作流的“法律审查”阶段时，即可记录这一关键步骤。
重要性法律审查是合同管理中常见的瓶颈。衡量其持续时间对于“法律审查绩效”仪表板以及发现提速机会至关重要。获取途径此事件取自工作流审计轨迹，其中记录了任务分配给法务团队，或合同状态变为“法律审查中”的时间戳。采集合同被分配至法律审查任务或队列时，由工作流引擎记录。事件类型 explicit
	收到内部审批	此里程碑表示所有必需的内部审批人员均已批准合同。工作流中最后一位必需审批人员完成任务时，即可记录此活动。
重要性这是一个关键里程碑，表示合同已准备好进入外部谈判或执行阶段。到达此节点前的延误可能反映内部协调问题。获取途径审批任务进入最终“已批准”状态时，工作流历史记录会记录此事件。采集顺序审批或并行审批工作流中的最后一位审批人员完成审批时记录。事件类型 explicit
	修订合同	此活动表示合同文件在谈判或审查过程中经过修订或修改。每次上传或保存文件新版本时都会记录。
重要性跟踪修订次数对于“合同返工率”关键绩效指标至关重要。修订次数过多可能意味着条款不清晰、谈判效率低或初稿质量不佳。获取途径根据与合同关联的文件版本历史推导。初稿之后创建的每个新版本都可视为一次“合同修订”事件。采集在DocuSign CLM存储库中上传或生成文件新版本时记录。事件类型 explicit
	发起合同续约	标志着现有合同续约流程开始。此活动通常由合同负责人手动触发，也可能根据合同到期日自动触发。
重要性此活动对于跟踪“合同按时续约率”关键绩效指标至关重要，可帮助了解组织管理即将到期合同的主动程度。获取途径执行特定的“续约合同”操作时记录。该操作可能会创建与原合同关联的新合同记录，或启动续约工作流。采集用户执行特定操作或自动触发续约工作流时记录。事件类型 explicit
	发送给合同对方	表示将合同文件发送给外部合同对方审查并签署。通过DocuSign CLM中的“发送”或“共享”操作即可记录此活动。
重要性此活动标志着合同移交给外部方，此时流程控制能力有限。了解合同在对方手中的耗时，有助于发现外部延误。获取途径此活动取自审计轨迹，其中记录了通过CLM发送附有文件的电子邮件，或通过外部门户共享文件等操作。采集通过平台功能向外部共享文件时，根据具体用户操作记录。事件类型 explicit
	合同已存入存储库	这是最后一个行政步骤，已完成签署的合同会自动归档至中央合同存储库。此事件通常由签署流程完成触发。
重要性确保流程以妥善归档记录收尾。此活动标志着执行前生命周期的结束和执行后阶段的开始。获取途径归档已签署文件的最后一步完成时，工作流历史记录会记录此活动。采集合同成功执行后，工作流引擎会将其记录为最后一个自动化步骤。事件类型 explicit
	开始与合同对方谈判	表示合同对方已作出回应，通常是提供反馈或修订后的合同版本。外部方上传文件新版本，或状态退回内部审查阶段时，可据此推断。
重要性此活动对于分析“每份合同的谈判交接次数”关键绩效指标至关重要。内部团队与合同对方之间频繁进行双向导入导出，可能表明谈判存在阻碍。获取途径收到外部来源提供的文件新版本，或用户手动更改状态以表示已收到合同对方反馈时，可据此推断。采集合同交由合同对方处理后，状态变回“内部审查”或“起草”时，可据此推断。事件类型 inferred
	开始义务监控	此活动表示执行后管理开始，期间会跟踪关键日期和交付事项。启动合同义务监控任务或子流程时即可记录。
重要性此活动对于“执行后义务履行率”关键绩效指标至关重要，可帮助您了解签署后合同承诺是否得到管理。获取途径需要进行系统分析。此活动可能根据与主合同关联的特定义务跟踪任务或工作流的创建情况记录。采集创建执行后义务管理相关任务或工作流时记录。事件类型 explicit
	开始内部审查	此活动表示合同草稿已提交给财务或运营等内部业务相关方审查。用户在工作流中启动“内部审查”任务时，即可记录此活动。
重要性这标志着审查阶段的开始，该阶段往往容易出现瓶颈。分析其持续时间有助于发现利益相关方反馈延迟。获取途径当合同状态变为“内部审查”，或审查任务分配给法务以外的内部用户时，工作流历史记录会记录此活动。采集工作流转入内部业务审查状态，或分配相应任务时记录。事件类型 explicit
	提交内部审批	合同完成审查后，会提交给指定的内部审批人员进行正式审批，此时便会发生此活动。启动审批工作流时即可记录。
重要性这标志着最终内部签批阶段的开始。其持续时间是“平均审批阶段持续时间”关键绩效指标的重要组成部分。获取途径用户提交合同进行审批时，工作流历史记录会记录这一明确操作，并触发审批人员任务分配。采集执行“提交审批”或类似工作流操作时记录。事件类型 explicit
	起草合同	表示合同文件初稿的创建和完成。首次上传或生成文件并将其保存在系统中时，即可记录此活动。
重要性跟踪此活动有助于了解审查开始前的起草和准备耗时，并为衡量后续修改频率提供基准。获取途径可根据合同文件历史记录中首个文件版本的创建时间戳，或状态变更为“起草完成”来推断。采集识别与合同ID关联的首个文件版本创建事件。事件类型 inferred

建议填写选填

提取指南

如何从DocuSign CLM获取数据

步骤

准备工作与API设置：运行脚本前，您必须拥有可访问API的DocuSign CLM账户。在DocuSign管理面板中创建集成密钥（应用ID），并将其配置为使用JWT授权。生成RSA密钥对，并将公钥提供给DocuSign。记录用户ID（API用户名GUID）、集成密钥和账户ID。
配置Python环境：设置本地Python环境。运行以下命令，安装用于发送API请求和处理JWT身份验证的必要库：pip install requests PyJWT pandas。建议使用Pandas简化数据处理和CSV导出。
在脚本中添加凭据：打开Python脚本，填写顶部的占位变量，包括INTEGRATION_KEY、USER_ID、ACCOUNT_ID、OAUTH_BASE_PATH（例如，演示账户使用account-d.docusign.com）以及private.key文件路径。
设置提取参数：在脚本主体中定义START_DATE和END_DATE，指定合同数据的提取时间范围。脚本会按合同创建日期筛选，以控制数据量。
运行Python脚本：在终端中运行python your_script_name.py。脚本会先向DocuSign API进行身份验证并获取访问令牌。
获取API数据：随后脚本会发起一系列API调用，先搜索指定日期范围内的所有文档（合同），再逐份获取合同的详细工作流历史记录和文档版本历史记录。
转换并映射数据：脚本会处理API返回的原始JSON数据，遍历每份合同的工作流历史步骤和文档版本，并将特定工作流步骤名称（如“Legal Review”）及事件类型（如上传新版本）映射为事件日志所需的标准ActivityName，例如“Legal Review Started”和“Contract Redlined”。
提取属性：脚本会为每项活动提取所需属性。ContractId取自文档对象，EventTime取自工作流步骤时间戳，ContractOwner、ContractType和ContractValue等其他元数据则取自文档属性列表。
处理推断事件：脚本包含生成非显式工作流步骤事件的逻辑。例如，在发生“Sent to Counterparty”事件后，如果上传了新的文档版本，则推断发生了“Counterparty Negotiation Started”。
生成并检查CSV输出：处理完所有合同及其历史记录后，脚本会将数据整理为结构化格式，并使用Pandas库导出为docusign_clm_event_log.csv。此文件可直接上传到ProcessMind。

配置

API凭据：必须提供有效的集成密钥、用户ID（GUID）和用于JWT身份验证的RSA私钥。这些信息须在DocuSign管理面板中配置，并授予适当权限，通常包括“signature”和“impersonation”。
账户ID：需要指定DocuSign账户ID，所有API调用的基础URL都会使用该ID。
日期范围：脚本使用createdStartDate和createdEndDate参数筛选合同。建议先选择有限的时间范围，例如最近3至6个月，以控制提取时间并避免触发API速率限制。
工作流命名规则：脚本逻辑依赖工作流步骤名称（如“Legal Review”“Internal Approval”）进行匹配。您必须自定义脚本中的ACTIVITY_MAP字典，使其与组织DocuSign CLM配置中的步骤名称完全一致。
API速率限制：请注意，DocuSign的API速率限制会限制每小时的调用次数。脚本包含基本的time.sleep()延迟以降低影响，但处理大型数据集时可能需要更完善的退避策略。
前提条件：与用户ID关联的账户必须具备查看待提取合同、工作流和文档的足够权限。

查询示例 python

import requests
import jwt
import time
import datetime
import csv
import json

class=class="hl-string">"hl-comment"># --- Configuration --- 
class=class="hl-string">"hl-comment"># Replace with your DocuSign account details
INTEGRATION_KEY = class="hl-string">"[Your Integration Key]"
USER_ID = class="hl-string">"[Your User ID GUID]"
ACCOUNT_ID = class="hl-string">"[Your Account ID]"
OAUTH_BASE_PATH = class="hl-string">"account-d.docusign.com" class=class="hl-string">"hl-comment"># Use account.docusign.com for demo, account.docusign.com for production

class=class="hl-string">"hl-comment"># --- Constants ---
SOURCE_SYSTEM = class="hl-string">"DocuSign CLM"
LAST_DATA_UPDATE = datetime.datetime.utcnow().isoformat() + class="hl-string">'Z'

class=class="hl-string">"hl-comment"># --- Functions ---
def get_access_token(private_key_path):
    class="hl-string">"""Generates a JWT and exchanges it for an access token."""
    try:
        with open(private_key_path, class="hl-string">'r') as key_file:
            private_key = key_file.read()

        payload = {
            class="hl-string">"iss": INTEGRATION_KEY,
            class="hl-string">"sub": USER_ID,
            class="hl-string">"iat": int(time.time()),
            class="hl-string">"exp": int(time.time()) + 3600,
            class="hl-string">"aud": OAUTH_BASE_PATH,
            class="hl-string">"scope": class="hl-string">"signature impersonation"
        }

        token = jwt.encode(payload, private_key, algorithm=class="hl-string">'RS256')
        
        headers = {class="hl-string">'Content-Type': class="hl-string">'application/x-www-form-urlencoded'}
        data = {
            class="hl-string">'grant_type': class="hl-string">'urn:ietf:params:oauth:grant-type:jwt-bearer',
            class="hl-string">'assertion': token
        }
        
        response = requests.post(fclass="hl-string">"https протокол://{OAUTH_BASE_PATH}/oauth/token", headers=headers, data=data)
        response.raise_for_status()
        return response.json()[class="hl-string">'access_token']

    except Exception as e:
        print(fclass="hl-string">"Error getting access token: {e}")
        return None

def get_document_attribute(doc_attributes, attribute_name):
    class="hl-string">"""Helper function to safely get a value from the document's attribute list."""
    for attr in doc_attributes:
        if attr.get(class="hl-string">'name') == attribute_name:
            return attr.get(class="hl-string">'value')
    return None

def extract_event_log(access_token, start_date_str, end_date_str):
    class="hl-string">"""Main function to extract, process, and save the event log."""
    
    event_log = []
    api_base_url = fclass="hl-string">"https протокол://{OAUTH_BASE_PATH.replace('account', 'api')}/api/v2/accounts/{ACCOUNT_ID}"
    headers = {class="hl-string">'Authorization': fclass="hl-string">'Bearer {access_token}', class="hl-string">'Content-Type': class="hl-string">'application/json'}
    
    class=class="hl-string">"hl-comment"># Activity mapping: Customize keys to match your workflow step names
    ACTIVITY_MAP = {
        class="hl-string">'Start': class="hl-string">'Contract Request Initiated',
        class="hl-string">'Drafting': class="hl-string">'Contract Drafted',
        class="hl-string">'Internal Review': class="hl-string">'Internal Review Started',
        class="hl-string">'Legal Review': class="hl-string">'Legal Review Started',
        class="hl-string">'Send for Internal Approval': class="hl-string">'Internal Approval Sent',
        class="hl-string">'Internal Approval': class="hl-string">'Internal Approval Received',
        class="hl-string">'Send to Counterparty': class="hl-string">'Sent to Counterparty',
        class="hl-string">'Send for Signature': class="hl-string">'Contract Sent for Signature',
        class="hl-string">'Executed': class="hl-string">'Contract Executed',
        class="hl-string">'Archive': class="hl-string">'Contract Stored in Repository',
        class="hl-string">'Start Obligation Monitoring': class="hl-string">'Obligation Monitoring Started',
        class="hl-string">'Initiate Renewal': class="hl-string">'Contract Renewal Initiated',
        class="hl-string">'Terminate': class="hl-string">'Contract Terminated'
    }
    
    class=class="hl-string">"hl-comment"># 1. Search for documents (contracts)
    search_url = fclass="hl-string">"{api_base_url}/search"
    search_params = {
        class="hl-string">'q': fclass="hl-string">'IsLatestVersion:true AND CreatedDate:[{start_date_str} TO {end_date_str}]',
        class="hl-string">'limit': 100, class=class="hl-string">"hl-comment"># Max limit per page
        class="hl-string">'offset': 0
    }
    
    while True:
        print(fclass="hl-string">"Searching for documents with offset {search_params['offset']}...")
        response = requests.get(search_url, headers=headers, params=search_params)
        if response.status_code != 200:
            print(fclass="hl-string">"Error searching documents: {response.text}")
            break
        
        data = response.json()
        documents = data.get(class="hl-string">'value', [])
        
        if not documents:
            print(class="hl-string">"No more documents found.")
            break

        for doc in documents:
            contract_id = doc.get(class="hl-string">'id')
            doc_attributes = doc.get(class="hl-string">'attributes', [])
            
            base_event_data = {
                class="hl-string">'ContractId': contract_id,
                class="hl-string">'ContractStatus': get_document_attribute(doc_attributes, class="hl-string">'Contract Status'),
                class="hl-string">'ContractOwner': get_document_attribute(doc_attributes, class="hl-string">'Contract Owner'),
                class="hl-string">'ContractType': doc.get(class="hl-string">'documentTypeName'),
                class="hl-string">'ContractValue': get_document_attribute(doc_attributes, class="hl-string">'Contract Value'),
                class="hl-string">'Counterparty': get_document_attribute(doc_attributes, class="hl-string">'Counterparty Name'),
                class="hl-string">'ExpirationDate': get_document_attribute(doc_attributes, class="hl-string">'Expiration Date'),
                class="hl-string">'SourceSystem': SOURCE_SYSTEM,
                class="hl-string">'LastDataUpdate': LAST_DATA_UPDATE,
                class="hl-string">'EndTime': None, class=class="hl-string">"hl-comment"># Can be populated if logic is added
                class="hl-string">'CycleTime': None class=class="hl-string">"hl-comment"># Requires post-processing
            }
            
            class=class="hl-string">"hl-comment"># 2. Get workflow history for each document
            workflow_url = fclass="hl-string">"{api_base_url}/documents/{contract_id}/workflow"
            workflow_response = requests.get(workflow_url, headers=headers)
            
            if workflow_response.status_code == 200:
                workflow_data = workflow_response.json()
                
                class=class="hl-string">"hl-comment"># Process workflow steps
                for step in workflow_data.get(class="hl-string">'workflow', {}).get(class="hl-string">'steps', []):
                    step_name = step.get(class="hl-string">'stepName')
                    if step_name in ACTIVITY_MAP:
                        event = base_event_data.copy()
                        event[class="hl-string">'ActivityName'] = ACTIVITY_MAP[step_name]
                        event[class="hl-string">'EventTime'] = step.get(class="hl-string">'started')
                        event[class="hl-string">'EndTime'] = step.get(class="hl-string">'completed')
                        event_log.append(event)
                        
                        class=class="hl-string">"hl-comment"># Special case for final approval
                        if step_name == class="hl-string">'Internal Approval' and step.get(class="hl-string">'completed'):
                            event_approval = base_event_data.copy()
                            event_approval[class="hl-string">'ActivityName'] = class="hl-string">'Internal Approval Received'
                            event_approval[class="hl-string">'EventTime'] = step.get(class="hl-string">'completed')
                            event_log.append(event_approval)
                            
            class=class="hl-string">"hl-comment"># 3. Get document version history for class="hl-string">'Contract Redlined' events
            versions_url = fclass="hl-string">"{api_base_url}/documents/{contract_id}/versions"
            versions_response = requests.get(versions_url, headers=headers)
            if versions_response.status_code == 200:
                versions_data = versions_response.json()
                for version in versions_data.get(class="hl-string">'value', []):
                    if version.get(class="hl-string">'versionNumber', 0) > 1: class=class="hl-string">"hl-comment"># Version 1 is the initial draft
                        event = base_event_data.copy()
                        event[class="hl-string">'ActivityName'] = class="hl-string">'Contract Redlined'
                        event[class="hl-string">'EventTime'] = version.get(class="hl-string">'createdDate')
                        event_log.append(event)
        
        class=class="hl-string">"hl-comment"># Handle pagination
        search_params[class="hl-string">'offset'] += len(documents)
        if len(documents) < 100:
            break class=class="hl-string">"hl-comment"># Last page

        time.sleep(1) class=class="hl-string">"hl-comment"># Simple rate limit mitigation
        
    class=class="hl-string">"hl-comment"># 4. Save to CSV
    if not event_log:
        print(class="hl-string">"No events were extracted.")
        return

    class=class="hl-string">"hl-comment"># Sort events by contract and time for logical order
    event_log.sort(key=lambda x: (x[class="hl-string">'ContractId'], x[class="hl-string">'EventTime'] or class="hl-string">''))

    fieldnames = [
        class="hl-string">'ContractId', class="hl-string">'ActivityName', class="hl-string">'EventTime', class="hl-string">'EndTime', class="hl-string">'ContractStatus',
        class="hl-string">'ContractOwner', class="hl-string">'ContractType', class="hl-string">'ContractValue', class="hl-string">'Counterparty',
        class="hl-string">'ExpirationDate', class="hl-string">'CycleTime', class="hl-string">'SourceSystem', class="hl-string">'LastDataUpdate'
    ]
    
    with open(class="hl-string">'docusign_clm_event_log.csv', class="hl-string">'w', newline=class="hl-string">'', encoding=class="hl-string">'utf-8') as csvfile:
        writer = csv.DictWriter(csvfile, fieldnames=fieldnames)
        writer.writeheader()
        writer.writerows(event_log)
        
    print(fclass="hl-string">"Successfully extracted {len(event_log)} events to docusign_clm_event_log.csv")

if __name__ == class="hl-string">"__main__":
    class=class="hl-string">"hl-comment"># --- Execution --- 
    PRIVATE_KEY_PATH = class="hl-string">"./private.key" class=class="hl-string">"hl-comment"># Path to your RSA private key file
    START_DATE = class="hl-string">"2023-01-01T00:00:00Z"
    END_DATE = class="hl-string">"2023-12-31T23:59:59Z"
    
    access_token = get_access_token(PRIVATE_KEY_PATH)
    if access_token:
        extract_event_log(access_token, START_DATE, END_DATE)

准备好开始了吗？

借助此数据模板，快速开启流程挖掘之旅，发掘合同管理工作流中的效率提升空间。

返回改进指南

下载模板

告别延误：立即优化合同管理

找出低效环节，将周期时间缩短30%，并加强合规管理。

开始免费试用

无需信用卡 • 几分钟即可开始

您的合同管理数据模板

您的合同管理数据模板

合同管理属性

合同管理活动

提取指南

使用DocuSign CLM REST API的Python脚本

步骤

配置

查询示例 python

准备好开始了吗？

告别延误：立即优化合同管理