GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  OPENXPKI::SERVER::WORKFLOW::ACTIVITY::REPORTS::DETAIL (3)

.ds Aq ’

Name

OpenXPKI::Server::Workflow::Activity::Reports::Detail

CONTENTS

Description

Write a detailed report with certificate status information to a CSV file. Selection criteria and output format can be controlled by several activity parameters, the default is to print all currenty valid certificates.

Configuration

    Activity parameters

target_filename Filename to write the report to, if relative (no slash), target_dir must be set and will be prepended. If not given, a random filename is set.
target_dir Mandatory if target_filename is relative. If either one is set, the system temp dir is used.
target_umask The umask to set on the generated file, default is 640. Note that the owner is the user/group running the socket, if you want to download this file using the webserver, make sure that either the webserver has permissions on the daemons group or set the umask to 644.
include_expired Parseable OpenXPKI::Datetime value (autodetected), certificates which are expired after the given date are included in the report. Default is not to include expired certificates.
include_revoked If set to a true value, certificates which are not in ISSUED state (revoked, crl pending, on hold) are also included in the report. Default is to show only issued certificates.
valid_at Parseable OpenXPKI::Datetime value (autodetected) used as base for validity calculation. Default is now.
cutoff_notbefore Parseable OpenXPKI::Datetime value (autodetected), show certificates where notebefore is greater than value.
cutoff_notafter Parseable OpenXPKI::Datetime value (autodetected), show certificates where notafter is less then value.
unique_subject If set to a true value, only the certiticate with the latest notbefore date for each subject is included in the report. Note that filtering on subject is done AFTER the other filters, e.g. in case you do not include revoked certifiates you get the latest one that was not revoked.
report_config Lookup extended specifications in the config system at report.<report_config>. The config can contain any of cutoff_notbefore, cutoff_notafter, include_revoked, include_expired. which will override any given value from the activity if a value is given. Additional columns can also be specified, these are appended at the end of each line.



   cols:
     - head: Title put in the head columns
       cert: issuer_identifier
     - head: Just another title
       attribute: meta_email
     - head: Third column
       template: "[% attribute.meta_email %]"



The cert key takes the value from the named column from the certificate table, attribute shows the value of the attribute. template is passed to OpenXPKI::Template with cert and attribute set. Note that all attributes are lists, even if there are single valued!

    Full example

Your activity definition:



    generate_report:
        class: OpenXPKI::Server::Workflow::Activity::Reports::Detail
        param:           
            target_umask: 0644
            _map_target_filename: "expiry report [% USE date(format=%Y-%m-%dT%H:%M:%S) %][% date.format( context.valid_at ) %].csv"
            target_dir: /tmp
            report_config: expiry



Content of report/expiry.yaml inside realms config directory:



   cutoff_notafter: +000060
   include_expired: -000030
   
   cols:
     - head: Requestor eMail
       attribute: meta_email



This gives you a nice report about certificates which have expired within the last 30 days or will expire in the next 60 days with the contact email used while the request process.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 OPENXPKI::SERVER::WORKFLOW::ACTIVITY::REPORTS::DETAIL (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.